🏃 more robust golden test

Author: Mengqi Yu

.travis.yml

@@ -27,6 +27,8 @@ before_install:
 # NOTE: The latest version of dep requires go 1.13
 - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then mkdir -p /Users/travis/gopath/bin; fi
 - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then GO111MODULE=on scripts/install_and_setup.sh; fi
+- GO111MODULE=on go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.2.2
+- GO111MODULE=on go get sigs.k8s.io/kustomize/kustomize/v3@v3.2.1
 
 before_script:
 
@@ -37,9 +39,10 @@ install:
   -
 
 script:
-- if [ "$TRAVIS_OS_NAME" = "linux" ]; then GO111MODULE=on TRACE=1 PATH=$PATH:$(pwd) ./test_e2e.sh ; fi
-- if [ "$TRAVIS_OS_NAME" = "linux" ]; then GO111MODULE=on TRACE=1 PATH=$PATH:$(pwd) ./test_e2e_v2.sh ; fi
+- GO111MODULE=on TRACE=1 ./golden_test.sh
 - GO111MODULE=on TRACE=1 ./test.sh
+- if [ "$TRAVIS_OS_NAME" = "linux" ]; then GO111MODULE=on TRACE=1 PATH=$PATH:$(pwd) ./test_e2e_v1.sh ; fi
+- if [ "$TRAVIS_OS_NAME" = "linux" ]; then GO111MODULE=on TRACE=1 PATH=$PATH:$(pwd) ./test_e2e_v2.sh ; fi
 
 # TBD. Suppressing for now.
 notifications:

Makefile

@@ -51,7 +51,7 @@ generate: ## Update/generate all mock data. You should run this commands to upda
 
 .PHONY: generate-testdata
 generate-testdata: ## Update/generate the testdata in $GOPATH/src/sigs.k8s.io/kubebuilder
-	GO111MODULE=on ./generated_golden.sh
+	GO111MODULE=on ./generate_golden.sh
 
 .PHONY: generate-vendor
 generate-vendor: ## Update/generate the vendor by using the path $GOPATH/src/sigs.k8s.io/kubebuilder-test

generated_golden.sh generate_golden.sh

@@ -76,6 +76,7 @@ scaffold_test_project() {
 	fi
 	make all test # v2 doesn't test by default
 	rm -f Gopkg.lock
+	rm -f go.sum
 	rm -rf ./vendor
 	rm -rf ./bin
 	export GOPATH=$oldgopath
@@ -84,6 +85,8 @@ scaffold_test_project() {
 
 set -e
 
+GOPROXY=https://proxy.golang.org/
+
 build_kb
 scaffold_test_project gopath/src/project 1
 scaffold_test_project project-v2 2

golden_test.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+# Copyright 2019 The Kubernetes 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.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+source common.sh
+
+fetch_tools
+build_kb
+
+setup_envs
+
+check_directory=testdata
+
+# Check testdata directory first. If there are any uncommitted change, fail the test.
+if [[ `git status ${check_directory} --porcelain` ]]; then
+  header_text "Golden test precondition failed!"
+  header_text "Please commit the change under testdata directory before running the golden test"
+  exit 1
+fi
+
+./generate_golden.sh
+
+# Check if there are any changes to files under testdata directory.
+if [[ `git status ${check_directory} --porcelain` ]]; then
+  header_text "git status ${check_directory} --porcelain"
+  git status ${check_directory} --porcelain
+  header_text "git diff ${check_directory}"
+  git diff ${check_directory}
+  header_text "Golden test failed!"
+  header_text "Please make sure you have run ./generate_golden.sh if you have changed the scaffolding"
+  exit 1
+else
+  header_text "Golden test passed!"
+fi

scripts/install_and_setup.sh

@@ -17,7 +17,6 @@
 export GO111MODULE=on
 
 go get sigs.k8s.io/kind@v0.5.1
-go get sigs.k8s.io/kustomize/v3/cmd/kustomize@v3.1.0
 
 # You can use --image flag to specify the cluster version you want, e.g --image=kindest/node:v1.13.6, the supported version are listed at https://hub.docker.com/r/kindest/node/tags
 kind create cluster --config test/kind-config.yaml --image=kindest/node:v1.14.1

test_e2e.sh test_e2e_v1.sh

@@ -3,6 +3,8 @@
 apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.2.2
   creationTimestamp: null
   name: admirals.crew.testproject.org
 spec:

testdata/project-v2/config/crd/bases/crew.testproject.org_admirals.yaml

@@ -3,6 +3,8 @@
 apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.2.2
   creationTimestamp: null
   name: captains.crew.testproject.org
 spec:

testdata/project-v2/config/crd/bases/crew.testproject.org_captains.yaml

@@ -3,6 +3,8 @@
 apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.2.2
   creationTimestamp: null
   name: firstmates.crew.testproject.org
 spec: