fix: annotation & naming convention

katanomi · Aug 22, 2022 · ee3b957 · ee3b957
1 parent 864a63c
commit ee3b957
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 10 deletions.
diff --git a/apis/data/v1alpha1/zz_generated.deepcopy.go b/apis/data/v1alpha1/zz_generated.deepcopy.go
diff --git a/apis/meta/v1alpha1/project_types.go b/apis/meta/v1alpha1/project_types.go
@@ -55,7 +55,7 @@ func (r ProjectSubType) Validate(fld *field.Path) field.ErrorList {
 		MavenRepositoryProjectSubType: {},
 		RawRepositoryProjectSubType:   {},
 		ProjectManagementSubtype:      {},
-		TestProjectSubtype:            {},
+		TestProjectSubType:            {},
 	}
 
 	if _, exist := supportedTypes[r]; !exist {
@@ -87,8 +87,8 @@ const (
 	// ProjectManagementSubtype project management subtype
 	ProjectManagementSubtype ProjectSubType = "ProjectManagement"
 
-	// TestProjectSubtype test project subtype
-	TestProjectSubtype ProjectSubType = "TestProject"
+	// TestProjectSubType test project subtype
+	TestProjectSubType ProjectSubType = "TestProject"
 
 	// TODO: add more subtypes
 )

diff --git a/apis/meta/v1alpha1/testmodule_types.go b/apis/meta/v1alpha1/testmodule_types.go
@@ -48,7 +48,7 @@ type TestModuleSpec struct {
 // TestModuleCaseRef refers to a test module and its order
 type TestModuleCaseRef struct {
 	// TestObjectRef refers to a test case
-	TestObjectRef `json:"ref"`
+	TestCase TestObjectRef `json:"ref"`
 	// Order indicates the ASC order of the object at same level
 	Order int `json:"order"`
 }
@@ -77,7 +77,7 @@ func (tm *TestModule) ContainsTestCaseID(caseID string) bool {
 	}
 
 	for _, tc := range tm.Spec.TestCases {
-		if tc.ID == caseID {
+		if tc.TestCase.ID == caseID {
 			return true
 		}
 	}

diff --git a/apis/meta/v1alpha1/testmodule_types_test.go b/apis/meta/v1alpha1/testmodule_types_test.go
@@ -38,7 +38,7 @@ var _ = Describe("TestModule", func() {
 		tm := TestModule{Spec: TestModuleSpec{
 			TestCases: []TestModuleCaseRef{
 				{
-					TestObjectRef: TestObjectRef{ID: "123", Name: "abc"},
+					TestCase: TestObjectRef{ID: "123", Name: "abc"},
 				},
 			},
 		}}

diff --git a/apis/meta/v1alpha1/testplan_types.go b/apis/meta/v1alpha1/testplan_types.go
@@ -108,7 +108,7 @@ type TestProjectOptions struct {
 	Search string `json:"search"`
 }
 
-func GetRefByIDFromMap(m map[string]*TestObjectRef, ID string) *TestObjectRef {
+func RefFromMap(m map[string]*TestObjectRef, ID string) *TestObjectRef {
 	if m == nil {
 		return nil
 	}

diff --git a/apis/meta/v1alpha1/zz_generated.deepcopy.go b/apis/meta/v1alpha1/zz_generated.deepcopy.go
diff --git a/plugin/client/testcase.go b/plugin/client/testcase.go
@@ -25,6 +25,7 @@ import (
 	duckv1 "knative.dev/pkg/apis/duck/v1"
 )
 
+// ClientTestCase for test case
 type ClientTestCase interface {
 	List(ctx context.Context, baseURL *duckv1.Addressable, params metav1alpha1.TestProjectOptions, options ...OptionFunc) (*metav1alpha1.TestCaseList, error)
 	Get(ctx context.Context, baseURL *duckv1.Addressable, params metav1alpha1.TestProjectOptions, options ...OptionFunc) (*metav1alpha1.TestCase, error)

diff --git a/plugin/client/testcaseexecution.go b/plugin/client/testcaseexecution.go
@@ -25,6 +25,7 @@ import (
 	duckv1 "knative.dev/pkg/apis/duck/v1"
 )
 
+// ClientTestCaseExecution client for test case execution
 type ClientTestCaseExecution interface {
 	List(ctx context.Context,
 		baseURL *duckv1.Addressable,

diff --git a/plugin/client/testmodule.go b/plugin/client/testmodule.go
@@ -25,6 +25,7 @@ import (
 	duckv1 "knative.dev/pkg/apis/duck/v1"
 )
 
+// ClientTestModule client for test module
 type ClientTestModule interface {
 	List(ctx context.Context, baseURL *duckv1.Addressable, params metav1alpha1.TestProjectOptions, options ...OptionFunc) (*metav1alpha1.TestModuleList, error)
 }

diff --git a/plugin/client/testplan.go b/plugin/client/testplan.go
@@ -25,6 +25,7 @@ import (
 	duckv1 "knative.dev/pkg/apis/duck/v1"
 )
 
+// ClientTestPlan client for test plan
 type ClientTestPlan interface {
 	List(ctx context.Context,
 		baseURL *duckv1.Addressable,