Skip to content
This repository was archived by the owner on Jan 22, 2026. It is now read-only.

Test fully specifying client config with env var #18

Merged
mangelajo merged 8 commits into from
May 29, 2025
Merged

Test fully specifying client config with env var #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dc93fd0
Rework test with bats
NickCao May 28, 2025
eee5c87
Update test
NickCao May 28, 2025
24970d3
Rework entire test
NickCao May 28, 2025
59b6260
Test env
NickCao May 28, 2025
ae28008
No trace
NickCao May 28, 2025
3acee95
--show-output-of-passing-tests
NickCao May 28, 2025
39c70f7
Fix process termination
NickCao May 28, 2025
1b4421e
Check for existence of the client/exporter objects themselves
NickCao May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 7 additions & 93 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ runs:
shell: bash
run: |
uv python install 3.12
- name: Install bats
shell: bash
run: |
sudo apt-get update
sudo apt-get install -y bats bats-support bats-assert
- name: Checkout jumpstarter controller
uses: actions/checkout@v4
with:
Expand Down Expand Up @@ -77,7 +82,7 @@ runs:
- name: Run jumpstarter
shell: bash
run: |
ENDPOINT=$(helm get values jumpstarter --output json | jq -r '."jumpstarter-controller".grpc.endpoint')
export ENDPOINT=$(helm get values jumpstarter --output json | jq -r '."jumpstarter-controller".grpc.endpoint')

sudo mkdir -p /etc/jumpstarter/exporters
sudo chown $USER /etc/jumpstarter/exporters
Expand All @@ -89,95 +94,4 @@ runs:
kubectl create -n default sa test-client-sa
kubectl create -n default sa test-exporter-sa

jmp admin create client test-client-oidc --unsafe --out /dev/null \
--oidc-username dex:test-client-oidc
jmp admin create client test-client-sa --unsafe --out /dev/null \
--oidc-username dex:system:serviceaccount:default:test-client-sa
jmp admin create client test-client-legacy --unsafe --save

jmp admin create exporter test-exporter-oidc --out /dev/null \
--oidc-username dex:test-exporter-oidc \
--label example.com/board=oidc
jmp admin create exporter test-exporter-sa --out /dev/null \
--oidc-username dex:system:serviceaccount:default:test-exporter-sa \
--label example.com/board=sa
jmp admin create exporter test-exporter-legacy --save \
--label example.com/board=legacy

jmp config client list
jmp config exporter list

jmp login --client test-client-oidc \
--endpoint "$ENDPOINT" --namespace default --name test-client-oidc \
--issuer https://dex.dex.svc.cluster.local:5556 \
--username test-client-oidc@example.com --password password --unsafe

jmp login --client test-client-sa \
--endpoint "$ENDPOINT" --namespace default --name test-client-sa \
--issuer https://dex.dex.svc.cluster.local:5556 \
--connector-id kubernetes \
--token $(kubectl create -n default token test-client-sa) --unsafe

jmp login --exporter test-exporter-oidc \
--endpoint "$ENDPOINT" --namespace default --name test-exporter-oidc \
--issuer https://dex.dex.svc.cluster.local:5556 \
--username test-exporter-oidc@example.com --password password

jmp login --exporter test-exporter-sa \
--endpoint "$ENDPOINT" --namespace default --name test-exporter-sa \
--issuer https://dex.dex.svc.cluster.local:5556 \
--connector-id kubernetes \
--token $(kubectl create -n default token test-exporter-sa)

go run github.com/mikefarah/yq/v4@latest -i ". * load(\"$GITHUB_ACTION_PATH/exporter.yaml\")" \
/etc/jumpstarter/exporters/test-exporter-oidc.yaml
go run github.com/mikefarah/yq/v4@latest -i ". * load(\"$GITHUB_ACTION_PATH/exporter.yaml\")" \
/etc/jumpstarter/exporters/test-exporter-sa.yaml
go run github.com/mikefarah/yq/v4@latest -i ". * load(\"$GITHUB_ACTION_PATH/exporter.yaml\")" \
/etc/jumpstarter/exporters/test-exporter-legacy.yaml

jmp config client list
jmp config exporter list

jmp run --exporter test-exporter-oidc &
jmp run --exporter test-exporter-sa &
jmp run --exporter test-exporter-legacy &

kubectl -n default wait --for=condition=Online --for=condition=Registered exporters.jumpstarter.dev/test-exporter-oidc
kubectl -n default wait --for=condition=Online --for=condition=Registered exporters.jumpstarter.dev/test-exporter-sa
kubectl -n default wait --for=condition=Online --for=condition=Registered exporters.jumpstarter.dev/test-exporter-legacy

