refactor to have main.go in root

Author: linkdata

.github/workflows/build.yml

@@ -37,7 +37,7 @@ jobs:
           args: ./...
 
       - name: Build
-        run: go build ./...
+        run: go build .
 
       - name: actions-goveralls
         uses: shogo82148/actions-goveralls@v1

README.md

@@ -15,3 +15,28 @@ If the match is not exact or the current branch is not the default branch
 or a protected branch, it creates a work-in-progress semver string like `v0.1.2-myfeature.123`.
 
 Supports raw git repositories as well as GitLab and GitHub builders.
+
+## Print current version of a git repository
+
+```sh
+$ go install github.com/linkdata/gitsemver@latest
+$ gitsemver $HOME/myreleasedpackage
+v1.2.3
+```
+
+## Generate a go package file with version information
+
+```go
+//go:generate go run github.com/linkdata/gitsemver@latest -gopackage -out version.gen.go
+```
+
+Generates a file called `version.gen.go` with contents like
+
+```go
+// Code generated by gitsemver at 2025-02-10 07:47:15 UTC DO NOT EDIT.
+// branch "mybranch", build 456
+package mypackage
+
+const PkgName = "mypackage"
+const PkgVersion = "v1.2.3-mybranch.456"
+```

main.go

@@ -0,0 +1,87 @@
+package main
+
+import (
+	"errors"
+	"flag"
+	"fmt"
+	"os"
+	"path"
+	"syscall"
+
+	gitsemver "github.com/linkdata/gitsemver/pkg"
+)
+
+func writeOutput(fileName, content string) (err error) {
+	f := os.Stdout
+	if len(fileName) > 0 {
+		fileName = path.Clean(fileName)
+		if f, err = os.Create(fileName); err != nil /* #nosec G304 */ {
+			return
+		}
+		defer f.Close()
+	}
+	_, err = f.WriteString(content)
+	return
+}
+
+var (
+	flagGit       = flag.String("git", "git", "path to Git executable")
+	flagOut       = flag.String("out", "", "write to file instead of stdout (relative paths are relative to repo)")
+	flagName      = flag.String("name", "", "override the Go PkgName, default is to use last portion of module in go.mod")
+	flagGoPackage = flag.Bool("gopackage", false, "write Go source with PkgName and PkgVersion")
+	flagNoFetch   = flag.Bool("nofetch", false, "don't fetch remote tags")
+	flagNoNewline = flag.Bool("nonewline", false, "don't print a newline after the output")
+)
+
+func mainfn() int {
+	repoDir := os.ExpandEnv(flag.Arg(0))
+	if repoDir == "" {
+		repoDir = "."
+	}
+
+	vs, err := gitsemver.New(*flagGit)
+	if err == nil {
+		if repoDir, err = vs.Git.CheckGitRepo(repoDir); err == nil {
+			if !*flagNoFetch {
+				err = vs.Git.FetchTags(repoDir)
+			}
+			if err == nil {
+				var vi gitsemver.VersionInfo
+				if vi, err = vs.GetVersion(repoDir); err == nil {
+					content := vi.Version
+					if *flagGoPackage {
+						content, err = vi.GoPackage(repoDir, *flagName)
+					}
+					if err == nil {
+						outpath := os.ExpandEnv(*flagOut)
+						if outpath != "" && !path.IsAbs(outpath) {
+							outpath = path.Join(repoDir, outpath)
+						}
+						if !*flagNoNewline {
+							content += "\n"
+						}
+						if err = writeOutput(outpath, content); err == nil {
+							return 0
+						}
+					}
+				}
+			}
+		}
+	}
+
+	retv := 125
+	fmt.Fprintln(os.Stderr, err.Error())
+	if e := errors.Unwrap(err); e != nil {
+		if errno, ok := e.(syscall.Errno); ok {
+			retv = int(errno)
+		}
+	}
+	return retv
+}
+
+var exitFn func(int) = os.Exit
+
+func main() {
+	flag.Parse()
+	exitFn(mainfn())
+}

main_test.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"flag"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestMainFn(t *testing.T) {
+	flag.Parse()
+	*flagGoPackage = true
+	*flagOut = "test.out"
+	mainfn()
+	b, err := os.ReadFile("test.out")
+	if err == nil {
+		defer os.Remove("test.out")
+		s := string(b)
+		if !strings.Contains(s, "package gitsemver") || !strings.Contains(s, "PkgName = \"gitsemver\"") {
+			t.Error(s)
+		}
+	} else {
+		t.Error(err)
+	}
+}
+
+func TestMainError(t *testing.T) {
+	flag.Parse()
+	exitFn = func(i int) {
+		if i == 0 {
+			t.Error(i)
+		}
+		if i == 125 {
+			t.Log("didn't get a syscall.Errno")
+		}
+	}
+	*flagOut = "/proc/.nonexistant"
+	main()
+}

