Move shared types to a separate package

This will enable the expanders in a future commit to be able to leverage
these types.

Signed-off-by: mprahl <[email protected]>

Author: mprahl

internal/plugin.go

@@ -9,6 +9,7 @@ import (
 	"sort"
 	"strings"
 
+	"github.com/open-cluster-management/policy-generator-plugin/internal/types"
 	"gopkg.in/yaml.v3"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 )
@@ -23,53 +24,6 @@ const (
 	placementRuleKind          = "PlacementRule"
 )
 
-type manifest struct {
-	Patches []map[string]interface{} `json:"patches,omitempty" yaml:"patches,omitempty"`
-	Path    string                   `json:"path,omitempty" yaml:"path,omitempty"`
-}
-
-type namespaceSelector struct {
-	Exclude []string `json:"exclude,omitempty" yaml:"exclude,omitempty"`
-	Include []string `json:"include,omitempty" yaml:"include,omitempty"`
-}
-
-type placementConfig struct {
-	ClusterSelectors  map[string]string `json:"clusterSelectors,omitempty" yaml:"clusterSelectors,omitempty"`
-	Name              string            `json:"name,omitempty" yaml:"name,omitempty"`
-	PlacementRulePath string            `json:"placementRulePath,omitempty" yaml:"placementRulePath,omitempty"`
-}
-
-// policyConfig represents a policy entry in the PolicyGenerator configuration.
-type policyConfig struct {
-	Categories     []string `json:"categories,omitempty" yaml:"categories,omitempty"`
-	ComplianceType string   `json:"complianceType,omitempty" yaml:"complianceType,omitempty"`
-	Controls       []string `json:"controls,omitempty" yaml:"controls,omitempty"`
-	Disabled       bool     `json:"disabled,omitempty" yaml:"disabled,omitempty"`
-	// Make this a slice of structs in the event we want additional configuration related to
-	// a manifest such as accepting patches.
-	Manifests         []manifest        `json:"manifests,omitempty" yaml:"manifests,omitempty"`
-	Name              string            `json:"name,omitempty" yaml:"name,omitempty"`
-	NamespaceSelector namespaceSelector `json:"namespaceSelector,omitempty" yaml:"namespaceSelector,omitempty"`
-	// This is named Placement so that eventually PlacementRules and Placements will be supported
-	Placement         placementConfig `json:"placement,omitempty" yaml:"placement,omitempty"`
-	RemediationAction string          `json:"remediationAction,omitempty" yaml:"remediationAction,omitempty"`
-	Severity          string          `json:"severity,omitempty" yaml:"severity,omitempty"`
-	Standards         []string        `json:"standards,omitempty" yaml:"standards,omitempty"`
-}
-
-type policyDefaults struct {
-	Categories        []string          `json:"categories,omitempty" yaml:"categories,omitempty"`
-	ComplianceType    string            `json:"complianceType,omitempty" yaml:"complianceType,omitempty"`
-	Controls          []string          `json:"controls,omitempty" yaml:"controls,omitempty"`
-	Namespace         string            `json:"namespace,omitempty" yaml:"namespace,omitempty"`
-	NamespaceSelector namespaceSelector `json:"namespaceSelector,omitempty" yaml:"namespaceSelector,omitempty"`
-	// This is named Placement so that eventually PlacementRules and Placements will be supported
-	Placement         placementConfig `json:"placement,omitempty" yaml:"placement,omitempty"`
-	RemediationAction string          `json:"remediationAction,omitempty" yaml:"remediationAction,omitempty"`
-	Severity          string          `json:"severity,omitempty" yaml:"severity,omitempty"`
-	Standards         []string        `json:"standards,omitempty" yaml:"standards,omitempty"`
-}
-
 // Plugin is used to store the PolicyGenerator configuration and the methods to generate the
 // desired policies.
 type Plugin struct {
@@ -79,8 +33,8 @@ type Plugin struct {
 	PlacementBindingDefaults struct {
 		Name string `json:"name,omitempty" yaml:"name,omitempty"`
 	} `json:"placementBindingDefaults,omitempty" yaml:"placementBindingDefaults,omitempty"`
-	PolicyDefaults policyDefaults `json:"policyDefaults,omitempty" yaml:"policyDefaults,omitempty"`
-	Policies       []policyConfig `json:"policies" yaml:"policies"`
+	PolicyDefaults types.PolicyDefaults `json:"policyDefaults,omitempty" yaml:"policyDefaults,omitempty"`
+	Policies       []types.PolicyConfig `json:"policies" yaml:"policies"`
 	// A set of all placement rule names that have been processed or generated
 	allPlrs map[string]bool
 	// This is a mapping of cluster selectors formatted as the return value of getCsKey to placement
@@ -92,7 +46,7 @@ type Plugin struct {
 	processedPlrs map[string]bool
 }
 
-var defaults = policyDefaults{
+var defaults = types.PolicyDefaults{
 	Categories:        []string{"CM Configuration Management"},
 	ComplianceType:    "musthave",
 	Controls:          []string{"CM-2 Baseline Configuration"},
@@ -153,7 +107,7 @@ func (p *Plugin) Generate() ([]byte, error) {
 	plcBindingCount := 0
 	for _, plrName := range plrNames {
 		// Determine which policies to be included in the placement binding.
-		policyConfs := []*policyConfig{}
+		policyConfs := []*types.PolicyConfig{}
 		for _, i := range plrNameToPolicyIdxs[plrName] {
 			policyConfs = append(policyConfs, &p.Policies[i])
 		}
@@ -333,7 +287,7 @@ func (p *Plugin) assertValidConfig() error {
 // createPolicy will generate the root policy based on the PolicyGenerator configuration.
 // The generated policy is written to the plugin's output buffer. An error is returned if the
 // manifests specified in the configuration are invalid or can't be read.
-func (p *Plugin) createPolicy(policyConf *policyConfig) error {
+func (p *Plugin) createPolicy(policyConf *types.PolicyConfig) error {
 	policyTemplate, err := getPolicyTemplate(policyConf)
 	if err != nil {
 		return err
@@ -426,13 +380,13 @@ func (p *Plugin) getPlrFromPath(plrPath string) (string, map[string]interface{},
 }
 
 // getCsKey generates the key for the policy's cluster selectors to be used in Policies.csToPlr.
-func getCsKey(policyConf *policyConfig) string {
+func getCsKey(policyConf *types.PolicyConfig) string {
 	return fmt.Sprintf("%#v", policyConf.Placement.ClusterSelectors)
 }
 
 // getPlrName will generate a placement rule name for the policy. If the placement rule has
 // previously been generated, skip will be true.
-func (p *Plugin) getPlrName(policyConf *policyConfig) (name string, skip bool) {
+func (p *Plugin) getPlrName(policyConf *types.PolicyConfig) (name string, skip bool) {
 	if policyConf.Placement.Name != "" {
 		// If the policy explicitly specifies a placement rule name, use it
 		return policyConf.Placement.Name, false
@@ -462,7 +416,7 @@ func (p *Plugin) getPlrName(policyConf *policyConfig) (name string, skip bool) {
 // the policy generator's output buffer. The name of the placement rule or an error is returned.
 // If the placement rule has already been generated, it will be reused and not added to the
 // policy generator's output buffer. An error is returned if the placement rule cannot be created.
-func (p *Plugin) createPlacementRule(policyConf *policyConfig) (
+func (p *Plugin) createPlacementRule(policyConf *types.PolicyConfig) (
 	name string, err error,
 ) {
 	plrPath := policyConf.Placement.PlacementRulePath
@@ -552,7 +506,7 @@ func (p *Plugin) createPlacementRule(policyConf *policyConfig) (
 // writing it to the policy generator's output buffer. An error is returned if the placement binding
 // cannot be created.
 func (p *Plugin) createPlacementBinding(
-	bindingName, plrName string, policyConfs []*policyConfig,
+	bindingName, plrName string, policyConfs []*types.PolicyConfig,
 ) error {
 	subjects := make([]map[string]string, 0, len(policyConfs))
 	for _, policyConf := range policyConfs {

internal/plugin_config_test.go

@@ -6,6 +6,8 @@ import (
 	"io/ioutil"
 	"path"
 	"testing"
+
+	"github.com/open-cluster-management/policy-generator-plugin/internal/types"
 )
 
 func createConfigMap(t *testing.T, tmpDir, filename string) {
@@ -87,7 +89,7 @@ policies:
 	assertEqual(t, p.PolicyDefaults.ComplianceType, "musthave")
 	assertReflectEqual(t, p.PolicyDefaults.Controls, []string{"PR.DS-1 Data-at-rest"})
 	assertEqual(t, p.PolicyDefaults.Namespace, "my-policies")
-	expectedNsSelector := namespaceSelector{
+	expectedNsSelector := types.NamespaceSelector{
 		Exclude: []string{"my-protected-ns"}, Include: []string{"default"},
 	}
 	assertReflectEqual(t, p.PolicyDefaults.NamespaceSelector, expectedNsSelector)
@@ -110,7 +112,7 @@ policies:
 	assertEqual(t, len(policy1.Manifests), 1)
 	assertEqual(t, policy1.Manifests[0].Path, configMapPath)
 	assertEqual(t, policy1.Name, "policy-app-config")
-	p1ExpectedNsSelector := namespaceSelector{
+	p1ExpectedNsSelector := types.NamespaceSelector{
 		Exclude: nil, Include: []string{"app-ns"},
 	}
 	assertReflectEqual(t, policy1.NamespaceSelector, p1ExpectedNsSelector)
@@ -174,7 +176,7 @@ policies:
 	assertEqual(t, p.PolicyDefaults.ComplianceType, "musthave")
 	assertReflectEqual(t, p.PolicyDefaults.Controls, []string{"CM-2 Baseline Configuration"})
 	assertEqual(t, p.PolicyDefaults.Namespace, "my-policies")
-	expectedNsSelector := namespaceSelector{Exclude: nil, Include: nil}
+	expectedNsSelector := types.NamespaceSelector{Exclude: nil, Include: nil}
 	assertReflectEqual(t, p.PolicyDefaults.NamespaceSelector, expectedNsSelector)
 	assertEqual(t, p.PolicyDefaults.Placement.PlacementRulePath, "")
 	assertEqual(t, len(p.PolicyDefaults.Placement.ClusterSelectors), 0)

internal/plugin_test.go

@@ -7,6 +7,8 @@ import (
 	"path"
 	"strings"
 	"testing"
+
+	"github.com/open-cluster-management/policy-generator-plugin/internal/types"
 )
 
 func TestGenerate(t *testing.T) {
@@ -24,18 +26,18 @@ func TestGenerate(t *testing.T) {
 			},
 		},
 	}
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name: "policy-app-config",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{
 				Path:    path.Join(tmpDir, "configmap.yaml"),
 				Patches: []map[string]interface{}{patch},
 			},
 		},
 	}
-	policyConf2 := policyConfig{
+	policyConf2 := types.PolicyConfig{
 		Name: "policy-app-config2",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{Path: path.Join(tmpDir, "configmap.yaml")},
 		},
 	}
@@ -155,15 +157,15 @@ func TestGenerateSeparateBindings(t *testing.T) {
 	createConfigMap(t, tmpDir, "configmap.yaml")
 	p := Plugin{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name: "policy-app-config",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{Path: path.Join(tmpDir, "configmap.yaml")},
 		},
 	}
-	policyConf2 := policyConfig{
+	policyConf2 := types.PolicyConfig{
 		Name: "policy-app-config2",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{Path: path.Join(tmpDir, "configmap.yaml")},
 		},
 	}
@@ -306,15 +308,15 @@ func TestGenerateMissingBindingName(t *testing.T) {
 	p.PlacementBindingDefaults.Name = ""
 	p.PolicyDefaults.Placement.Name = "my-placement-rule"
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name: "policy-app-config",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{Path: path.Join(tmpDir, "configmap.yaml")},
 		},
 	}
-	policyConf2 := policyConfig{
+	policyConf2 := types.PolicyConfig{
 		Name: "policy-app-config2",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{Path: path.Join(tmpDir, "configmap.yaml")},
 		},
 	}
@@ -343,9 +345,9 @@ func TestCreatePolicy(t *testing.T) {
 	createConfigMap(t, tmpDir, "configmap.yaml")
 	p := Plugin{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name: "policy-app-config",
-		Manifests: []manifest{
+		Manifests: []types.Manifest{
 			{Path: path.Join(tmpDir, "configmap.yaml")},
 		},
 	}
@@ -402,10 +404,10 @@ func TestCreatePolicyDir(t *testing.T) {
 	createConfigMap(t, tmpDir, "configmap2.yaml")
 	p := Plugin{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name:              "policy-app-config",
-		Manifests:         []manifest{{Path: tmpDir}},
-		NamespaceSelector: namespaceSelector{Include: []string{"default"}},
+		Manifests:         []types.Manifest{{Path: tmpDir}},
+		NamespaceSelector: types.NamespaceSelector{Include: []string{"default"}},
 	}
 	p.Policies = append(p.Policies, policyConf)
 	p.applyDefaults()
@@ -474,9 +476,9 @@ func TestCreatePolicyInvalidYAML(t *testing.T) {
 	}
 	p := Plugin{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name:      "policy-app-config",
-		Manifests: []manifest{{Path: manifestPath}},
+		Manifests: []types.Manifest{{Path: manifestPath}},
 	}
 	p.Policies = append(p.Policies, policyConf)
 	p.applyDefaults()
@@ -499,7 +501,7 @@ func TestCreatePlacementRuleDefault(t *testing.T) {
 	p.allPlrs = map[string]bool{}
 	p.csToPlr = map[string]string{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{Name: "policy-app-config"}
+	policyConf := types.PolicyConfig{Name: "policy-app-config"}
 
 	name, err := p.createPlacementRule(&policyConf)
 	if err != nil {
@@ -533,7 +535,7 @@ func TestCreatePlacementRuleSinglePlr(t *testing.T) {
 	p.csToPlr = map[string]string{}
 	p.PolicyDefaults.Namespace = "my-policies"
 	p.PolicyDefaults.Placement.Name = "my-placement-rule"
-	policyConf := policyConfig{Name: "policy-app-config"}
+	policyConf := types.PolicyConfig{Name: "policy-app-config"}
 
 	name, err := p.createPlacementRule(&policyConf)
 	if err != nil {
@@ -573,7 +575,7 @@ func TestCreatePlacementRuleClusterSelectors(t *testing.T) {
 	p.allPlrs = map[string]bool{}
 	p.csToPlr = map[string]string{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{Name: "policy-app-config"}
+	policyConf := types.PolicyConfig{Name: "policy-app-config"}
 	policyConf.Placement.ClusterSelectors = map[string]string{
 		"cloud": "red hat",
 		"game":  "pacman",
@@ -618,15 +620,15 @@ func TestCreatePlacementRuleDuplicateName(t *testing.T) {
 	p.allPlrs = map[string]bool{}
 	p.csToPlr = map[string]string{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{
+	policyConf := types.PolicyConfig{
 		Name: "policy-app-config",
-		Placement: placementConfig{
+		Placement: types.PlacementConfig{
 			Name: "my-placement",
 		},
 	}
-	policyConf2 := policyConfig{
+	policyConf2 := types.PolicyConfig{
 		Name: "policy-app-config2",
-		Placement: placementConfig{
+		Placement: types.PlacementConfig{
 			ClusterSelectors: map[string]string{"my": "app"},
 			Name:             "my-placement",
 		},
@@ -659,7 +661,7 @@ func plrPathHelper(t *testing.T, plrYAML string) (*Plugin, string) {
 	p.allPlrs = map[string]bool{}
 	p.processedPlrs = map[string]bool{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{Name: "policy-app-config"}
+	policyConf := types.PolicyConfig{Name: "policy-app-config"}
 	policyConf.Placement.PlacementRulePath = plrPath
 	p.Policies = append(p.Policies, policyConf)
 
@@ -832,14 +834,14 @@ func TestCreatePlacementBinding(t *testing.T) {
 	t.Parallel()
 	p := Plugin{}
 	p.PolicyDefaults.Namespace = "my-policies"
-	policyConf := policyConfig{Name: "policy-app-config"}
+	policyConf := types.PolicyConfig{Name: "policy-app-config"}
 	p.Policies = append(p.Policies, policyConf)
-	policyConf2 := policyConfig{Name: "policy-app-config2"}
+	policyConf2 := types.PolicyConfig{Name: "policy-app-config2"}
 	p.Policies = append(p.Policies, policyConf2)
 
 	bindingName := "my-placement-binding"
 	plrName := "my-placement-rule"
-	policyConfs := []*policyConfig{}
+	policyConfs := []*types.PolicyConfig{}
 	policyConfs = append(policyConfs, &p.Policies[0], &p.Policies[1])
 
 	err := p.createPlacementBinding(bindingName, plrName, policyConfs)