Refactor project layout for better go build and get ergonomics (#20)

Author: zackproser

.circleci/config.yml

@@ -43,7 +43,7 @@ jobs:
       - checkout
       - run: 
           <<: *install_gruntwork_utils
-      - run: build-go-binaries --app-name git-xargs --src-path ./cmd --dest-path bin --ld-flags "-X main.VERSION=$CIRCLE_TAG"
+      - run: build-go-binaries --app-name git-xargs --src-path ./ --dest-path bin --ld-flags "-X main.VERSION=$CIRCLE_TAG"
       - run: cd bin && sha256sum * > SHA256SUMS
       - run: upload-github-release-assets bin/* 
 workflows:

.gitignore

@@ -1,4 +1,4 @@
-git-xargs
 test-repo/
 .idea
-*.iml
+*.iml
+git-xargs

README.md

@@ -1,10 +1,11 @@
-package main
+package auth
 
 import (
 	"context"
 	"os"
 
 	"github.com/google/go-github/v32/github"
+	"github.com/gruntwork-io/git-xargs/types"
 	"github.com/gruntwork-io/go-commons/errors"
 
 	"golang.org/x/oauth2"
@@ -39,7 +40,7 @@ func NewClient(client *github.Client) GithubClient {
 }
 
 // configureGithubClient creates a Github API client using the user-supplied GITHUB_OAUTH_TOKEN and return the configured Github client
-func configureGithubClient() GithubClient {
+func ConfigureGithubClient() GithubClient {
 	// Ensure user provided a GITHUB_OAUTH_TOKEN
 	GithubOauthToken := os.Getenv("GITHUB_OAUTH_TOKEN")
 
@@ -56,9 +57,9 @@ func configureGithubClient() GithubClient {
 }
 
 // ensureGithubOauthTokenSet is a sanity check that a value is exported for GITHUB_OAUTH_TOKEN
-func ensureGithubOauthTokenSet() error {
+func EnsureGithubOauthTokenSet() error {
 	if os.Getenv("GITHUB_OAUTH_TOKEN") == "" {
-		return errors.WithStackTrace(NoGithubOauthTokenProvidedErr{})
+		return errors.WithStackTrace(types.NoGithubOauthTokenProvidedErr{})
 	}
 	return nil
 }

cmd/auth.go renamed to auth/auth.go

@@ -1,4 +1,4 @@
-package main
+package auth
 
 import (
 	"os"
@@ -11,7 +11,7 @@ import (
 func TestConfigureGithubClient(t *testing.T) {
 	t.Parallel()
 
-	client := configureGithubClient()
+	client := ConfigureGithubClient()
 	assert.NotNil(t, client)
 }
 
@@ -24,6 +24,6 @@ func TestNoGithubOAuthTokenPassed(t *testing.T) {
 
 	os.Setenv("GITHUB_OAUTH_TOKEN", "")
 
-	err := ensureGithubOauthTokenSet()
+	err := EnsureGithubOauthTokenSet()
 	assert.Error(t, err)
 }

cmd/auth_test.go renamed to auth/auth_test.go

@@ -1,57 +1,25 @@
-package main
+package cmd
 
 import (
 	"bufio"
-	"github.com/gruntwork-io/go-commons/errors"
-	"github.com/gruntwork-io/go-commons/logging"
-	"github.com/urfave/cli"
 	"io"
 	"os"
 	"strings"
-)
-
-// GitXargsConfig is the internal representation of a given git-xargs run as specified by the user
-type GitXargsConfig struct {
-	DryRun                 bool
-	SkipPullRequests       bool
-	BranchName             string
-	CommitMessage          string
-	PullRequestTitle       string
-	PullRequestDescription string
-	ReposFile              string
-	GithubOrg              string
-	RepoSlice              []string
-	RepoFromStdIn          []string
-	Args                   []string
-	GithubClient           GithubClient
-	GitClient              GitClient
-	Stats                  *RunStats
-}
 
-// NewGitXargsConfig sets reasonable defaults for a GitXargsConfig and returns a pointer to a the config
-func NewGitXargsConfig() *GitXargsConfig {
-	return &GitXargsConfig{
-		DryRun:                 false,
-		SkipPullRequests:       false,
-		BranchName:             "",
-		CommitMessage:          DefaultCommitMessage,
-		PullRequestTitle:       DefaultPullRequestTitle,
-		PullRequestDescription: DefaultPullRequestDescription,
-		ReposFile:              "",
-		GithubOrg:              "",
-		RepoSlice:              []string{},
-		RepoFromStdIn:          []string{},
-		Args:                   []string{},
-		GithubClient:           configureGithubClient(),
-		GitClient:              NewGitClient(GitProductionProvider{}),
-		Stats:                  NewStatsTracker(),
-	}
-}
+	"github.com/gruntwork-io/git-xargs/auth"
+	"github.com/gruntwork-io/git-xargs/config"
+	gitxargs_io "github.com/gruntwork-io/git-xargs/io"
+	"github.com/gruntwork-io/git-xargs/repository"
+	"github.com/gruntwork-io/git-xargs/types"
+	"github.com/gruntwork-io/go-commons/errors"
+	"github.com/gruntwork-io/go-commons/logging"
+	"github.com/urfave/cli"
+)
 
 // parseGitXargsConfig accepts a urfave cli context and binds its values
 // to an internal representation of the data supplied by the user
-func parseGitXargsConfig(c *cli.Context) (*GitXargsConfig, error) {
-	config := NewGitXargsConfig()
+func parseGitXargsConfig(c *cli.Context) (*config.GitXargsConfig, error) {
+	config := config.NewGitXargsConfig()
 	config.DryRun = c.Bool("dry-run")
 	config.SkipPullRequests = c.Bool("skip-pull-requests")
 	config.BranchName = c.String("branch-name")
@@ -117,14 +85,14 @@ func parseSliceFromReader(reader io.Reader) ([]string, error) {
 
 // handleRepoProcessing encapsulates the main processing logic for the supplied repos and printing the run report that
 // is built up throughout the processing
-func handleRepoProcessing(config *GitXargsConfig) error {
+func handleRepoProcessing(config *config.GitXargsConfig) error {
 	// Track whether or not pull requests were skipped
 	config.Stats.SetSkipPullRequests(config.SkipPullRequests)
 
 	// Update raw command supplied
 	config.Stats.SetCommand(config.Args)
 
-	if err := OperateOnRepos(config); err != nil {
+	if err := repository.OperateOnRepos(config); err != nil {
 		return err
 	}
 
@@ -138,24 +106,24 @@ func handleRepoProcessing(config *GitXargsConfig) error {
 // 1. An exported GITHUB_OAUTH_TOKEN
 // 2. Arguments passed to the binary itself which should be executed against the targeted repos
 // 3. At least one of the three valid methods for selecting repositories
-func sanityCheckInputs(config *GitXargsConfig) error {
-	if err := ensureGithubOauthTokenSet(); err != nil {
+func sanityCheckInputs(config *config.GitXargsConfig) error {
+	if err := auth.EnsureGithubOauthTokenSet(); err != nil {
 		return err
 	}
 
 	if len(config.Args) < 1 {
-		return errors.WithStackTrace(NoArgumentsPassedErr{})
+		return errors.WithStackTrace(types.NoArgumentsPassedErr{})
 	}
 
-	if err := ensureValidOptionsPassed(config); err != nil {
+	if err := gitxargs_io.EnsureValidOptionsPassed(config); err != nil {
 		return errors.WithStackTrace(err)
 	}
 
 	return nil
 }
 
 // runGitXargs is the urfave cli app's Action that is called when the user executes the binary
-func runGitXargs(c *cli.Context) error {
+func RunGitXargs(c *cli.Context) error {
 	// If someone calls us with no args at all, show the help text and exit
 	if !c.Args().Present() {
 		return cli.ShowAppHelp(c)

cmd/git-xargs.go

@@ -1,10 +1,13 @@
-package main
+package cmd
 
 import (
-	"github.com/stretchr/testify/require"
 	"strings"
 	"testing"
 
+	"github.com/gruntwork-io/git-xargs/config"
+	"github.com/gruntwork-io/git-xargs/mocks"
+	"github.com/stretchr/testify/require"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -13,13 +16,13 @@ import (
 func TestHandleRepoProcessing(t *testing.T) {
 	t.Parallel()
 
-	config := NewGitXargsTestConfig()
-	config.ReposFile = "./_testdata/good-test-repos.txt"
-	config.BranchName = "test-branch-name"
-	config.CommitMessage = "test-commit-name"
-	config.Args = []string{"touch", "test.txt"}
-	config.GithubClient = configureMockGithubClient()
-	err := handleRepoProcessing(config)
+	testConfig := config.NewGitXargsTestConfig()
+	testConfig.ReposFile = "../data/test/good-test-repos.txt"
+	testConfig.BranchName = "test-branch-name"
+	testConfig.CommitMessage = "test-commit-name"
+	testConfig.Args = []string{"touch", "test.txt"}
+	testConfig.GithubClient = mocks.ConfigureMockGithubClient()
+	err := handleRepoProcessing(testConfig)
 
 	assert.NoError(t, err)
 }