Issue#237 (#248)

raffaelespazzoli · web-flow · commit 19ed71970afe · 2024-07-08T14:24:20.000-05:00
* refactor to prevent attempting t delete non-deletable resources Signed-off-by: raffaelespazzoli <raffaele.spazzoli@gmail.com> * documented Signed-off-by: raffaelespazzoli <raffaele.spazzoli@gmail.com> * updated dependencies Signed-off-by: raffaelespazzoli <raffaele.spazzoli@gmail.com> * updated dependencies #2 Signed-off-by: raffaelespazzoli <raffaele.spazzoli@gmail.com> * upgraded go to 1.21 Signed-off-by: raffaelespazzoli <raffaele.spazzoli@gmail.com> --------- Signed-off-by: raffaelespazzoli <raffaele.spazzoli@gmail.com>
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -13,5 +13,5 @@ jobs:
       RUN_UNIT_TESTS: true
       RUN_INTEGRATION_TESTS: true
       RUN_HELMCHART_TEST: true
-      GO_VERSION: ~1.19
+      GO_VERSION: ~1.21
       OPERATOR_SDK_VERSION: v1.25.3
diff --git a/.github/workflows/push.yaml b/.github/workflows/push.yaml
@@ -20,5 +20,5 @@ jobs:
       RUN_UNIT_TESTS: true
       RUN_INTEGRATION_TESTS: true
       RUN_HELMCHART_TEST: true
-      GO_VERSION: ~1.19
+      GO_VERSION: ~1.21
       OPERATOR_SDK_VERSION: v1.25.3
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.19 as builder
+FROM golang:1.21 as builder
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
diff --git a/api/v1alpha1/authenginemount_types.go b/api/v1alpha1/authenginemount_types.go
@@ -53,6 +53,10 @@ type AuthEngineMountSpec struct {
 	Name string `json:"name,omitempty"`
 }
 
+func (d *AuthEngineMount) IsDeletable() bool {
+	return true
+}
+
 func (d *AuthEngineMount) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath(d.GetEngineListPath() + "/" + string(d.Spec.Path) + "/" + d.Spec.Name)
