feat: add version cmd

.gitignore

@@ -86,3 +86,6 @@ Temporary Items
 # local build folders
 istio-1.22.0/
 kontrol-service/Run_kontrol_service
+
+# Ignoring the file that gets generated with the repo's version
+/kardinal_version/kardinal_version.go

flake.nix

@@ -87,6 +87,19 @@
               };
           };
 
+        generateKardinalVersion = pkgs.callPackage ./kardinal-cli/scripts/generate_kardinal_version.nix {
+          inherit pkgs;
+        };
+
+        runGenerateVersion = pkgs.stdenv.mkDerivation {
+          name = "run-generate-kardinal-version";
+          buildInputs = [ generateKardinalVersion ];
+          installPhase = ''
+            echo "Generating kardinal_version.go..."
+            ${generateKardinalVersion}/bin/generate-kardinal-version
+          '';
+        };
+
         systemOutput = rec {
           devShells.default = pkgs.callPackage ./shell.nix {
             inherit pkgs;
@@ -110,6 +123,7 @@
           packages.go-tidy-all = pkgs.callPackage ./scripts/go-tidy-all.nix {
             inherit pkgs;
           };
+          packages.generate-kardinal-version = runGenerateVersion;
 
           containers = let
             os = "linux";

go.work

@@ -6,4 +6,5 @@ use (
 	./libs/cli-kontrol-api
 	./kardinal-cli
 	./sidecars/redis-overlay-service
+	./kardinal_version
 )

kardinal-cli/cmd/root.go

@@ -32,6 +32,7 @@ import (
 	"kardinal.cli/kontrol"
 	"kardinal.cli/tenant"
 
+	"github.com/kurtosis-tech/kardinal/kardinal_version"
 	api "github.com/kurtosis-tech/kardinal/libs/cli-kontrol-api/api/golang/client"
 	api_types "github.com/kurtosis-tech/kardinal/libs/cli-kontrol-api/api/golang/types"
 	appv1 "k8s.io/api/apps/v1"
@@ -622,6 +623,15 @@ var tenantShowCmd = &cobra.Command{
 	},
 }
 
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Show version of Kardinal CLI running",
+	Args:  cobra.ExactArgs(0),
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("%s\n", kardinal_version.KardinalVersion)
+	},
+}
+
 func init() {
 	devMode = false
 	if os.Getenv("KARDINAL_CLI_DEV_MODE") == "TRUE" {
@@ -637,6 +647,7 @@ func init() {
 	rootCmd.AddCommand(reportInstall)
 	rootCmd.AddCommand(topologyCmd)
 	rootCmd.AddCommand(tenantCmd)
+	rootCmd.AddCommand(versionCmd)
 
 	flowCmd.AddCommand(listCmd, createCmd, deleteCmd, telepresenceInterceptCmd)
 	managerCmd.AddCommand(deployManagerCmd, removeManagerCmd)

kardinal-cli/default.nix

@@ -1,20 +1,28 @@
 {
-  pkgs,
-  commit_hash ? "dirty",
+    pkgs,
+    commit_hash ? "dirty"
 }: let
   pname = "kardinal.cli";
+
+  generateKardinalVersion = pkgs.callPackage ./scripts/generate_kardinal_version.nix {
+    inherit pkgs;
+  };
+  _ = pkgs.runCommand "generate-version" {
+    buildInputs = [ generateKardinalVersion ];
+  };
+
   ldflags = pkgs.lib.concatStringsSep "\n" [
     "-X github.com/kurtosis-tech/kurtosis/kardinal.AppName=${pname}"
     "-X github.com/kurtosis-tech/kurtosis/kardinal.Commit=${commit_hash}"
   ];
 in
   pkgs.buildGoApplication {
     # pname has to match the location (folder) where the main function is or use
-    # subPackges to specify the file (e.g. subPackages = ["some/folder/main.go"];)
+    # subPackages to specify the file (e.g. subPackages = ["some/folder/main.go"];)
     inherit pname ldflags;
     name = "${pname}";
     pwd = ./.;
     src = ./.;
     modules = ./gomod2nix.toml;
     CGO_ENABLED = 0;
-  }
+  }

kardinal-cli/go.mod

@@ -1,14 +1,16 @@
 module kardinal.cli
 
-go 1.22.0
+go 1.22.3
 
-toolchain go1.22.3
-
-replace github.com/kurtosis-tech/kardinal/libs/cli-kontrol-api => ../libs/cli-kontrol-api
+replace (
+	github.com/kurtosis-tech/kardinal/kardinal_version => ../kardinal_version
+	github.com/kurtosis-tech/kardinal/libs/cli-kontrol-api => ../libs/cli-kontrol-api
+)
 
 require (
 	github.com/adrg/xdg v0.4.0
 	github.com/google/uuid v1.6.0
+	github.com/kurtosis-tech/kardinal/kardinal_version v0.0.0-00010101000000-000000000000
 	github.com/kurtosis-tech/stacktrace v0.0.0-20211028211901-1c67a77b5409
 	github.com/samber/lo v1.46.0
 	github.com/segmentio/analytics-go/v3 v3.3.0

kardinal-cli/scripts/generate_kardinal_version.nix

@@ -0,0 +1,37 @@
+{ pkgs, ... }:
+pkgs.writeShellApplication {
+  name = "generate-kardinal-version";
+  runtimeInputs = with pkgs; [ git ];
+
+  text = ''
+    set -euo pipefail
+    root_dirpath=$(git rev-parse --show-toplevel)
+
+    KARDINAL_VERSION_PACKAGE_DIR="kardinal_version"
+    KARDINAL_VERSION_GO_FILE="kardinal_version.go"
+
+    # Check if the current commit has a tag
+    if git describe --tags --exact-match > /dev/null 2>&1; then
+        # If there's an exact match to a tag, use the tag as the version
+        new_version="$(git describe --tags --exact-match)"
+    else
+        # Otherwise, use the short commit SHA
+        commit_sha="$(git rev-parse --short=6 HEAD)"
+        # Check if the working directory is dirty
+        suffix="$(git diff --quiet || echo '-dirty')"
+        new_version="$commit_sha$suffix"
+    fi
+
+    kardinal_version_go_file_abs_path="$root_dirpath/$KARDINAL_VERSION_PACKAGE_DIR/$KARDINAL_VERSION_GO_FILE"
+
+    cat << EOF > "$kardinal_version_go_file_abs_path"
+package $KARDINAL_VERSION_PACKAGE_DIR
+
+const (
+    // !!!!!!!!!!!!!!!!!! DO NOT MODIFY THIS! IT WILL BE UPDATED AUTOMATICALLY DURING THE BUILD PROCESS !!!!!!!!!!!!!!!
+    KardinalVersion = "$new_version"
+    // !!!!!!!!!!!!!!!!!! DO NOT MODIFY THIS! IT WILL BE UPDATED AUTOMATICALLY DURING THE BUILD PROCESS !!!!!!!!!!!!!!!
+)
+EOF
+  '';
+}

kardinal_version/go.mod

@@ -0,0 +1,3 @@
+module github.com/kurtosis-tech/kardinal/kardinal_version
+
+go 1.22.3

shell.nix

@@ -12,7 +12,7 @@
   '';
 
   go-tidy-all = import ./scripts/go-tidy-all.nix {inherit pkgs;};
-
+  generate-kardinal-version = import ./kardinal-cli/scripts/generate_kardinal_version.nix {inherit pkgs;};
   manager_shell = pkgs.callPackage ./kardinal-manager/shell.nix {inherit pkgs;};
   cli_shell = pkgs.callPackage ./kardinal-cli/shell.nix {inherit pkgs;};
   cli_kontrol_api_shell = pkgs.callPackage ./libs/cli-kontrol-api/shell.nix {inherit pkgs;};
@@ -25,6 +25,7 @@
       buildInputs = [
         kardinal
         go-tidy-all
+        generate-kardinal-version
         kubectl
         kustomize
         kubernetes-helm