From 407b9fefa752122e216da09adf927de23bf5fe19 Mon Sep 17 00:00:00 2001
From: Tony <kavinjsir@gmail.com>
Date: Thu, 17 Nov 2022 18:44:11 -0500
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20(kustomize/v2-alpha):=20add=20kusto?=
 =?UTF-8?q?mize=20file=20to=20track=20crd=20sample=20info?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../manually_migration_guide_gov3_to_gov4.md  |  1 +
 docs/book/src/migration/v3vsv4.md             | 13 ++--
 .../kustomize/v2-alpha/scaffolds/api.go       | 19 +++++
 .../templates/config/samples/kustomization.go | 70 +++++++++++++++++++
 .../config/samples/kustomization.yaml         |  5 ++
 .../config/samples/kustomization.yaml         |  5 ++
 .../config/samples/kustomization.yaml         | 13 ++++
 .../config/samples/kustomization.yaml         |  5 ++
 8 files changed, 126 insertions(+), 5 deletions(-)
 create mode 100644 pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/samples/kustomization.go
 create mode 100644 testdata/project-v4-config/config/samples/kustomization.yaml
 create mode 100644 testdata/project-v4-declarative-v1/config/samples/kustomization.yaml
 create mode 100644 testdata/project-v4-multigroup/config/samples/kustomization.yaml
 create mode 100644 testdata/project-v4/config/samples/kustomization.yaml

diff --git a/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md b/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md
index 741ea3b82c..cae361c45c 100644
--- a/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md
+++ b/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md
@@ -43,6 +43,7 @@ layout:
 `go mod tidy` to ensure that you get the latest dependencies and your Golang code has no breaking changes.
 - Update the manifest under `config/` directory with all changes performed in the default scaffold done with `go/v4-alpha` plugin. (see for example `testdata/project-v4/config/`) to get all changes in the 
 default scaffolds to be applied on your project
+- Create `config/samples/kustomization.yaml` with all CR samples specified. (see for example `testdata/project-v4/config/samples/kustomization.yaml`)
 - Replace the import `admissionv1beta1 "k8s.io/api/admission/v1beta1"` with `admissionv1 "k8s.io/api/admission/v1"` in the webhook test files
 
 <aside class="warning">
diff --git a/docs/book/src/migration/v3vsv4.md b/docs/book/src/migration/v3vsv4.md
index 7d4e6f6f38..1cd0e39031 100644
--- a/docs/book/src/migration/v3vsv4.md
+++ b/docs/book/src/migration/v3vsv4.md
@@ -1,8 +1,9 @@
-# go/v3 vs go/v4-alpha 
+# go/v3 vs go/v4-alpha
 
 This document covers all breaking changes when migrating from projects built using the plugin go/v3 (default for any scaffold done since `28 Apr 2021`) to the next alpha version of the Golang plugin `go/v4-alpha`.
 
 The details of all changes (breaking or otherwise) can be found in:
+
 - [controller-runtime][controller-runtime]
 - [controller-tools][controller-tools]
 - [kustomize][kustomize-release]
@@ -12,11 +13,12 @@ The details of all changes (breaking or otherwise) can be found in:
 
 - `go/v4-alpha` projects use Kustomize v4x (instead of v3x)
 - note that some manifests under `config/` directory have been changed in order to no longer use the deprecated Kustomize features
-such as env vars. 
+  such as env vars.
+- A `kustomization.yaml` is scaffolded under `config/samples`. This helps simply and flexibly generate sample manifests: `kustomize build config/samples`.
 - adds support for Apple Silicon M1 (darwin/arm64)
 - remove support to CRD/WebHooks Kubernetes API v1beta1 version which are no longer supported since k8s 1.22
 - no longer scaffold webhook test files with `"k8s.io/api/admission/v1beta1"` the k8s API which is no longer served since k8s `1.25`. By default
-webhooks test files are scaffolding using `"k8s.io/api/admission/v1"` which is support from k8s `1.20`
+  webhooks test files are scaffolding using `"k8s.io/api/admission/v1"` which is support from k8s `1.20`
 - no longer provide backwards compatible support with k8s versions < `1.16`
 
 <aside class="note">
@@ -28,7 +30,7 @@ Further details can be found in the [go/v4-alpha plugin section][go/v4-doc]
 
 ## TL;DR of the New `go/v4-alpha` Plugin
 
-***More details on this can be found at [here][kb-releases], but for the highlights, check below***
+**_More details on this can be found at [here][kb-releases], but for the highlights, check below_**
 
 <aside class="note">
 <h1>Default plugin</h1>
@@ -47,7 +49,7 @@ For example, you should refrain from moving the scaffolded files, doing so will
 
 ## Migrating to Kubebuilder go/v4-alpha
 
-If you want to upgrade your scaffolding to use the latest and greatest features then, follow the guide 
+If you want to upgrade your scaffolding to use the latest and greatest features then, follow the guide
 which will cover the steps in the most straightforward way to allow you to upgrade your project to get all
 latest changes and improvements.
 
