Merge pull request #201 from cschleiden/more-reliable-analyzer

Make the analyzer workflow detection more robust

Author: cschleiden

analyzer/analyzer.go

@@ -23,8 +23,9 @@ func run(pass *analysis.Pass) (interface{}, error) {
 	// AST node is a descendant of a workflow FuncDecl.
 	inWorkflow := true
 
-	inspector.Nodes(nil, func(node ast.Node, push bool) bool {
+	workflowImportName := "workflow"
 
+	inspector.Nodes(nil, func(node ast.Node, push bool) bool {
 		if _, ok := node.(*ast.FuncDecl); ok {
 			if !push {
 				// Finished with the current workflow
@@ -44,9 +45,14 @@ func run(pass *analysis.Pass) (interface{}, error) {
 		}
 
 		switch n := node.(type) {
+		case *ast.ImportSpec:
+			if n.Path.Value == `"github.com/cschleiden/go-workflows/workflow"` {
+				workflowImportName = n.Name.Name
+			}
+
 		case *ast.FuncDecl:
 			// Only check functions that look like workflows
-			if !isWorkflow(n) {
+			if !isWorkflow(workflowImportName, n) {
 				return false
 			}
 
@@ -170,7 +176,7 @@ func checkNamed(pass *analysis.Pass, ref types.Object, named *types.Named) {
 
 }
 
-func isWorkflow(funcDecl *ast.FuncDecl) bool {
+func isWorkflow(workflowImportName string, funcDecl *ast.FuncDecl) bool {
 	params := funcDecl.Type.Params.List
 
 	// Need at least workflow.Context
@@ -189,7 +195,7 @@ func isWorkflow(funcDecl *ast.FuncDecl) bool {
 	}
 
 	selname := firstParam.Sel.Name
-	if xname.Name+"."+selname != "workflow.Context" {
+	if xname.Name+"."+selname != workflowImportName+".Context" {
 		return false
 	}
 

analyzer/analyzer_test.go

@@ -7,5 +7,5 @@ import (
 )
 
 func TestAll(t *testing.T) {
-	analysistest.Run(t, analysistest.TestData(), Analyzer, "p")
+	analysistest.Run(t, analysistest.TestData(), Analyzer, "p", "q")
 }

analyzer/testdata/src/github.com/cschleiden/go-workflows/workflow/workflow.go

@@ -0,0 +1,3 @@
+package workflow
+
+type Context interface{}

analyzer/testdata/src/p/p.go

@@ -1,19 +1,20 @@
-//nolint
+// nolint
 package p
 
 // Work around module issues. The analyzer just looks for `workflow.Context` currently
 import (
 	"context"
-	workflow "context"
 	"fmt"
 	"time"
 
+	workflow "github.com/cschleiden/go-workflows/workflow"
+
 	"sync"
 )
 
 var foo int = 42
 
-func wf(ctx workflow.Context) error {
+func wfSimple(ctx workflow.Context) error {
 	fmt.Println(foo)
 
 	return nil

analyzer/testdata/src/q/q.go

@@ -0,0 +1,11 @@
+// nolint
+package q
+
+// Work around module issues. The analyzer just looks for `workflow.Context` currently
+import (
+	wf "github.com/cschleiden/go-workflows/workflow"
+)
+
+func wfWrongOrder2(ctx wf.Context) (error, string) { // want "workflow `wfWrongOrder2` doesn't return `error` as last return value"
+	return nil, ""
+}