cyclic: refactor to return error instead

Author: andreynering

cyclic.go

@@ -1,29 +1,29 @@
 package task
 
-// HasCyclicDep checks if a task tree has any cyclic dependency
-func (e *Executor) HasCyclicDep() bool {
+// CheckCyclicDep checks if a task tree has any cyclic dependency
+func (e *Executor) CheckCyclicDep() error {
 	visits := make(map[string]struct{}, len(e.Tasks))
 
-	var checkCyclicDep func(string, *Task) bool
-	checkCyclicDep = func(name string, t *Task) bool {
+	var checkCyclicDep func(string, *Task) error
+	checkCyclicDep = func(name string, t *Task) error {
 		if _, ok := visits[name]; ok {
-			return false
+			return ErrCyclicDepDetected
 		}
 		visits[name] = struct{}{}
 		defer delete(visits, name)
 
 		for _, d := range t.Deps {
-			if !checkCyclicDep(d.Task, e.Tasks[d.Task]) {
-				return false
+			if err := checkCyclicDep(d.Task, e.Tasks[d.Task]); err != nil {
+				return err
 			}
 		}
-		return true
+		return nil
 	}
 
 	for k, v := range e.Tasks {
-		if !checkCyclicDep(k, v) {
-			return true
+		if err := checkCyclicDep(k, v); err != nil {
+			return err
 		}
 	}
-	return false
+	return nil
 }

cyclic_test.go

@@ -4,6 +4,8 @@ import (
 	"testing"
 
 	"github.com/go-task/task"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestCyclicDepCheck(t *testing.T) {
@@ -18,9 +20,7 @@ func TestCyclicDepCheck(t *testing.T) {
 		},
 	}
 
-	if !isCyclic.HasCyclicDep() {
-		t.Error("Task should be cyclic")
-	}
+	assert.Equal(t, task.ErrCyclicDepDetected, isCyclic.CheckCyclicDep(), "task should be cyclic")
 
 	isNotCyclic := &task.Executor{
 		Tasks: task.Tasks{
@@ -34,7 +34,5 @@ func TestCyclicDepCheck(t *testing.T) {
 		},
 	}
 
-	if isNotCyclic.HasCyclicDep() {
-		t.Error("Task should not be cyclic")
-	}
+	assert.NoError(t, isNotCyclic.CheckCyclicDep())
 }

errors.go

@@ -6,8 +6,8 @@ import (
 )
 
 var (
-	// ErrCyclicDependencyDetected is returned when a cyclic dependency was found in the Taskfile
-	ErrCyclicDependencyDetected = errors.New("task: cyclic dependency detected")
+	// ErrCyclicDepDetected is returned when a cyclic dependency was found in the Taskfile
+	ErrCyclicDepDetected = errors.New("task: cyclic dependency detected")
 	// ErrTaskfileAlreadyExists is returned on creating a Taskfile if one already exists
 	ErrTaskfileAlreadyExists = errors.New("task: A Taskfile already exists")
 )

task.go

@@ -61,8 +61,8 @@ type Task struct {
 
 // Run runs Task
 func (e *Executor) Run(args ...string) error {
-	if e.HasCyclicDep() {
-		return ErrCyclicDependencyDetected
+	if err := e.CheckCyclicDep(); err != nil {
+		return err
 	}
 
 	if e.Stdin == nil {