Detect Invoke as a task runner via tasks.py

Author: andrew

detect/detect_test.go

@@ -548,6 +548,46 @@ func TestDetectSelfNotTriggeredOnOtherGoProjects(t *testing.T) {
 	}
 }
 
+func TestInvokeDetection(t *testing.T) {
+	dir := t.TempDir()
+	if err := os.WriteFile(filepath.Join(dir, "foo.py"), []byte("x = 1\n"), 0o644); err != nil {
+		t.Fatal(err)
+	}
+	tasks := "from invoke import task\n\n@task\ndef build(c):\n    c.run('true')\n"
+	if err := os.WriteFile(filepath.Join(dir, "tasks.py"), []byte(tasks), 0o644); err != nil {
+		t.Fatal(err)
+	}
+
+	r, err := New(loadKB(t), dir).Run()
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+
+	assertToolDetected(t, r, "build", "Invoke")
+	for _, d := range r.Tools["build"] {
+		if d.Name == "Invoke" {
+			if d.Command == nil || d.Command.Run != "invoke --list" {
+				t.Errorf("expected 'invoke --list' command, got %v", d.Command)
+			}
+		}
+	}
+
+	// A tasks.py that doesn't import invoke should not trigger detection.
+	celery := "from celery import shared_task\n\n@shared_task\ndef foo():\n    pass\n"
+	if err := os.WriteFile(filepath.Join(dir, "tasks.py"), []byte(celery), 0o644); err != nil {
+		t.Fatal(err)
+	}
+	r, err = New(loadKB(t), dir).Run()
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	for _, d := range r.Tools["build"] {
+		if d.Name == "Invoke" {
+			t.Error("tasks.py without invoke import should not trigger Invoke detection")
+		}
+	}
+}
+
 func assertToolDetected(t *testing.T, r *brief.Report, category, name string) {
 	t.Helper()
 	tools, ok := r.Tools[category]

knowledge/python/invoke.toml

@@ -2,18 +2,28 @@
 name = "Invoke"
 category = "build"
 homepage = "https://www.pyinvoke.org"
-docs = "https://www.pyinvoke.org"
+docs = "https://docs.pyinvoke.org"
 repo = "https://github.com/pyinvoke/invoke"
-description = "Task execution and command running"
+description = "Pythonic task execution, like Make or Rake"
 
 [detect]
+files = ["invoke.yaml", "invoke.yml", "invoke.json"]
 dependencies = ["invoke"]
 ecosystems = ["python"]
+[detect.file_contains]
+"tasks.py" = ["from invoke", "import invoke"]
+"tasks/__init__.py" = ["from invoke", "import invoke"]
+
+[commands]
+run = "invoke --list"
+alternatives = ["inv --list"]
+
+[config]
+files = ["tasks.py", "invoke.yaml", "invoke.yml", "invoke.json"]
 
 [taxonomy]
-role = ["library"]
-function = ["process-execution", "automation"]
-layer = ["backend"]
+role = ["build-tool"]
+function = ["automation", "process-execution"]
 
 [[security.sinks]]
 symbol = "Context.run"