Move test project to testdata

Go tooling ignores testdata, so the Go module manipulation commands
(pretty much everything that Go does) will ignore the test projects.

The v1 scaffolding needs to be in its own gopath, otherwise the tooling
will ignore the vendor directory.

Author: DirectXMan12

.gitignore

@@ -12,3 +12,7 @@ docs/book/node_modules/
 
 # skip bin
 bin/*
+
+# skip testdata gopath non-src
+/testdata/gopath/bin
+/testdata/gopath/pkg

common.sh

@@ -161,7 +161,7 @@ function setup_envs {
 
 function restore_go_deps {
   header_text "restoring Go dependencies"
-  tar -zxf ${go_workspace}/src/sigs.k8s.io/kubebuilder/test/vendor.v1.tgz
+  tar -zxf ${go_workspace}/src/sigs.k8s.io/kubebuilder/testdata/vendor.v1.tgz
 }
 
 function cache_project {

generated_golden.sh

@@ -29,17 +29,20 @@ build_kb() {
 scaffold_test_project() {
 	project=$1
 	version=$2
-	mkdir -p ./test/$project
-	rm -rf ./test/$project/*
+    testdata_dir=$(pwd)/testdata
+	mkdir -p ./testdata/$project
+	rm -rf ./testdata/$project/*
 	pushd . 
-	cd test/$project
+	cd testdata/$project
 	# untar Gopkg.lock and vendor directory for appropriate project version
 	tar -zxf ../vendor.v$version.tgz
 
-	kb=../../bin/kubebuilder
+	kb=$testdata_dir/../bin/kubebuilder
 
-	$kb init --project-version $version --domain testproject.org --license apache2 --owner "The Kubernetes authors" --dep=false
+    oldgopath=$GOPATH
 	if [ $version == "1" ]; then
+        export GOPATH=$(pwd)/../.. # go ignores vendor under testdata, so fake out a gopath
+        $kb init --project-version $version --domain testproject.org --license apache2 --owner "The Kubernetes authors" --dep=false
 		$kb create api --group crew --version v1 --kind FirstMate --controller=true --resource=true --make=false
 		$kb alpha webhook --group crew --version v1 --kind FirstMate --type=mutating --operations=create,update --make=false
 		$kb alpha webhook --group crew --version v1 --kind FirstMate --type=mutating --operations=delete --make=false
@@ -51,6 +54,7 @@ scaffold_test_project() {
 		$kb alpha webhook --group core --version v1 --kind Namespace --type=mutating --operations=update --make=false
 		$kb create api --group policy --version v1beta1 --kind HealthCheckPolicy --example=false --controller=true --resource=true --namespaced=false --make=false
 	elif [ $version == "2" ]; then
+        $kb init --project-version $version --domain testproject.org --license apache2 --owner "The Kubernetes authors"
 		$kb create api --group crew --version v1 --kind Captain --controller=true --resource=true --make=false
 		$kb create api --group crew --version v1 --kind FirstMate --controller=true --resource=true --make=false
 		$kb alpha webhook --group crew --version v1 --kind FirstMate --type=mutating --operations=create,update --make=false
@@ -66,9 +70,11 @@ scaffold_test_project() {
 	rm -f Gopkg.lock
 	rm -rf ./vendor
 	rm -rf ./bin
+    export GOPATH=$oldgopath
 	popd
 }
 
-build_kb && \
-scaffold_test_project project 1 && \
+set -e
+build_kb
+scaffold_test_project gopath/src/project 1
 scaffold_test_project project_v2 2

pkg/scaffold/project/project_test.go

@@ -180,7 +180,7 @@ Copyright %s Example Owners.
 		Context("with defaults ", func() {
 			It("should match the golden file", func() {
 				instance := &project.Makefile{Image: "controller:latest"}
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -197,7 +197,7 @@ Copyright %s Example Owners.
 		Context("with defaults ", func() {
 			It("should match the golden file", func() {
 				instance := &project.Kustomize{Prefix: "project"}
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -214,7 +214,7 @@ Copyright %s Example Owners.
 		Context("with rbac", func() {
 			It("should match the golden file", func() {
 				instance := &project.KustomizeRBAC{}
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -231,7 +231,7 @@ Copyright %s Example Owners.
 		Context("with manager", func() {
 			It("should match the golden file", func() {
 				instance := &project.KustomizeManager{}
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -248,7 +248,7 @@ Copyright %s Example Owners.
 		Context("with defaults ", func() {
 			It("should match the golden file", func() {
 				instance := &project.KustomizeImagePatch{}
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -265,7 +265,7 @@ Copyright %s Example Owners.
 		Context("with defaults ", func() {
 			It("should match the golden file", func() {
 				instance := &project.KustomizePrometheusMetricsPatch{}
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -300,7 +300,7 @@ Copyright %s Example Owners.
 				instance := &project.Project{}
 				instance.Version = "1"
 				instance.Domain = "testproject.org"
-				instance.Repo = "sigs.k8s.io/kubebuilder/test/project"
+				instance.Repo = "project"
 				Expect(s.Execute(input.Options{}, instance)).NotTo(HaveOccurred())
 
 				// Verify the contents matches the golden file.
@@ -360,7 +360,7 @@ Copyright %s Example Owners.
 				i, err := instance.GetInput()
 				Expect(err).NotTo(HaveOccurred())
 				Expect(i.Path).To(Equal("PROJECT"))
-				Expect(i.Repo).To(Equal("sigs.k8s.io/kubebuilder/pkg/scaffold/project"))
+				Expect(i.Repo).To(Equal("project"))
 			})
 		})
 	})

pkg/scaffold/scaffoldtest/scaffoldtest.go

@@ -23,6 +23,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"go/build"
 
 	"github.com/onsi/ginkgo"
 	"github.com/onsi/gomega"
@@ -36,7 +37,7 @@ type TestResult struct {
 	// Actual is the bytes written to a scaffolded file.
 	Actual bytes.Buffer
 
-	// Golden is the golden file contents read from the controller-tools/test package
+	// Golden is the golden file contents read from the controller-tools/testdata package
 	Golden string
 }
 
@@ -45,17 +46,17 @@ func getProjectRoot() string {
 	return path.Join(gopath, "src", "sigs.k8s.io", "kubebuilder")
 }
 
-// ProjectPath is the path to the controller-tools/test project file
+// ProjectPath is the path to the controller-tools/testdata project file
 func ProjectPath() string {
-	return filepath.Join(getProjectRoot(), "test", "project", "PROJECT")
+	return filepath.Join(getProjectRoot(), "testdata", "gopath", "src", "project", "PROJECT")
 }
 
-// BoilerplatePath is the path to the controller-tools/test boilerplate file
+// BoilerplatePath is the path to the controller-tools/testdata boilerplate file
 func BoilerplatePath() string {
-	return filepath.Join(getProjectRoot(), "test", "project", "hack", "boilerplate.go.txt")
+	return filepath.Join(getProjectRoot(), "testdata", "gopath", "src", "project", "hack", "boilerplate.go.txt")
 }
 
-// Options are the options for scaffolding in the controller-tools/test directory
+// Options are the options for scaffolding in the controller-tools/testdata directory
 func Options() input.Options {
 	return input.Options{
 		BoilerplatePath: BoilerplatePath(),
@@ -73,11 +74,12 @@ func NewTestScaffold(writeToPath, goldenPath string) (*scaffold.Scaffold, *TestR
 			gomega.Expect(path).To(gomega.Equal(writeToPath))
 			return &r.Actual, nil
 		},
-		ProjectPath: filepath.Join(getProjectRoot(), "test", "project"),
+		ProjectPath: filepath.Join(getProjectRoot(), "testdata", "gopath", "src", "project"),
 	}
+	build.Default.GOPATH = filepath.Join(getProjectRoot(), "testdata", "gopath")
 
 	if len(goldenPath) > 0 {
-		b, err := ioutil.ReadFile(filepath.Join(getProjectRoot(), "test", "project", goldenPath))
+		b, err := ioutil.ReadFile(filepath.Join(getProjectRoot(), "testdata", "gopath", "src", "project", goldenPath))
 		gomega.Expect(err).NotTo(gomega.HaveOccurred())
 		r.Golden = string(b)
 	}

test.sh

@@ -89,10 +89,12 @@ function test_project {
   project_dir=$1
   version=$2
   header_text "performing tests in dir $project_dir for project version v$version"
-  cd test/$project_dir
-  tar -zxf ../vendor.v$version.tgz
+  vendor_tarball=$(pwd)/testdata/vendor.v$version.tgz
+  cd testdata/$project_dir
+  # v2 uses modules, and thus doesn't have a vendor directory
+  [[ -e ${vendor_tarball} ]] && tar -zxf $vendor_tarball 
   make
-  rm -rf ./vendor && rm -f Gopkg.lock
+  [[ -e ${vendor_tarball} ]] && rm -rf ./vendor && rm -f Gopkg.lock
   cd -
 }
 
@@ -139,7 +141,9 @@ cd ${go_workspace}/src/sigs.k8s.io/kubebuilder
 go test ./cmd/... ./pkg/...
 
 # test project v1
-test_project project 1
+# auto is roughly equivalent to off in our case, 
+# since we'll be in a gopath (basically, reset to default)
+GO111MODULE=auto test_project gopath/src/project 1
 
 # test project v2
 test_project project_v2 2