24469330094

Committed 15 Apr 2026 05:44PM UTC coverage: 80.992% (-1.2%) from 82.18%

Build # 24469330094

Build Type

Pull #5621

github

Committed by

camilamacedo86

Commit Message

chore(helm/v2-alpha): Refactory the code

Pull Request Pull Request #5621: 🌱 (helm/v2-alpha): Refactory the code

Coverage Stats

3278 of 3699 new or added lines in 29 files covered. (88.62%)

20 existing lines in 1 file now uncovered.

7802 of 9633 relevant lines covered (80.99%)

70.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

40.68

/pkg/plugins/optional/helm/v2alpha/edit.go

/*
Copyright 2025 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 v2alpha

import (
        "errors"
        "fmt"
        "io"
        "log/slog"
        "os"
        "path/filepath"
        "strings"

        "github.com/spf13/pflag"
        "go.yaml.in/yaml/v3"

        "sigs.k8s.io/kubebuilder/v4/pkg/config"
        cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
        "sigs.k8s.io/kubebuilder/v4/pkg/machinery"
        "sigs.k8s.io/kubebuilder/v4/pkg/plugin"
        "sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
        "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v2alpha/internal/common"
        "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v2alpha/scaffolds"
)

const (
        // DefaultManifestsFile is the default path for kustomize output manifests
        DefaultManifestsFile = "dist/install.yaml"
        // v1AlphaPluginKey is the deprecated v1-alpha plugin key
        v1AlphaPluginKey = "helm.kubebuilder.io/v1-alpha"
)

var _ plugin.EditSubcommand = &editSubcommand{}

type editSubcommand struct {
        config        config.Config
        force         bool
        manifestsFile string
        outputDir     string
}

//nolint:lll
func (p *editSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) {
        subcmdMeta.Description = `Generate a Helm chart from your project's kustomize output.

Parses 'make build-installer' output (dist/install.yaml) and generates chart to allow easy
distribution of your project. When enabled, adds Helm helpers targets to Makefile`

        subcmdMeta.Examples = fmt.Sprintf(`# Generate Helm chart from default manifests (dist/install.yaml) to default output (dist/)
  %[1]s edit --plugins=%[2]s

# Generate Helm chart and overwrite existing files (useful for updates)
  %[1]s edit --plugins=%[2]s --force

# Generate Helm chart from a custom manifests file
  %[1]s edit --plugins=%[2]s --manifests=path/to/custom-install.yaml

# Generate Helm chart to a custom output directory
  %[1]s edit --plugins=%[2]s --output-dir=charts

# Generate from custom manifests to custom output directory
  %[1]s edit --plugins=%[2]s --manifests=manifests/install.yaml --output-dir=helm-charts

# Typical workflow:
  make build-installer  # Generate dist/install.yaml with latest changes
  %[1]s edit --plugins=%[2]s  # Generate/update Helm chart in dist/chart/

**NOTE**: Chart.yaml is never overwritten (contains user-managed version info).
Without --force, the plugin also preserves values.yaml, NOTES.txt, _helpers.tpl, .helmignore,
and .github/workflows/test-chart.yml.
All other template files in templates/ are always regenerated to match your current
kustomize output. Use --force to regenerate all files except Chart.yaml.

The generated chart structure mirrors your config/ directory:
<output>/chart/
├── Chart.yaml
├── values.yaml
├── .helmignore
└── templates/
    ├── NOTES.txt
    ├── _helpers.tpl
    ├── rbac/
    ├── manager/
    ├── webhook/
    └── ...
`, cliMeta.CommandName, plugin.KeyFor(Plugin{}))
}

func (p *editSubcommand) BindFlags(fs *pflag.FlagSet) {
        fs.BoolVar(&p.force, "force", false, "if true, regenerates all the files")
        fs.StringVar(&p.manifestsFile, "manifests", DefaultManifestsFile,
                "path to the YAML file containing Kubernetes manifests from kustomize output")
        fs.StringVar(&p.outputDir, "output-dir", common.DefaultOutputDir, "output directory for the generated Helm chart")
}

func (p *editSubcommand) InjectConfig(c config.Config) error {
        p.config = c
        return nil
}

func (p *editSubcommand) Scaffold(fs machinery.Filesystem) error {
        // If using default manifests file, ensure it exists by running make build-installer
        if p.manifestsFile == DefaultManifestsFile {
                if err := p.ensureManifestsExist(); err != nil {
                        slog.Warn("Failed to generate default manifests file", "error", err, "file", p.manifestsFile)
                }
        }

        scaffolder := scaffolds.NewChartScaffolder(p.config, p.force, p.manifestsFile, p.outputDir)
        scaffolder.InjectFS(fs)
        err := scaffolder.Scaffold()
        if err != nil {
                return fmt.Errorf("error scaffolding Helm chart: %w", err)
        }

        // Remove deprecated v1-alpha plugin entry from PROJECT file
        // This must happen in Scaffold (before config is saved) to be persisted
        p.removeV1AlphaPluginEntry()

        // Save plugin config to PROJECT file
        key := plugin.GetPluginKeyForConfig(p.config.GetPluginChain(), Plugin{})
        canonicalKey := plugin.KeyFor(Plugin{})
        cfg := pluginConfig{}
        isFirstRun := false
        if err = p.config.DecodePluginConfig(key, &cfg); err != nil {
                switch {
                case errors.As(err, &config.UnsupportedFieldError{}):
                        // Config version doesn't support plugin metadata
                        return nil
                case errors.As(err, &config.PluginKeyNotFoundError{}):
                        // This is the first time the plugin is run
                        isFirstRun = true
                        if key != canonicalKey {
                                if err2 := p.config.DecodePluginConfig(canonicalKey, &cfg); err2 != nil {
                                        if errors.As(err2, &config.UnsupportedFieldError{}) {
                                                return nil
                                        }
                                        if !errors.As(err2, &config.PluginKeyNotFoundError{}) {
                                                return fmt.Errorf("error decoding plugin configuration: %w", err2)
                                        }
                                } else {
                                        // Found config under canonical key, not first run
                                        isFirstRun = false
                                }
                        }
                default:
                        return fmt.Errorf("error decoding plugin configuration: %w", err)
                }
        }

        // Update configuration with current parameters
        cfg.ManifestsFile = p.manifestsFile
        cfg.OutputDir = p.outputDir

        if err = p.config.EncodePluginConfig(key, cfg); err != nil {
                return fmt.Errorf("error encoding plugin configuration: %w", err)
        }

        // Add Helm deployment targets to Makefile only on first run
        if isFirstRun {
                slog.Info("adding Helm deployment targets to Makefile...")
                // Extract namespace from manifests for accurate Makefile generation
                namespace := p.extractNamespaceFromManifests()
                if err := p.addHelmMakefileTargets(namespace); err != nil {
                        slog.Warn("failed to add Helm targets to Makefile", "error", err)
                }
        }

        return nil
}

// ensureManifestsExist runs make build-installer to generate the default manifests file
func (p *editSubcommand) ensureManifestsExist() error {
        slog.Info("Generating default manifests file", "file", p.manifestsFile)

        // Run the required make targets to generate the manifests file
        targets := []string{"manifests", "generate", "build-installer"}
        for _, target := range targets {
                if err := util.RunCmd(fmt.Sprintf("Running make %s", target), "make", target); err != nil {
                        return fmt.Errorf("make %s failed: %w", target, err)
                }
        }

        // Verify the file was created
        if _, err := os.Stat(p.manifestsFile); err != nil {
                return fmt.Errorf("manifests file %s was not created: %w", p.manifestsFile, err)
        }

        slog.Info("Successfully generated manifests file", "file", p.manifestsFile)
        return nil
}

// PostScaffold automatically uncomments cert-manager installation when webhooks are present
func (p *editSubcommand) PostScaffold() error {
        hasWebhooks := hasWebhooksWith(p.config)

        if hasWebhooks {
                workflowFile := filepath.Join(".github", "workflows", "test-chart.yml")
                if _, err := os.Stat(workflowFile); err != nil {
                        slog.Info(
                                "Workflow file not found, unable to uncomment cert-manager installation",
                                "error", err,
                                "file", workflowFile,
                        )
                        return nil
                }
                target := `
#      - name: Install cert-manager via Helm (wait for readiness)
#        run: |
#          helm repo add jetstack https://charts.jetstack.io
#          helm repo update
#          helm install cert-manager jetstack/cert-manager \
#            --namespace cert-manager \
#            --create-namespace \
#            --set crds.enabled=true \
#            --wait \
#            --timeout 300s`
                if err := util.UncommentCode(workflowFile, target, "#"); err != nil {
                        hasUncommented, errCheck := util.HasFileContentWith(workflowFile, "- name: Install cert-manager via Helm")
                        if !hasUncommented || errCheck != nil {
                                slog.Warn("Failed to uncomment cert-manager installation in workflow file", "error", err, "file", workflowFile)
                        }
                } else {
                        target = `# TODO: Uncomment if cert-manager is enabled`
                        _ = util.ReplaceInFile(workflowFile, target, "")
                }
        }
        return nil
}

// addHelmMakefileTargets appends Helm deployment targets to the Makefile if they don't already exist
func (p *editSubcommand) addHelmMakefileTargets(namespace string) error {
        makefilePath := "Makefile"
        if _, err := os.Stat(makefilePath); os.IsNotExist(err) {
                return fmt.Errorf("makefile not found")
        }

        // Get the Helm Makefile targets
        helmTargets := getHelmMakefileTargets(p.config.GetProjectName(), namespace, p.outputDir)

        // Append the targets if they don't already exist
        if err := util.AppendCodeIfNotExist(makefilePath, helmTargets); err != nil {
                return fmt.Errorf("failed to append Helm targets to Makefile: %w", err)
        }

        slog.Info("added Helm deployment targets to Makefile",
                "targets", "helm-deploy, helm-uninstall, helm-status, helm-history, helm-rollback")
        return nil
}

// extractNamespaceFromManifests parses the manifests file to extract the manager namespace.
// Returns projectName-system if manifests don't exist or namespace not found.
func (p *editSubcommand) extractNamespaceFromManifests() string {
        // Default to project-name-system pattern
        defaultNamespace := p.config.GetProjectName() + "-system"

        // If manifests file doesn't exist, use default
        if _, err := os.Stat(p.manifestsFile); os.IsNotExist(err) {
                return defaultNamespace
        }

        // Parse the manifests to get the namespace
        file, err := os.Open(p.manifestsFile)
        if err != nil {
                return defaultNamespace
        }
        defer func() {
                _ = file.Close()
        }()

        // Parse YAML documents looking for the manager Deployment
        decoder := yaml.NewDecoder(file)
        for {
                var doc map[string]any
                if err := decoder.Decode(&doc); err != nil {
                        if err == io.EOF {
                                break
                        }
                        continue
                }

                // Check if this is a Deployment (manager)
                if kind, ok := doc["kind"].(string); ok && kind == "Deployment" {
                        if metadata, ok := doc["metadata"].(map[string]any); ok {
                                // Check if it's the manager deployment
                                if name, ok := metadata["name"].(string); ok && strings.Contains(name, "controller-manager") {
                                        // Extract namespace from the manager Deployment
                                        if namespace, ok := metadata["namespace"].(string); ok && namespace != "" {
                                                return namespace
                                        }
                                }
                        }
                }
        }

        // Fallback to default if manager Deployment not found
        return defaultNamespace
}

// getHelmMakefileTargets returns the Helm Makefile targets as a string
// following the same patterns as the existing Makefile deployment section
func getHelmMakefileTargets(projectName, namespace, outputDir string) string {
        if outputDir == "" {
                outputDir = "dist"
        }

        // Use the project name as default for release name
        release := projectName

        return helmMakefileTemplate(namespace, release, outputDir)
}

// helmMakefileTemplate returns the Helm deployment section template
// This follows the same pattern as the Kustomize deployment section in the Go plugin
const helmMakefileTemplateFormat = `
##@ Helm Deployment

## Helm binary to use for deploying the chart
HELM ?= helm
## Namespace to deploy the Helm release
HELM_NAMESPACE ?= %s
## Name of the Helm release
HELM_RELEASE ?= %s
## Path to the Helm chart directory
HELM_CHART_DIR ?= %s/chart
## Additional arguments to pass to helm commands
HELM_EXTRA_ARGS ?=

.PHONY: install-helm
install-helm: ## Install the latest version of Helm.
        @command -v $(HELM) >/dev/null 2>&1 || { \
                echo "Installing Helm..." && \
                curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-4 | bash; \
        }

.PHONY: helm-deploy
helm-deploy: install-helm ## Deploy manager to the K8s cluster via Helm. Specify an image with IMG.
        $(HELM) upgrade --install $(HELM_RELEASE) $(HELM_CHART_DIR) \
                --namespace $(HELM_NAMESPACE) \
                --create-namespace \
                --set manager.image.repository=$${IMG%%:*} \
                --set manager.image.tag=$${IMG##*:} \
                --wait \
                --timeout 5m \
                $(HELM_EXTRA_ARGS)

.PHONY: helm-uninstall
helm-uninstall: ## Uninstall the Helm release from the K8s cluster.
        $(HELM) uninstall $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)

.PHONY: helm-status
helm-status: ## Show Helm release status.
        $(HELM) status $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)

.PHONY: helm-history
helm-history: ## Show Helm release history.
        $(HELM) history $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)

.PHONY: helm-rollback
helm-rollback: ## Rollback to previous Helm release.
        $(HELM) rollback $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)
`

func helmMakefileTemplate(namespace, release, outputDir string) string {
        return fmt.Sprintf(helmMakefileTemplateFormat, namespace, release, outputDir)
}

func hasWebhooksWith(c config.Config) bool {
        resources, err := c.GetResources()
        if err != nil {
                return false
        }

        for _, res := range resources {
                if res.HasDefaultingWebhook() || res.HasValidationWebhook() || res.HasConversionWebhook() {
                        return true
                }
        }

        return false
}

// removeV1AlphaPluginEntry removes the deprecated helm.kubebuilder.io/v1-alpha plugin entry.
// This must be called from Scaffold (before config is saved) for changes to be persisted.
func (p *editSubcommand) removeV1AlphaPluginEntry() {
        // Only attempt to remove if using v3 config (which supports plugin configs)
        cfg, ok := p.config.(*cfgv3.Cfg)
        if !ok {
                return
        }

        // Check if v1-alpha plugin entry exists
        if cfg.Plugins == nil {
                return
        }

        if _, exists := cfg.Plugins[v1AlphaPluginKey]; exists {
                delete(cfg.Plugins, v1AlphaPluginKey)
                slog.Info("removed deprecated v1-alpha plugin entry")
        }
}

1	/*
2	Copyright 2025 The Kubernetes Authors.
3
4	Licensed under the Apache License, Version 2.0 (the "License");
5	you may not use this file except in compliance with the License.
6	You may obtain a copy of the License at
7
8	http://www.apache.org/licenses/LICENSE-2.0
9
10	Unless required by applicable law or agreed to in writing, software
11	distributed under the License is distributed on an "AS IS" BASIS,
12	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	See the License for the specific language governing permissions and
14	limitations under the License.
15	*/
16
17	package v2alpha
18
19	import (
20	"errors"
21	"fmt"
22	"io"
23	"log/slog"
24	"os"
25	"path/filepath"
26	"strings"
27
28	"github.com/spf13/pflag"
29	"go.yaml.in/yaml/v3"
30
31	"sigs.k8s.io/kubebuilder/v4/pkg/config"
32	cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
33	"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
34	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
35	"sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
36	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v2alpha/internal/common"
37	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v2alpha/scaffolds"
38	)
39
40	const (
41	// DefaultManifestsFile is the default path for kustomize output manifests
42	DefaultManifestsFile = "dist/install.yaml"
43	// v1AlphaPluginKey is the deprecated v1-alpha plugin key
44	v1AlphaPluginKey = "helm.kubebuilder.io/v1-alpha"
45	)
46
47	var _ plugin.EditSubcommand = &editSubcommand{}
48
49	type editSubcommand struct {
50	config config.Config
51	force bool
52	manifestsFile string
53	outputDir string
54	}
55
56	//nolint:lll
57	func (p editSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta plugin.SubcommandMetadata) {	1✔
58	subcmdMeta.Description = `Generate a Helm chart from your project's kustomize output.	1✔
59		1✔
60	Parses 'make build-installer' output (dist/install.yaml) and generates chart to allow easy	1✔
61	distribution of your project. When enabled, adds Helm helpers targets to Makefile`	1✔
62		1✔
63	subcmdMeta.Examples = fmt.Sprintf(`# Generate Helm chart from default manifests (dist/install.yaml) to default output (dist/)	1✔
64	%[1]s edit --plugins=%[2]s	1✔
65		1✔
66	# Generate Helm chart and overwrite existing files (useful for updates)	1✔
67	%[1]s edit --plugins=%[2]s --force	1✔
68		1✔
69	# Generate Helm chart from a custom manifests file	1✔
70	%[1]s edit --plugins=%[2]s --manifests=path/to/custom-install.yaml	1✔
71		1✔
72	# Generate Helm chart to a custom output directory	1✔
73	%[1]s edit --plugins=%[2]s --output-dir=charts	1✔
74		1✔
75	# Generate from custom manifests to custom output directory	1✔
76	%[1]s edit --plugins=%[2]s --manifests=manifests/install.yaml --output-dir=helm-charts	1✔
77		1✔
78	# Typical workflow:	1✔
79	make build-installer # Generate dist/install.yaml with latest changes	1✔
80	%[1]s edit --plugins=%[2]s # Generate/update Helm chart in dist/chart/	1✔
81		1✔
82	NOTE: Chart.yaml is never overwritten (contains user-managed version info).	1✔
83	Without --force, the plugin also preserves values.yaml, NOTES.txt, _helpers.tpl, .helmignore,	1✔
84	and .github/workflows/test-chart.yml.	1✔
85	All other template files in templates/ are always regenerated to match your current	1✔
86	kustomize output. Use --force to regenerate all files except Chart.yaml.	1✔
87		1✔
88	The generated chart structure mirrors your config/ directory:	1✔
89	<output>/chart/	1✔
90	├── Chart.yaml	1✔
91	├── values.yaml	1✔
92	├── .helmignore	1✔
93	└── templates/	1✔
94	├── NOTES.txt	1✔
95	├── _helpers.tpl	1✔
96	├── rbac/	1✔
97	├── manager/	1✔
98	├── webhook/	1✔
99	└── ...	1✔
100	`, cliMeta.CommandName, plugin.KeyFor(Plugin{}))	1✔
101	}	1✔
102
103	func (p editSubcommand) BindFlags(fs pflag.FlagSet) {	1✔
104	fs.BoolVar(&p.force, "force", false, "if true, regenerates all the files")	1✔
105	fs.StringVar(&p.manifestsFile, "manifests", DefaultManifestsFile,	1✔
106	"path to the YAML file containing Kubernetes manifests from kustomize output")	1✔
107	fs.StringVar(&p.outputDir, "output-dir", common.DefaultOutputDir, "output directory for the generated Helm chart")	1✔
108	}	1✔
109
110	func (p *editSubcommand) InjectConfig(c config.Config) error {	1✔
111	p.config = c	1✔
112	return nil	1✔
113	}	1✔
114
115	func (p *editSubcommand) Scaffold(fs machinery.Filesystem) error {	×
116	// If using default manifests file, ensure it exists by running make build-installer	×
117	if p.manifestsFile == DefaultManifestsFile {	×
118	if err := p.ensureManifestsExist(); err != nil {	×
119	slog.Warn("Failed to generate default manifests file", "error", err, "file", p.manifestsFile)	×
120	}	×
121	}
122
NEW 123	scaffolder := scaffolds.NewChartScaffolder(p.config, p.force, p.manifestsFile, p.outputDir)	×
124	scaffolder.InjectFS(fs)	×
125	err := scaffolder.Scaffold()	×
126	if err != nil {	×
127	return fmt.Errorf("error scaffolding Helm chart: %w", err)	×
128	}	×
129
130	// Remove deprecated v1-alpha plugin entry from PROJECT file
131	// This must happen in Scaffold (before config is saved) to be persisted
132	p.removeV1AlphaPluginEntry()	×
133		×
134	// Save plugin config to PROJECT file	×
135	key := plugin.GetPluginKeyForConfig(p.config.GetPluginChain(), Plugin{})	×
136	canonicalKey := plugin.KeyFor(Plugin{})	×
137	cfg := pluginConfig{}	×
138	isFirstRun := false	×
139	if err = p.config.DecodePluginConfig(key, &cfg); err != nil {	×
140	switch {	×
141	case errors.As(err, &config.UnsupportedFieldError{}):	×
142	// Config version doesn't support plugin metadata	×
143	return nil	×
144	case errors.As(err, &config.PluginKeyNotFoundError{}):	×
145	// This is the first time the plugin is run	×
146	isFirstRun = true	×
147	if key != canonicalKey {	×
148	if err2 := p.config.DecodePluginConfig(canonicalKey, &cfg); err2 != nil {	×
149	if errors.As(err2, &config.UnsupportedFieldError{}) {	×
150	return nil	×
151	}	×
152	if !errors.As(err2, &config.PluginKeyNotFoundError{}) {	×
153	return fmt.Errorf("error decoding plugin configuration: %w", err2)	×
154	}	×
155	} else {	×
156	// Found config under canonical key, not first run	×
157	isFirstRun = false	×
158	}	×
159	}
160	default:	×
161	return fmt.Errorf("error decoding plugin configuration: %w", err)	×
162	}
163	}
164
165	// Update configuration with current parameters
166	cfg.ManifestsFile = p.manifestsFile	×
167	cfg.OutputDir = p.outputDir	×
168		×
169	if err = p.config.EncodePluginConfig(key, cfg); err != nil {	×
170	return fmt.Errorf("error encoding plugin configuration: %w", err)	×
171	}	×
172
173	// Add Helm deployment targets to Makefile only on first run
174	if isFirstRun {	×
175	slog.Info("adding Helm deployment targets to Makefile...")	×
176	// Extract namespace from manifests for accurate Makefile generation	×
177	namespace := p.extractNamespaceFromManifests()	×
178	if err := p.addHelmMakefileTargets(namespace); err != nil {	×
179	slog.Warn("failed to add Helm targets to Makefile", "error", err)	×
180	}	×
181	}
182
183	return nil	×
184	}
185
186	// ensureManifestsExist runs make build-installer to generate the default manifests file
187	func (p *editSubcommand) ensureManifestsExist() error {	×
188	slog.Info("Generating default manifests file", "file", p.manifestsFile)	×
189		×
190	// Run the required make targets to generate the manifests file	×
191	targets := []string{"manifests", "generate", "build-installer"}	×
192	for _, target := range targets {	×
193	if err := util.RunCmd(fmt.Sprintf("Running make %s", target), "make", target); err != nil {	×
194	return fmt.Errorf("make %s failed: %w", target, err)	×
195	}	×
196	}
197
198	// Verify the file was created
199	if _, err := os.Stat(p.manifestsFile); err != nil {	×
200	return fmt.Errorf("manifests file %s was not created: %w", p.manifestsFile, err)	×
201	}	×
202
203	slog.Info("Successfully generated manifests file", "file", p.manifestsFile)	×
204	return nil	×
205	}
206
207	// PostScaffold automatically uncomments cert-manager installation when webhooks are present
208	func (p *editSubcommand) PostScaffold() error {	2✔
209	hasWebhooks := hasWebhooksWith(p.config)	2✔
210		2✔
211	if hasWebhooks {	2✔
212	workflowFile := filepath.Join(".github", "workflows", "test-chart.yml")	×
213	if _, err := os.Stat(workflowFile); err != nil {	×
214	slog.Info(	×
215	"Workflow file not found, unable to uncomment cert-manager installation",	×
216	"error", err,	×
217	"file", workflowFile,	×
218	)	×
219	return nil	×
220	}	×
221	target := `	×
222	# - name: Install cert-manager via Helm (wait for readiness)	×
223	# run: \|	×
224	# helm repo add jetstack https://charts.jetstack.io	×
225	# helm repo update	×
226	# helm install cert-manager jetstack/cert-manager \	×
227	# --namespace cert-manager \	×
228	# --create-namespace \	×
229	# --set crds.enabled=true \	×
230	# --wait \	×
231	# --timeout 300s`	×
232	if err := util.UncommentCode(workflowFile, target, "#"); err != nil {	×
233	hasUncommented, errCheck := util.HasFileContentWith(workflowFile, "- name: Install cert-manager via Helm")	×
234	if !hasUncommented \|\| errCheck != nil {	×
235	slog.Warn("Failed to uncomment cert-manager installation in workflow file", "error", err, "file", workflowFile)	×
236	}	×
237	} else {	×
238	target = `# TODO: Uncomment if cert-manager is enabled`	×
239	_ = util.ReplaceInFile(workflowFile, target, "")	×
240	}	×
241	}
242	return nil	2✔
243	}
244
245	// addHelmMakefileTargets appends Helm deployment targets to the Makefile if they don't already exist
246	func (p *editSubcommand) addHelmMakefileTargets(namespace string) error {	3✔
247	makefilePath := "Makefile"	3✔
248	if _, err := os.Stat(makefilePath); os.IsNotExist(err) {	4✔
249	return fmt.Errorf("makefile not found")	1✔
250	}	1✔
251
252	// Get the Helm Makefile targets
253	helmTargets := getHelmMakefileTargets(p.config.GetProjectName(), namespace, p.outputDir)	2✔
254		2✔
255	// Append the targets if they don't already exist	2✔
256	if err := util.AppendCodeIfNotExist(makefilePath, helmTargets); err != nil {	2✔
257	return fmt.Errorf("failed to append Helm targets to Makefile: %w", err)	×
258	}	×
259
260	slog.Info("added Helm deployment targets to Makefile",	2✔
261	"targets", "helm-deploy, helm-uninstall, helm-status, helm-history, helm-rollback")	2✔
262	return nil	2✔
263	}
264
265	// extractNamespaceFromManifests parses the manifests file to extract the manager namespace.
266	// Returns projectName-system if manifests don't exist or namespace not found.
267	func (p *editSubcommand) extractNamespaceFromManifests() string {	×
268	// Default to project-name-system pattern	×
269	defaultNamespace := p.config.GetProjectName() + "-system"	×
270		×
271	// If manifests file doesn't exist, use default	×
272	if _, err := os.Stat(p.manifestsFile); os.IsNotExist(err) {	×
273	return defaultNamespace	×
274	}	×
275
276	// Parse the manifests to get the namespace
277	file, err := os.Open(p.manifestsFile)	×
278	if err != nil {	×
279	return defaultNamespace	×
280	}	×
281	defer func() {	×
282	_ = file.Close()	×
283	}()	×
284
285	// Parse YAML documents looking for the manager Deployment
286	decoder := yaml.NewDecoder(file)	×
287	for {	×
288	var doc map[string]any	×
289	if err := decoder.Decode(&doc); err != nil {	×
290	if err == io.EOF {	×
291	break	×
292	}
293	continue	×
294	}
295
296	// Check if this is a Deployment (manager)
297	if kind, ok := doc["kind"].(string); ok && kind == "Deployment" {	×
298	if metadata, ok := doc["metadata"].(map[string]any); ok {	×
299	// Check if it's the manager deployment	×
300	if name, ok := metadata["name"].(string); ok && strings.Contains(name, "controller-manager") {	×
301	// Extract namespace from the manager Deployment	×
302	if namespace, ok := metadata["namespace"].(string); ok && namespace != "" {	×
303	return namespace	×
304	}	×
305	}
306	}
307	}
308	}
309
310	// Fallback to default if manager Deployment not found
311	return defaultNamespace	×
312	}
313
314	// getHelmMakefileTargets returns the Helm Makefile targets as a string
315	// following the same patterns as the existing Makefile deployment section
316	func getHelmMakefileTargets(projectName, namespace, outputDir string) string {	5✔
317	if outputDir == "" {	5✔
318	outputDir = "dist"	×
319	}	×
320
321	// Use the project name as default for release name
322	release := projectName	5✔
323		5✔
324	return helmMakefileTemplate(namespace, release, outputDir)	5✔
325	}
326
327	// helmMakefileTemplate returns the Helm deployment section template
328	// This follows the same pattern as the Kustomize deployment section in the Go plugin
329	const helmMakefileTemplateFormat = `
330	##@ Helm Deployment
331
332	## Helm binary to use for deploying the chart
333	HELM ?= helm
334	## Namespace to deploy the Helm release
335	HELM_NAMESPACE ?= %s
336	## Name of the Helm release
337	HELM_RELEASE ?= %s
338	## Path to the Helm chart directory
339	HELM_CHART_DIR ?= %s/chart
340	## Additional arguments to pass to helm commands
341	HELM_EXTRA_ARGS ?=
342
343	.PHONY: install-helm
344	install-helm: ## Install the latest version of Helm.
345	@command -v $(HELM) >/dev/null 2>&1 \|\| { \
346	echo "Installing Helm..." && \
347	curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-4 \| bash; \
348	}
349
350	.PHONY: helm-deploy
351	helm-deploy: install-helm ## Deploy manager to the K8s cluster via Helm. Specify an image with IMG.
352	$(HELM) upgrade --install $(HELM_RELEASE) $(HELM_CHART_DIR) \
353	--namespace $(HELM_NAMESPACE) \
354	--create-namespace \
355	--set manager.image.repository=$${IMG%%:*} \
356	--set manager.image.tag=$${IMG##*:} \
357	--wait \
358	--timeout 5m \
359	$(HELM_EXTRA_ARGS)
360
361	.PHONY: helm-uninstall
362	helm-uninstall: ## Uninstall the Helm release from the K8s cluster.
363	$(HELM) uninstall $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)
364
365	.PHONY: helm-status
366	helm-status: ## Show Helm release status.
367	$(HELM) status $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)
368
369	.PHONY: helm-history
370	helm-history: ## Show Helm release history.
371	$(HELM) history $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)
372
373	.PHONY: helm-rollback
374	helm-rollback: ## Rollback to previous Helm release.
375	$(HELM) rollback $(HELM_RELEASE) --namespace $(HELM_NAMESPACE)
376	`
377
378	func helmMakefileTemplate(namespace, release, outputDir string) string {	5✔
379	return fmt.Sprintf(helmMakefileTemplateFormat, namespace, release, outputDir)	5✔
380	}	5✔
381
382	func hasWebhooksWith(c config.Config) bool {	3✔
383	resources, err := c.GetResources()	3✔
384	if err != nil {	3✔
385	return false	×
386	}	×
387
388	for _, res := range resources {	3✔
389	if res.HasDefaultingWebhook() \|\| res.HasValidationWebhook() \|\| res.HasConversionWebhook() {	×
390	return true	×
391	}	×
392	}
393
394	return false	3✔
395	}
396
397	// removeV1AlphaPluginEntry removes the deprecated helm.kubebuilder.io/v1-alpha plugin entry.
398	// This must be called from Scaffold (before config is saved) for changes to be persisted.
399	func (p *editSubcommand) removeV1AlphaPluginEntry() {	4✔
400	// Only attempt to remove if using v3 config (which supports plugin configs)	4✔
401	cfg, ok := p.config.(*cfgv3.Cfg)	4✔
402	if !ok {	4✔
403	return	×
404	}	×
405
406	// Check if v1-alpha plugin entry exists
407	if cfg.Plugins == nil {	6✔
408	return	2✔
409	}	2✔
410
411	if _, exists := cfg.Plugins[v1AlphaPluginKey]; exists {	4✔
412	delete(cfg.Plugins, v1AlphaPluginKey)	2✔
413	slog.Info("removed deprecated v1-alpha plugin entry")	2✔
414	}	2✔
415	}

kubernetes-sigs / kubebuilder / 24469330094

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous