Refactor Trigger Actions and Add Ability To Kick Off Runs With Specified Terraform Version

.env.example

@@ -0,0 +1,13 @@
+## TFBuddy Settings
+#TFBUDDY_LOG_LEVEL=INFO
+TFBUDDY_HOOK_SECRET=asdf
+
+## Terraform Cloud Settings
+TFC_ORGANIZATION=*SOME_ORG_HERE*
+TFC_TOKEN=*YOUR_TFC_TOKEN_HERE*
+
+## GITLAB Settings
+GITLAB_TOKEN=*YOUR_GITLAB_TOKEN_HERE*
+
+## GITHUB Settings
+GITHUB_TOKEN=*YOUR_GITHUB_TOKEN_HERE*

.tool-versions

@@ -1,3 +1,4 @@
 # asdf plugin add earthly https://github.com/YR-ZR0/asdf-earthly
 earthly 0.6.30
 golang 1.19.3
+kustomize 4.5.7

Makefile

@@ -13,11 +13,14 @@ docker:
 	docker build -t tfbuddy:dev -f Dockerfile.server ./
 
 minikube-up:
-	minikube start --driver=hyperkit
+	minikube start --driver=docker
 	minikube addons enable ingress
 	minikube addons enable registry
 	echo "Remember to run minikube tunnel on mac before running localdev"
 
+tunnel:
+	minikube tunnel
+
 setup-localdev:
 	tilt up
 

README.md