diff --git a/api/v1alpha1/azureauthengineconfig_types.go b/api/v1alpha1/azureauthengineconfig_types.go
@@ -130,6 +130,10 @@ type AzureConfig struct {
 var _ vaultutils.VaultObject = &AzureAuthEngineConfig{}
 var _ vaultutils.ConditionsAware = &AzureAuthEngineConfig{}
 
+func (d *AzureAuthEngineConfig) IsDeletable() bool {
+	return true
+}
+
 func (d *AzureAuthEngineConfig) GetVaultConnection() *vaultutils.VaultConnection {
 	return d.Spec.Connection
 }
diff --git a/api/v1alpha1/azureauthenginerole_types.go b/api/v1alpha1/azureauthenginerole_types.go
@@ -188,6 +188,10 @@ func init() {
 	SchemeBuilder.Register(&AzureAuthEngineRole{}, &AzureAuthEngineRoleList{})
 }
 
+func (d *AzureAuthEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (r *AzureAuthEngineRole) GetConditions() []metav1.Condition {
 	return r.Status.Conditions
 }
diff --git a/api/v1alpha1/azuresecretengineconfig_types.go b/api/v1alpha1/azuresecretengineconfig_types.go
@@ -128,6 +128,10 @@ func init() {
 	SchemeBuilder.Register(&AzureSecretEngineConfig{}, &AzureSecretEngineConfigList{})
 }
 
+func (d *AzureSecretEngineConfig) IsDeletable() bool {
+	return true
+}
+
 func (r *AzureSecretEngineConfig) SetConditions(conditions []metav1.Condition) {
 	r.Status.Conditions = conditions
 }
diff --git a/api/v1alpha1/databasesecretengineconfig_types.go b/api/v1alpha1/databasesecretengineconfig_types.go
@@ -69,6 +69,10 @@ func (d *DatabaseSecretEngineConfig) GetVaultConnection() *vaultutils.VaultConne
 	return d.Spec.Connection
 }
 
+func (d *DatabaseSecretEngineConfig) IsDeletable() bool {
+	return true
+}
+
 func (d *DatabaseSecretEngineConfig) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath(string(d.Spec.Path) + "/" + "config" + "/" + d.Spec.Name)
diff --git a/api/v1alpha1/databasesecretenginerole_types.go b/api/v1alpha1/databasesecretenginerole_types.go
@@ -59,6 +59,10 @@ var _ vaultutils.VaultObject = &DatabaseSecretEngineRole{}
 
 var _ vaultutils.ConditionsAware = &DatabaseSecretEngineRole{}
 
+func (d *DatabaseSecretEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (d *DatabaseSecretEngineRole) GetVaultConnection() *vaultutils.VaultConnection {
 	return d.Spec.Connection
 }
diff --git a/api/v1alpha1/databasesecretenginestaticrole_types.go b/api/v1alpha1/databasesecretenginestaticrole_types.go
@@ -144,6 +144,10 @@ func (d *DatabaseSecretEngineStaticRole) GetVaultConnection() *vaultutils.VaultC
 	return d.Spec.Connection
 }
 
+func (d *DatabaseSecretEngineStaticRole) IsDeletable() bool {
+	return true
+}
+
 func (d *DatabaseSecretEngineStaticRole) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath(string(d.Spec.Path) + "/" + "static-roles" + "/" + d.Spec.Name)
diff --git a/api/v1alpha1/gcpauthengineconfig_types.go b/api/v1alpha1/gcpauthengineconfig_types.go
@@ -147,6 +147,10 @@ func (d *GCPAuthEngineConfig) GetVaultConnection() *vaultutils.VaultConnection {
 	return d.Spec.Connection
 }
 
+func (d *GCPAuthEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (r *GCPAuthEngineConfig) GetConditions() []metav1.Condition {
 	return r.Status.Conditions
 }
diff --git a/api/v1alpha1/gcpauthenginerole_types.go b/api/v1alpha1/gcpauthenginerole_types.go
@@ -215,6 +215,10 @@ func init() {
 	SchemeBuilder.Register(&GCPAuthEngineRole{}, &GCPAuthEngineRoleList{})
 }
 
+func (d *GCPAuthEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (r *GCPAuthEngineRole) GetConditions() []metav1.Condition {
 	return r.Status.Conditions
 }
diff --git a/api/v1alpha1/githubsecretengineconfig_types.go b/api/v1alpha1/githubsecretengineconfig_types.go
@@ -96,6 +96,10 @@ func (d *GitHubSecretEngineConfig) GetVaultConnection() *vaultutils.VaultConnect
 	return d.Spec.Connection
 }
 
+func (d *GitHubSecretEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (d *GitHubSecretEngineConfig) GetPath() string {
 	return string(d.Spec.Path) + "/" + "config"
 }
diff --git a/api/v1alpha1/githubsecretenginerole_types.go b/api/v1alpha1/githubsecretenginerole_types.go
@@ -115,6 +115,10 @@ func (d *GitHubSecretEngineRole) IsInitialized() bool {
 	return true
 }
 
+func (d *GitHubSecretEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (d *GitHubSecretEngineRole) PrepareInternalValues(context context.Context, object client.Object) error {
 	return nil
 }
diff --git a/api/v1alpha1/group_types.go b/api/v1alpha1/group_types.go
@@ -119,6 +119,10 @@ func (m *Group) GetConditions() []metav1.Condition {
 	return m.Status.Conditions
 }
 
+func (d *Group) IsDeletable() bool {
+	return true
+}
+
 func (m *Group) SetConditions(conditions []metav1.Condition) {
 	m.Status.Conditions = conditions
 }
diff --git a/api/v1alpha1/groupalias_types.go b/api/v1alpha1/groupalias_types.go
@@ -107,6 +107,10 @@ func (m *GroupAlias) GetConditions() []metav1.Condition {
 	return m.Status.Conditions
 }
 
+func (d *GroupAlias) IsDeletable() bool {
+	return true
+}
+
 func (m *GroupAlias) SetConditions(conditions []metav1.Condition) {
 	m.Status.Conditions = conditions
 }
diff --git a/api/v1alpha1/jwtoidcauthengineconfig_types.go b/api/v1alpha1/jwtoidcauthengineconfig_types.go
@@ -174,6 +174,10 @@ func (d *JWTOIDCAuthEngineConfig) GetVaultConnection() *vaultutils.VaultConnecti
 	return d.Spec.Connection
 }
 
+func (d *JWTOIDCAuthEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (r *JWTOIDCAuthEngineConfig) GetConditions() []metav1.Condition {
 	return r.Status.Conditions
 }
diff --git a/api/v1alpha1/jwtoidcauthenginerole_types.go b/api/v1alpha1/jwtoidcauthenginerole_types.go
@@ -257,6 +257,10 @@ func (d *JWTOIDCAuthEngineRole) GetVaultConnection() *vaultutils.VaultConnection
 	return d.Spec.Connection
 }
 
+func (d *JWTOIDCAuthEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (r *JWTOIDCAuthEngineRole) GetKubeAuthConfiguration() *vaultutils.KubeAuthConfiguration {
 	return &r.Spec.Authentication
 }
diff --git a/api/v1alpha1/kubernetesauthengineconfig_types.go b/api/v1alpha1/kubernetesauthengineconfig_types.go
@@ -85,6 +85,10 @@ func (d *KubernetesAuthEngineConfig) IsInitialized() bool {
 	return true
 }
 
+func (d *KubernetesAuthEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (d *KubernetesAuthEngineConfig) PrepareInternalValues(context context.Context, object client.Object) error {
 	log := log.FromContext(context)
 
diff --git a/api/v1alpha1/kubernetesauthenginerole_types.go b/api/v1alpha1/kubernetesauthenginerole_types.go
@@ -67,6 +67,10 @@ func (d *KubernetesAuthEngineRole) GetVaultConnection() *vaultutils.VaultConnect
 	return d.Spec.Connection
 }
 
+func (d *KubernetesAuthEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (d *KubernetesAuthEngineRole) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath("auth/" + string(d.Spec.Path) + "/role/" + d.Spec.Name)
diff --git a/api/v1alpha1/kubernetessecretengineconfig_types.go b/api/v1alpha1/kubernetessecretengineconfig_types.go
@@ -106,6 +106,10 @@ func (d *KubernetesSecretEngineConfig) GetVaultConnection() *vaultutils.VaultCon
 	return d.Spec.Connection
 }
 
+func (d *KubernetesSecretEngineConfig) IsDeletable() bool {
+	return true
+}
+
 func (d *KubernetesSecretEngineConfig) GetPath() string {
 	return string(d.Spec.Path) + "/" + "config"
 }
diff --git a/api/v1alpha1/kubernetessecretenginerole_types.go b/api/v1alpha1/kubernetessecretenginerole_types.go
@@ -61,6 +61,10 @@ var _ vaultutils.VaultObject = &KubernetesSecretEngineRole{}
 
 var _ vaultutils.ConditionsAware = &KubernetesSecretEngineRole{}
 
+func (d *KubernetesSecretEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (d *KubernetesSecretEngineRole) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath(string(d.Spec.Path) + "/" + "roles" + "/" + d.Spec.Name)
diff --git a/api/v1alpha1/ldapauthengineconfig_types.go b/api/v1alpha1/ldapauthengineconfig_types.go
@@ -61,6 +61,10 @@ func (d *LDAPAuthEngineConfig) GetVaultConnection() *vaultutils.VaultConnection
 	return d.Spec.Connection
 }
 
+func (d *LDAPAuthEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (d *LDAPAuthEngineConfig) GetPath() string {
 	return vaultutils.CleansePath("auth/" + string(d.Spec.Path) + "/config")
 }
diff --git a/api/v1alpha1/ldapauthenginegroup_types.go b/api/v1alpha1/ldapauthenginegroup_types.go
@@ -63,6 +63,10 @@ func (d *LDAPAuthEngineGroup) GetPath() string {
 	return vaultutils.CleansePath("auth/" + string(d.Spec.Path) + "/groups/" + string(d.Spec.Name))
 }
 
+func (d *LDAPAuthEngineGroup) IsDeletable() bool {
+	return true
+}
+
 func (d *LDAPAuthEngineGroup) GetPayload() map[string]interface{} {
 	return d.toMap()
 }
diff --git a/api/v1alpha1/passwordpolicy_types.go b/api/v1alpha1/passwordpolicy_types.go
@@ -54,6 +54,10 @@ func (d *PasswordPolicy) IsInitialized() bool {
 	return true
 }
 
+func (d *PasswordPolicy) IsDeletable() bool {
+	return true
+}
+
 func (d *PasswordPolicy) PrepareInternalValues(context context.Context, object client.Object) error {
 	return nil
 }
diff --git a/api/v1alpha1/pkisecretengineconfig_types.go b/api/v1alpha1/pkisecretengineconfig_types.go
@@ -233,6 +233,10 @@ func (d *PKISecretEngineConfig) GetVaultConnection() *vaultutils.VaultConnection
 	return d.Spec.Connection
 }
 
+func (d *PKISecretEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (p *PKISecretEngineConfig) GetPath() string {
 	return string(p.Spec.Path)
 }
diff --git a/api/v1alpha1/pkisecretenginerole_types.go b/api/v1alpha1/pkisecretenginerole_types.go
@@ -92,6 +92,10 @@ func (r *PKISecretEngineRole) IsValid() (bool, error) {
 	return true, nil
 }
 
+func (d *PKISecretEngineRole) IsDeletable() bool {
+	return true
+}
+
 type PKIRole struct {
 
 	// Specifies the Time To Live value provided as a string duration with time suffix. Hour is the largest suffix. If not set, uses the system default value or the value of max_ttl, whichever is shorter.
diff --git a/api/v1alpha1/policy_types.go b/api/v1alpha1/policy_types.go
@@ -71,6 +71,10 @@ func (d *Policy) IsInitialized() bool {
 	return true
 }
 
+func (d *Policy) IsDeletable() bool {
+	return true
+}
+
 func (d *Policy) PrepareInternalValues(context context.Context, object client.Object) error {
 	// Fast path escape if no "${..}" placeholder is detected
 	match, err := regexp.MatchString("\\${[^}]+}", d.Spec.Policy)
diff --git a/api/v1alpha1/quaysecretengineconfig_types.go b/api/v1alpha1/quaysecretengineconfig_types.go
@@ -59,6 +59,10 @@ func (d *QuaySecretEngineConfig) GetVaultConnection() *vaultutils.VaultConnectio
 	return d.Spec.Connection
 }
 
+func (d *QuaySecretEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (q *QuaySecretEngineConfig) GetPath() string {
 	return string(q.Spec.Path) + "/" + "config"
 }
diff --git a/api/v1alpha1/quaysecretenginerole_types.go b/api/v1alpha1/quaysecretenginerole_types.go
@@ -76,6 +76,10 @@ func (d *QuaySecretEngineRole) GetVaultConnection() *vaultutils.VaultConnection
 	return d.Spec.Connection
 }
 
+func (d *QuaySecretEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (d *QuaySecretEngineRole) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath(string(d.Spec.Path) + "/" + "roles" + "/" + d.Spec.Name)
diff --git a/api/v1alpha1/quaysecretenginestaticrole_types.go b/api/v1alpha1/quaysecretenginestaticrole_types.go
@@ -74,6 +74,10 @@ func (q *QuaySecretEngineStaticRole) IsInitialized() bool {
 	return true
 }
 
+func (d *QuaySecretEngineStaticRole) IsDeletable() bool {
+	return true
+}
+
 func (q *QuaySecretEngineStaticRole) PrepareInternalValues(context context.Context, object client.Object) error {
 	return nil
 }
diff --git a/api/v1alpha1/rabbitmqsecretengineconfig_types.go b/api/v1alpha1/rabbitmqsecretengineconfig_types.go
@@ -153,6 +153,10 @@ func (m *RabbitMQSecretEngineConfig) SetConditions(conditions []metav1.Condition
 	m.Status.Conditions = conditions
 }
 
+func (d *RabbitMQSecretEngineConfig) IsDeletable() bool {
+	return false
+}
+
 func (m *RabbitMQSecretEngineConfig) SetUsernameAndPassword(username string, password string) {
 	m.Spec.RMQSEConfig.retrievedUsername = username
 	m.Spec.RMQSEConfig.retrievedPassword = password
diff --git a/api/v1alpha1/rabbitmqsecretenginerole_types.go b/api/v1alpha1/rabbitmqsecretenginerole_types.go
@@ -152,6 +152,10 @@ func (m *RabbitMQSecretEngineRole) GetConditions() []metav1.Condition {
 	return m.Status.Conditions
 }
 
+func (d *RabbitMQSecretEngineRole) IsDeletable() bool {
+	return true
+}
+
 func (m *RabbitMQSecretEngineRole) SetConditions(conditions []metav1.Condition) {
 	m.Status.Conditions = conditions
 }
diff --git a/api/v1alpha1/randomsecret_types.go b/api/v1alpha1/randomsecret_types.go
@@ -98,6 +98,10 @@ func (d *RandomSecret) GetPath() string {
 	return vaultutils.CleansePath(string(d.Spec.Path) + "/" + d.Name)
 }
 
+func (d *RandomSecret) IsDeletable() bool {
+	return true
+}
+
 func (d *RandomSecret) getV1Payload() map[string]interface{} {
 
 	payload := map[string]interface{}{
diff --git a/api/v1alpha1/secretenginemount_types.go b/api/v1alpha1/secretenginemount_types.go
@@ -36,6 +36,10 @@ func (d *SecretEngineMount) GetVaultConnection() *vaultutils.VaultConnection {
 	return d.Spec.Connection
 }
 
+func (d *SecretEngineMount) IsDeletable() bool {
+	return true
+}
+
 func (d *SecretEngineMount) GetPath() string {
 	if d.Spec.Name != "" {
 		return vaultutils.CleansePath(d.GetEngineListPath() + "/" + string(d.Spec.Path) + "/" + d.Spec.Name)
diff --git a/api/v1alpha1/utils/vaultobject.go b/api/v1alpha1/utils/vaultobject.go
@@ -32,6 +32,7 @@ type VaultObject interface {
 	IsEquivalentToDesiredState(payload map[string]interface{}) bool
 	IsInitialized() bool
 	IsValid() (bool, error)
+	IsDeletable() bool
 	PrepareInternalValues(context context.Context, object client.Object) error
 	PrepareTLSConfig(context context.Context, object client.Object) error
 	GetKubeAuthConfiguration() *KubeAuthConfiguration
diff --git a/controllers/vaultresourcecontroller/utils.go b/controllers/vaultresourcecontroller/utils.go
diff --git a/controllers/vaultresourcecontroller/vaultengineresourcereconciler.go b/controllers/vaultresourcecontroller/vaultengineresourcereconciler.go
diff --git a/controllers/vaultresourcecontroller/vaultpkiengineresourcereconciler.go b/controllers/vaultresourcecontroller/vaultpkiengineresourcereconciler.go
diff --git a/controllers/vaultresourcecontroller/vaultresourcereconciler.go b/controllers/vaultresourcecontroller/vaultresourcereconciler.go
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/readme.md b/readme.md

Original file line number	Diff line number	Diff line change
`@@ -188,6 +188,10 @@ func init() {`
`188`	`188`	`SchemeBuilder.Register(&AzureAuthEngineRole{}, &AzureAuthEngineRoleList{})`
`189`	`189`	`}`
`190`	`190`
	`191`	`+func (d *AzureAuthEngineRole) IsDeletable() bool {`
	`192`	`+ return true`
	`193`	`+}`
	`194`	`+`
`191`	`195`	`func (r *AzureAuthEngineRole) GetConditions() []metav1.Condition {`
`192`	`196`	`return r.Status.Conditions`
`193`	`197`	`}`
Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,10 @@ func init() {`
`128`	`128`	`SchemeBuilder.Register(&AzureSecretEngineConfig{}, &AzureSecretEngineConfigList{})`
`129`	`129`	`}`
`130`	`130`
	`131`	`+func (d *AzureSecretEngineConfig) IsDeletable() bool {`
	`132`	`+ return true`
	`133`	`+}`
	`134`	`+`
`131`	`135`	`func (r *AzureSecretEngineConfig) SetConditions(conditions []metav1.Condition) {`
`132`	`136`	`r.Status.Conditions = conditions`
`133`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,10 @@ var _ vaultutils.VaultObject = &DatabaseSecretEngineRole{}`
`59`	`59`
`60`	`60`	`var _ vaultutils.ConditionsAware = &DatabaseSecretEngineRole{}`
`61`	`61`
	`62`	`+func (d *DatabaseSecretEngineRole) IsDeletable() bool {`
	`63`	`+ return true`
	`64`	`+}`
	`65`	`+`
`62`	`66`	`func (d DatabaseSecretEngineRole) GetVaultConnection() vaultutils.VaultConnection {`
`63`	`67`	`return d.Spec.Connection`
`64`	`68`	`}`