Only have one set of examples and test that they are valid

We ended up in a state where we had both an `examples` dir and a `samples` dir, and neither were tested, so both were slightly out of sync with each other and the actual types. This was b/c: - When we used kubebuilder, we generated our types from an original set of examples - previously these were in `config/samples` and they ended up in `samples`. We used the validation tests generated by kubebuilder to test these, but when we removed kubebuilder we removed the tests - Before presenting the API to the Build CRD working group, we wanted to have some more complex, real world examples, which @tejal29 created from the `kritis` project and the k8s guestbook example This commit makes sure that all of the functionality demonstrated in `samples` is in `examples`, and removes `samples`. This included: - Fixing `passedConstraints` to be plural as the types expected - Including references to the `PipelineParams` in the `TaskRun` example - Fixing clusterBindings to refer to the actual names of the clusters involved It also adds a step to the integration tests to deploy the examples, which will fail if they do not match the expected schema. At this point they are torn down immediately after creation, but in #108 we can expand this to actually test that they are working. Also had to make some tweaks to the types: - actually including `ClusterBindings` in the `Pipeline` - Using names which include `Resource` instead of `Source`, which we moved away from in #39 Fixes #20
bobcatfish · Oct 8, 2018 · 2b31251 · 2b31251
1 parent f9d5590
commit 2b31251
Show file tree

Hide file tree

Showing 21 changed files with 127 additions and 329 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/README.md b/README.md
@@ -144,8 +144,11 @@ as inputs and outputs of a `TaskRun`.
 
 * `Resources` is created directly in a pipeline configuration and bound 
 to `TaskRun` as an input and/or output source. 
-* The (optional) `passedConstraint` key on an `input source` defines a set of previous task names.
-* When the `passedConstraint` key is specified on an input source, only the version of 
+* The (optional) `passedConstraints` key on an `input source` defines a set of previous task names.
+* When the `passedConstraints` key is specified on an input source, only the version of 
 the resource that passed through the defined list of tasks is used.
-* The `passedConstraint` allows for `Tasks` to fan in and fan out, and ordering can be expressed explicitly 
+* The `passedConstraints` allows for `Tasks` to fan in and fan out, and ordering can be expressed explicitly 
 using this key since a task needing a resource from a another task would have to run after.
