Use PipelineWorkspaceDeclaration instead of WorkspacePipelineDeclarat…

…ion 👷‍♀️ This is a super minor change to rename WorkspacePipelineDeclaration to PipelineWorkspaceDeclaration. WorkspacePipelineDeclaration sounds like it's a pipeline declaration inside of a workspace, but actually its meant to be a workspace declaration inside of a pipeline! I'm trying to pickup some of the work started in #1936 and this seemed like a reasonable improvement to carve off and merge on its own :D Co-authored-by: Scott <[email protected]>
tektoncd · Jun 3, 2020 · 2838997 · 2838997
1 parent ea3e72e
commit 2838997
Show file tree

Hide file tree

Showing 16 changed files with 45 additions and 40 deletions.
diff --git a/internal/builder/v1alpha1/pipeline.go b/internal/builder/v1alpha1/pipeline.go
@@ -609,7 +609,7 @@ func PipelineResourceSpecSecretParam(fieldname, secretName, secretKey string) Pi
 func PipelineWorkspaceDeclaration(names ...string) PipelineSpecOp {
 	return func(spec *v1alpha1.PipelineSpec) {
 		for _, name := range names {
-			spec.Workspaces = append(spec.Workspaces, v1alpha1.WorkspacePipelineDeclaration{Name: name})
+			spec.Workspaces = append(spec.Workspaces, v1alpha1.PipelineWorkspaceDeclaration{Name: name})
 		}
 	}
 }

diff --git a/internal/builder/v1alpha1/pipeline_test.go b/internal/builder/v1alpha1/pipeline_test.go
@@ -145,7 +145,7 @@ func TestPipeline(t *testing.T) {
 					}}},
 				}},
 			}},
-			Workspaces: []v1alpha1.WorkspacePipelineDeclaration{{
+			Workspaces: []v1alpha1.PipelineWorkspaceDeclaration{{
 				Name: "workspace1",
 			}},
 		},

diff --git a/internal/builder/v1beta1/pipeline.go b/internal/builder/v1beta1/pipeline.go
@@ -541,7 +541,7 @@ func PipelineRunTaskRunsStatus(taskRunName string, status *v1beta1.PipelineRunTa
 func PipelineWorkspaceDeclaration(names ...string) PipelineSpecOp {
 	return func(spec *v1beta1.PipelineSpec) {
 		for _, name := range names {
-			spec.Workspaces = append(spec.Workspaces, v1beta1.WorkspacePipelineDeclaration{Name: name})
+			spec.Workspaces = append(spec.Workspaces, v1beta1.PipelineWorkspaceDeclaration{Name: name})
 		}
 	}
 }

diff --git a/internal/builder/v1beta1/pipeline_test.go b/internal/builder/v1beta1/pipeline_test.go
@@ -144,7 +144,7 @@ func TestPipeline(t *testing.T) {
 					}}},
 				},
 			}},
-			Workspaces: []v1beta1.WorkspacePipelineDeclaration{{
+			Workspaces: []v1beta1.PipelineWorkspaceDeclaration{{
 				Name: "workspace1",
 			}},
 		},

diff --git a/pkg/apis/pipeline/v1alpha1/pipeline_conversion_test.go b/pkg/apis/pipeline/v1alpha1/pipeline_conversion_test.go
@@ -71,7 +71,7 @@ func TestPipelineConversion(t *testing.T) {
 					Type:        v1beta1.ParamTypeString,
 					Description: "My first param",
 				}},
