Merge pull request #23 from flying7eleven/feat/add-status-option-for-accessing-some-information-automatically

hekmekk · web-flow · commit dbaac4e6a0bf · 2025-06-06T09:56:04.000+02:00
Add `--json` flag for the `status` sub-command
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 ./git-team
 target/
 mocks/
+.idea/
diff --git a/Makefile b/Makefile
@@ -1,16 +1,24 @@
 VERSION := $(shell grep -E "version\s+=" `pwd`/main.go | awk -F '"' '{print $$2}')
 
 GOOS :=
+GOARCH :=
 prefix :=
 UNAME_S := $(shell uname -s)
+UNAME_M := $(shell uname -m)
 ifeq ($(UNAME_S),Darwin)
 	GOOS=darwin
 	prefix:=/usr/local
 endif
+ifeq ($(UNAME_M),arm64)
+	GOARCH=arm64
+endif
 ifeq ($(UNAME_S),Linux)
 	GOOS=linux
 	prefix:=/usr
 endif
+ifeq ($(UNAME_M),x86_64)
+	GOARCH=amd64
+endif
 
 exec_prefix := $(prefix)
 bindir := $(exec_prefix)/bin
@@ -47,7 +55,7 @@ test: go-test hookscript-tests
 verify: test acceptance-tests
 
 mocks:
-	docker run --rm --user "$(shell id -u):$(shell id -g)" -v "$(CURR_DIR):/src" -w /src vektra/mockery:v2.14.0 --dir=src/ --all --keeptree
+	docker run --rm --user "$(shell id -u):$(shell id -g)" -v "$(CURR_DIR):/src" -w /src vektra/mockery:v2.15.0 --dir=src/ --all --keeptree
 
 go-test: mocks deps
 	go test -cover ./src/...
@@ -61,7 +69,7 @@ ifndef GOPATH
 	$(error GOPATH is not set)
 endif
 	mkdir -p $(CURR_DIR)/target/bin
-	CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=amd64 go build -o $(CURR_DIR)/target/bin ./...
+	CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH) go build -o $(CURR_DIR)/target/bin ./...
 	@echo "[INFO] Successfully built git-team version v$(VERSION)"
 
 man-page: deps
diff --git a/acceptance-tests.Dockerfile b/acceptance-tests.Dockerfile
@@ -29,7 +29,7 @@ RUN go mod download
 COPY src ./src
 COPY main.go .
 
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go install ./...
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=$TARGETARCH go install ./...
 
 # ----------------------------------------------------------------- #
 
diff --git a/acceptance-tests/disable_global.bats b/acceptance-tests/disable_global.bats
@@ -72,7 +72,7 @@ teardown() {
 	assert_line "ls: /home/git-team-acceptance-test/.git-team/commit-templates/global/COMMIT_TEMPLATE: No such file or directory"
 }
 