@@ -63,6 +65,7 @@ kubebuilder init --domain my.domain --repo my.domain/guestbook --plugins=go/v4-a
 ```
 
 **Note**: The `go/v4-alpha` plugin is an unstable version and can have breaking changes in future releases.
+
 </aside>
 
 - [Migration Guide go/v3 to go/v4][migration-guide-gov3-to-gov4] **(Recommended)**
diff --git a/pkg/plugins/common/kustomize/v2-alpha/scaffolds/api.go b/pkg/plugins/common/kustomize/v2-alpha/scaffolds/api.go
index 5d14ccf99f..768fb42fe3 100644
--- a/pkg/plugins/common/kustomize/v2-alpha/scaffolds/api.go
+++ b/pkg/plugins/common/kustomize/v2-alpha/scaffolds/api.go
@@ -18,6 +18,7 @@ package scaffolds
 
 import (
 	"fmt"
+	"strings"
 
 	"sigs.k8s.io/kubebuilder/v3/pkg/config"
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
@@ -68,10 +69,23 @@ func (s *apiScaffolder) Scaffold() error {
 		machinery.WithResource(&s.resource),
 	)
 
+	rs, err := s.config.GetResources()
+	if err != nil {
+		return err
+	}
+
+	crdManifests := []string{}
+	for _, r := range rs {
+		crdManifests = append(crdManifests, s.generateManifestsPath(r))
+	}
+
+	crdManifests = append(crdManifests, s.generateManifestsPath(s.resource))
+
 	// Keep track of these values before the update
 	if s.resource.HasAPI() {
 		if err := scaffold.Execute(
 			&samples.CRDSample{Force: s.force},
+			&samples.Kustomization{CRDManifests: crdManifests},
 			&rbac.CRDEditorRole{},
 			&rbac.CRDViewerRole{},
 			&patches.EnableWebhookPatch{},
@@ -85,3 +99,8 @@ func (s *apiScaffolder) Scaffold() error {
 
 	return nil
 }
+
+func (s *apiScaffolder) generateManifestsPath(r resource.Resource) string {
+	// nolint: lll
+	return strings.ToLower(r.GVK.Group) + "_" + strings.ToLower(r.GVK.Version) + "_" + strings.ToLower(r.GVK.Kind) + ".yaml"
+}
diff --git a/pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/samples/kustomization.go b/pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/samples/kustomization.go
new file mode 100644
index 0000000000..1a33feef3c
--- /dev/null
+++ b/pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/samples/kustomization.go
@@ -0,0 +1,70 @@
+/*
+Copyright 2022 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.
+*/
+
+package samples
+
+import (
+	"bytes"
+	"fmt"
+	"path/filepath"
+	"text/template"
+
+	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
+)
+
+var _ machinery.Template = &Kustomization{}
+
+// Kustomization scaffolds a file that defines the kustomization scheme for the prometheus folder
+type Kustomization struct {
+	machinery.TemplateMixin
+
+	CRDManifests []string
+}
+
+// SetTemplateDefaults implements file.Template
+func (f *Kustomization) SetTemplateDefaults() error {
+	if f.Path == "" {
+		f.Path = filepath.Join("config", "samples", "kustomization.yaml")
+	}
+
+	defaultTemplate, err := f.createTemplate()
+	if err != nil {
+		return err
+	}
+
+	f.TemplateBody = defaultTemplate
+
+	f.IfExistsAction = machinery.OverwriteFile
+
+	return nil
+}
+
+func (f *Kustomization) createTemplate() (string, error) {
+	t := template.Must(template.New("customResourcesConfig").Parse(kustomizationTemplate))
+
+	outputTmpl := &bytes.Buffer{}
+	if err := t.Execute(outputTmpl, f.CRDManifests); err != nil {
+		return "", fmt.Errorf("error when generating sample kustomization manifest: %w", err)
+	}
+
+	return outputTmpl.String(), nil
+
+}
+
+const kustomizationTemplate = `---
+resources:{{ range $i ,$e := . }}
+  - {{ . }}{{end}}
+`
diff --git a/testdata/project-v4-config/config/samples/kustomization.yaml b/testdata/project-v4-config/config/samples/kustomization.yaml
new file mode 100644
index 0000000000..d2695576a2
--- /dev/null
+++ b/testdata/project-v4-config/config/samples/kustomization.yaml
@@ -0,0 +1,5 @@
+---
+resources:
+  - crew_v1_captain.yaml
+  - crew_v1_firstmate.yaml
+  - crew_v1_admiral.yaml
diff --git a/testdata/project-v4-declarative-v1/config/samples/kustomization.yaml b/testdata/project-v4-declarative-v1/config/samples/kustomization.yaml
new file mode 100644
index 0000000000..d2695576a2
--- /dev/null
+++ b/testdata/project-v4-declarative-v1/config/samples/kustomization.yaml
@@ -0,0 +1,5 @@
+---
+resources:
+  - crew_v1_captain.yaml
+  - crew_v1_firstmate.yaml
+  - crew_v1_admiral.yaml
diff --git a/testdata/project-v4-multigroup/config/samples/kustomization.yaml b/testdata/project-v4-multigroup/config/samples/kustomization.yaml
new file mode 100644
index 0000000000..e3ee1201d7
--- /dev/null
+++ b/testdata/project-v4-multigroup/config/samples/kustomization.yaml
@@ -0,0 +1,13 @@
+---
+resources:
+  - crew_v1_captain.yaml
+  - ship_v1beta1_frigate.yaml
+  - ship_v1_destroyer.yaml
+  - ship_v2alpha1_cruiser.yaml
+  - sea-creatures_v1beta1_kraken.yaml
+  - sea-creatures_v1beta2_leviathan.yaml
+  - foo.policy_v1_healthcheckpolicy.yaml
+  - apps_v1_deployment.yaml
+  - foo_v1_bar.yaml
+  - fiz_v1_bar.yaml
+  - _v1_lakers.yaml
diff --git a/testdata/project-v4/config/samples/kustomization.yaml b/testdata/project-v4/config/samples/kustomization.yaml
new file mode 100644
index 0000000000..d2695576a2
--- /dev/null
+++ b/testdata/project-v4/config/samples/kustomization.yaml
@@ -0,0 +1,5 @@
+---
+resources:
+  - crew_v1_captain.yaml
+  - crew_v1_firstmate.yaml
+  - crew_v1_admiral.yaml