+
+See [docs/pipeline-resources.md](./docs/pipeline-resources.md) for more detail about tyeps
+of `Resources`.
diff --git a/examples/README.md b/examples/README.md
@@ -3,11 +3,11 @@
 This directory contains examples of [the Pipeline CRDs](../README.md) in action.
 
 To deploy them to your cluster (after
-[installing the CRDs and running the controller](../DEVELOPMENT.md#installing-andrunning)):
+[installing the CRDs and running the controller](../DEVELOPMENT.md#getting-started)):
 
 ```bash
-kubectl apply -f examples/pipelines
 kubectl apply -f examples/
+kubectl apply -f examples/pipelines
 kubectl apply -f examples/invocations
 ```
 

diff --git a/examples/deploy_tasks.yaml b/examples/deploy_tasks.yaml
@@ -16,12 +16,12 @@ spec:
             - name: image
               value: string
         cluster:
-            - name: clusterName
+            - name: targetCluster
     buildSpec:
         steps:
         - name: deploy
           image: kubernetes-helm
-          args: ['deploy', '--path=${pathToHelmChart}', '--set image=${image}', '${helmArgs}']
+          args: ['install', '--kube-context=${targetCluster}', '--set image=${image}', '${helmArgs}', '${pathToHelmChart}']
 
 ---
 apiVersion: pipeline.knative.dev/v1alpha1

diff --git a/examples/invocations/run-kritis-test.yaml b/examples/invocations/run-kritis-test.yaml
@@ -9,31 +9,19 @@ spec:
         name: make
     trigger:
         triggerRef:
-            type: manual
+            type: PipelineRun
+            name: kritis-pipeline-run-12321312984
+    pipelineParamsRef:
+        name: pipelineparams-sample
     inputs:
-        sources:
-            - name: 'kritis'
-              type: 'github'
-              url:  'github.com/grafeas/kritis'
-              branch: 'featureX'
-              commit: 'HEAD'
+        resourcesVersion:
+          - resourceRef:
+              name: kritis-resources-git
+            version: 4da79b91e8e37ea441cfe4972565e2184c1a127f
         params:
             - name: 'makeTarget'
               type: 'string'
               value: 'test'
-    results:
-        runs:
-          name: 'runsBucket'
-          type: 'gcs'
-          url: 'gcs://somebucket/results/runs'
-        logs:
-          name: 'logBucket'
-          type: 'gcs'
-          url: 'gcs://somebucket/results/logs'
-        tests:
-          name: 'testBucket'
-          type: 'gcs'
-          url: 'gcs://somebucket/results/tests'
 status:
     steps:
     - name: make

diff --git a/examples/pipelines/guestbook.yaml b/examples/pipelines/guestbook.yaml
@@ -45,21 +45,21 @@ spec:
               key: workspace
               resourceRef:
                   name: guestbook-resources-git  
-              passedConstraint: 
+              passedConstraints: 
                 - build-guestbook
                 - build-redis
             - name: workspace
               key: redis-docker
               resourceRef:
                   name: guestbook-resources-redis-docker  
-              passedConstraint:
+              passedConstraints:
                - build-push
           params:
               - name: pathToFiles
                 value: guestbook/all-in-one/guestbook-all-in-one.yaml
           clusterBindings:
-              - inputName: test
-                key: test
+              - inputName: clusterName
+                key: testCluster
         - name: int-test-osx                    # 3.a Run Integration tests for osx
           taskRef:
               name: integrationTestInDocker
@@ -68,7 +68,7 @@ spec:
                 key: workspace
                 resourceRef:
                   name: guestbook-resources-git  
-                passedConstraint:
+                passedConstraints:
                 - deploy-bundle-test
           params:
               - name: dockerBuildFile
@@ -81,7 +81,7 @@ spec:
                 key: workspace
                 resourceRef:
                   name: guestbook-resources-git  
-                passedConstraint:
+                passedConstraints:
                 - deploy-bundle-test
           params:
               - name: dockerBuildFile
@@ -94,12 +94,12 @@ spec:
                 key: workspace
                 resourceRef:
                   name: guestbook-resources-git  
-                passedConstraint:
+                passedConstraints:
                 - int-test-osx
                 - int-test-linux
           params:
               - name: pathToFiles
                 value: guestbook/all-in-one/guestbook-all-in-one.yaml
           clusterBindings:
-              - inputName: staging
-                key: staging
+              - inputName: targetCluster
+                key: stagingCluster
diff --git a/examples/pipelines/kritis.yaml b/examples/pipelines/kritis.yaml
@@ -24,7 +24,7 @@ spec:
             key: workspace # bind to the name in the task
             resourceRef:
               name: kritis-resources-git
-            passedConstraint:
+            passedConstraints:
               - unit-test-make
         outputSourceBindings:
           - name: kritisImage
@@ -42,13 +42,13 @@ spec:
             key: workspace
             resourceRef:
               name: kritis-resources-image
-            passedConstraint: [build-push]
+            passedConstraints: [build-push]
         params:
           - name: pathToHelmCharts
             value: kritis-charts
         clusterBindings:
-          - inputName: test
-            key: test
+          - inputName: targetCluster
+            key: testCluster
       - name: integration-test          # 4. Run Integration Tests in test cluster
         taskRef:
           name: integration-test-in-docker
@@ -57,7 +57,7 @@ spec:
             key: workspace
             resourceRef:
                 name: kritis-resources-test-git
-            passedConstraint: [deploy-with-helm]
+            passedConstraints: [deploy-with-helm]
         params:
           - name: testArgs
             value: "-e REMOTE_INTEGRATION=true"
diff --git a/examples/smoke-test.sh b/examples/smoke-test.sh
@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Copyright 2018 The Knative Authors.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# smoke_test.sh will attempt to deploy all of the example CRDs to whatever
+# is the current kubectl cluster context.
+# It will not wait for any Runs to complete and instead will destroy the CRDs
+# immediately after creation, so at the moment this pretty much just makes
+# sure the structure is valid (and this might even have weird side effects..).
+
+set -o xtrace
+set -o errexit
+set -o pipefail
+
+kubectl apply -f examples/
+kubectl apply -f examples/pipelines
+kubectl apply -f examples/invocations
+
+sleep 5
+
+kubectl delete -f examples/invocations
+kubectl delete -f examples/pipelines
+kubectl delete -f examples/
diff --git a/pkg/apis/pipeline/v1alpha1/pipeline_types.go b/pkg/apis/pipeline/v1alpha1/pipeline_types.go
@@ -67,6 +67,9 @@ type PipelineTask struct {
 	InputSourceBindings []SourceBinding `json:"inputSourceBindings,omitempty"`
 	// +optional
 	OutputSourceBindings []SourceBinding `json:"outputSourceBindings,omitempty"`
+	// TODO(#68) Cluster should become a type of Resource
+	// +optional
+	ClusterBindings []ClusterBinding `json:"clusterBindings,omitempty"`
 	// +optional
 	Params []Param `json:"params,omitempty"`
 }

diff --git a/pkg/apis/pipeline/v1alpha1/resource_types.go b/pkg/apis/pipeline/v1alpha1/resource_types.go
@@ -57,6 +57,16 @@ type PipelineResourceSpec struct {
 	Params []Param              `json:"params"`
 }
 
+// TaskResource defines an input or output Resource declared as a requirement
+// by a Task. The Name field will be used to refer to these Resources within
+// the Task definition, and when provided as an Input, the Name will be the
+// path to the volume mounted containing this Resource as an input (e.g.
+// an input Resource named `workspace` will be mounted at `/workspace`).
+type TaskResource struct {
+	Name string               `json:"name"`
+	Type PipelineResourceType `json:"type"`
+}
+
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 

diff --git a/pkg/apis/pipeline/v1alpha1/task_types.go b/pkg/apis/pipeline/v1alpha1/task_types.go
@@ -26,7 +26,7 @@ type TaskSpec struct {
 	// +optional
 	Inputs *Inputs `json:"inputs,omitempty"`
 	// +optional
-	Outputs   *Outputs                 `json:"outputs,omitempty"`
+	Outputs   *Outputs                `json:"outputs,omitempty"`
 	BuildSpec buildv1alpha1.BuildSpec `json:"buildSpec"`
 }
 
@@ -57,27 +57,14 @@ type Task struct {
 // Inputs are the requirements that a task needs to run a Build.
 type Inputs struct {
 	// +optional
-	Sources []Source `json:"resources,omitempty"`
+	Resources []TaskResource `json:"resources,omitempty"`
 	// +optional
 	Params []Param `json:"params,omitempty"`
+	// TODO(#68) a cluster and/or deployment should be a type of Resource
 	// +optional
 	Clusters []Cluster `json:"clusters,omitempty"`
 }
 
-// Source is data which is required by a Build/Task for context
-// (e.g. a repo from which to build an image). The name of the input will be
-// used as the name of the volume containing this context which will be mounted
-// into the container executed by the Build/Task, e.g. a Source with the
-// name "workspace" would be mounted into "/workspace".
-//
-// TODO(#62): Something is wrong here, this should be a reference to a resource,
-// could just be that the names and comments are out of date.
-type Source struct {
-	// name of the source should match the name of the SourceBinding in the pipeline
-	Name string               `json:"name"`
-	Type PipelineResourceType `json:"type"`
-}
-
 // Param defines arbitrary parameters needed by a task beyond typed inputs
 // such as resources.
 type Param struct {
@@ -91,7 +78,7 @@ type Outputs struct {
 	// +optional
 	Results []TestResult `json:"results,omitempty"`
 	// +optional
-	Sources []Source `json:"resources,omitempty"`
+	Resources []TaskResource `json:"resources,omitempty"`
 }
 
 // TestResult allows a task to specify the location where test logs