Merge pull request #34 from WilliamK112/agent/fabricopsctl-version

Add fabricopsctl version command

Author: dpereowei

.github/workflows/release.yml

@@ -100,7 +100,8 @@ jobs:
       - name: Build binaries
         run: |
           make build
-          make build-fabricopsctl
+          make build-fabricopsctl-release VERSION="${VERSION}"
+          test "$(bin/fabricopsctl version)" = "fabricopsctl ${VERSION}"
 
       - name: Build release artifacts
         run: |

.github/workflows/test.yml

@@ -32,5 +32,10 @@ jobs:
         run: |
           make test
 
+      - name: Verify fabricopsctl release version
+        run: |
+          make build-fabricopsctl-release VERSION=1.2.3
+          test "$(bin/fabricopsctl version)" = "fabricopsctl 1.2.3"
+
       - name: Verify generated files are committed
         run: git diff --exit-code

Makefile

@@ -6,6 +6,8 @@ IMAGE_REGISTRY ?= ghcr.io/lf-decentralized-trust-labs
 IMAGE_REPOSITORY ?= fabricops
 VERSION ?= 0.2.0
 RELEASE_IMG ?= $(IMAGE_REGISTRY)/$(IMAGE_REPOSITORY):$(VERSION)
+FABRICOPSCTL_VERSION ?= development
+FABRICOPSCTL_LDFLAGS ?= -X main.version=$(FABRICOPSCTL_VERSION)
 SAMPLE_CHAINCODE_IMAGES ?= $(IMAGE_REGISTRY)/fabricops-node-settlement:$(VERSION) $(IMAGE_REGISTRY)/fabricops-go-settlement:$(VERSION) $(IMAGE_REGISTRY)/fabricops-java-settlement:$(VERSION)
 RELEASE_CHECK_IMAGES ?= $(RELEASE_IMG) $(SAMPLE_CHAINCODE_IMAGES)
 # YEAR defines the year value used for substituting the YEAR placeholder in the boilerplate header.
@@ -177,7 +179,11 @@ build: manifests generate fmt vet ## Build manager binary.
 
 .PHONY: build-fabricopsctl
 build-fabricopsctl: fmt vet ## Build fabricopsctl helper binary.
-	go build -o bin/fabricopsctl ./cmd/fabricopsctl
+	go build -ldflags "$(FABRICOPSCTL_LDFLAGS)" -o bin/fabricopsctl ./cmd/fabricopsctl
+
+.PHONY: build-fabricopsctl-release
+build-fabricopsctl-release: ## Build fabricopsctl with VERSION embedded for a release.
+	$(MAKE) build-fabricopsctl FABRICOPSCTL_VERSION=$(VERSION)
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.

README.md

@@ -115,6 +115,7 @@ Install the CLI with Go:
 ```bash
 go install github.com/LF-Decentralized-Trust-labs/FabricOps/cmd/fabricopsctl@latest
 export PATH="$(go env GOPATH)/bin:$PATH"
+fabricopsctl version
 fabricopsctl status -n default fabricnetwork-sample
 fabricopsctl wait -n default --timeout 20m fabricnetwork-sample
 fabricopsctl status --participant -n default bankb-participant
@@ -143,6 +144,7 @@ When building from source:
 
 ```bash
 make build-fabricopsctl
+bin/fabricopsctl version
 bin/fabricopsctl status -n default fabricnetwork-sample
 bin/fabricopsctl wait -n default --timeout 20m fabricnetwork-sample
 bin/fabricopsctl status --participant -n default bankb-participant
@@ -162,6 +164,10 @@ bin/fabricopsctl query --participant -n default --org BankB \
   --args '["settlement-001"]' bankb-participant
 ```
 
+Local source builds report `fabricopsctl development`. Release builds use
+`make build-fabricopsctl-release VERSION=<version>` to inject the release
+version into the binary with Go linker flags.
+
 Tools that render or apply FabricOps resources, including a future Fablo
 Kubernetes engine, can use the same CLI surface after applying the
 `FabricNetwork` or `FabricParticipant`: `wait` for readiness or a named
@@ -398,6 +404,9 @@ generates `install.yaml` and the Helm chart package, verifies GHCR public
 visibility, commits the release-prep changes, tags the commit, and creates the
 GitHub release with the generated assets.
 
+The workflow also builds `fabricopsctl` with the release version embedded and
+verifies the binary through the normal build gate.
+
 The local release helpers remain useful for debugging individual steps. For
 example:
 

cmd/fabricopsctl/main.go

@@ -40,9 +40,10 @@ import (
 )
 
 const (
-	defaultNamespace = "default"
-	defaultWaitFor   = "condition=Ready"
-	defaultCondition = "Ready"
+	defaultNamespace   = "default"
+	defaultWaitFor     = "condition=Ready"
+	defaultCondition   = "Ready"
+	developmentVersion = "development"
 
 	connectionProfileJSONKey = "connection.json"
 	connectionProfileYAMLKey = "connection.yaml"
@@ -51,6 +52,7 @@ const (
 var (
 	errUsage  = errors.New("usage error")
 	cliScheme = runtime.NewScheme()
+	version   = developmentVersion
 )
 
 func init() {
@@ -83,6 +85,8 @@ func run(args []string, stdout, stderr io.Writer) error {
 	case "help", "-h", "--help":
 		printUsage(stdout)
 		return nil
+	case "version":
+		return runVersion(args[1:], stdout, stderr)
 	case "status":
 		return runStatus(args[1:], stdout, stderr)
 	case "wait":
@@ -101,6 +105,15 @@ func run(args []string, stdout, stderr io.Writer) error {
 	}
 }
 
+func runVersion(args []string, stdout, stderr io.Writer) error {
+	if len(args) != 0 {
+		printLine(stderr, "Usage: fabricopsctl version")
+		return errUsage
+	}
+	printf(stdout, "fabricopsctl %s\n", version)
+	return nil
+}
+
 func runStatus(args []string, stdout, stderr io.Writer) error {
 	var kube kubeOptions
 	var output string
@@ -856,6 +869,7 @@ func printLine(out io.Writer, args ...any) {
 
 func printUsage(out io.Writer) {
 	printLine(out, `Usage:
