Merge pull request #489 from jenkins-x-plugins/gc_drafts

feat: support destroying previews for draft PRs as well

charts/jx-preview/templates/gc-jobs-cj.yaml

@@ -26,7 +26,7 @@ spec:
             - command:
               - /bin/sh
               - -c
-              - jx gitops git setup --namespace {{ .Release.Namespace }} --secret tekton-git --git-provider {{ .Values.jxRequirements.cluster.gitServer | default "https://gitlab.com" }} && jx preview gc
+              - jx gitops git setup --namespace {{ .Release.Namespace }} --secret tekton-git --git-provider {{ .Values.jxRequirements.cluster.gitServer | default "https://gitlab.com" }} && jx preview gc {{ .Values.gcJobs.extraArgs }}
               env:
               - name: XDG_CONFIG_HOME
                 value: /home

charts/jx-preview/values.yaml

@@ -23,6 +23,9 @@ gcJobs:
   # gcJobs.concurrencyPolicy -- Drives the job's concurrency policy
   concurrencyPolicy: Forbid
 
+  # Extra arguments to the jx preview gc command
+  extraArgs: ""
+
 
 jxRequirements:
   cluster:

pkg/cmd/gc/gc.go

@@ -3,7 +3,6 @@ package gc
 import (
 	"context"
 	"fmt"
-	"strings"
 
 	"github.com/jenkins-x-plugins/jx-preview/pkg/cmd/destroy"
 	"github.com/jenkins-x-plugins/jx-preview/pkg/previews"
@@ -24,7 +23,8 @@ import (
 type Options struct {
 	destroy.Options
 
-	Deleted []string
+	Deleted       []string
+	DestroyDrafts bool
 }
 
 var (
@@ -42,7 +42,6 @@ var (
 `)
 )
 
-// NewCmd s a command object for the "step" command
 func NewCmdGCPreviews() (*cobra.Command, *Options) {
 	options := &Options{}
 
@@ -56,6 +55,8 @@ func NewCmdGCPreviews() (*cobra.Command, *Options) {
 			helper.CheckErr(err)
 		},
 	}
+	cmd.Flags().BoolVarP(&options.DestroyDrafts, "gc-drafts", "", false, "Also garbage collect drafts")
+
 	return cmd, options
 }
 
@@ -125,10 +126,7 @@ func (o *Options) Run() error {
 			return errors.Wrapf(err, "failed to query PullRequest %s", prLink)
 		}
 
-		lowerState := strings.ToLower(pullRequest.State)
-
-		if strings.HasPrefix(lowerState, "clos") || strings.HasPrefix(lowerState, "merged") || strings.HasPrefix(lowerState, "superseded") || strings.HasPrefix(lowerState, "declined") {
-
+		if pullRequest.Closed || pullRequest.Merged || (o.DestroyDrafts && pullRequest.Draft && !scmhelpers.ContainsLabel(pullRequest.Labels, "ok-to-test")) {
 			err = o.Destroy(name)
 			if err != nil {
 				return fmt.Errorf("failed to destroy preview environment %s: %v", name, err)
@@ -138,7 +136,7 @@ func (o *Options) Run() error {
 		}
 	}
 	if len(o.Deleted) == 0 {
-		log.Logger().Debug("no preview environments found")
+		log.Logger().Debug("no preview environments to garbage collect where found")
 		return nil
 	}
 	return nil

pkg/cmd/gc/gc_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/jenkins-x-plugins/jx-preview/pkg/client/clientset/versioned/fake"
 	"github.com/jenkins-x-plugins/jx-preview/pkg/cmd/gc"
 	"github.com/jenkins-x-plugins/jx-preview/pkg/previews/fakepreviews"
+	"github.com/jenkins-x/go-scm/scm"
 	fakescm "github.com/jenkins-x/go-scm/scm/driver/fake"
 	jxfake "github.com/jenkins-x/jx-api/v4/pkg/client/clientset/versioned/fake"
 	"github.com/jenkins-x/jx-helpers/v3/pkg/cmdrunner/fakerunner"
@@ -26,10 +27,11 @@ func TestPreviewGC(t *testing.T) {
 	preview1, pr1 := fakepreviews.CreateTestPreviewAndPullRequest(fakeScmData, ns, "myower", "myrepo", 2)
 	preview2, _ := fakepreviews.CreateTestPreviewAndPullRequest(fakeScmData, ns, "myower", "myrepo", 3)
 	preview3, pr3 := fakepreviews.CreateTestPreviewAndPullRequest(fakeScmData, ns, "myower", "another", 1)
+	preview4, pr4 := fakepreviews.CreateTestPreviewAndPullRequest(fakeScmData, ns, "myower", "athird", 4)
 
 	fakeScmData.CurrentUser.Login = gitUser
 
-	previewClient := fake.NewSimpleClientset(preview1, preview2, preview3)
+	previewClient := fake.NewSimpleClientset(preview1, preview2, preview3, preview4)
 	kubeClient := fakekube.NewSimpleClientset()
 
 	devEnv := jxenv.CreateDefaultDevEnvironment(ns)
@@ -41,17 +43,16 @@ func TestPreviewGC(t *testing.T) {
 	testCases := []struct {
 		name            string
 		expectedDeleted []string
-		initialise      func() error
+		initialise      func(o *gc.Options) error
 	}{
 		{
 			name: "startup",
 		},
 		{
 			name:            "gc1",
 			expectedDeleted: []string{preview1.Name},
-			initialise: func() error {
-				pr1.State = "Closed"
-				t.Logf("modified state of PR %s to: %s", pr1.Link, pr1.State)
+			initialise: func(o *gc.Options) error {
+				pr1.Closed = true
 				return nil
 			},
 		},
@@ -61,9 +62,32 @@ func TestPreviewGC(t *testing.T) {
 		{
 			name:            "gc3",
 			expectedDeleted: []string{preview3.Name},
-			initialise: func() error {
-				pr3.State = "Merged"
-				t.Logf("modified state of PR %s to: %s", pr3.Link, pr3.State)
+			initialise: func(o *gc.Options) error {
+				pr3.Merged = true
+				return nil
+			},
+		},
+		{
+			name: "gc4",
+			initialise: func(o *gc.Options) error {
+				pr4.Draft = true
+				return nil
+			},
+		},
+		{
+			name: "gc5",
+			initialise: func(o *gc.Options) error {
+				o.DestroyDrafts = true
+				pr4.Labels = []*scm.Label{{Name: "ok-to-test"}}
+				return nil
+			},
+		},
+		{
+			name:            "gc6",
+			expectedDeleted: []string{preview4.Name},
+			initialise: func(o *gc.Options) error {
+				o.DestroyDrafts = true
+				pr4.Labels = nil
 				return nil
 			},
 		},
@@ -83,7 +107,7 @@ func TestPreviewGC(t *testing.T) {
 		o.CommandRunner = runner.Run
 
 		if tc.initialise != nil {
-			err := tc.initialise()
+			err := tc.initialise(o)
 			require.NoError(t, err, "failed to initialise test  %s", tc.name)
 		}
 		t.Logf("running GC for test: %s\n", tc.name)