Merge pull request #6 from stackrox/sb/add-find-func

Add find function for Test

Author: SimonBaeumer

pkg/framework/test.go

@@ -144,3 +144,37 @@ func (t *Test) forEachScopeTopDown(doFn func(t *Test)) {
 	}
 	doFn(t)
 }
+
+// findFirst tries to find the first test under a given path where the path's index represents the level of the test.
+func (t *Test) findFirst(path []string) *Test {
+	r := t.find(path)
+	if len(r) > 0 {
+		return r[0]
+	}
+
+	return nil
+}
+
+// find tries to find all tests under a given path where the path's index represents the level of the test.
+func (t *Test) find(path []string) []*Test {
+	var result []*Test
+	if t == nil || len(path) == 0 {
+		return nil
+	}
+
+	if path[0] != t.Name {
+		return nil
+	}
+	if len(path) == 1 {
+		return append(result, t)
+	}
+
+	for _, child := range t.Tests {
+		found := child.find(path[1:])
+		if found != nil {
+			return append(result, found...)
+		}
+	}
+
+	return nil
+}

pkg/framework/test_test.go

@@ -0,0 +1,59 @@
+package framework
+
+import (
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+func TestFind(t *testing.T) {
+	childTest := &Test{
+		Name: "child test",
+		Tests: []*Test{{
+			Name: "child child test",
+		}},
+	}
+	anotherChildTest := &Test{
+		Name: "another child test",
+		Tests: []*Test{{
+			Name: "another child child test",
+		}},
+	}
+
+	suite := &Test{
+		Name: "root test",
+		Tests: []*Test{
+			childTest,
+			anotherChildTest,
+			{Name: "same name"},
+			{Name: "same name"},
+		},
+	}
+
+	testCases := map[string]struct {
+		query          []string
+		expectNotFound bool
+	}{
+		"with only root node":                        {query: []string{"root test"}},
+		"with child test":                            {query: []string{"root test", "child test"}},
+		"with nested child":                          {query: []string{"root test", "child test", "child child test"}},
+		"with not existing nested":                   {query: []string{"root test", "child test", "child child test", "does not exist"}, expectNotFound: true},
+		"with not existing root":                     {query: []string{"root does not exist"}, expectNotFound: true},
+		"with another child":                         {query: []string{"root test", "another child test"}},
+		"with another nested child":                  {query: []string{"root test", "another child test", "another child child test"}},
+		"with same name finds both":                  {query: []string{"root test", "same name"}},
+		"with not existent root should not be found": {query: []string{"non-existent root test", "child test"}, expectNotFound: true},
+	}
+
+	for _, tt := range testCases {
+		results := suite.find(tt.query)
+		if tt.expectNotFound {
+			assert.Empty(t, results)
+		} else {
+			require.NotEmpty(t, results)
+			for _, result := range results {
+				assert.Equal(t, tt.query[len(tt.query)-1], result.Name)
+			}
+		}
+	}
+}