Merge pull request #4: git-bundle-server CLI 3: Cleanups and builds

derrickstolee · web-flow · commit acfad6f6a3a1 · 2022-09-21T11:02:40.000-04:00
* Consolidate Git executable creation so we can use the `LC_CTYPE=C` environment variable universally.
* Modify how `go.mod` files work as well as set up automated builds to verify things compile.

I _really struggled_ to figure out how all this module stuff works, so I probably messed it up in some way. However, it builds locally _and_ builds in the GitHub Actions build, so that's a start.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,29 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.19.0'
+
+      - uses: actions/checkout@v2
+        with:
+          path: src/git-bundle-server
+
+      - name: Build
+        run: |
+          cd $GITHUB_WORKSPACE/src/git-bundle-server
+          GOPATH="$GITHUB_WORKSPACE/../../" go build ./cmd/git-bundle-server
+
+      - name: Check style
+        run: |
+          cd $GITHUB_WORKSPACE/src/git-bundle-server
+          GOPATH="$GITHUB_WORKSPACE/../../" go vet ./cmd/git-bundle-server
+
+      # TODO: add automated tests.
diff --git a/cmd/git-bundle-server/go.mod b/cmd/git-bundle-server/go.mod
@@ -0,0 +1,3 @@
+module github.com/github/git-bundle-server/cmd/git-bundle-server
+
+go 1.19
diff --git a/cmd/git-bundle-server/init.go b/cmd/git-bundle-server/init.go
@@ -3,9 +3,10 @@ package main
 import (
 	"errors"
 	"fmt"
-	"git-bundle-server/internal/bundles"
-	"git-bundle-server/internal/core"
-	"git-bundle-server/internal/git"
+
+	"github.com/github/git-bundle-server/internal/bundles"
+	"github.com/github/git-bundle-server/internal/core"
+	"github.com/github/git-bundle-server/internal/git"
 )
 
 type Init struct{}
@@ -29,12 +30,22 @@ func (Init) run(args []string) error {
 	}
 
 	fmt.Printf("Cloning repository from %s\n", url)
-	gitErr := git.GitCommand("clone", "--mirror", url, repo.RepoDir)
+	gitErr := git.GitCommand("clone", "--bare", url, repo.RepoDir)
 
 	if gitErr != nil {
 		return fmt.Errorf("failed to clone repository: %w", gitErr)
 	}
 
+	gitErr = git.GitCommand("-C", repo.RepoDir, "config", "remote.origin.fetch", "+refs/heads/*:refs/heads/*")
+	if gitErr != nil {
+		return fmt.Errorf("failed to configure refspec: %w", gitErr)
+	}
+
+	gitErr = git.GitCommand("-C", repo.RepoDir, "fetch", "origin")
+	if gitErr != nil {
+		return fmt.Errorf("failed to fetch latest refs: %w", gitErr)
+	}
+
 	bundle := bundles.CreateInitialBundle(repo)
 	fmt.Printf("Constructing base bundle file at %s\n", bundle.Filename)
 
diff --git a/cmd/git-bundle-server/update-all.go b/cmd/git-bundle-server/update-all.go
@@ -2,9 +2,10 @@ package main
 
 import (
 	"fmt"
-	"git-bundle-server/internal/core"
 	"os"
 	"os/exec"
+
+	"github.com/github/git-bundle-server/internal/core"
 )
 
 type UpdateAll struct{}
diff --git a/cmd/git-bundle-server/update.go b/cmd/git-bundle-server/update.go
@@ -3,8 +3,9 @@ package main
 import (
 	"errors"
 	"fmt"
-	"git-bundle-server/internal/bundles"
-	"git-bundle-server/internal/core"
+
+	"github.com/github/git-bundle-server/internal/bundles"
+	"github.com/github/git-bundle-server/internal/core"
 )
 
 type Update struct{}
diff --git a/doc.go b/doc.go
@@ -0,0 +1 @@
+package docs
diff --git a/go.mod b/go.mod
@@ -1,3 +1,8 @@
-module git-bundle-server
+module github.com/github/git-bundle-server
 
