Refactor and write unit tests

Author: cbullinger

.github/workflows/test-go-sdk.yml

@@ -0,0 +1,14 @@
+# name: CI
+# on: [push, pull_request]
+# jobs:
+#   test:
+#     runs-on: ubuntu-latest
+#     steps:
+#         - name: Checkout code
+#           uses: actions/checkout@v4
+#         - name: Set up Go
+#           uses: actions/setup-go@v5
+#           with:
+#             go-version-file: go.mod
+#         - name: Test
+#           run: go test

usage-examples/go/atlas-sdk-go/bluehawk/copy.sh renamed to usage-examples/go/atlas-sdk-go/.bluehawk/copy.sh

@@ -9,12 +9,12 @@ PROJECT=$(git rev-parse --show-toplevel)
 INPUT_DIR="$PROJECT/usage-examples/go/atlas-sdk-go/"
 OUTPUT_DIR="$PROJECT/generated-usage-examples/go/atlas-sdk-go/project-copy/"
 
-# Set ignored internal files and directories
+# Set directories and files to ignore
 IGNORE=(
   "README.md"
   "bluehawk/"
   "tests/"
-  ".env"
+  ".*"
   "*.gz"
   "*.log"
 )
@@ -23,8 +23,18 @@ for path in "${IGNORE[@]}"; do
   IGNORE_ARGS+=("--ignore=$path")
 done
 
+# Set directories and files to rename
+RENAME=(
+  "REPO_README.md:README.md"
+)
+RENAME_ARGS=()
+for path in "${RENAME[@]}"; do
+  IFS=":" read -r src dst <<< "$path" # Split the path into source and destination
+  RENAME_ARGS+=("--rename=$src:$dst") # Add the rename argument to the array
+done
+
 # Run Bluehawk copy command, passing all ignore args and "copy" state
-bluehawk copy \
+.bluehawk copy \
   "${IGNORE_ARGS[@]}" \
   --state copy \
   -o "$OUTPUT_DIR" \

usage-examples/go/atlas-sdk-go/bluehawk/snip.sh renamed to usage-examples/go/atlas-sdk-go/.bluehawk/snip.sh

@@ -5,11 +5,11 @@ PROJECT=$(git rev-parse --show-toplevel)
 GO_SDK_EXAMPLES="$PROJECT/usage-examples/go/atlas-sdk-go/"
 GENERATED_EXAMPLES="$PROJECT/generated-usage-examples/go/atlas-sdk-go/usage-examples/"
 