jmp config client use test-client-oidc

jmp create lease --selector example.com/board=oidc --duration 1d
jmp get leases
jmp get exporters
jmp delete leases --all

jmp admin get client
jmp admin get exporter
jmp admin get lease

jmp run --exporter test-exporter-oidc &
kubectl -n default wait --for=condition=Online --for=condition=Registered exporters.jumpstarter.dev/test-exporter-oidc

jmp shell --client test-client-oidc --selector example.com/board=oidc <<EOF
j power on
EOF

jmp shell --client test-client-sa --selector example.com/board=sa <<EOF
j power on
EOF

jmp shell --client test-client-legacy --selector example.com/board=legacy <<EOF
j power on
EOF

kubectl -n default get secret test-client-oidc-client
kubectl -n default get secret test-exporter-oidc-exporter

jmp admin delete client test-client-oidc -d
jmp admin delete exporter test-exporter-oidc -d

! kubectl -n default get secret test-client-oidc-client
! kubectl -n default get secret test-exporter-oidc-exporter
bats --show-output-of-passing-tests --verbose-run "$GITHUB_ACTION_PATH"/tests.bats
Comment thread
NickCao marked this conversation as resolved.
161 changes: 161 additions & 0 deletions tests.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
setup() {
bats_load_library bats-support
bats_load_library bats-assert
}

@test "can create clients with admin cli" {
jmp admin create client test-client-oidc --unsafe --out /dev/null \
--oidc-username dex:test-client-oidc
jmp admin create client test-client-sa --unsafe --out /dev/null \
--oidc-username dex:system:serviceaccount:default:test-client-sa
jmp admin create client test-client-legacy --unsafe --save
}

@test "can create exporters with admin cli" {
jmp admin create exporter test-exporter-oidc --out /dev/null \
--oidc-username dex:test-exporter-oidc \
--label example.com/board=oidc
jmp admin create exporter test-exporter-sa --out /dev/null \
--oidc-username dex:system:serviceaccount:default:test-exporter-sa \
--label example.com/board=sa
jmp admin create exporter test-exporter-legacy --save \
--label example.com/board=legacy
}

@test "can login with oidc" {
jmp config client list
jmp config exporter list

jmp login --client test-client-oidc \
--endpoint "$ENDPOINT" --namespace default --name test-client-oidc \
--issuer https://dex.dex.svc.cluster.local:5556 \
--username test-client-oidc@example.com --password password --unsafe

jmp login --client test-client-sa \
--endpoint "$ENDPOINT" --namespace default --name test-client-sa \
--issuer https://dex.dex.svc.cluster.local:5556 \
--connector-id kubernetes \
--token $(kubectl create -n default token test-client-sa) --unsafe

jmp login --exporter test-exporter-oidc \
--endpoint "$ENDPOINT" --namespace default --name test-exporter-oidc \
--issuer https://dex.dex.svc.cluster.local:5556 \
--username test-exporter-oidc@example.com --password password

jmp login --exporter test-exporter-sa \
--endpoint "$ENDPOINT" --namespace default --name test-exporter-sa \
--issuer https://dex.dex.svc.cluster.local:5556 \
--connector-id kubernetes \
--token $(kubectl create -n default token test-exporter-sa)

go run github.com/mikefarah/yq/v4@latest -i ". * load(\"$GITHUB_ACTION_PATH/exporter.yaml\")" \
/etc/jumpstarter/exporters/test-exporter-oidc.yaml
go run github.com/mikefarah/yq/v4@latest -i ". * load(\"$GITHUB_ACTION_PATH/exporter.yaml\")" \
/etc/jumpstarter/exporters/test-exporter-sa.yaml
go run github.com/mikefarah/yq/v4@latest -i ". * load(\"$GITHUB_ACTION_PATH/exporter.yaml\")" \
/etc/jumpstarter/exporters/test-exporter-legacy.yaml
Comment thread
NickCao marked this conversation as resolved.

jmp config client list
jmp config exporter list
}
Comment thread
NickCao marked this conversation as resolved.

@test "can run exporters" {
cat <<EOF | bash 3>&- &
while true; do
jmp run --exporter test-exporter-oidc
done
EOF

cat <<EOF | bash 3>&- &
while true; do
jmp run --exporter test-exporter-sa
done
EOF

cat <<EOF | bash 3>&- &
while true; do
jmp run --exporter test-exporter-legacy
done
EOF

kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-oidc
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-sa
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-legacy
}