-@test "git-team: (scope: global) disable should treat a previously disabled git-team idempotently" {
+@test "git-team: (scope: global) disable should treat a previously disabled git-team in an idempotent way" {
 	run /usr/local/bin/git-team disable
 	assert_success
 	assert_line "git-team disabled"
diff --git a/acceptance-tests/disable_repo_local.bats b/acceptance-tests/disable_repo_local.bats
@@ -85,7 +85,7 @@ teardown() {
 	assert_line "ls: /home/git-team-acceptance-test/.git-team/commit-templates/repo-local/$REPO_CHECKSUM: No such file or directory"
 }
 
-@test "git-team: (scope: repo-local) disable should treat a previously disabled git-team idempotently" {
+@test "git-team: (scope: repo-local) disable should treat a previously disabled git-team in an idempotent way" {
 	run /usr/local/bin/git-team disable
 	assert_success
 	assert_line "git-team disabled"
diff --git a/acceptance-tests/status_global.bats b/acceptance-tests/status_global.bats
@@ -13,7 +13,7 @@ setup() {
 	assert_line 'git-team disabled'
 }
 
-@test 'git-team: (scope: global) status should properly disaplay the enabled status' {
+@test 'git-team: (scope: global) status should properly display the enabled status' {
 	/usr/local/bin/git-team enable 'A <a@x.y>' 'B <b@x.y>' 'C <c@x.y>'
 
 	run /usr/local/bin/git-team status
@@ -27,3 +27,13 @@ setup() {
 	/usr/local/bin/git-team disable
 }
 
+@test 'git-team: (scope: global) status should properly display the enabled status in a json format' {
+	/usr/local/bin/git-team enable 'A <a@x.y>' 'B <b@x.y>' 'C <c@x.y>'
+
+	run /usr/local/bin/git-team status --json
+	assert_success
+	assert_line --index 0 '{"status":"enabled","coAuthors":["A <a@x.y>","B <b@x.y>","C <c@x.y>"],"previousHooksPath":""}'
+
+	/usr/local/bin/git-team disable
+}
+
diff --git a/acceptance-tests/status_repo_local.bats b/acceptance-tests/status_repo_local.bats
@@ -30,7 +30,7 @@ teardown() {
 	assert_line 'git-team disabled'
 }
 
-@test 'git-team: (scope: repo-local) status should properly disaplay the enabled status' {
+@test 'git-team: (scope: repo-local) status should properly display the enabled status' {
 	/usr/local/bin/git-team enable 'A <a@x.y>' 'B <b@x.y>' 'C <c@x.y>'
 
 	run /usr/local/bin/git-team status
@@ -44,6 +44,15 @@ teardown() {
 	/usr/local/bin/git-team disable
 }
 
+@test 'git-team: (scope: repo-local) status should properly display the enabled status' {
+	/usr/local/bin/git-team enable 'A <a@x.y>' 'B <b@x.y>' 'C <c@x.y>'
+
+	run /usr/local/bin/git-team status --json
+	assert_success
+	assert_line --index 0 '{"status":"enabled","coAuthors":["A <a@x.y>","B <b@x.y>","C <c@x.y>"],"previousHooksPath":""}'
+
+	/usr/local/bin/git-team disable
+}
 
 @test 'git-team: (scope: repo-local) status should fail when not inside a git repository' {
 	cd /tmp
diff --git a/hookscript-tests.Dockerfile b/hookscript-tests.Dockerfile
@@ -29,7 +29,7 @@ RUN go mod download
 COPY src ./src
 COPY main.go .
 
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go install ./...
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=$TARGETARCH go install ./...
 
 # ----------------------------------------------------------------- #
 
diff --git a/src/command/disable/cliadapter/cmd/cmd_mapper.go b/src/command/disable/cliadapter/cmd/cmd_mapper.go
@@ -21,7 +21,7 @@ func Command() *cli.Command {
 		Name:  "disable",
 		Usage: "Use default commit template and remove prepare-commit-msg hook",
 		Action: func(c *cli.Context) error {
-			return commandadapter.Run(policy(), disableeventadapter.MapEventToEffectFactory(statuscmdmapper.Policy()))
+			return commandadapter.Run(policy(), disableeventadapter.MapEventToEffectFactory(statuscmdmapper.Policy(false)))
 		},
 	}
 }
diff --git a/src/command/enable/cliadapter/cmd/cmd_mapper.go b/src/command/enable/cliadapter/cmd/cmd_mapper.go
@@ -32,7 +32,7 @@ func Command() *cli.Command {
 		Action: func(c *cli.Context) error {
 			coauthors := c.Args().Slice()
 			useAll := c.Bool("all")
-			return commandadapter.Run(policy(&coauthors, &useAll), enableeventadapter.MapEventToEffectFactory(statuscmdmapper.Policy()))
+			return commandadapter.Run(policy(&coauthors, &useAll), enableeventadapter.MapEventToEffectFactory(statuscmdmapper.Policy(false)))
 		},
 		BashComplete: func(c *cli.Context) {
 			remainingAliases := aliascompletion.NewAliasShellCompletion(gitconfig.NewDataSource()).Complete(c.Args().Slice())
diff --git a/src/command/status/cliadapter/cmd/cmd_mapper.go b/src/command/status/cliadapter/cmd/cmd_mapper.go
@@ -17,19 +17,25 @@ func Command() *cli.Command {
 	return &cli.Command{
 		Name:  "status",
 		Usage: "Print the current status",
+		Flags: []cli.Flag{
+			&cli.BoolFlag{Name: "json", Value: false, Usage: "Display the current status as a JSON formatted struct"},
+		},
 		Action: func(c *cli.Context) error {
-			return commandadapter.Run(Policy(), statuseventadapter.MapEventToEffect)
+			stateAsJson := c.Bool("json")
+
+			return commandadapter.Run(Policy(stateAsJson), statuseventadapter.MapEventToEffect)
 		},
 	}
 }
 
 // Policy the status policy constructor
-func Policy() status.Policy {
+func Policy(stateAsJson bool) status.Policy {
 	return status.Policy{
 		Deps: status.Dependencies{
 			ConfigReader:        config.NewGitconfigDataSource(gitconfig.NewDataSource()),
 			StateReader:         state.NewGitConfigDataSource(gitconfig.NewDataSource()),
 			ActivationValidator: activation.NewGitConfigDataSource(gitconfig.NewDataSource()),
+			StateAsJson:         stateAsJson,
 		},
 	}
 }
diff --git a/src/command/status/cliadapter/event/event_mapper.go b/src/command/status/cliadapter/event/event_mapper.go
@@ -2,6 +2,7 @@ package statuseventadapter
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
 	"sort"
 
@@ -17,6 +18,9 @@ import (
 func MapEventToEffect(event events.Event) effects.Effect {
 	switch evt := event.(type) {
 	case status.StateRetrievalSucceeded:
+		if evt.StateAsJson {
+			return toJson(evt.State)
+		}
 		return effects.NewExitOkMsg(toString(evt.State))
 	case status.StateRetrievalFailed:
 		return effects.NewExitErrMsg(evt.Reason)
@@ -44,3 +48,14 @@ func toString(theState state.State) string {
 
 	return buffer.String()
 }
+
+func toJson(theState state.State) effects.Effect {
+	var buffer bytes.Buffer
+	encoder := json.NewEncoder(&buffer)
+	encoder.SetEscapeHTML(false)
+	err := encoder.Encode(theState)
+	if err != nil {
+		return effects.NewExitErrMsg(err)
+	}
+	return effects.NewExitOkMsg(buffer.String())
+}
diff --git a/src/command/status/events.go b/src/command/status/events.go
@@ -1,12 +1,18 @@
 package status
 
 import (
+	"fmt"
 	state "github.com/hekmekk/git-team/src/shared/state/entity"
 )
 
 // StateRetrievalSucceeded successfully got the current state
 type StateRetrievalSucceeded struct {
-	State state.State
+	State       state.State
+	StateAsJson bool
+}
+
+func (s StateRetrievalSucceeded) String() string {
+	return fmt.Sprintf("%s", s.State)
 }
 
 // StateRetrievalFailed failed to get the current state
diff --git a/src/command/status/policy.go b/src/command/status/policy.go
@@ -15,6 +15,7 @@ type Dependencies struct {
 	StateReader         state.Reader
 	ConfigReader        config.Reader
 	ActivationValidator activation.Validator
+	StateAsJson         bool
 }
 
 // Policy the policy to apply
@@ -37,10 +38,10 @@ func (policy Policy) Apply() events.Event {
 		return StateRetrievalFailed{Reason: fmt.Errorf("failed to get status with activation-scope=%s: not inside a git repository", activationScope)}
 	}
 
-	state, stateRepositoryQueryErr := deps.StateReader.Query(cfg.ActivationScope)
+	retState, stateRepositoryQueryErr := deps.StateReader.Query(cfg.ActivationScope)
 	if stateRepositoryQueryErr != nil {
 		return StateRetrievalFailed{Reason: fmt.Errorf("failed to query current state: %s", stateRepositoryQueryErr)}
 	}
 
-	return StateRetrievalSucceeded{State: state}
+	return StateRetrievalSucceeded{State: retState, StateAsJson: deps.StateAsJson}
 }
diff --git a/src/shared/state/entity/state.go b/src/shared/state/entity/state.go
@@ -9,9 +9,9 @@ const (
 
 // State the state of git-team
 type State struct {
-	Status            teamStatus
-	Coauthors         []string
-	PreviousHooksPath string
+	Status            teamStatus `json:"status"`
+	Coauthors         []string   `json:"coAuthors"`
+	PreviousHooksPath string     `json:"previousHooksPath"`
 }
 
 // NewStateEnabled the constructor for the enabled state

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 ./git-team
 target/
 mocks/
 +.idea/
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ teardown() {`
`72`	`72`	`assert_line "ls: /home/git-team-acceptance-test/.git-team/commit-templates/global/COMMIT_TEMPLATE: No such file or directory"`
`73`	`73`	`}`
`74`	`74`
`75`		`-@test "git-team: (scope: global) disable should treat a previously disabled git-team idempotently" {`
	`75`	`+@test "git-team: (scope: global) disable should treat a previously disabled git-team in an idempotent way" {`
`76`	`76`	`run /usr/local/bin/git-team disable`
`77`	`77`	`assert_success`
`78`	`78`	`assert_line "git-team disabled"`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ teardown() {`
`85`	`85`	`assert_line "ls: /home/git-team-acceptance-test/.git-team/commit-templates/repo-local/$REPO_CHECKSUM: No such file or directory"`
`86`	`86`	`}`
`87`	`87`
`88`		`-@test "git-team: (scope: repo-local) disable should treat a previously disabled git-team idempotently" {`
	`88`	`+@test "git-team: (scope: repo-local) disable should treat a previously disabled git-team in an idempotent way" {`
`89`	`89`	`run /usr/local/bin/git-team disable`
`90`	`90`	`assert_success`
`91`	`91`	`assert_line "git-team disabled"`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ func Command() *cli.Command {`
`21`	`21`	`Name: "disable",`
`22`	`22`	`Usage: "Use default commit template and remove prepare-commit-msg hook",`
`23`	`23`	`Action: func(c *cli.Context) error {`
`24`		`- return commandadapter.Run(policy(), disableeventadapter.MapEventToEffectFactory(statuscmdmapper.Policy()))`
	`24`	`+ return commandadapter.Run(policy(), disableeventadapter.MapEventToEffectFactory(statuscmdmapper.Policy(false)))`
`25`	`25`	`},`
`26`	`26`	`}`
`27`	`27`	`}`