Merge pull request #5300 from asalkeld/operator-required-fixes-combined

🌱 Operator two small required changes

Author: k8s-ci-robot

cmd/clusterctl/client/repository/client.go

@@ -157,7 +157,7 @@ func repositoryFactory(providerConfig config.Provider, configVariablesClient con
 
 	// if the url is a github repository
 	if rURL.Scheme == httpsScheme && rURL.Host == githubDomain {
-		repo, err := newGitHubRepository(providerConfig, configVariablesClient)
+		repo, err := NewGitHubRepository(providerConfig, configVariablesClient)
 		if err != nil {
 			return nil, errors.Wrap(err, "error creating the GitHub repository client")
 		}

cmd/clusterctl/client/repository/components.go

@@ -144,6 +144,25 @@ func (c *components) Yaml() ([]byte, error) {
 	return utilyaml.FromUnstructured(c.objs)
 }
 
+// ComponentsAlterFn defines the function that is used to alter the components.Objs().
+type ComponentsAlterFn func(objs []unstructured.Unstructured) ([]unstructured.Unstructured, error)
+
+// AlterComponents provides a mechanism to alter the component.Objs from outside
+// the repository module.
+func AlterComponents(comps Components, alterFn ComponentsAlterFn) error {
+	c, ok := comps.(*components)
+	if !ok {
+		return errors.New("could not alter components as Components is not of the correct type")
+	}
+
+	alteredObjs, err := alterFn(c.Objs())
+	if err != nil {
+		return err
+	}
+	c.objs = alteredObjs
+	return nil
+}
+
 // ComponentsOptions represents specific inputs that are passed in to
 // clusterctl library. These are user specified inputs.
 type ComponentsOptions struct {

cmd/clusterctl/client/repository/components_test.go

@@ -948,3 +948,40 @@ func Test_addCommonLabels(t *testing.T) {
 		})
 	}
 }
+
+func TestAlterComponents(t *testing.T) {
+	c := &components{
+		targetNamespace: "test-ns",
+		objs: []unstructured.Unstructured{
+			{
+				Object: map[string]interface{}{
+					"kind": "ClusterRole",
+				},
+			},
+		},
+	}
+	want := []unstructured.Unstructured{
+		{
+			Object: map[string]interface{}{
+				"kind": "ClusterRole",
+				"metadata": map[string]interface{}{
+					"labels": map[string]interface{}{
+						clusterctlv1.ClusterctlLabelName: "",
+						clusterv1.ProviderLabelName:      "infrastructure-provider",
+					},
+				},
+			},
+		},
+	}
+
+	alterFn := func(objs []unstructured.Unstructured) ([]unstructured.Unstructured, error) {
+		// reusing addCommonLabels to do an example modification.
+		return addCommonLabels(objs, config.NewProvider("provider", "", clusterctlv1.InfrastructureProviderType)), nil
+	}
+
+	g := NewWithT(t)
+	if err := AlterComponents(c, alterFn); err != nil {
+		t.Errorf("AlterComponents() error = %v", err)
+	}
+	g.Expect(c.objs).To(Equal(want))
+}

cmd/clusterctl/client/repository/repository_github.go

@@ -116,8 +116,8 @@ func (g *gitHubRepository) GetFile(version, path string) ([]byte, error) {
 	return files, nil
 }
 
-// newGitHubRepository returns a gitHubRepository implementation.
-func newGitHubRepository(providerConfig config.Provider, configVariablesClient config.VariablesClient, opts ...githubRepositoryOption) (*gitHubRepository, error) {
+// NewGitHubRepository returns a gitHubRepository implementation.
+func NewGitHubRepository(providerConfig config.Provider, configVariablesClient config.VariablesClient, opts ...githubRepositoryOption) (Repository, error) {
 	if configVariablesClient == nil {
 		return nil, errors.New("invalid arguments: configVariablesClient can't be nil")
 	}

cmd/clusterctl/client/repository/repository_github_test.go

@@ -112,7 +112,7 @@ func Test_githubRepository_newGitHubRepository(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gitHub, err := newGitHubRepository(tt.field.providerConfig, tt.field.variableClient)
+			gitHub, err := NewGitHubRepository(tt.field.providerConfig, tt.field.variableClient)
 			if tt.wantErr {
 				g.Expect(err).To(HaveOccurred())
 				return
@@ -212,7 +212,7 @@ func Test_githubRepository_getFile(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gitHub, err := newGitHubRepository(providerConfig, configVariablesClient, injectGithubClient(client))
+			gitHub, err := NewGitHubRepository(providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			got, err := gitHub.GetFile(tt.release, tt.fileName)
@@ -268,10 +268,10 @@ func Test_gitHubRepository_getVersions(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gitHub, err := newGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
+			gitHub, err := NewGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
-			got, err := gitHub.getVersions()
+			got, err := gitHub.(*gitHubRepository).getVersions()
 			if tt.wantErr {
 				g.Expect(err).To(HaveOccurred())
 				return
@@ -357,7 +357,7 @@ func Test_gitHubRepository_getLatestContractRelease(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gRepo, err := newGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
+			gRepo, err := NewGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			got, err := latestContractRelease(gRepo, tt.contract)
@@ -443,7 +443,7 @@ func Test_gitHubRepository_getLatestRelease(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gRepo, err := newGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
+			gRepo, err := NewGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			got, err := latestRelease(gRepo)
@@ -453,7 +453,7 @@ func Test_gitHubRepository_getLatestRelease(t *testing.T) {
 			}
 			g.Expect(err).NotTo(HaveOccurred())
 			g.Expect(got).To(Equal(tt.want))
-			g.Expect(gRepo.defaultVersion).To(Equal(tt.want))
+			g.Expect(gRepo.(*gitHubRepository).defaultVersion).To(Equal(tt.want))
 		})
 	}
 }
@@ -525,7 +525,7 @@ func Test_gitHubRepository_getLatestPatchRelease(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gRepo, err := newGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
+			gRepo, err := NewGitHubRepository(tt.field.providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			got, err := latestPatchRelease(gRepo, tt.major, tt.minor)
@@ -584,10 +584,10 @@ func Test_gitHubRepository_getReleaseByTag(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gRepo, err := newGitHubRepository(providerConfig, configVariablesClient, injectGithubClient(client))
+			gRepo, err := NewGitHubRepository(providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
-			got, err := gRepo.getReleaseByTag(tt.args.tag)
+			got, err := gRepo.(*gitHubRepository).getReleaseByTag(tt.args.tag)
 			if tt.wantErr {
 				g.Expect(err).To(HaveOccurred())
 				return
@@ -690,10 +690,10 @@ func Test_gitHubRepository_downloadFilesFromRelease(t *testing.T) {
 			g := NewWithT(t)
 			resetCaches()
 
-			gRepo, err := newGitHubRepository(providerConfig, configVariablesClient, injectGithubClient(client))
+			gRepo, err := NewGitHubRepository(providerConfig, configVariablesClient, injectGithubClient(client))
 			g.Expect(err).NotTo(HaveOccurred())
 
-			got, err := gRepo.downloadFilesFromRelease(tt.args.release, tt.args.fileName)
+			got, err := gRepo.(*gitHubRepository).downloadFilesFromRelease(tt.args.release, tt.args.fileName)
 			if tt.wantErr {
 				g.Expect(err).To(HaveOccurred())
 				return