@test "can specify client config only using environment variables" {
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-oidc

JMP_NAMEPSACE=default \
JMP_NAME=test-exporter-legacy \
JMP_ENDPOINT=$(kubectl get clients.jumpstarter.dev -n default test-client-legacy -o 'jsonpath={.status.endpoint}') \
JMP_TOKEN=$(kubectl get secrets -n default test-client-legacy-client -o 'jsonpath={.data.token}' | base64 -d) \
jmp shell --selector example.com/board=oidc j power on
}
Comment on lines +89 to +98
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix typo in environment variable name and clarify naming convention.

There's a typo in the environment variable name that will prevent proper configuration.

Apply this diff to fix the typo:

- JMP_NAMEPSACE=default \
+ JMP_NAMESPACE=default \

Additionally, consider clarifying the naming convention - using JMP_NAME=test-exporter-legacy for client configuration might be confusing since it suggests an exporter name rather than a client session name.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
@test "can specify client config only using environment variables" {
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-oidc
JMP_NAMEPSACE=default \
JMP_NAME=test-exporter-legacy \
JMP_ENDPOINT=$(kubectl get clients.jumpstarter.dev -n default test-client-legacy -o 'jsonpath={.status.endpoint}') \
JMP_TOKEN=$(kubectl get secrets -n default test-client-legacy-client -o 'jsonpath={.data.token}' | base64 -d) \
jmp shell --selector example.com/board=oidc j power on
}
@test "can specify client config only using environment variables" {
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-oidc
JMP_NAMESPACE=default \
JMP_NAME=test-exporter-legacy \
JMP_ENDPOINT=$(kubectl get clients.jumpstarter.dev -n default test-client-legacy -o 'jsonpath={.status.endpoint}') \
JMP_TOKEN=$(kubectl get secrets -n default test-client-legacy-client -o 'jsonpath={.data.token}' | base64 -d) \
jmp shell --selector example.com/board=oidc j power on
}
🤖 Prompt for AI Agents 
In tests.bats around lines 89 to 98, there is a typo in the environment variable
name "JMP_NAMEPSACE" which should be corrected to "JMP_NAMESPACE" to ensure
proper configuration. Additionally, rename "JMP_NAME" to something more
descriptive like "JMP_CLIENT_NAME" to clearly indicate it refers to the client
session name rather than an exporter name, improving clarity and
maintainability.


@test "can operate on leases" {
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-oidc

jmp config client use test-client-oidc

jmp create lease --selector example.com/board=oidc --duration 1d
jmp get leases
jmp get exporters
jmp delete leases --all
}

@test "can lease and connect to exporters" {
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-oidc
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-sa
kubectl -n default wait --for=condition=Online --for=condition=Registered \
exporters.jumpstarter.dev/test-exporter-legacy

jmp shell --client test-client-oidc --selector example.com/board=oidc j power on
jmp shell --client test-client-sa --selector example.com/board=sa j power on
jmp shell --client test-client-legacy --selector example.com/board=legacy j power on
}

@test "can get crds with admin cli" {
jmp admin get client
jmp admin get exporter
jmp admin get lease
}

@test "can delete clients with admin cli" {
kubectl -n default get secret test-client-oidc-client
kubectl -n default get clients.jumpstarter.dev/test-client-oidc
kubectl -n default get clients.jumpstarter.dev/test-client-sa
kubectl -n default get clients.jumpstarter.dev/test-client-legacy

jmp admin delete client test-client-oidc --delete
jmp admin delete client test-client-sa --delete
jmp admin delete client test-client-legacy --delete

run ! kubectl -n default get secret test-client-oidc-client
run ! kubectl -n default get clients.jumpstarter.dev/test-client-oidc
run ! kubectl -n default get clients.jumpstarter.dev/test-client-sa
run ! kubectl -n default get clients.jumpstarter.dev/test-client-legacy
}

@test "can delete exporters with admin cli" {
kubectl -n default get secret test-exporter-oidc-exporter
kubectl -n default get exporters.jumpstarter.dev/test-exporter-oidc
kubectl -n default get exporters.jumpstarter.dev/test-exporter-sa
kubectl -n default get exporters.jumpstarter.dev/test-exporter-legacy

jmp admin delete exporter test-exporter-oidc --delete
jmp admin delete exporter test-exporter-sa --delete
jmp admin delete exporter test-exporter-legacy --delete

run ! kubectl -n default get secret test-exporter-oidc-exporter
Comment thread
NickCao marked this conversation as resolved.
run ! kubectl -n default get exporters.jumpstarter.dev/test-exporter-oidc
run ! kubectl -n default get exporters.jumpstarter.dev/test-exporter-sa
run ! kubectl -n default get exporters.jumpstarter.dev/test-exporter-legacy
}
Loading