initial commit

Author: trstringer

Diff for: Dockerfile

@@ -0,0 +1,9 @@
+FROM golang:1.17 AS builder
+COPY . /var/app
+WORKDIR /var/app
+RUN CGO_ENABLED=0 go build -o app .
+
+FROM alpine:3.14
+RUN apk update && apk add ca-certificates
+COPY --from=builder /var/app/app /var/app/app
+CMD ["/var/app/app"]

Diff for: README.md

@@ -0,0 +1,12 @@
+name: Manual Workflow Approval
+description: Pause a workflow and get user approval to continue
+inputs:
+  approvers:
+    description: Required approvers
+    required: true
+  secret:
+    description: Secret
+    required: true
+runs:
+  using: docker
+  image: docker://ghcr.io/trstringer/manual-approval:1.0.0

Diff for: action.yaml

@@ -0,0 +1,96 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/google/go-github/v43/github"
+)
+
+type approvalEnvironment struct {
+	client              *github.Client
+	repoFullName        string
+	repo                string
+	repoOwner           string
+	runID               int
+	approvers           []string
+	approvalIssue       *github.Issue
+	approvalIssueNumber int
+}
+
+func newApprovalEnvironment(client *github.Client, repoFullName, repoOwner string, runID int, approvers []string) (*approvalEnvironment, error) {
+	repoOwnerAndName := strings.Split(repoFullName, "/")
+	if len(repoOwnerAndName) != 2 {
+		return nil, fmt.Errorf("repo owner and name in unexpected format: %s", repoFullName)
+	}
+	repo := repoOwnerAndName[1]
+
+	return &approvalEnvironment{
+		client:       client,
+		repoFullName: repoFullName,
+		repo:         repo,
+		repoOwner:    repoOwner,
+		runID:        runID,
+		approvers:    approvers,
+	}, nil
+}
+
+func (a approvalEnvironment) runURL() string {
+	return fmt.Sprintf("https://github.com/%s/actions/runs/%d", a.repoFullName, a.runID)
+}
+
+func (a *approvalEnvironment) createApprovalIssue(ctx context.Context) error {
+	issueTitle := fmt.Sprintf("Manual approval required for workflow run %d", a.runID)
+	issueBody := fmt.Sprintf(`Workflow is pending manual review.
+URL: %s
+
+Required approvers: %s
+
+Respond '%s' to continue workflow or '%s' to cancel.
+	`, a.runURL(), a.approvers, approvalStatusApproved, approvalStatusDenied)
+	var err error
+	a.approvalIssue, _, err = a.client.Issues.Create(ctx, a.repoOwner, a.repo, &github.IssueRequest{
+		Title:     &issueTitle,
+		Body:      &issueBody,
+		Assignees: &a.approvers,
+	})
+	a.approvalIssueNumber = a.approvalIssue.GetNumber()
+	return err
+}
+
+func approvalFromComments(comments []*github.IssueComment, approvers []string) approvalStatus {
+	remainingApprovers := make([]string, len(approvers))
+	copy(remainingApprovers, approvers)
+
+	for _, comment := range comments {
+		commentUser := comment.User.GetLogin()
+		approverIdx := approversIndex(remainingApprovers, commentUser)
+		if approverIdx < 0 {
+			continue
+		}
+
+		commentBody := comment.GetBody()
+		if commentBody == string(approvalStatusApproved) {
+			if len(remainingApprovers) == 1 {
+				return approvalStatusApproved
+			}
+			remainingApprovers[approverIdx] = remainingApprovers[len(remainingApprovers)-1]
+			remainingApprovers = remainingApprovers[:len(remainingApprovers)-1]
+			continue
+		} else if commentBody == string(approvalStatusDenied) {
+			return approvalStatusDenied
+		}
+	}
+
+	return approvalStatusPending
+}
+
+func approversIndex(approvers []string, name string) int {
+	for idx, approver := range approvers {
+		if approver == name {
+			return idx
+		}
+	}
+	return -1
+}

Diff for: approval.go

@@ -0,0 +1,125 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/google/go-github/v43/github"
+)
+
+func TestApprovalFromComments(t *testing.T) {
+	login1 := "login1"
+	login2 := "login2"
+	bodyApproved := "Approved"
+	bodyDenied := "Denied"
+	bodyPending := "not approval or denial"
+
+	testCases := []struct {
+		name           string
+		comments       []*github.IssueComment
+		approvers      []string
+		expectedStatus approvalStatus
+	}{
+		{
+			name: "single_approver_single_comment_approved",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyApproved,
+				},
+			},
+			approvers:      []string{login1},
+			expectedStatus: approvalStatusApproved,
+		},
+		{
+			name: "single_approver_single_comment_denied",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyDenied,
+				},
+			},
+			approvers:      []string{login1},
+			expectedStatus: approvalStatusDenied,
+		},
+		{
+			name: "single_approver_single_comment_pending",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyPending,
+				},
+			},
+			approvers:      []string{login1},
+			expectedStatus: approvalStatusPending,
+		},
+		{
+			name: "single_approver_multi_comment_approved",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyPending,
+				},
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyApproved,
+				},
+			},
+			approvers:      []string{login1},
+			expectedStatus: approvalStatusApproved,
+		},
+		{
+			name: "multi_approver_approved",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyApproved,
+				},
+				{
+					User: &github.User{Login: &login2},
+					Body: &bodyApproved,
+				},
+			},
+			approvers:      []string{login1, login2},
+			expectedStatus: approvalStatusApproved,
+		},
+		{
+			name: "multi_approver_mixed",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyPending,
+				},
+				{
+					User: &github.User{Login: &login2},
+					Body: &bodyApproved,
+				},
+			},
+			approvers:      []string{login1, login2},
+			expectedStatus: approvalStatusPending,
+		},
+		{
+			name: "multi_approver_denied",
+			comments: []*github.IssueComment{
+				{
+					User: &github.User{Login: &login1},
+					Body: &bodyDenied,
+				},
+				{
+					User: &github.User{Login: &login2},
+					Body: &bodyApproved,
+				},
+			},
+			approvers:      []string{login1, login2},
+			expectedStatus: approvalStatusDenied,
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			actual := approvalFromComments(testCase.comments, testCase.approvers)
+			if actual != testCase.expectedStatus {
+				t.Fatalf("actual %s, expected %s", actual, testCase.expectedStatus)
+			}
+		})
+	}
+}

Diff for: approval_test.go

@@ -0,0 +1,9 @@
+package main
+
+type approvalStatus string
+
+const (
+	approvalStatusPending  approvalStatus = "Pending"
+	approvalStatusApproved approvalStatus = "Approved"
+	approvalStatusDenied   approvalStatus = "Denied"
+)

Diff for: approvalstatus.go

@@ -0,0 +1,13 @@
+package main
+
+import "time"
+
+const (
+	pollingInterval time.Duration = 10 * time.Second
+
+	envVarRepoFullName string = "GITHUB_REPOSITORY"
+	envVarRunID        string = "GITHUB_RUN_ID"
+	envVarRepoOwner    string = "GITHUB_REPOSITORY_OWNER"
+	envVarToken        string = "INPUT_SECRET"
+	envVarApprovers    string = "INPUT_APPROVERS"
+)

Diff for: constants.go

@@ -0,0 +1,17 @@
+module github.com/trstringer/manual-approval
+
+go 1.17
+
+require (
+	github.com/google/go-github/v43 v43.0.0
+	golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a
+)
+
+require (
+	github.com/golang/protobuf v1.4.2 // indirect
+	github.com/google/go-querystring v1.1.0 // indirect
+	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
+	golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/protobuf v1.25.0 // indirect
+)