fix: Init gh actions logic

Author: coolapso

cmd/utils.go

@@ -13,27 +13,27 @@ import (
 
 // This function could use a better name
 func initGHSettings() (err error) {
-	token, err = getGHToken()
-	if err != nil {
-		return err
+	if repository == "" {
+		repository, err = getRepository()
+		if err != nil {
+			return err
+		}
 	}
 
-	if prNumber == 0 {
-		if !githubAction() {
-			return errMissingPRNum
-		}
+	if !githubAction() && prNumber == 0 { 
+		return errMissingPRNum
+	}
 
+	if pullRequest() {
 		prNumber, err = getPRNumber()
 		if err != nil {
 			return fmt.Errorf("failed to get pull request number from github context GITHUB_REF_NAME, %v", err)
 		}
 	}
 
-	if repository == "" {
-		repository, err = getRepository()
-		if err != nil {
-			return err
-		}
+	token, err = getGHToken()
+	if err != nil {
+		return err
 	}
 
 	return nil
@@ -74,7 +74,7 @@ func githubAction() bool {
 }
 
 func pullRequest() bool {
-	if v := os.Getenv("GITHUB_EVENT_TYPE"); v == "pull_request" {
+	if v := os.Getenv("GITHUB_EVENT_NAME"); v == "pull_request" {
 		return true
 	}
 

cmd/utils_test.go

@@ -6,6 +6,90 @@ import (
 	"testing"
 )
 
+func TestInitGitHubSettings(t *testing.T) {
+	t.Run("github action pull request", func(t *testing.T) {
+		// Set this vars if running locally, othersie just use the ones from the workflow
+		if _, ok := os.LookupEnv("GITHUB_ACTIONS"); !ok {
+			_ = os.Setenv("GITHUB_ACTIONS", "true")
+			defer os.Unsetenv("GITHUB_ACTIONS")
+			_ = os.Setenv("GITHUB_TOKEN", "foo")
+			defer os.Unsetenv("GITHUB_TOKEN")
+			_ = os.Setenv("GITHUB_REPOSITORY", "coolapso/convcommitlint")
+			defer os.Unsetenv("GITHUB_REPOSITORY")
+			defer func(){ repository = "" }()
+			_ = os.Setenv("GITHUB_REF_NAME", "25/merge")
+			defer os.Unsetenv("GITHUB_REF_NAME")
+		}
+
+		var tempType string
+		if v, ok := os.LookupEnv("GITHUB_EVENT_NAME"); ok {
+			if v != "pull_request" {
+				tempType = v
+				os.Setenv("GITHUB_EVENT_NAME", "pull_request")
+				defer os.Setenv("GITHUB_EVENT_NAME", tempType)
+			}
+		} else {
+			_ = os.Setenv("GITHUB_EVENT_NAME", "pull_request")
+			defer os.Unsetenv("GITHUB_EVENT_NAME")
+		}
+
+		got := initGHSettings()
+		if got != nil {
+			t.Fatal("Expected nil, got:", got)
+		}
+	})
+
+	t.Run("github action push", func(t *testing.T) {
+		if _, ok := os.LookupEnv("GITHUB_ACTIONS"); !ok {
+			_ = os.Setenv("GITHUB_ACTIONS", "true")
+			defer os.Unsetenv("GITHUB_ACTIONS")
+			_ = os.Setenv("GITHUB_TOKEN", "foo")
+			defer os.Unsetenv("GITHUB_REPOSITORY")
+			_ = os.Setenv("GITHUB_REPOSITORY", "coolapso/convcommitlint")
+			defer os.Unsetenv("GITHUB_TOKEN")
+			defer func(){ repository = ""}()
+		}
+
+		var eventTemp string
+		if v, ok := os.LookupEnv("GITHUB_EVENT_NAME"); ok {
+			eventTemp = v
+			os.Setenv("GITHUB_EVENT_NAME", "push")
+			defer os.Setenv("GITHUB_EVENT_NAME", eventTemp)
+		} else { 
+			os.Setenv("GITHUB_EVENT_NAME", "push")
+			defer os.Setenv("GITHUB_EVENT_NAME", eventTemp)
+		}
+
+		got := initGHSettings()
+		if got != nil {
+			t.Fatal("Expected nil, got:", got)
+		}
+	})
+
+	t.Run("missing github repository", func(t *testing.T) {
+		got := initGHSettings()
+		if got != errMissingRepository {
+			t.Fatalf("Expected [ %v ] error, got [ %v ]", errMissingRepository, got)
+		}
+	})
+
+
+	t.Run("Run locally", func(t *testing.T) {
+		if _, ok := os.LookupEnv("GITHUB_ACTIONS"); !ok {
+			_ = os.Setenv("GITHUB_TOKEN", "foo")
+			defer os.Unsetenv("GITHUB_TOKEN")
+			_ = os.Setenv("GITHUB_REPOSITORY", "coolapso/convcommitlint")
+			defer os.Unsetenv("GITHUB_REPOSITORY")
+			func(){ repository = "" }()
+		}
+		prNumber = 25
+		got := initGHSettings()
+		if got != nil {
+			t.Fatal("Expected nil, got:", got)
+		}
+	})
+}
+
 func TestGetGHToken(t *testing.T) {
 	t.Run("missing token", func(t *testing.T) {
 		want := errMissingGHToken
@@ -132,7 +216,20 @@ func TestSplitOwnerRepo(t *testing.T) {
 
 func TestPullRequest(t *testing.T) {
 	t.Run("Is pull request", func(t *testing.T) {
-		_ = os.Setenv("GITHUB_EVENT_TYPE", "pull_request")
+		if _, ok := os.LookupEnv("GITHUB_ACTIONS"); !ok {
+			_ = os.Setenv("GITHUB_EVENT_NAME", "pull_request")
+			defer os.Unsetenv("GITHUB_EVENT_NAME")
+		} 
+
+		var eventTemp string
+		if _, ok := os.LookupEnv("GITHUB_ACTIONS"); ok {
+			if v := os.Getenv("GITHUB_EVENT_NAME"); v != "pull_request" {
+				eventTemp = v
+				os.Setenv("GITHUB_EVENT_NAME", "pull_request")
+				defer func(){ os.Setenv("GITHUB_EVENT_NAME", eventTemp) }()
+			}
+		} 
+
 		want := true
 		got := pullRequest()
 		if got != want {
@@ -141,7 +238,7 @@ func TestPullRequest(t *testing.T) {
 	})
 
 	t.Run("Is not pull request", func(t *testing.T) {
-		_ = os.Setenv("GITHUB_EVENT_TYPE", "push")
+		_ = os.Setenv("GITHUB_EVENT_NAME", "push")
 		want := false
 		got := pullRequest()
 		if got != want {