Renamed MergeRoleForResource func and added CHANGELOG

Author: bharathi-tenneti

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Add support to release SDK arm64 binaries and images. ([#2742](https://github.com/operator-framework/operator-sdk/pull/2715))
 - Add annotation `helm.operator-sdk/upgrade-force: "True"` to allow force resources replacement (`helm upgrade --force`) for Helm based-operators. ([#2773](https://github.com/operator-framework/operator-sdk/pull/2773))
 - The [`--make-manifests`](website/content/en/docs/cli/operator-sdk_generate_csv.md#options) flag directs `operator-sdk generate csv` to create a `manifests/` directory for the latest operator bundle, including CRDs. This flag is set by default. ([#2776](https://github.com/operator-framework/operator-sdk/pull/2776))
+- Add support for additional API creation for Anisble/Helm based operators. ([#2703](https://github.com/operator-framework/operator-sdk/pull/2703))
 
 ### Changed
 

cmd/operator-sdk/add/api.go

@@ -271,7 +271,7 @@ func doHelmAPIScaffold() error {
 		roleScaffold = helm.GenerateRoleScaffold(dc, chart)
 	}
 
-	if err = scaffold.MergeHelmRoleForResource(r, absProjectPath, roleScaffold); err != nil {
+	if err = scaffold.MergeRoleForResource(r, absProjectPath, roleScaffold); err != nil {
 		return fmt.Errorf("failed to merge rules in the RBAC manifest for resource (%v, %v): %v",
 			r.APIVersion, r.Kind, err)
 	}

internal/scaffold/role.go

@@ -21,7 +21,6 @@ import (
 	"io/ioutil"
 	"path/filepath"
 	"sort"
-	"strings"
 
 	log "github.com/sirupsen/logrus"
 	yaml "gopkg.in/yaml.v2"
@@ -146,8 +145,8 @@ func UpdateRoleForResource(r *Resource, absProjectPath string) error {
 	}
 }
 
-// MergeHelmRoleForResource merges incoming new API resource rules with existing deploy/role.yaml
-func MergeHelmRoleForResource(r *Resource, absProjectPath string, roleScaffold Role) error {
+// MergeRoleForResource merges incoming new API resource rules with existing deploy/role.yaml
+func MergeRoleForResource(r *Resource, absProjectPath string, roleScaffold Role) error {
 	roleFilePath := filepath.Join(absProjectPath, DeployDir, RoleYamlFile)
 	roleYAML, err := ioutil.ReadFile(roleFilePath)
 	if err != nil {
@@ -161,21 +160,20 @@ func MergeHelmRoleForResource(r *Resource, absProjectPath string, roleScaffold R
 	if len(roleScaffold.CustomRules) == 0 {
 		return fmt.Errorf("customRules cannot be empty for new Role at: %v", r.APIVersion)
 	}
-	if roleScaffold.IsClusterScoped {
-		// TODO: Add logic to merge Cluster scoped rules into existing Kind: Role scoped rules
-		// Check if existing deploy/role.yaml is ClusterScoped already.
-		if !strings.Contains(string(roleYAML), "kind: ClusterRole") {
-			return fmt.Errorf("cannot Merge Cluster scoped rules with existing deploy/role.yaml" +
-				"please modify existing deploy/role.yaml and deploy/role_binding.yaml " +
-				"to reflect Cluster scope and try again")
-		}
-	}
+
 	obj, _, err := cgoscheme.Codecs.UniversalDeserializer().Decode(roleYAML, nil, nil)
 	if err != nil {
 		return fmt.Errorf("failed to decode role manifest %v: %v", roleFilePath, err)
 	}
 	switch role := obj.(type) {
 	case *rbacv1.Role:
+		// TODO: Add logic to merge Cluster scoped rules into existing Kind: Role scoped rules
+		// Error out for ClusterRole merging with existing Kind: Role
+		if roleScaffold.IsClusterScoped {
+			return fmt.Errorf("cannot Merge Cluster scoped rules with existing deploy/role.yaml. " +
+				"please modify existing deploy/role.yaml and deploy/role_binding.yaml " +
+				"to reflect Cluster scope and try again")
+		}
 		mergedRoleRules := mergeRules(role.Rules, roleScaffold)
 		role.Rules = mergedRoleRules
 

internal/scaffold/role_test.go

@@ -88,7 +88,7 @@ func TestRoleCustomRules(t *testing.T) {
 	}
 }
 
-func TestMergeHelmRoleForResource(t *testing.T) {
+func TestMergeRoleForResource(t *testing.T) {
 	clusterRoleFilePath1 := "./testdata/testroles/valid_clusterrole"
 	clusterRoleFile1 := clusterRoleFilePath1 + "/deploy/role.yaml"
 	if err := ioutil.WriteFile(clusterRoleFile1, []byte(clusterRole), fileutil.DefaultFileMode); err != nil {
@@ -471,7 +471,7 @@ func TestMergeHelmRoleForResource(t *testing.T) {
 			},
 		},
 		{
-			name:           "Invalid  ClusterRole",
+			name:           "Invalid ClusterRole",
 			absProjectPath: roleFilePath1,
 			r: &Resource{
 				APIVersion: "charts.helm.k8s.io/v1alpha1",
@@ -536,7 +536,7 @@ func TestMergeHelmRoleForResource(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			actualErr := MergeHelmRoleForResource(tc.r, tc.absProjectPath, *tc.roleScaffold)
+			actualErr := MergeRoleForResource(tc.r, tc.absProjectPath, *tc.roleScaffold)
 			absFilePath := tc.absProjectPath + "/deploy/role.yaml"
 			actualMergedRoleYAML, err := ioutil.ReadFile(absFilePath)
 			if err != nil {