feat(qa-script): adds qa scripts for mac (arm) developers #1602

ale8k · 2025-05-19T14:01:12Z

There are two scripts. qa-lxd-mac and qa-lxd-mac-forward.sh. The first spins up a multipass VM, runs jimm within compose inside and adds a controller. The second port-forwards JIMM and keycloak, and is expected to be run AFTER qa-lxd-mac, such that you can connect and QA. The VM has a volume mount and changes will be reflected and updated from the hosts jimm repo.

This needs QA'ing on a mac before merging. I will update the PR once this has been done.

The exact steps for running this are simple.

Clone jimm
cd to ./local/jimm
Run ./qa-lxd-mac.sh

And that should be enough to get anybody up and running. I've also added a linux option, for anybody who wishes to run the QA of JIMM within a VM.

There are two scripts. qa-lxd-mac and qa-lxd-mac-forward.sh. The first spins up a multipass VM, runs jimm within compose inside and adds a controller. The second port-forwards JIMM and keycloak, and is expected to be run AFTER qa-lxd-mac, such that you can connect and QA. The VM has a volume mount and changes will be reflected and updated from the hosts jimm repo.

Copilot

Pull Request Overview

This pull request adds two QA scripts for Mac (and Linux) developers, designed to easily set up a multipass VM running JIMM with port-forwarding for keycloak.

qa-lxd-mac.sh spins up a multipass VM, configures mounts, installs dependencies, and sets up the JIMM environment.
qa-lxd-mac-forward.sh sets up SSH tunnels for JIMM and keycloak thereby enabling local connections.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
local/jimm/qa-lxd-mac.sh	Creates a multipass VM and configures the JIMM environment.
local/jimm/qa-lxd-mac-forward.sh	Forwards SSH tunnels for keycloak and JIMM based on specified OS flags.

Comments suppressed due to low confidence (2)

local/jimm/qa-lxd-mac-forward.sh:51

The variable '$KEY' is undefined; consider replacing it with '$KEY_PATH' to ensure the correct SSH key path is used.

if [ ! -f "$KEY" ]; then

local/jimm/qa-lxd-mac-forward.sh:61

Replace '$KEY' with '$KEY_PATH' for consistency when echoing the key path being used.

echo "Using SSH key: $KEY"

Copilot · 2025-05-19T14:14:07Z

local/jimm/qa-lxd-mac.sh

+
+echo "Installing & setting up dependencies"
+multipass exec $VM_NAME -- sudo snap install juju
+multipass exec $VM_NAME -- sudo sudo apt-get -y install make


Remove the duplicate 'sudo' to improve command clarity.

Suggested change

multipass exec $VM_NAME -- sudo sudo apt-get -y install make

multipass exec $VM_NAME -- sudo apt-get -y install make

kian99

Looks good overall, just some minor comments

kian99 · 2025-05-19T15:17:37Z

local/jimm/qa-lxd-mac-forward.sh

+
+echo "Copying ssh key to local"
+KEY_COPIED_PATH="../../local/vm/id_rsa"
+if [ ! -f "$KEY" ]; then


Should this be

Suggested change

if [ ! -f "$KEY" ]; then

if [ ! -f "$KEY_COPIED_PATH" ]; then

? Or are you trying to allow the user to provide a key via an env var?

Yes! Good spot

kian99 · 2025-05-19T15:24:23Z

local/jimm/qa-lxd-mac.sh

+# We want a classic mount to reflect changes on the host to the VM.
+echo "Setting up classic mount"
+multipass umount jimm jimm || true
+multipass mount --type=classic ../../ jimm:jimm || true 


Why the || true? If it fails wouldn't the rest of the script fail to work?

I want the script to continue even if this fails

local/jimm/qa-lxd-mac.sh

kian99 · 2025-05-19T15:26:20Z

local/jimm/qa-lxd-mac.sh

+multipass exec --working-directory /home/ubuntu/jimm/local/traefik/certs $VM_NAME -- sudo update-ca-certificates
+multipass exec --working-directory /home/ubuntu/jimm $VM_NAME -- make version/commit.txt
+multipass exec --working-directory /home/ubuntu/jimm $VM_NAME -- make version/version.txt
+# TODO(ale8k): Have docker cache images somewhere that can be shared, the compose takes forever otherwise.


Usually what takes longest is pulling all JIMM dependencies (Juju and others) and then building.

Honestly the pulling of images was slowest for me.

