Merge pull request #11295 from sbueringer/pr-remove-dep

k8s-ci-robot · web-flow · commit b59bca9166a4 · 2024-10-17T11:49:03.000+01:00
🌱 Remove Go dependencies on k8s.io/kubectl, k8s.io/metrics, sigs.k8s.io/kustomize, ...
diff --git a/cmd/clusterctl/cmd/completion.go b/cmd/clusterctl/cmd/completion.go
@@ -30,6 +30,7 @@ import (
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/cluster"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 const completionBoilerPlate = `# Copyright 2021 The Kubernetes Authors.
@@ -48,13 +49,13 @@ const completionBoilerPlate = `# Copyright 2021 The Kubernetes Authors.
 `
 
 var (
-	completionLong = LongDesc(`
+	completionLong = templates.LongDesc(`
 		Output shell completion code for the specified shell (bash, zsh or fish).
 		The shell code must be evaluated to provide interactive completion of
 		clusterctl commands. This can be done by sourcing it from the
 		.bash_profile.`)
 
-	completionExample = Examples(`
+	completionExample = templates.Examples(`
 		Bash:
 		# Install bash completion on macOS using Homebrew
 		brew install bash-completion
@@ -87,7 +88,7 @@ var (
 		Use:     "completion [bash|zsh|fish]",
 		GroupID: groupOther,
 		Short:   "Output shell completion code for the specified shell (bash, zsh or fish)",
-		Long:    LongDesc(completionLong),
+		Long:    templates.LongDesc(completionLong),
 		Example: completionExample,
 		Args: func(_ *cobra.Command, args []string) error {
 			if len(args) != 1 {
diff --git a/cmd/clusterctl/cmd/config_repositories.go b/cmd/clusterctl/cmd/config_repositories.go
@@ -29,6 +29,7 @@ import (
 	"sigs.k8s.io/yaml"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 const (
@@ -53,13 +54,13 @@ var configRepositoryCmd = &cobra.Command{
 	Use:   "repositories",
 	Args:  cobra.NoArgs,
 	Short: "Display the list of providers and their repository configurations",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Display the list of providers and their repository configurations.
 
 		clusterctl ships with a list of known providers; if necessary, edit
 		$XDG_CONFIG_HOME/cluster-api/clusterctl.yaml file to add a new provider or to customize existing ones.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Displays the list of available providers.
 		clusterctl config repositories
 
diff --git a/cmd/clusterctl/cmd/delete.go b/cmd/clusterctl/cmd/delete.go
@@ -23,6 +23,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 type deleteOptions struct {
@@ -46,10 +47,10 @@ var deleteCmd = &cobra.Command{
 	Use:     "delete [providers]",
 	GroupID: groupManagement,
 	Short:   "Delete one or more providers from the management cluster",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Delete one or more providers from the management cluster.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Deletes the AWS provider
 		# Please note that this implies the deletion of all provider components except the hosting namespace
 		# and the CRDs.
diff --git a/cmd/clusterctl/cmd/describe_cluster.go b/cmd/clusterctl/cmd/describe_cluster.go
@@ -36,6 +36,7 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/tree"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 const (
@@ -73,12 +74,12 @@ var dc = &describeClusterOptions{}
 var describeClusterClusterCmd = &cobra.Command{
 	Use:   "cluster NAME",
 	Short: "Describe workload clusters",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Provide an "at glance" view of a Cluster API cluster designed to help the user in quickly
 		understanding if there are problems and where.
 		.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Describe the cluster named test-1.
 		clusterctl describe cluster test-1
 
diff --git a/cmd/clusterctl/cmd/generate_cluster.go b/cmd/clusterctl/cmd/generate_cluster.go
@@ -24,6 +24,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 type generateClusterOptions struct {
@@ -52,7 +53,7 @@ var gc = &generateClusterOptions{}
 var generateClusterClusterCmd = &cobra.Command{
 	Use:   "cluster NAME",
 	Short: "Generate templates for creating workload clusters",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Generate templates for creating workload clusters.
 
 		clusterctl ships with a list of known providers; if necessary, edit
@@ -61,7 +62,7 @@ var generateClusterClusterCmd = &cobra.Command{
 		Each provider configuration links to a repository; clusterctl uses this information
 		to fetch templates when creating a new cluster.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Generates a yaml file for creating workload clusters using
 		# the pre-installed infrastructure and bootstrap providers.
 		clusterctl generate cluster my-cluster
diff --git a/cmd/clusterctl/cmd/generate_provider.go b/cmd/clusterctl/cmd/generate_provider.go
@@ -24,6 +24,7 @@ import (
 
 	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 type generateProvidersOptions struct {
@@ -46,15 +47,15 @@ var generateProviderCmd = &cobra.Command{
 	Use:   "provider",
 	Args:  cobra.NoArgs,
 	Short: "Generate templates for provider components",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Generate templates for provider components.
 
 		clusterctl fetches the provider components from the provider repository and performs variable substitution.
 		
 		Variable values are either sourced from the clusterctl config file or
 		from environment variables`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Generates a yaml file for creating provider with variable values using
         # components defined in the provider repository.
 		clusterctl generate provider --infrastructure aws
diff --git a/cmd/clusterctl/cmd/generate_yaml.go b/cmd/clusterctl/cmd/generate_yaml.go
@@ -25,6 +25,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 type generateYAMLOptions struct {
@@ -37,7 +38,7 @@ var gyOpts = &generateYAMLOptions{}
 var generateYamlCmd = &cobra.Command{
 	Use:   "yaml",
 	Short: "Process yaml using clusterctl's yaml processor",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Process yaml using clusterctl's yaml processor.
 
 		clusterctl ships with a simple yaml processor that performs variable
@@ -46,7 +47,7 @@ var generateYamlCmd = &cobra.Command{
 		Variable values are either sourced from the clusterctl config file or
 		from environment variables`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Generates a configuration file with variable values using
 		a template from a specific URL.
 		clusterctl generate yaml --from https://github.com/foo-org/foo-repository/blob/main/cluster-template.yaml
diff --git a/cmd/clusterctl/cmd/get_kubeconfig.go b/cmd/clusterctl/cmd/get_kubeconfig.go
@@ -25,6 +25,7 @@ import (
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 type getKubeconfigOptions struct {
@@ -38,10 +39,10 @@ var gk = &getKubeconfigOptions{}
 var getKubeconfigCmd = &cobra.Command{
 	Use:   "kubeconfig NAME",
 	Short: "Gets the kubeconfig file for accessing a workload cluster",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Gets the kubeconfig file for accessing a workload cluster`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Get the workload cluster's kubeconfig.
 		clusterctl get kubeconfig <name of workload cluster>
 
diff --git a/cmd/clusterctl/cmd/init.go b/cmd/clusterctl/cmd/init.go
@@ -23,6 +23,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 type initOptions struct {
@@ -47,7 +48,7 @@ var initCmd = &cobra.Command{
 	Use:     "init",
 	GroupID: groupManagement,
 	Short:   "Initialize a management cluster",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Initialize a management cluster.
 
 		Installs Cluster API core components, the kubeadm bootstrap provider,
@@ -65,7 +66,7 @@ var initCmd = &cobra.Command{
 
 		See https://cluster-api.sigs.k8s.io for more details.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Initialize a management cluster, by installing the given infrastructure provider.
 		#
 		# Note: when this command is executed on an empty management cluster,
diff --git a/cmd/clusterctl/cmd/init_list_images.go b/cmd/clusterctl/cmd/init_list_images.go
@@ -23,17 +23,18 @@ import (
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 var initListImagesCmd = &cobra.Command{
 	Use:   "list-images",
 	Short: "Lists the container images required for initializing the management cluster",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Lists the container images required for initializing the management cluster.
 
 		See https://cluster-api.sigs.k8s.io for more details.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		# Lists the container images required for initializing the management cluster.
 		#
 		# Note: This command is a dry-run; it won't perform any action other than printing to screen.
diff --git a/cmd/clusterctl/cmd/internal/templates/normalizers.go b/cmd/clusterctl/cmd/internal/templates/normalizers.go
@@ -0,0 +1,71 @@
+/*
+Copyright 2024 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 templates provides templates for descriptions and examples.
+// This code has been inlined from https://github.com/kubernetes/kubernetes/blob/v1.31.0/staging/src/k8s.io/kubectl/pkg/util/templates/normalizers.go#L27
+// to avoid a dependency on k8s.io/kubectl.
+package templates
+
+import (
+	"strings"
+
+	"github.com/MakeNowJust/heredoc"
+)
+
+const indentation = `  `
+
+// LongDesc normalizes a command's long description to follow the conventions.
+func LongDesc(s string) string {
+	if s == "" {
+		return s
+	}
+	return normalizer{s}.heredoc().trim().string
+}
+
+// Examples normalizes a command's examples to follow the conventions.
+func Examples(s string) string {
+	if s == "" {
+		return s
+	}
+	return normalizer{s}.trim().indent().string
+}
+
+// TODO: document this, what does it do? Why is it here?
+type normalizer struct {
+	string
+}
+
+func (s normalizer) heredoc() normalizer {
+	s.string = heredoc.Doc(s.string)
+	return s
+}
+
+func (s normalizer) trim() normalizer {
+	s.string = strings.TrimSpace(s.string)
+	return s
+}
+
+func (s normalizer) indent() normalizer {
+	splitLines := strings.Split(s.string, "\n")
+	indentedLines := make([]string, 0, len(splitLines))
+	for _, line := range splitLines {
+		trimmed := strings.TrimSpace(line)
+		indented := indentation + trimmed
+		indentedLines = append(indentedLines, indented)
+	}
+	s.string = strings.Join(indentedLines, "\n")
+	return s
+}
diff --git a/cmd/clusterctl/cmd/move.go b/cmd/clusterctl/cmd/move.go
@@ -27,6 +27,7 @@ import (
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/cluster"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 	logf "sigs.k8s.io/cluster-api/cmd/clusterctl/log"
 	"sigs.k8s.io/cluster-api/util/apiwarnings"
 )
@@ -49,12 +50,12 @@ var moveCmd = &cobra.Command{
 	Use:     "move",
 	GroupID: groupManagement,
 	Short:   "Move Cluster API objects and all dependencies between management clusters",
-	Long: LongDesc(`
+	Long: templates.LongDesc(`
 		Move Cluster API objects and all dependencies between management clusters.
 
 		Note: The destination cluster MUST have the required provider components installed.`),
 
-	Example: Examples(`
+	Example: templates.Examples(`
 		Move Cluster API objects and all dependencies between management clusters.
 		clusterctl move --to-kubeconfig=target-kubeconfig.yaml
 
diff --git a/cmd/clusterctl/cmd/rollout.go b/cmd/clusterctl/cmd/rollout.go
@@ -19,19 +19,20 @@ package cmd
 import (
 	"github.com/spf13/cobra"
 
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/rollout"
 )
 
 var (
-	rolloutLong = LongDesc(`
+	rolloutLong = templates.LongDesc(`
 		Manage the rollout of a cluster-api resource.
 		Valid resource types include:
 
 		   * machinedeployment
 		   * kubeadmcontrolplane
 		`)
 
-	rolloutExample = Examples(`
+	rolloutExample = templates.Examples(`
 		# Force an immediate rollout of machinedeployment or kubeadmcontrolplane
 		clusterctl alpha rollout restart machinedeployment/my-md-0
 		clusterctl alpha rollout restart kubeadmcontrolplane/my-kcp
diff --git a/cmd/clusterctl/cmd/rollout/pause.go b/cmd/clusterctl/cmd/rollout/pause.go
@@ -21,9 +21,9 @@ import (
 	"context"
 
 	"github.com/spf13/cobra"
-	"k8s.io/kubectl/pkg/util/templates"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 // pauseOptions is the start of the data required to perform the operation.
diff --git a/cmd/clusterctl/cmd/rollout/restart.go b/cmd/clusterctl/cmd/rollout/restart.go
@@ -20,9 +20,9 @@ import (
 	"context"
 
 	"github.com/spf13/cobra"
-	"k8s.io/kubectl/pkg/util/templates"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 // restartOptions is the start of the data required to perform the operation.
diff --git a/cmd/clusterctl/cmd/rollout/resume.go b/cmd/clusterctl/cmd/rollout/resume.go
@@ -20,9 +20,9 @@ import (
 	"context"
 
 	"github.com/spf13/cobra"
-	"k8s.io/kubectl/pkg/util/templates"
 
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/cmd/internal/templates"
 )
 
 // resumeOptions is the start of the data required to perform the operation.
diff --git a/cmd/clusterctl/cmd/rollout/undo.go b/cmd/clusterctl/cmd/rollout/undo.go
diff --git a/cmd/clusterctl/cmd/root.go b/cmd/clusterctl/cmd/root.go
diff --git a/cmd/clusterctl/cmd/topology_plan.go b/cmd/clusterctl/cmd/topology_plan.go
diff --git a/cmd/clusterctl/cmd/upgrade_apply.go b/cmd/clusterctl/cmd/upgrade_apply.go
diff --git a/cmd/clusterctl/cmd/upgrade_plan.go b/cmd/clusterctl/cmd/upgrade_plan.go
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