-# ——— helper: run bluehawk and only show the key lines ———
+# ——— helper: run .bluehawk and only show the key lines ———
 run_snip() {
   local extra_flags="$1"
   local label="$2"
-  local dst="$GENERATED_EXAMPLES"
+  local dest="$GENERATED_EXAMPLES"
 
   echo "→ $label"
   npx bluehawk snip "$GO_SDK_EXAMPLES" -o "$GENERATED_EXAMPLES"
@@ -18,9 +18,9 @@ run_snip() {
 run_snip "" "Global snippets"
 
 # ——— 2) state‑specific snippets ———
-read -p "Do you have any state tags to enter? [y/N]: " resp
+read -r -p "Do you have any state tags to enter? [y/N]: " resp
 if [[ $resp =~ ^[Yy]$ ]]; then
-  read -a STATES -p "Enter one or more state tags (space‑separated): "
+  read -r -a STATES -p "Enter one or more state tags (space‑separated): "
   for s in "${STATES[@]}"; do
     run_snip "--state $s" "State: $s"
   done

usage-examples/go/atlas-sdk-go/README.md

@@ -1,44 +1,40 @@
-[//]: # (.. Don't Copy to Target Repo )
 # Atlas SDK for Go
 
-This project demonstrates how to script specific functionality using the Atlas SDK for Go. Code examples are included in the Atlas Architecture Center docs and available in a user-facing version of the project. 
-
-- Generated usage examples, which are included directly in the docs
-- Within a 
+This project demonstrates how to script specific functionality using the Atlas
+SDK for Go. Code examples are used in the Atlas Architecture Center docs, and
+the project is made available in a user-facing repo.
 
 ## Project Structure
 ```text
 atlas-sdk-go/
-│── bluehawk/             # Bluehawk scripts to snip and copy code examples
-│   ├── copy.sh  
-│   ├── snip.sh  
 │── cmd/                  # Self-contained, runnable scripts
 │   ├── get_logs/  
 │       ├── main.go             
-│   ├── get_metrics/ 
-│       ├── dev/ 
-│           ├── main.go            
-│       ├── prod/    
-│           ├── main.go         
+│   ├── get_metrics_disk/
+│       ├── main.go
+│   ├── get_metrics_process/
+│       ├── main.go
 │── config/                # Atlas configuration settings
 │   ├── config.json             
 │── internal/              # Shared internal logic
-    │── auth/              
-        ├── auth.go                   
-│   ├── config_loader.go        
-│   ├── secrets_loader.go       
+│   ├── auth/
+|       ├── client.go
+│   ├── config/
+|       ├── json.go
+|       ├── secrets.go
+|       ├── loader.go
 │── .env                   # Secrets file (excluded from Git)
 │── go.mod                     
 │── go.sum                           
-│── README.md              # Internal-only README (do not copy)         
+│── README.md              # Internal-only README (do not copy with Copier Tool)
+│── scripts/               # Internal-only Bluehawk scripts to snip and copy code examples
+│   ├── bluehawk.sh
 ```
 
 ## Runnable Scripts
-You can run individual scripts using `run_cmd.sh` and specifying the script's action (i.e. the parent directory for the `main.go` you want to run). 
-
-For example, to run `get_logs/main.go`:
+You can run individual scripts from the terminal. For example, to run `get_logs/main.go`:
 ```shell
-./run_cmd.sh get_logs
+go run cmd/get_logs/main.go
 ```
 
 ## Set up 
@@ -47,9 +43,11 @@ For example, to run `get_logs/main.go`:
 
 - A [service account](https://www.mongodb.com/docs/atlas/api/service-accounts-overview/#std-label-service-accounts-overview) with access to your Atlas project
 
+> **NOTE:** Some scripts require an M10+ cluster
+
 ### Set environment variables and config file
 
-1. Set the following variable values, either as a `.env` file in the root directory or through your IDE
+1. Set the following variable values, either as a `.env` file in the root directory or through your IDE:
     ```shell
     MONGODB_ATLAS_SERVICE_ACCOUNT_ID=your-service-account-id
     MONGODB_ATLAS_SERVICE_ACCOUNT_SECRET=your-service-account-secret
@@ -67,54 +65,26 @@ For example, to run `get_logs/main.go`:
    }
     ```
     > **NOTE: Group ID == Project ID** Groups and projects are synonymous terms. Groups and projects are synonymous terms. Your group id is the same as your project id. 
-3. 
+
+## Write Tests
+
+# TODO
 
 ## Generate Examples
 
-### Generate code usage examples for docs
-This project uses the following Bluehawk commands to generate the code examples:
+This project uses Bluehawk to generate code examples from the source code.
 
-- Usage examples for the docs. These are generated using the `bluehawk snip` command based on the `snippet` markup in the code file.
-  ```shell
-   ./bluehawk/snip.sh
-   ```
+- Usage examples for the docs. These are generated using the `bluehawk snip`
+  command based on the `snippet` markup in the code file.
+- Full project files for the user-facing project repo. These are generated using
+  the `bluehawk copy` command.
 
-### Copy project files for user-facing project repo
+Run the bluehawk script and enter either `snip` or `copy`. The selected command
+runs with the defined defaults.
 
-To copy the full project files for the user-facing artifact repo. These are generated using the `bluehawk copy` command, and any specified files are ignored.
   ```shell
-   ./bluehawk/copy.sh
+   ./scripts/bluehawk.sh
    ```
 
 > **NOTE: "Copy" State** This project uses a state named "copy" specifically for any manipulations needed for code copied to the artifact repo. 
 
-## Copy Generated Examples to Other Repos
-
-
-
----
-scratchpad:
-- manually test against real infra
-- pull the real data
-
-PR Push > run on captured data
-& scheduled job to validate? (or bump our sdk version along with the v release &
-verify; fix any failing test)
-- run the gh action locally
----
-1. go sdk testing
-2. atlas testing
-
-we'd need to be notified when either change
-we can test sdk automatically with the captured data
-
-periodic manual validation step to test the infra side
-- release cadence for sdk > gh
-- release cadence for atlas/infra > server version? api update?
----
-arch center docs versioning considerations
-- how to keep arch center version in sync with code example version updates?
----
-snippets in generated-examples > push to arch center repo to use in docs?
----
-narrating out loud the next step?

usage-examples/go/atlas-sdk-go/REPO_README.md

@@ -0,0 +1,51 @@
+# MongoDB Atlas Architecture Center Go SDK Code Examples
+
+This repository contains [Atlas Go SDK](https://www.mongodb.com/docs/atlas/sdk/)
+code examples that follow recommendations in MongoDB's official
+[Atlas Architecture Center documentation](https://www.mongodb.com/docs/atlas/architecture/current/).
+You can run, download, and modify these code examples as starting points for
+configuring your MongoDB Atlas architecture for your use case.
+
+## Overview
+
+### Project Structure
+
+```text
+Project Root  
+├── cmd  
+│   ├── get_logs/main.go  
+│   ├── get_metrics_disk/main.go  
+│   ├── get_metrics_process/main.go  
+├── internal  
+│   ├── auth  
+│   │   ├── auth.go  
+│   ├── logs  
+│   │   ├── downloader.go  
+│   ├── metrics  
+│   │   ├── metrics.go  
+├── go.mod  
+├── go.sum  
+├── configs  
+│   ├── config.json 
+├── .env        #             
+```
+
+> NOTE: In a production environment, you are likely to use 
+
+note in the README that you'll most likely be using a secrets manager in prod
+## License
+
+This project is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+## Issues
+
+To report an issue with any of these code examples, please leave feedback
+through the corresponding documentation page in the
+[MongoDB Atlas Architecture Center](https://www.mongodb.com/docs/atlas/architecture/current/).
+Using the `Rate This Page` button, you can add a comment about the issue after
+leaving a star rating.
+
+## Contributing
+
+We are not currently accepting public contributions to this repository at this
+time.****