(feat): automatically delete temporary resources

Co-authored-by: Troy Connor  <troy0820@users.noreply.github.com>
Signed-off-by: schristoff <28318173+schristoff@users.noreply.github.com>

api/v1/agentconfig_types.go

@@ -67,6 +67,7 @@ type AgentConfigSpec struct {
 
 	// TTLSecondsAfterFinished set the time limit of the lifetime of a Job
 	// that has finished execution.
+	// +kubebuilder:default:=600
 	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty" mapstructure:"ttlSecondsAftterFinished,omitempty"`
 
 	// PullPolicy specifies when to pull the Porter Agent image. The default
@@ -331,11 +332,16 @@ func (c AgentConfigSpecAdapter) GetInstallationServiceAccount() string {
 	return c.original.InstallationServiceAccount
 }
 
-// SetRetryAnnotation flags the resource to retry its last operation.
+// GetRetryLimit returns the config value of RetryLimit
 func (c *AgentConfigSpecAdapter) GetRetryLimit() *int32 {
 	return c.original.RetryLimit
 }
 
+// GetTTLSecondsAfterFinished returns the config value of TTLSecondsAfterFinished
+func (c *AgentConfigSpecAdapter) GetTTLSecondsAfterFinished() *int32 {
+	return c.original.TTLSecondsAfterFinished
+}
+
 func (c AgentConfigSpecAdapter) ToPorterDocument() ([]byte, error) {
 	raw := struct {
 		SchemaType    string            `yaml:"schemaType"`
@@ -350,16 +356,6 @@ func (c AgentConfigSpecAdapter) ToPorterDocument() ([]byte, error) {
 	return yaml.Marshal(raw)
 }
 
-// GetTTLSecondsAfterFinished returns the config value of
-// TTLSecondsAfterFinished defaults to 600
-func (c AgentConfigSpecAdapter) GetTTLSecondsAfterFinished() *int32 {
-	if c.original.TTLSecondsAfterFinished == nil {
-		defaultTTLSeconds := int32(600)
-		c.original.TTLSecondsAfterFinished = &defaultTTLSeconds
-	}
-	return c.original.TTLSecondsAfterFinished
-}
-
 // PluginConfigList is the list implementation of the Plugins map.
 // The list is sorted based on the plugin names alphabetically.
 type PluginsConfigList struct {

api/v1/agentconfig_types_test.go

@@ -370,6 +370,28 @@ func TestAgentConfigSpecAdapter_GetRetryLimit(t *testing.T) {
 	}
 }
 
+func TestAgentConfigSpecAdapter_GetTTLSecondsAfterFinished(t *testing.T) {
+	// var testdataDefault int32 = 600
+	var testdatauserSubmitted int32 = 700
+	testCases := []struct {
+		name                    string
+		TTLSecondsAfterFinished *int32
+		expected                *int32
+	}{
+		// {name: "default", TTLSecondsAfterFinished: nil, expected: &testdataDefault},
+		{name: "user submitted", TTLSecondsAfterFinished: &testdatauserSubmitted, expected: &testdatauserSubmitted},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			adapter := NewAgentConfigSpecAdapter(AgentConfigSpec{
+				TTLSecondsAfterFinished: tc.TTLSecondsAfterFinished,
+			})
+			result := adapter.GetTTLSecondsAfterFinished()
+			require.Equal(t, tc.expected, result)
+		})
+	}
+}
+
 func TestHashString(t *testing.T) {
 	str := hashString("fake-string")
 	assert.Equal(t, "ab19e45285992b247dd281213f803479", str)

config/crd/bases/getporter.org_agentconfigs.yaml

@@ -103,6 +103,12 @@ spec:
                   Porter will request when running the Porter Agent. It is used to
                   determine what the storage class will be for the volume requested
                 type: string
+              ttlSecondsAfterFinished:
+                default: 600
+                description: TTLSecondsAfterFinished set the time limit of the lifetime
+                  of a Job that has finished execution.
+                format: int32
+                type: integer
               volumeSize:
                 description: VolumeSize is the size of the persistent volume that
                   Porter will request when running the Porter Agent. It is used to

controllers/agentaction_controller_test.go

@@ -405,13 +405,15 @@ func TestAgentActionReconciler_createAgentVolume(t *testing.T) {
 			}
 			spec := porterv1.NewAgentConfigSpecAdapter(agentCfg)
 			pvc, err := controller.createAgentVolume(context.Background(), logr.Discard(), action, spec)
+
 			require.NoError(t, err)
 
 			// Verify the pvc properties
 			if test.created {
 				assert.Equal(t, "porter-hello-", pvc.GenerateName, "incorrect pvc name")
 				assert.Equal(t, []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce}, pvc.Spec.AccessModes, "incorrect pvc access modes")
 				assert.Equal(t, pvc.Spec.Resources.Requests[corev1.ResourceStorage], resource.MustParse("128Mi"))
+				assert.Equal(t, pvc.OwnerReferences[0].Name, action.Name)
 			} else {
 				assert.Equal(t, "existing-", pvc.GenerateName, "incorrect pvc name")
 				assert.Equal(t, []corev1.PersistentVolumeAccessMode{corev1.ReadWriteMany}, pvc.Spec.AccessModes, "incorrect pvc access modes")