kian99 · 2025-05-19T15:27:10Z

local/jimm/qa-lxd-mac.sh

+multipass exec --working-directory /home/ubuntu/jimm $VM_NAME -- docker compose --profile dev up --wait -d 
+
+echo "Building JAAS CLI"
+$(cd  ../../ && go build ./cmd/jaas)


Because of the path assumptions, we should document where the script needs to be run from i.e. it cannot be run from the root-directory of jimm.

I'm gonna switch it into a make target afterwards, just wanted it qa'd a little first.

kian99 · 2025-05-19T15:27:48Z

local/jimm/qa-lxd-mac.sh

+
+echo "To continue the QA environment setup, please login to keycloak."
+echo "The username is: \"jimm-test\" and the password is: \"password\""
+multipass exec --working-directory /home/ubuntu/jimm $VM_NAME -- juju login jimm.localhost -c jimm-dev


I wouldn't include this step since the web team don't usually use the Juju CLI afaik

This is to add the controller?

kian99 · 2025-05-19T15:30:18Z

local/jimm/qa-lxd-mac-forward.sh

+# ./qa-lxd-mac-forward.sh jimm2 --linux         - Run for a VM named jimm2, on linux, and exit immediately
+# ./qa-lxd-mac-forward.sh --linux               - Run for the default VM (jimm), on linux, and exit immediately
+# ./qa-lxd-mac-forward.sh jimm2 --mac --wait    - Run for a VM named jimm2, on mac, and wait after tunnels are established
+


Always a good idea to add set -euo pipefail at the top to ensure errors stop the script.

True, I'll add Wednesday (this applies to all comments I'll do them Wednesday)

local/jimm/qa-lxd-mac.sh

kian99 · 2025-05-19T15:32:37Z

local/jimm/qa-lxd-mac-forward.sh

+echo "VM Address: $VM_ADDR"
+
+# Test SSH connection first (non-blocking, just exits if failure)
+ssh -i "$KEY_COPIED_PATH" -o BatchMode=yes -o ConnectTimeout=5 ubuntu@$VM_ADDR "exit"


There's a connectTimeout on this one but not on the next.

Rightly or wrongly I just presumed if it's reachable now, it will be immediately afterwards. Can add the timeouts to the others if you'd like?

SimoneDutto

it seems very complicate to do all of this. Can you explain why the docker is not working on mac, and maybe we can try to work out that before using multipass, etc, etc.

should we add a arm64 smoke test to make sure this script keeps working?

SimoneDutto · 2025-05-20T14:55:36Z

local/jimm/qa-lxd-mac-forward.sh

+# Set the key path based on OS
+if [[ "$OS" == "mac" ]]; then
+  KEY_PATH="$KEY_PATH_MAC"
+elif [[ "$OS" == "linux" ]]; then
+  KEY_PATH="$KEY_PATH_LINUX"
+else
+  echo "Error: You must specify --linux or --mac"
+  exit 1
+fi


do you need all of this? For example you could use multipass exec, multipass shell, multipass transfer.
It would read much better adn you don't need the custom rsa key

ale8k requested a review from a team as a code owner May 19, 2025 14:01

ale8k force-pushed the add-script-to-qa-on-mac branch from bc7a385 to fbe7308 Compare May 19, 2025 14:01

ale8k added 2 commits May 19, 2025 15:02

chore: new line

e425cf2

ale8k force-pushed the add-script-to-qa-on-mac branch from fbe7308 to e425cf2 Compare May 19, 2025 14:02

kian99 requested a review from Copilot May 19, 2025 14:13

Copilot AI reviewed May 19, 2025

View reviewed changes

kian99 reviewed May 19, 2025

View reviewed changes

SimoneDutto reviewed May 20, 2025

View reviewed changes

	multipass exec $VM_NAME -- sudo sudo apt-get -y install make
	multipass exec $VM_NAME -- sudo apt-get -y install make

	if [ ! -f "$KEY" ]; then
	if [ ! -f "$KEY_COPIED_PATH" ]; then

feat(qa-script): adds qa scripts for mac (arm) developers #1602

Are you sure you want to change the base?

feat(qa-script): adds qa scripts for mac (arm) developers #1602

Uh oh!

Conversation

ale8k commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 19, 2025

Choose a reason for hiding this comment

Uh oh!

kian99 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SimoneDutto left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ale8k commented May 19, 2025 •

edited

Loading

SimoneDutto left a comment •

edited

Loading