From 112e7f5ac769af35b0262819df66f3aa76cfb937 Mon Sep 17 00:00:00 2001
From: Martin Kysel <code@martinkysel.com>
Date: Thu, 5 Dec 2024 16:44:05 -0500
Subject: [PATCH] Build CLI Docker Image (#307)

Partners might have to run the CLI to export the public key (or generate
it in the first place) and provide it to Ephemera for use in the
`testnet`.

It is not too convenient to download the repo, install go, just to run
the CLI.

Build a docker image instead.

We will eventually need releases here in GH for easy download, and
`homebrew` as well.

The important question is. How should this binary be called?

This should help @jhaaaa with docs.
---
 .github/workflows/build-xmtpd.yml | 18 ++++++++++++++----
 cmd/cli/main.go                   |  9 +++++++++
 dev/cli                           |  2 +-
 dev/docker/Dockerfile-cli         | 28 ++++++++++++++++++++++++++++
 4 files changed, 52 insertions(+), 5 deletions(-)
 create mode 100644 dev/docker/Dockerfile-cli

diff --git a/.github/workflows/build-xmtpd.yml b/.github/workflows/build-xmtpd.yml
index 33f91097..2dacb172 100644
--- a/.github/workflows/build-xmtpd.yml
+++ b/.github/workflows/build-xmtpd.yml
@@ -8,8 +8,12 @@ on:
   workflow_dispatch:
 
 jobs:
+
   push_to_registry:
-    name: Push Docker Image to GitHub Packages
+    strategy:
+      matrix:
+        image: ["xmtpd", "xmtpd-cli"]
+    name: Push Docker Images to GitHub Packages
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -17,7 +21,7 @@ jobs:
     env:
       DOCKER_METADATA_PR_HEAD_SHA: true
     outputs:
-      digest: ${{ steps.push.outputs.digest }}
+      xmtpd_digest: ${{ steps.set_xmtpd_digest.outputs.digest }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -32,7 +36,7 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ghcr.io/xmtp/xmtpd
+          images: ghcr.io/xmtp/${{ matrix.image }}
           tags: |
             type=schedule
             type=ref,event=branch
@@ -51,6 +55,12 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           build-args: "GIT_COMMIT=${{ github.event_name != 'pull_request' && github.sha || github.event.pull_request.head.sha }}"
 
+      - name: Set xmtpd digest output
+        if: ${{ matrix.image == 'xmtpd' }}
+        id: set_xmtpd_digest
+        run: echo "digest=${{ steps.push.outputs.digest }}" >> $GITHUB_OUTPUT
+
+
   deploy:
     name: Deploy new images to infra
     runs-on: ubuntu-latest
@@ -68,5 +78,5 @@ jobs:
           terraform-org: xmtp
           terraform-workspace: testnet
           variable-name: xmtpd_server_docker_image
-          variable-value: "ghcr.io/xmtp/xmtpd@${{ needs.push_to_registry.outputs.digest }}"
+          variable-value: "ghcr.io/xmtp/xmtpd@${{ needs.push_to_registry.outputs.xmtpd_digest }}"
           variable-value-required-prefix: "ghcr.io/xmtp/xmtpd@sha256:"
\ No newline at end of file
diff --git a/cmd/cli/main.go b/cmd/cli/main.go
index 1d286600..adf7e489 100644
--- a/cmd/cli/main.go
+++ b/cmd/cli/main.go
@@ -15,6 +15,8 @@ import (
 	"go.uber.org/zap"
 )
 
+var Commit string = "unknown"
+
 type globalOptions struct {
 	Contracts config.ContractsOptions `group:"Contracts Options" namespace:"contracts"`
 	Log       config.LogOptions       `group:"Log Options"       namespace:"log"`
@@ -264,6 +266,13 @@ func updateAddress(logger *zap.Logger, options *CLI) {
 }
 
 func main() {
+	for _, arg := range os.Args[1:] {
+		if arg == "-v" || arg == "--version" {
+			fmt.Printf("Version: %s\n", Commit)
+			return
+		}
+	}
+
 	options, err := parseOptions(os.Args[1:])
 	if err != nil {
 		log.Fatalf("Could not parse options: %s", err)
diff --git a/dev/cli b/dev/cli
index 2f7b5d0a..d20abd37 100755
--- a/dev/cli
+++ b/dev/cli
@@ -2,4 +2,4 @@
 
 set -eu
 
-go run cmd/cli/main.go "$@"
\ No newline at end of file
+go run -ldflags="-X main.Commit=$(git rev-parse HEAD)" cmd/cli/main.go "$@"
\ No newline at end of file
diff --git a/dev/docker/Dockerfile-cli b/dev/docker/Dockerfile-cli
new file mode 100644
index 00000000..9e3a970b
--- /dev/null
+++ b/dev/docker/Dockerfile-cli
@@ -0,0 +1,28 @@
+# BUILD IMAGE --------------------------------------------------------
+ARG GO_VERSION=1.22
+FROM golang:${GO_VERSION}-alpine AS builder
+
+# Get build tools and required header files
+RUN apk add --no-cache build-base
+
+WORKDIR /app
+COPY . .
+
+# Build the final node binary
+ARG GIT_COMMIT=unknown
+RUN go build -ldflags="-X 'main.Commit=$GIT_COMMIT'" -o bin/xmtpd-cli cmd/cli/main.go
+
+# ACTUAL IMAGE -------------------------------------------------------
+
+FROM alpine:3.12
+
+LABEL maintainer="engineering@xmtp.com"
+LABEL source="https://github.com/xmtp/xmtpd"
+LABEL description="XMTPD CLI"
+
+# color, nocolor, json
+ENV GOLOG_LOG_FMT=nocolor
+
+COPY --from=builder /app/bin/xmtpd-cli /usr/bin/
+
+ENTRYPOINT ["/usr/bin/xmtpd-cli"]