-go 1.18
+go 1.19
+
+require (
+	golang.org/x/lint v0.0.0-20210508222113-6edffad5e616 // indirect
+	golang.org/x/tools v0.1.12 // indirect
+)
diff --git a/go.work b/go.work
@@ -0,0 +1,8 @@
+go 1.18
+
+use (
+	./cmd/git-bundle-server/
+	./internal/bundles/
+	./internal/core/
+	./internal/git/
+)
diff --git a/internal/bundles/bundles.go b/internal/bundles/bundles.go
@@ -4,13 +4,14 @@ import (
 	"bufio"
 	"encoding/json"
 	"fmt"
-	"git-bundle-server/internal/core"
-	"git-bundle-server/internal/git"
 	"os"
 	"sort"
 	"strconv"
 	"strings"
 	"time"
+
+	"github.com/github/git-bundle-server/internal/core"
+	"github.com/github/git-bundle-server/internal/git"
 )
 
 type BundleHeader struct {
diff --git a/internal/bundles/go.mod b/internal/bundles/go.mod
@@ -1,3 +1,3 @@
 module github.com/github/git-bundle-server/internal/bundles
 
-go 1.18
+go 1.19
diff --git a/internal/core/go.mod b/internal/core/go.mod
@@ -0,0 +1,3 @@
+module github.com/github/git-bundle-server/internal/core
+
+go 1.19
diff --git a/internal/git/git.go b/internal/git/git.go
@@ -8,18 +8,28 @@ import (
 	"strings"
 )
 
-func GitCommand(args ...string) error {
-	git, lookErr := exec.LookPath("git")
-
-	if lookErr != nil {
-		return lookErr
+func GetExecCommand(args []string) (*exec.Cmd, error) {
+	git, err := exec.LookPath("git")
+	if err != nil {
+		return nil, fmt.Errorf("failed to find 'git' on the path: %w", err)
 	}
 
 	cmd := exec.Command(git, args...)
+	cmd.Env = append(cmd.Env, "LC_CTYPE=C")
+
+	return cmd, nil
+}
+
+func GitCommand(args ...string) error {
+	cmd, err := GetExecCommand(args)
+	if err != nil {
+		return err
+	}
+
 	cmd.Stderr = os.Stderr
 	cmd.Stdout = os.Stdout
 
-	err := cmd.Start()
+	err = cmd.Start()
 	if err != nil {
 		return fmt.Errorf("git command failed to start: %w", err)
 	}
@@ -33,26 +43,23 @@ func GitCommand(args ...string) error {
 }
 
 func GitCommandWithStdin(stdinLines []string, args ...string) error {
-	git, lookErr := exec.LookPath("git")
-
-	if lookErr != nil {
-		return lookErr
+	cmd, err := GetExecCommand(args)
+	if err != nil {
+		return err
 	}
 
 	buffer := bytes.Buffer{}
 	for line := range stdinLines {
 		buffer.Write([]byte(stdinLines[line] + "\n"))
 	}
 
-	cmd := exec.Command(git, args...)
-
 	cmd.Stdin = &buffer
 
 	errorBuffer := bytes.Buffer{}
 	cmd.Stderr = &errorBuffer
 	cmd.Stdout = os.Stdout
 
-	err := cmd.Start()
+	err = cmd.Start()
 	if err != nil {
 		return fmt.Errorf("git command failed to start: %w", err)
 	}
@@ -68,7 +75,7 @@ func GitCommandWithStdin(stdinLines []string, args ...string) error {
 func CreateBundle(repoDir string, filename string) (bool, error) {
 	err := GitCommand(
 		"-C", repoDir, "bundle", "create",
-		filename, "--all")
+		filename, "--branches")
 	if err != nil {
 		if strings.Contains(err.Error(), "Refusing to create empty bundle") {
 			return false, nil
@@ -105,7 +112,7 @@ func CreateBundleFromRefs(repoDir string, filename string, refs map[string]strin
 func CreateIncrementalBundle(repoDir string, filename string, prereqs []string) (bool, error) {
 	err := GitCommandWithStdin(
 		prereqs, "-C", repoDir, "bundle", "create",
-		filename, "--stdin", "--all")
+		filename, "--stdin", "--branches")
 	if err != nil {
 		if strings.Contains(err.Error(), "Refusing to create empty bundle") {
 			return false, nil
diff --git a/internal/git/go.mod b/internal/git/go.mod
@@ -0,0 +1,3 @@
+module github.com/github/git-bundle-server/internal/git
+
+go 1.19

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module github.com/github/git-bundle-server/cmd/git-bundle-server`
	`2`	`+`
	`3`	`+go 1.19`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`module github.com/github/git-bundle-server/internal/bundles`
`2`	`2`
`3`		`-go 1.18`
	`3`	`+go 1.19`