lingliufu/desgin-sdk

.goreleaser.yaml

@@ -16,12 +16,17 @@ before:
     - go generate ./...
 
 builds:
-  - env:
-      - CGO_ENABLED=0
+  - binary: sumdiff
+    main: ./cli/sumdiff.go
     goos:
       - linux
-      - windows
       - darwin
+      - windows
+    goarch:
+      - amd64
+      - 386
+      - arm64
+
 
 archives:
   - format: tar.gz

Makefile

@@ -2,7 +2,7 @@ install:
 
 build:
 	mkdir -p ./bin
-	go build -o ./bin/sumdiff ./app/sumdiff.go
+	go build -o ./bin/sumdiff ./cli/sumdiff.go
 
 install: build
 	sudo rm -rf ~/go/bin/sumdiff
@@ -13,6 +13,8 @@ tools:
 	go install github.com/goreleaser/goreleaser@latest
 	go install github.com/spf13/cobra-cli@latest
 
+release:
+	goreleaser release --clean
 
 snapshot:
 	goreleaser release --snapshot --clean

README.md

@@ -1,5 +1,25 @@
 # sumdiff
-Compare tools for directory and files.
+Compare sdk/tools for directory and files.
+
+# SDK
+
+## Install
+```bash
+go get -u github.com/foolin/sumdiff
+```
+
+## API
+```go
+
+//Compare 
+ok, result, err := Cmp(path1, path2)
+
+//Equal
+ok, err := Equal(v.path1, v.path2)
+
+```
+
+# CLI Tool
 
 ```
 sumdiff  --help
@@ -154,4 +174,9 @@ linux:
 
 tar -xvf sumdiff_Linux_x86_64.tar.gz && sudo mv sumdiff /usr/local/bin
 
-```
+```
+
+## TODO
+[ ] Output table,csv,yaml,json
+[ ] Config display statusbar
+[ ] Write file

cmd/cmp.go

@@ -25,7 +25,7 @@ import (
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/plog"
 	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/internal/vo"
+	"github.com/foolin/sumdiff/vo"
 
 	"github.com/spf13/cobra"
 )

cmd/hash.go

@@ -25,7 +25,7 @@ import (
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/plog"
 	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/internal/vo"
+	"github.com/foolin/sumdiff/vo"
 	"github.com/spf13/cobra"
 )
 

cmd/md5.go

@@ -23,11 +23,11 @@ package cmd
 
 import (
 	"crypto/md5"
+	"github.com/foolin/sumdiff/vo"
 
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/plog"
 	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/internal/vo"
 	"github.com/spf13/cobra"
 )
 

cmd/sha1.go

@@ -23,11 +23,11 @@ package cmd
 
 import (
 	"crypto/sha1"
+	"github.com/foolin/sumdiff/vo"
 
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/plog"
 	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/internal/vo"
 	"github.com/spf13/cobra"
 )
 

cmd/sha256.go

@@ -23,11 +23,11 @@ package cmd
 
 import (
 	"crypto/sha256"
+	"github.com/foolin/sumdiff/vo"
 
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/plog"
 	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/internal/vo"
 	"github.com/spf13/cobra"
 )
 

cmp.go

@@ -4,17 +4,15 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/foolin/sumdiff/vo"
+
 	"github.com/foolin/sumdiff/internal/statusbar"
 	"github.com/foolin/sumdiff/internal/util"
-	"github.com/foolin/sumdiff/internal/vo"
 	"github.com/hashicorp/go-multierror"
 )
 
-func Cmp(path1, path2 string) (bool, []*vo.CmpVo, error) {
-	statusbar.Display("compare start...")
-	defer func() {
-		statusbar.Display("compare done!")
-	}()
+func Cmp(path1, path2 string) (ok bool, res []*vo.CmpVo, err error) {
+	statusbar.Display("Comparing %v <-> %v", path1, path2)
 
 	path1 = util.FormatPath(path1)
 	path2 = util.FormatPath(path2)
@@ -25,13 +23,13 @@ func Cmp(path1, path2 string) (bool, []*vo.CmpVo, error) {
 
 	s1, err := os.Stat(path1)
 	if err != nil {
-		result.X.Error = err
+		result.Hash1.Error = err
 		outError = multierror.Append(outError, err)
 	}
 
 	s2, err := os.Stat(path2)
 	if err != nil {
-		result.Y.Error = err
+		result.Hash2.Error = err
 		outError = multierror.Append(outError, err)
 	}
 
@@ -60,13 +58,13 @@ func CmpDir(path1, path2 string) (bool, []*vo.CmpVo, error) {
 
 	data1, err := listPathWithStatusbar(path1)
 	if err != nil {
-		outResult.X.Error = err
+		outResult.Hash1.Error = err
 		outError = multierror.Append(outError, err)
 	}
 
 	data2, err := listPathWithStatusbar(path2)
 	if err != nil {
-		outResult.Y.Error = err
+		outResult.Hash2.Error = err
 		outError = multierror.Append(outError, err)
 	}
 
@@ -80,21 +78,21 @@ func CmpDir(path1, path2 string) (bool, []*vo.CmpVo, error) {
 	retList := make([]*vo.CmpVo, 0)
 
 	for k, v1 := range data1 {
-		statusbar.Display("Comparing %v", k)
+		statusbar.Display("Comparing " + k)
 		itemResult := vo.NewCmpVo(k, k)
-		itemResult.X.Size = v1.Info.Size()
+		itemResult.Hash1.Size = v1.Info.Size()
 		itemResult.Equal = false
 		v2, ok := data2[k]
 
 		if !ok {
-			itemResult.Y.Error = fmt.Errorf("not exist [%v]", k)
+			itemResult.Hash2.Error = fmt.Errorf("not exist [%v]", k)
 			//itemResult.Msg = fmt.Sprintf("path2 not exist [%v]", k)
 			itemResult.Msg = "path2 not exist"
 			retList = append(retList, itemResult)
 			notEqualCount++
 			continue
 		} else {
-			itemResult.Y.Size = v2.Info.Size()
+			itemResult.Hash2.Size = v2.Info.Size()
 		}
 
 		if v1.Info.Size() != v2.Info.Size() {
@@ -119,20 +117,20 @@ func CmpDir(path1, path2 string) (bool, []*vo.CmpVo, error) {
 
 			h1, err := util.Sha256(v1.Path)
 			if err != nil {
-				itemResult.X.Error = err
+				itemResult.Hash1.Error = err
 				itemError = multierror.Append(outError, err)
 				outError = multierror.Append(outError, err)
 			} else {
-				itemResult.X.Hash = h1
+				itemResult.Hash1.Hash = h1
 			}
 
 			h2, err := util.Sha256(v2.Path)
 			if err != nil {
-				itemResult.Y.Error = err
+				itemResult.Hash2.Error = err
 				itemError = multierror.Append(outError, err)
 				outError = multierror.Append(outError, err)
 			} else {
-				itemResult.Y.Hash = h2
+				itemResult.Hash2.Hash = h2
 			}
 
 			if itemError != nil {
@@ -166,9 +164,9 @@ func CmpDir(path1, path2 string) (bool, []*vo.CmpVo, error) {
 	if len(data2) != 0 {
 		for k, v2 := range data2 {
 			itemResult := vo.NewCmpVo(k, k)
-			itemResult.Y.Size = v2.Info.Size()
+			itemResult.Hash2.Size = v2.Info.Size()
 			itemResult.Equal = false
-			itemResult.X.Error = fmt.Errorf("not exist [%v]", k)
+			itemResult.Hash1.Error = fmt.Errorf("not exist [%v]", k)
 			//itemResult.Msg = fmt.Sprintf("path1 not exist [%v]", k)
 			itemResult.Msg = "not exist path1"
 			retList = append(retList, itemResult)
@@ -185,30 +183,34 @@ func CmpFile(file1, file2 string) (bool, *vo.CmpVo, error) {
 
 	f1, err := os.Stat(file1)
 	if err != nil {
-		result.X.Error = err
+		result.Hash1.Error = err
 		outError = multierror.Append(outError, err)
 	} else {
-		result.X.Size = f1.Size()
+		result.Hash1.Size = f1.Size()
 	}
 
 	f2, err := os.Stat(file2)
 	if err != nil {
-		result.Y.Error = err
+		result.Hash2.Error = err
 		outError = multierror.Append(outError, err)
 	} else {
-		result.Y.Size = f2.Size()
+		result.Hash2.Size = f2.Size()
 	}
 
 	h1, err := util.Sha256(file1)
 	if err != nil {
-		result.X.Error = err
+		result.Hash1.Error = err
 		outError = multierror.Append(outError, err)
+	} else {
+		result.Hash1.Hash = h1
 	}
 
 	h2, err := util.Sha256(file2)
 	if err != nil {
-		result.Y.Error = err
+		result.Hash2.Error = err
 		outError = multierror.Append(outError, err)
+	} else {
+		result.Hash2.Hash = h2
 	}
 
 	result.Equal = false

eq.go

@@ -2,13 +2,14 @@ package sumdiff
 
 import (
 	"fmt"
-	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/internal/util"
 	"os"
 	"strings"
+
+	"github.com/foolin/sumdiff/internal/statusbar"
+	"github.com/foolin/sumdiff/internal/util"
 )
 
-func Equal(path1, path2 string) (bool, error) {
+func Equal(path1, path2 string) (ok bool, err error) {
 	path1 = util.FormatPath(path1)
 	path2 = util.FormatPath(path2)
 
@@ -52,7 +53,7 @@ func EqualDir(path1, path2 string) (bool, error) {
 	}
 
 	for k, v1 := range data1 {
-		statusbar.Display("Comparing %v", k)
+		statusbar.Display("Comparing %v ...", k)
 		v2, ok := data2[k]
 		if !ok {
 			return false, fmt.Errorf("path2 not exist path %v", k)

example_test.go

@@ -0,0 +1,44 @@
+package sumdiff_test
+
+import (
+	"crypto/sha1"
+	"encoding/json"
+	"fmt"
+	"github.com/foolin/sumdiff"
+	"testing"
+)
+
+func TestExample(t *testing.T) {
+	path1 := "./test_data/a.txt"
+	path2 := "./test_data/b.txt"
+
+	//Compare
+	ok, res, err := sumdiff.Cmp(path1, path2)
+	fmt.Println("OK:", ok)
+	fmt.Println("Result:", toJson(res))
+	if err != nil {
+		fmt.Println("Error:", err)
+	}
+	fmt.Print("---------\n\n")
+
+	//Equal
+	ok, err = sumdiff.Equal(path1, path2)
+	fmt.Println("OK:", ok)
+	if err != nil {
+		fmt.Println("Error:", err)
+	}
+	fmt.Print("---------\n\n")
+
+	//Hash
+	res2, err := sumdiff.Hash(sha1.New(), path1, path2)
+	fmt.Println("Result:", toJson(res2))
+	if err != nil {
+		fmt.Println("Error:", err)
+	}
+	fmt.Print("---------\n\n")
+}
+
+func toJson(v any) string {
+	data, _ := json.Marshal(v)
+	return string(data)
+}

go.mod

@@ -3,22 +3,18 @@ module github.com/foolin/sumdiff
 go 1.20
 
 require (
+	github.com/hashicorp/go-multierror v1.1.1
 	github.com/mattn/go-runewidth v0.0.15
 	github.com/spf13/cobra v1.8.0
+	github.com/stretchr/testify v1.8.4
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/hashicorp/errwrap v1.0.0 // indirect
-	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/stretchr/objx v0.5.0 // indirect
-	github.com/stretchr/testify v1.8.4 // indirect
-	golang.org/x/crypto v0.16.0 // indirect
-	golang.org/x/sys v0.15.0 // indirect
-	golang.org/x/term v0.15.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )