Intermediate merge of branch Dev

.github/workflows/go-util-build.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Setup Go environment
         uses: actions/[email protected]
         with:
-          go-version: "1.20"
+          go-version: "1.23"
 
       - name: Checkout
         uses: actions/[email protected]

.gitignore

@@ -1,3 +1,4 @@
 *.out
+coverage.*
 __debug_bin
 **/artifacts

README.md

@@ -1,6 +1,10 @@
 Notes & External Docs
 ---------------------
 
+### Libraries ###
+
+* [CLI Parser Kong](https://github.com/alecthomas/kong#readme)
+
 ### Cross Compiling ###
 
 * [Go Architecture Matrix](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63)

SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+| Version   | Supported          |
+| --------- | ------------------ |
+|   tbd     | :white_check_mark: |
+| < tbd     | :x:                |
+|   latest  | :x:                |
+
+## Reporting a Vulnerability
+
+To report any vulnerability or bugs open an issue at:
+
+https://github.com/soerenkoehler/go-chdiff/issues
+
+Resource considerations: Real life will always out-prioritise non-commercial
+open source hobby projects. So don't expect 24/7 support with 30min response
+time.

chdiff/chdiff.go

@@ -2,61 +2,155 @@ package chdiff
 
 import (
 	_ "embed"
-	"log"
+	"encoding/json"
+	"io"
 	"os"
-	"path"
+	"path/filepath"
 
 	"github.com/alecthomas/kong"
-	"github.com/soerenkoehler/chdiff-go/digest"
-	"github.com/soerenkoehler/chdiff-go/util"
+	"github.com/soerenkoehler/go-chdiff/common"
+	"github.com/soerenkoehler/go-chdiff/diff"
+	"github.com/soerenkoehler/go-chdiff/digest"
+	"github.com/soerenkoehler/go-chdiff/util"
 )
 
-//go:embed description.txt
-var _Description string
+const (
+	DefaultDigestName  string = ".chdiff.txt"
+	UserConfigFileName string = ".chdiff-config.json"
+)
 
-var cli struct {
-	Create cmdDigest `cmd:"" name:"create" aliases:"c" help:"Create digest file for PATH."`
-	Verify cmdDigest `cmd:"" name:"verify" aliases:"v" default:"1" help:"Verify digest file for PATH."`
-}
+var (
+	//go:embed description.txt
+	_description string
+
+	//go:embed default-config.json
+	_defaultConfigJson []byte
+)
 
 type cmdDigest struct {
-	Path      string `arg:"" name:"PATH" type:"path" default:"." help:"Path for which to calculate the digest"`
-	Algorithm string `name:"alg" help:"The checksum algorithm to use [SHA256,SHA512]." enum:"SHA256,SHA512" default:"SHA256"`
+	RootPath   string `arg:"" name:"PATH" type:"path" default:"." help:"Path for which to calculate the digest"`
+	DigestFile string `name:"file" short:"f" help:"Optional: Path to different location of the digest file."`
 }
 
-func DoMain(
+type CmdCreate struct {
+	cmdDigest
+	Algorithm string `name:"algorithm" short:"a" help:"The checksum algorithm to use [SHA256,SHA512]." enum:"SHA256,SHA512" default:"SHA256"`
+}
+
+type CmdVerify struct{ cmdDigest }
+
+type ChdiffDependencies interface {
+	DigestRead(string, string) (digest.Digest, error)
+	DigestWrite(digest.Digest, string) error
+	DigestCalculate(string, digest.HashType) digest.Digest
+	DigestCompare(digest.Digest, digest.Digest) diff.Diff
+	DiffPrint(io.Writer, diff.Diff)
+	Stdout() io.Writer
+	Stderr() io.Writer
+	KongExit() func(int)
+}
+
+func Chdiff(
 	version string,
 	args []string,
-	digestService digest.Service,
-	stdioService util.StdIOService) {
+	deps ChdiffDependencies) {
 
 	os.Args = args
-	log.SetOutput(stdioService.Stdout())
+	util.InitLogger(deps.Stderr())
+
+	loadConfig()
+
+	var cli struct {
+		Create CmdCreate `cmd:"" name:"create" aliases:"c" help:"Create digest file for PATH."`
+		Verify CmdVerify `cmd:"" name:"verify" aliases:"v" help:"Verify digest file for PATH."`
+	}
 
 	ctx := kong.Parse(
 		&cli,
 		kong.Vars{"VERSION": version},
-		kong.Description(_Description),
+		kong.Description(_description),
 		kong.UsageOnError(),
-		kong.Writers(
-			stdioService.Stdout(),
-			stdioService.Stderr()))
+		kong.Writers(deps.Stdout(), deps.Stderr()),
+		kong.Exit(deps.KongExit()),
+		kong.BindTo(deps, (*ChdiffDependencies)(nil)))
 
-	switch ctx.Command() {
+	if ctx != nil {
+		ctx.FatalIfErrorf(ctx.Run(deps))
+	}
+}
 
-	case "create", "create <PATH>":
-		digestService.Create(
-			cli.Create.Path,
-			path.Join(cli.Create.Path, "out.txt"),
-			cli.Create.Algorithm)
+func (cmd *CmdCreate) Run(deps ChdiffDependencies) error {
+	return deps.DigestWrite(
+		deps.DigestCalculate(
+			cmd.RootPath,
+			hashTypeFromAlgorithm(cmd.Algorithm)),
+		defaultDigestFile(cmd.cmdDigest))
+}
 
-	case "verify", "verify <PATH>":
-		digestService.Verify(
-			cli.Verify.Path,
-			path.Join(cli.Verify.Path, "out.txt"),
-			cli.Verify.Algorithm)
+func (cmd *CmdVerify) Run(deps ChdiffDependencies) error {
+	var chain util.ChainContext
+	var oldDigest digest.Digest
 
+	chain.Chain(func() {
+		oldDigest, chain.Err = deps.DigestRead(
+			cmd.RootPath,
+			defaultDigestFile(cmd.cmdDigest))
+	}).Chain(func() {
+		deps.DiffPrint(
+			deps.Stdout(),
+			deps.DigestCompare(
+				oldDigest,
+				deps.DigestCalculate(
+					cmd.RootPath,
+					oldDigest.Algorithm)))
+	}).ChainError("verify")
+
+	return chain.Err
+}
+
+func loadConfig() {
+	chain := &util.ChainContext{}
+	chain.Chain(func() {
+		chain.Err = json.Unmarshal(readConfigFile(), &common.Config)
+	}).Chain(func() {
+		util.SetLogLevelByName(common.Config.LogLevel)
+		util.Debug("%+v", common.Config)
+	}).ChainFatal("reading config")
+}
+
+func readConfigFile() []byte {
+	userhome, err := os.UserHomeDir()
+	if err != nil {
+		util.Warn("can't determine user home")
+		return _defaultConfigJson
+	}
+
+	configFile := filepath.Join(userhome, UserConfigFileName)
+	data, err := os.ReadFile(configFile)
+	if err != nil {
+		os.WriteFile(configFile, _defaultConfigJson, 0744)
+		return _defaultConfigJson
+	}
+
+	return data
+}
+
+func hashTypeFromAlgorithm(algorithm string) digest.HashType {
+	switch algorithm {
+	case "SHA512":
+		return digest.SHA512
+	case "SHA256":
+		fallthrough
 	default:
-		log.Fatalf("unknown command: %s", ctx.Command())
+		return digest.SHA256
+	}
+}
+
+func defaultDigestFile(cmd cmdDigest) string {
+	digestFile := cmd.DigestFile
+	if len(cmd.DigestFile) == 0 {
+		digestFile = filepath.Join(cmd.RootPath, DefaultDigestName)
 	}
+	absPath, _ := filepath.Abs(digestFile)
+	return absPath
 }