-				Workspaces: []WorkspacePipelineDeclaration{{
+				Workspaces: []PipelineWorkspaceDeclaration{{
 					Name: "workspace1",
 				}},
 				Tasks: []PipelineTask{{

diff --git a/pkg/apis/pipeline/v1alpha1/pipeline_types.go b/pkg/apis/pipeline/v1alpha1/pipeline_types.go
@@ -39,7 +39,7 @@ type PipelineSpec struct {
 	// Workspaces declares a set of named workspaces that are expected to be
 	// provided by a PipelineRun.
 	// +optional
-	Workspaces []WorkspacePipelineDeclaration `json:"workspaces,omitempty"`
+	Workspaces []PipelineWorkspaceDeclaration `json:"workspaces,omitempty"`
 	// Results are values that this pipeline can output once run
 	// +optional
 	Results []PipelineResult `json:"results,omitempty"`

diff --git a/pkg/apis/pipeline/v1alpha1/pipeline_validation.go b/pkg/apis/pipeline/v1alpha1/pipeline_validation.go
@@ -231,7 +231,7 @@ func validatePipelineTaskName(ctx context.Context, prefix string, i int, t Pipel
 	return nil
 }
 
-func validatePipelineWorkspaces(wss []WorkspacePipelineDeclaration, pts []PipelineTask) *apis.FieldError {
+func validatePipelineWorkspaces(wss []PipelineWorkspaceDeclaration, pts []PipelineTask) *apis.FieldError {
 	// Workspace names must be non-empty and unique.
 	wsTable := make(map[string]struct{})
 	for i, ws := range wss {

diff --git a/pkg/apis/pipeline/v1alpha1/workspace_types.go b/pkg/apis/pipeline/v1alpha1/workspace_types.go
@@ -26,9 +26,9 @@ type WorkspaceDeclaration = v1beta1.WorkspaceDeclaration
 // WorkspaceBinding maps a Task's declared workspace to a Volume.
 type WorkspaceBinding = v1beta1.WorkspaceBinding
 
-// WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun
+// PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun
 // is expected to populate with a workspace binding.
-type WorkspacePipelineDeclaration = v1beta1.WorkspacePipelineDeclaration
+type PipelineWorkspaceDeclaration = v1beta1.PipelineWorkspaceDeclaration
 
 // WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be
 // mapped to a task's declared workspace.

diff --git a/pkg/apis/pipeline/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/pipeline/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/apis/pipeline/v1beta1/pipeline_types.go b/pkg/apis/pipeline/v1beta1/pipeline_types.go
@@ -67,7 +67,7 @@ type PipelineSpec struct {
 	// Workspaces declares a set of named workspaces that are expected to be
 	// provided by a PipelineRun.
 	// +optional
-	Workspaces []WorkspacePipelineDeclaration `json:"workspaces,omitempty"`
+	Workspaces []PipelineWorkspaceDeclaration `json:"workspaces,omitempty"`
 	// Results are values that this pipeline can output once run
 	// +optional
 	Results []PipelineResult `json:"results,omitempty"`

diff --git a/pkg/apis/pipeline/v1beta1/pipeline_validation.go b/pkg/apis/pipeline/v1beta1/pipeline_validation.go
@@ -245,7 +245,7 @@ func validatePipelineTaskName(ctx context.Context, prefix string, i int, t Pipel
 
 // validatePipelineWorkspaces validates the specified workspaces, ensuring having unique name without any empty string,
 // and validates that all the referenced workspaces (by pipeline tasks) are specified in the pipeline
-func validatePipelineWorkspaces(wss []WorkspacePipelineDeclaration, pts []PipelineTask) *apis.FieldError {
+func validatePipelineWorkspaces(wss []PipelineWorkspaceDeclaration, pts []PipelineTask) *apis.FieldError {
 	// Workspace names must be non-empty and unique.
 	wsTable := make(map[string]struct{})
 	for i, ws := range wss {

diff --git a/pkg/apis/pipeline/v1beta1/pipeline_validation_test.go b/pkg/apis/pipeline/v1beta1/pipeline_validation_test.go
@@ -85,7 +85,7 @@ func TestPipeline_Validate_Success(t *testing.T) {
 						StringVal: "pipeline-default",
 					},
 				}},
-				Workspaces: []WorkspacePipelineDeclaration{{
+				Workspaces: []PipelineWorkspaceDeclaration{{
 					Name:        "shared-workspace",
 					Description: "this is my shared workspace",
 				}},
@@ -978,11 +978,11 @@ func TestValidatePipelineParameterVariables_Failure(t *testing.T) {
 func TestValidatePipelineWorkspaces_Success(t *testing.T) {
 	tests := []struct {
 		name       string
-		workspaces []WorkspacePipelineDeclaration
+		workspaces []PipelineWorkspaceDeclaration
 		tasks      []PipelineTask
 	}{{
 		name: "unused pipeline spec workspaces do not cause an error",
-		workspaces: []WorkspacePipelineDeclaration{{
+		workspaces: []PipelineWorkspaceDeclaration{{
 			Name: "foo",
 		}, {
 			Name: "bar",
@@ -1004,11 +1004,11 @@ func TestValidatePipelineWorkspaces_Success(t *testing.T) {
 func TestValidatePipelineWorkspaces_Failure(t *testing.T) {
 	tests := []struct {
 		name       string
-		workspaces []WorkspacePipelineDeclaration
+		workspaces []PipelineWorkspaceDeclaration
 		tasks      []PipelineTask
 	}{{
 		name: "workspace bindings relying on a non-existent pipeline workspace cause an error",
-		workspaces: []WorkspacePipelineDeclaration{{
+		workspaces: []PipelineWorkspaceDeclaration{{
 			Name: "foo",
 		}},
 		tasks: []PipelineTask{{
@@ -1020,7 +1020,7 @@ func TestValidatePipelineWorkspaces_Failure(t *testing.T) {
 		}},
 	}, {
 		name: "multiple workspaces sharing the same name are not allowed",
-		workspaces: []WorkspacePipelineDeclaration{{
+		workspaces: []PipelineWorkspaceDeclaration{{
 			Name: "foo",
 		}, {
 			Name: "foo",
@@ -1030,7 +1030,7 @@ func TestValidatePipelineWorkspaces_Failure(t *testing.T) {
 		}},
 	}, {
 		name: "workspace name must not be empty",
-		workspaces: []WorkspacePipelineDeclaration{{
+		workspaces: []PipelineWorkspaceDeclaration{{
 			Name: "",
 		}},
 		tasks: []PipelineTask{{

diff --git a/pkg/apis/pipeline/v1beta1/workspace_types.go b/pkg/apis/pipeline/v1beta1/workspace_types.go
@@ -78,7 +78,12 @@ type WorkspaceBinding struct {
 
 // WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun
 // is expected to populate with a workspace binding.
-type WorkspacePipelineDeclaration struct {
+// Deprecated: use PipelineWorkspaceDeclaration type instead
+type WorkspacePipelineDeclaration = PipelineWorkspaceDeclaration
+
+// PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun
+// is expected to populate with a workspace binding.
+type PipelineWorkspaceDeclaration struct {
 	// Name is the name of a workspace to be provided by a PipelineRun.
 	Name string `json:"name"`
 	// Description is a human readable string describing how the workspace will be

diff --git a/pkg/apis/pipeline/v1beta1/zz_generated.deepcopy.go b/pkg/apis/pipeline/v1beta1/zz_generated.deepcopy.go
diff --git a/test/builder/pipeline_test.go b/test/builder/pipeline_test.go
@@ -145,7 +145,7 @@ func TestPipeline(t *testing.T) {
 					}}},
 				}},
 			}},
-			Workspaces: []v1alpha1.WorkspacePipelineDeclaration{{
+			Workspaces: []v1alpha1.PipelineWorkspaceDeclaration{{
 				Name: "workspace1",
 			}},
 		},

diff --git a/test/workspace_test.go b/test/workspace_test.go
@@ -135,7 +135,7 @@ func TestWorkspacePipelineRunDuplicateWorkspaceEntriesInvalid(t *testing.T) {
 	pipeline := &v1beta1.Pipeline{
 		ObjectMeta: metav1.ObjectMeta{Name: pipelineName, Namespace: namespace},
 		Spec: v1beta1.PipelineSpec{
-			Workspaces: []v1beta1.WorkspacePipelineDeclaration{{
+			Workspaces: []v1beta1.PipelineWorkspaceDeclaration{{
 				Name: "foo",
 			}},
 			Tasks: []v1beta1.PipelineTask{{
@@ -204,7 +204,7 @@ func TestWorkspacePipelineRunMissingWorkspaceInvalid(t *testing.T) {
 	pipeline := &v1beta1.Pipeline{
 		ObjectMeta: metav1.ObjectMeta{Name: pipelineName, Namespace: namespace},
 		Spec: v1beta1.PipelineSpec{
-			Workspaces: []v1beta1.WorkspacePipelineDeclaration{{
+			Workspaces: []v1beta1.PipelineWorkspaceDeclaration{{
 				Name: "foo",
 			}},
 			Tasks: []v1beta1.PipelineTask{{