@@ -27,6 +27,10 @@ TFBuddy consists of the webhook handler and a NATS cluster.
 
 See [Installation Docs](https://tfbuddy.readthedocs.io/en/stable/usage/)
 
+## Contributing
+
+The [contributing](https://tfbuddy.readthedocs.io/en/stable/contributing/) has everything you need to start working on TFBuddy.
+
 
 ## Documentation
 

Tiltfile

@@ -251,7 +251,7 @@ cfgInputs = {
   'TFBUDDY_LOG_LEVEL': 'debug',
   'TFBUDDY_DEFAULT_TFC_ORGANIZATION' : os.getenv('TFC_ORGANIZATION'),
   'TFBUDDY_WORKSPACE_ALLOW_LIST' : tfcOutputs.setdefault('tfc_workspace', '') if tfcOutputs else '',
-  'GITLAB_TOKEN_USER' : os.getenv('GITLAB_TOKEN_USER'),
+  'GITLAB_TOKEN' : os.getenv('GITLAB_TOKEN'),
 }
 if cfg.get('enable_gitlab') and gitlabOutputs:
   cfgInputs.update({'TFBUDDY_PROJECT_ALLOW_LIST': gitlabOutputs.setdefault('gitlab_project_name', '')})

docs/usage.md

@@ -34,12 +34,10 @@ helm install tfbuddy charts/tfbuddy \
 ```console
 export TFC_TOKEN="" \
        GITLAB_TOKEN="" \
-       GITLAB_TOKEN_USER=""
 
 helm install tfbuddy charts/tfbuddy \
   --set secrets.env.TFC_TOKEN="${TFC_TOKEN}" \
   --set secrets.env.GITLAB_TOKEN="${GITLAB_TOKEN}" \
-  --set secrets.env.GITLAB_TOKEN_USER="${GITLAB_TOKEN_USER}" \
   --dependency-update
 ```
 

pkg/comment_actions/parsing.go

@@ -7,17 +7,20 @@ import (
 
 	"github.com/jessevdk/go-flags"
 	"github.com/rs/zerolog/log"
+	"github.com/zapier/tfbuddy/pkg/tfc_trigger"
 	"github.com/zapier/tfbuddy/pkg/utils"
 )
 
 var (
 	ErrNotTFCCommand = errors.New("not a TFC command")
-	ErrOtherTFTool   = errors.New("Use 'tfc' to interact with tfbuddy.")
+	ErrOtherTFTool   = errors.New("use 'tfc' to interact with tfbuddy")
+	ErrNoNotePassed  = errors.New("no notes passed in note block")
+	ErrInvalidAction = errors.New("invalid tfc action")
 )
 
 type CommentOpts struct {
-	Args      CommentArgs `positional-args:"yes" required:"yes"`
-	Workspace string      `short:"w" long:"workspace" description:"A specific terraform Workspace to use" required:"false"`
+	TriggerOpts *tfc_trigger.TFCTriggerOptions
+	Args        CommentArgs `positional-args:"yes" required:"yes"`
 }
 
 type CommentArgs struct {
@@ -28,14 +31,20 @@ type CommentArgs struct {
 
 func ParseCommentCommand(noteBody string) (*CommentOpts, error) {
 	comment := strings.TrimSpace(strings.ToLower(noteBody))
-
 	words := strings.Fields(comment)
-	if len(words) < 2 || len(words) > 4 {
+
+	if len(words) == 0 {
+		return nil, ErrNoNotePassed
+	}
+
+	if len(words)%2 != 0 {
 		log.Debug().Str("comment", comment[0:10]).Msg("not a tfc command")
 		return nil, ErrNotTFCCommand
 	}
 
-	opts := &CommentOpts{}
+	opts := &CommentOpts{
+		TriggerOpts: &tfc_trigger.TFCTriggerOptions{},
+	}
 	_, err := flags.ParseArgs(opts, words)
 	if err != nil {
 		log.Error().Err(err).Msg("error parsing comment as command")
@@ -50,5 +59,10 @@ func ParseCommentCommand(noteBody string) (*CommentOpts, error) {
 		return nil, ErrNotTFCCommand
 	}
 
+	opts.TriggerOpts.Action = tfc_trigger.CheckTriggerAction(opts.Args.Command)
+	if opts.TriggerOpts.Action == tfc_trigger.InvalidAction {
+		return nil, ErrInvalidAction
+	}
+
 	return opts, nil
 }

pkg/comment_actions/parsing_test.go

@@ -0,0 +1,72 @@
+package comment_actions
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/zapier/tfbuddy/pkg/tfc_trigger"
+)
+
+func TestParseCommentCommand(t *testing.T) {
+	tcs := []struct {
+		noteBody     string
+		expectedOpts *CommentOpts
+		e            error
+		testName     string
+	}{
+		{"", nil, ErrNoNotePassed, "empty test"},
+		{"tfc apply", &CommentOpts{
+			TriggerOpts: &tfc_trigger.TFCTriggerOptions{
+				Action: tfc_trigger.ApplyAction,
+			},
+			Args: CommentArgs{
+				Agent:   "tfc",
+				Command: "apply",
+			},
+		}, nil, "simple plan"},
+		{"tfc plan -w fake_space", &CommentOpts{
+			TriggerOpts: &tfc_trigger.TFCTriggerOptions{
+				Workspace: "fake_space",
+				Action:    tfc_trigger.PlanAction,
+			},
+			Args: CommentArgs{
+				Agent:   "tfc",
+				Command: "plan",
+			},
+		}, nil, "simple plan with workspace"},
+		{"tfc apply -w fake_space -v 1.1.7", &CommentOpts{
+			TriggerOpts: &tfc_trigger.TFCTriggerOptions{
+				Workspace: "fake_space",
+				TFVersion: "1.1.7",
+				Action:    tfc_trigger.ApplyAction,
+			},
+			Args: CommentArgs{
+				Agent:   "tfc",
+				Command: "apply",
+			},
+		}, nil, "simple plan with workspace and version"},
+		{"tfc plan -v 1.1.8", &CommentOpts{
+			TriggerOpts: &tfc_trigger.TFCTriggerOptions{
+				TFVersion: "1.1.8",
+				Action:    tfc_trigger.PlanAction,
+			},
+			Args: CommentArgs{
+				Agent:   "tfc",
+				Command: "plan",
+			},
+		}, nil, "simple plan with version"},
+		{"tfc plan -w -v 1.1.8",
+			nil,
+			ErrNotTFCCommand,
+			"not a valid command",
+		},
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.testName, func(t *testing.T) {
+			opts, err := ParseCommentCommand(tc.noteBody)
+			assert.Equal(t, tc.expectedOpts, opts, tc.testName)
+			assert.ErrorIs(t, err, tc.e, tc.testName)
+		})
+	}
+}

pkg/github/hooks/github_hooks_handler.go

@@ -21,7 +21,7 @@ type TriggerCreationFunc func(
 	vcs vcs.GitClient,
 	tfc tfc_api.ApiClient,
 	runstream runstream.StreamClient,
-	cfg tfc_trigger.TriggerConfig,
+	cfg *tfc_trigger.TFCTriggerOptions,
 ) tfc_trigger.Trigger
 
 type GithubHooksHandler struct {

pkg/github/hooks/stream_worker.go

@@ -64,15 +64,20 @@ func (h *GithubHooksHandler) processIssueComment(msg *GithubIssueCommentEventMsg
 	}
 	pullReq := pr.(*github.GithubPR)
 
-	trigger := h.triggerCreation(h.vcs, h.tfc, h.runstream,
-		&tfc_trigger.TFCTriggerConfig{
-			Branch:                   pr.GetSourceBranch(),
-			CommitSHA:                pullReq.GetBase().GetSHA(),
-			ProjectNameWithNamespace: event.GetRepo().GetFullName(),
-			MergeRequestIID:          *event.Issue.Number,
-			TriggerSource:            tfc_trigger.CommentTrigger,
-			VcsProvider:              "github",
-		})
+	opts.TriggerOpts.Branch = pr.GetSourceBranch()
+	opts.TriggerOpts.CommitSHA = pullReq.GetBase().GetSHA()
+	opts.TriggerOpts.ProjectNameWithNamespace = event.GetRepo().GetFullName()
+	opts.TriggerOpts.MergeRequestIID = *event.Issue.Number
+	opts.TriggerOpts.TriggerSource = tfc_trigger.CommentTrigger
+	opts.TriggerOpts.VcsProvider = "github"
+
+	cfg, err := tfc_trigger.NewTFCTriggerConfig(opts.TriggerOpts)
+	if err != nil {
+		log.Error().Err(err).Msg("could not create TFCTriggerConfig")
+		return err
+	}
+
+	trigger := h.triggerCreation(h.vcs, h.tfc, h.runstream, cfg)
 
 	//// TODO: support additional commands and arguments (e.g. destroy, refresh, lock, unlock)
 	//// TODO: this should be refactored and be agnostic to the VCS type
@@ -88,24 +93,12 @@ func (h *GithubHooksHandler) processIssueComment(msg *GithubIssueCommentEventMsg
 			h.postPullRequestComment(event, ":no_entry: Apply failed. Pull Request has conflicts that need to be resolved.")
 			return nil
 		}
-		trigger.GetConfig().SetAction(tfc_trigger.ApplyAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	case "lock":
 		log.Info().Msg("Got TFC lock command")
-		trigger.GetConfig().SetAction(tfc_trigger.LockAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	case "plan":
 		log.Info().Msg("Got TFC plan command")
-		trigger.GetConfig().SetAction(tfc_trigger.PlanAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	case "unlock":
 		log.Info().Msg("Got TFC unlock command")
-		trigger.GetConfig().SetAction(tfc_trigger.UnlockAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	default:
 		return fmt.Errorf("could not parse command")
 	}

pkg/gitlab/client.go

@@ -40,6 +40,7 @@ func NewGitlabClient() *GitlabClient {
 			return nil
 		}
 	}
+	//TODO: I believe this is legacy and can be removed?
 	tokenUser := os.Getenv("GITLAB_TOKEN_USER")
 	if token == "" {
 		if token == "" {

pkg/gitlab_hooks/comment_actions.go

@@ -33,18 +33,23 @@ func (w *GitlabEventWorker) processNoteEvent(event vcs.MRCommentEvent) (projectN
 		return proj, err
 	}
 
-	trigger := w.triggerCreation(w.gl, w.tfc, w.runstream,
-		&tfc_trigger.TFCTriggerConfig{
-			Branch:                   event.GetMR().GetSourceBranch(),
-			CommitSHA:                event.GetLastCommit().GetSHA(),
-			ProjectNameWithNamespace: proj,
-			MergeRequestIID:          event.GetMR().GetInternalID(),
-			TriggerSource:            tfc_trigger.CommentTrigger,
-			VcsProvider:              "gitlab",
-		})
+	opts.TriggerOpts.Branch = event.GetMR().GetSourceBranch()
+	opts.TriggerOpts.CommitSHA = event.GetLastCommit().GetSHA()
+	opts.TriggerOpts.ProjectNameWithNamespace = proj
+	opts.TriggerOpts.MergeRequestIID = event.GetMR().GetInternalID()
+	opts.TriggerOpts.TriggerSource = tfc_trigger.CommentTrigger
+	opts.TriggerOpts.VcsProvider = "gitlab"
+
+	cfg, err := tfc_trigger.NewTFCTriggerConfig(opts.TriggerOpts)
+	if err != nil {
+		log.Error().Err(err).Msg("could not create TFCTriggerConfig")
+		return proj, err
+	}
+
+	trigger := w.triggerCreation(w.gl, w.tfc, w.runstream, cfg)
 
 	if event.GetAttributes().GetType() == string(gitlab.DiscussionNote) {
-		trigger.GetConfig().SetMergeRequestDiscussionID(event.GetAttributes().GetDiscussionID())
+		trigger.SetMergeRequestDiscussionID(event.GetAttributes().GetDiscussionID())
 	}
 
 	// TODO: support additional commands and arguments (e.g. destroy, refresh, lock, unlock)
@@ -60,24 +65,12 @@ func (w *GitlabEventWorker) processNoteEvent(event vcs.MRCommentEvent) (projectN
 			w.postMessageToMergeRequest(event, ":no_entry: Apply failed. Merge Request has conflicts that need to be resolved.")
 			return proj, nil
 		}
-		trigger.GetConfig().SetAction(tfc_trigger.ApplyAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	case "lock":
 		log.Info().Msg("Got TFC lock command")
-		trigger.GetConfig().SetAction(tfc_trigger.LockAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	case "plan":
 		log.Info().Msg("Got TFC plan command")
-		trigger.GetConfig().SetAction(tfc_trigger.PlanAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	case "unlock":
 		log.Info().Msg("Got TFC unlock command")
-		trigger.GetConfig().SetAction(tfc_trigger.UnlockAction)
-		trigger.GetConfig().SetWorkspace(opts.Workspace)
-
 	default:
 		return proj, nil
 	}