From d44e19d22b15996805b8942e4f0672c1075fbbbe Mon Sep 17 00:00:00 2001
From: tangowithfoxtrot <5676771+tangowithfoxtrot@users.noreply.github.com>
Date: Thu, 22 Feb 2024 09:09:08 -0800
Subject: [PATCH] add documentation and build script for Go wrapper

---
 languages/go/README.md |  4 ++++
 languages/go/build.sh  | 44 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)
 create mode 100644 languages/go/build.sh

diff --git a/languages/go/README.md b/languages/go/README.md
index cea02e282..8bafdafee 100644
--- a/languages/go/README.md
+++ b/languages/go/README.md
@@ -8,6 +8,10 @@ managing projects and secrets, as well as a client interface to facilitate opera
 - Go installed
 - C environment to run CGO
 
+## Building the SDK
+
+`cargo` and `npm` are required to build the SDK. To build, run the `./build.sh` script.
+
 ## Installation
 
 Download the SDK files and place them in your Go project directory.
diff --git a/languages/go/build.sh b/languages/go/build.sh
new file mode 100644
index 000000000..26284f579
--- /dev/null
+++ b/languages/go/build.sh
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+check_command() {
+  if ! command -v "$1" &>/dev/null; then
+    printf '%s\n' "$1 is required to build locally. Please install $2."
+    exit 1
+  fi
+}
+
+check_command cargo Rust
+check_command go Go
+check_command npm Node.js
+
+REPO_ROOT="$(git rev-parse --show-toplevel)"
+GO_LIB_DIR="$REPO_ROOT/languages/go/internal/cinterface/lib"
+
+pushd "$REPO_ROOT" || exit 1
+printf '%s\n\n' "Cleaning old builds..."
+rm -f languages/go/example/example && rm -rf "$GO_LIB_DIR"
+
+printf '%s\n\n' "Building binaries..."
+cargo build
+npm run schemas
+
+printf '%s\n\n' "Copying Go bindings to $GO_LIB_DIR..."
+mkdir -p "$GO_LIB_DIR"
+find target/debug -maxdepth 1 -type f -name "libbitwarden_c.*" -exec cp {} "$GO_LIB_DIR"/ \;
+
+printf '%s\n\n' "Build complete!"
+printf '%s\n' "To run the Go example, set the following environment variables:
+  export API_URL=\"http://localhost:4000\" # your Bitwarden API URL
+  export IDENTITY_URL=\"http://localhost:33656\" # your Bitwarden Identity URL
+  export ACCESS_TOKEN=\"your-access-token\" # your Bitwarden access token
+  export STATE_PATH=\"your-absolute-path\" # the absolute path to your state file
+  export ORGANIZATION_ID=\"your-org-id\" # your Bitwarden organization ID
+  export PROJECT_NAME=\"your-project-name\" # an arbitrary project name
+"
+
+printf '%s\n' "Then, run the example with:
+  pushd $REPO_ROOT/languages/go/example
+  go mod tidy
+  go run example.go
+  popd
+"