+  fabricopsctl version
   fabricopsctl status [flags] <fabricnetwork>
   fabricopsctl status --participant [flags] <fabricparticipant>
   fabricopsctl wait [flags] <fabricnetwork>
@@ -878,6 +892,7 @@ Common flags:
       --context string     Kubeconfig context override
 
 Examples:
+  fabricopsctl version
   fabricopsctl status fabricnetwork-sample
   fabricopsctl status --participant bankb-participant
   fabricopsctl status -n default -o json fabricnetwork-sample

cmd/fabricopsctl/main_test.go

@@ -29,6 +29,63 @@ import (
 	fabricopsv1alpha1 "github.com/LF-Decentralized-Trust-labs/FabricOps/api/v1alpha1"
 )
 
+func TestRunVersionPrintsDevelopmentVersion(t *testing.T) {
+	var stdout, stderr bytes.Buffer
+	if err := run([]string{"version"}, &stdout, &stderr); err != nil {
+		t.Fatalf("run(version) error = %v", err)
+	}
+	if got, want := strings.TrimSpace(stdout.String()), "fabricopsctl development"; got != want {
+		t.Fatalf("stdout = %q, want %q", got, want)
+	}
+	if stderr.Len() != 0 {
+		t.Fatalf("stderr = %q, want empty", stderr.String())
+	}
+}
+
+func TestRunVersionPrintsInjectedVersion(t *testing.T) {
+	originalVersion := version
+	t.Cleanup(func() { version = originalVersion })
+	version = "0.2.0"
+
+	var stdout, stderr bytes.Buffer
+	if err := run([]string{"version"}, &stdout, &stderr); err != nil {
+		t.Fatalf("run(version) error = %v", err)
+	}
+	if got, want := strings.TrimSpace(stdout.String()), "fabricopsctl 0.2.0"; got != want {
+		t.Fatalf("stdout = %q, want %q", got, want)
+	}
+	if stderr.Len() != 0 {
+		t.Fatalf("stderr = %q, want empty", stderr.String())
+	}
+}
+
+func TestRunVersionRejectsArguments(t *testing.T) {
+	var stdout, stderr bytes.Buffer
+	err := run([]string{"version", "extra"}, &stdout, &stderr)
+	if !errors.Is(err, errUsage) {
+		t.Fatalf("run(version extra) error = %v, want errUsage", err)
+	}
+	if stdout.Len() != 0 {
+		t.Fatalf("stdout = %q, want empty", stdout.String())
+	}
+	if got, want := strings.TrimSpace(stderr.String()), "Usage: fabricopsctl version"; got != want {
+		t.Fatalf("stderr = %q, want %q", got, want)
+	}
+}
+
+func TestHelpListsVersionCommand(t *testing.T) {
+	var stdout, stderr bytes.Buffer
+	if err := run([]string{"--help"}, &stdout, &stderr); err != nil {
+		t.Fatalf("run(--help) error = %v", err)
+	}
+	if !strings.Contains(stdout.String(), "fabricopsctl version") {
+		t.Fatalf("stdout does not list version command:\n%s", stdout.String())
+	}
+	if stderr.Len() != 0 {
+		t.Fatalf("stderr = %q, want empty", stderr.String())
+	}
+}
+
 func TestWaitForFabricNetworkReadyReturnsOnReadyCondition(t *testing.T) {
 	var stdout, stderr bytes.Buffer
 	err := waitForFabricNetworkReady(

docs/first-release-checklist.md

@@ -16,6 +16,7 @@ The workflow performs these release gates:
 - Validate the release tag and ensure the release does not already exist.
 - Update release-version files.
 - Run Go module tidy verification, unit/envtest tests, lint, and binary builds.
+- Build `fabricopsctl` with the release version embedded through Go linker flags.
 - Build and push the multi-platform manager image.
 - Build and push sample chaincode images.
 - Build `dist/install.yaml` and `dist/fabricops-<version>.tgz`.
@@ -26,6 +27,15 @@ The workflow performs these release gates:
 The commands below mirror the automated workflow and are useful for local
 debugging or release dry runs.
 
+## Verify The CLI Version
+
+Build the CLI with the same linker-injected version used by the release workflow:
+
+```bash
+make build-fabricopsctl-release VERSION=0.2.0
+test "$(bin/fabricopsctl version)" = "fabricopsctl 0.2.0"
+```
+
 ## Build And Publish Images
 
 ```bash