environment.go renamed to pkg/environment.go

@@ -4,7 +4,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/linkdata/gitsemver"
+	gitsemver "github.com/linkdata/gitsemver/pkg"
 )
 
 func Test_OsEnvironment_Getenv(t *testing.T) {

environment_test.go renamed to pkg/environment_test.go

@@ -3,7 +3,7 @@ package gitsemver_test
 import (
 	"testing"
 
-	"github.com/linkdata/gitsemver"
+	gitsemver "github.com/linkdata/gitsemver/pkg"
 )
 
 func Test_NewVersionStringer_SucceedsNormally(t *testing.T) {

gitsemver.go renamed to pkg/gitsemver.go

@@ -2,7 +2,6 @@ package gitsemver
 
 import (
 	"errors"
-	"fmt"
 	"os"
 	"os/exec"
 	"path"
@@ -42,41 +41,45 @@ func NewDefaultGitter(gitBin string) (gitter Gitter, err error) {
 	return
 }
 
+var ErrNotDirectory = errors.New("not a directory")
+
 // checkDir checks that the given path is accessible and is a directory.
 // Returns nil if it is, else an error.
 func checkDir(dir string) (err error) {
-	var fi os.FileInfo
+	_, err = os.ReadDir(dir)
+	/*var fi os.FileInfo
 	if fi, err = os.Stat(dir); err == nil {
 		if !fi.IsDir() {
-			err = fmt.Errorf("'%s' is not a directory", dir)
+			err = ErrNotDirectory
 		}
-	}
+	}*/
 	return
 }
 
 // dirOrParentHasGitSubdir returns the name of a directory containing
 // a '.git' subdirectory or an empty string. It searches starting from
 // the given directory and looks in that and it's parents.
-func dirOrParentHasGitSubdir(dir string) string {
-	if dir != "/" && dir != "." {
-		if checkDir(path.Join(dir, ".git")) == nil {
-			return dir
+func dirOrParentHasGitSubdir(s string) (dir string, err error) {
+	if err = checkDir(path.Join(s, ".git")); err != nil {
+		s = path.Dir(s)
+		if s != "/" {
+			if s, e := dirOrParentHasGitSubdir(s); e == nil {
+				return s, nil
+			}
 		}
-		return dirOrParentHasGitSubdir(path.Dir(dir))
+	} else {
+		dir = s
 	}
-	return ""
+	return
 }
 
 // CheckGitRepo checks that the given directory is part of a git repository,
 // meaning that it or one of it's parent directories has a '.git' subdirectory.
 // If it is, it returns the absolute path of the git repo and a nil error.
 func (dg DefaultGitter) CheckGitRepo(dir string) (repo string, err error) {
 	if dir, err = filepath.Abs(dir); err == nil {
-		if err = checkDir(dir); err == nil {
-			if repo = dirOrParentHasGitSubdir(dir); repo == "" {
-				err = errors.New("can't find .git directory")
-				repo = dir
-			}
+		if repo, err = dirOrParentHasGitSubdir(dir); err != nil {
+			repo = dir
 		}
 	}
 	return

gitsemver_test.go renamed to pkg/gitsemver_test.go

@@ -5,7 +5,7 @@ import (
 	"slices"
 	"testing"
 
-	"github.com/linkdata/gitsemver"
+	gitsemver "github.com/linkdata/gitsemver/pkg"
 )
 
 func Test_NewDefaultGitter_SucceedsNormally(t *testing.T) {
@@ -37,7 +37,7 @@ func Test_CheckGitRepo_SucceedsForSubdir(t *testing.T) {
 	if err != nil {
 		t.Error(err)
 	}
-	repo, err := dg.CheckGitRepo("./subdir")
+	repo, err := dg.CheckGitRepo("../pkg/subdir")
 	if err != nil {
 		t.Error(err)
 	}
@@ -46,7 +46,7 @@ func Test_CheckGitRepo_SucceedsForSubdir(t *testing.T) {
 	}
 }
 
-func Test_CheckGitRepo_FailsForRootAndFile(t *testing.T) {
+func Test_CheckGitRepo_FailsForRoot(t *testing.T) {
 	dg, err := gitsemver.NewDefaultGitter("git")
 	if err != nil {
 		t.Error(err)
@@ -58,13 +58,6 @@ func Test_CheckGitRepo_FailsForRootAndFile(t *testing.T) {
 	if repo != "/" {
 		t.Error(repo)
 	}
-	repo, err = dg.CheckGitRepo("./subdir/empty.txt")
-	if err == nil {
-		t.Error("no error")
-	}
-	if repo != "" {
-		t.Error(repo)
-	}
 }
 
 func Test_CheckGitRepo_IgnoresFileNamedGit(t *testing.T) {