Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[pre-commit][kuttl]Fix false positive asserts #430

Merged
merged 5 commits into from
Jun 26, 2024
Merged

[pre-commit][kuttl]Fix false positive asserts #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
18f34a4
[kuttl]Fix false positive asserts
gibizer May 13, 2024
bbe5cd4
[pre-commit][kuttl]Check for multiple TestAsserts
gibizer May 13, 2024
9338ee9
Fix all kuttl asserts
steveb May 14, 2024
003e6d2
Run kuttl curl endpoint check inside the cluster
steveb Jun 24, 2024
c197299
Set namespace context to $NAMESPACE
steveb Jun 25, 2024
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
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,11 @@ repos:
hooks:
- id: golangci-lint-full
args: ["-v"]

- repo: https://github.com/openstack-k8s-operators/openstack-k8s-operators-ci
# NOTE(gibi): we cannot automatically track main here
# see https://pre-commit.com/#using-the-latest-version-for-a-repository
rev: e30d72fcbced0ab8a7b6d23be1dee129e2a7b849
hooks:
- id: kuttl-single-test-assert
args: ["tests/kuttl"]
54 changes: 24 additions & 30 deletions tests/kuttl/common/assert-endpoints.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,83 +13,77 @@ apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -euxo pipefail
oc config set-context --current --namespace=$NAMESPACE
template='{{.status.apiEndpoints.ironic.public}}{{":"}}{{.status.apiEndpoints.ironic.internal}}{{"\n"}}'
regex="http:\/\/ironic-public-$NAMESPACE\.apps.*:http:\/\/ironic-admin-$NAMESPACE\.apps.*:http:\/\/ironic-internal-$NAMESPACE\.apps.*"
apiEndpoints=$(oc get -n $NAMESPACE ironics.ironic.openstack.org ironic -o go-template="$template")
regex="http:\/\/ironic-public\.$NAMESPACE\..*:http:\/\/ironic-internal\.$NAMESPACE\..*"
apiEndpoints=$(oc get ironics.ironic.openstack.org ironic -o go-template="$template")
matches=$(echo "$apiEndpoints" | sed -e "s?$regex??")
if [ -z "$matches" ]; then
exit 0
else
exit 1
fi
---
# the actual addresses of the apiEndpoints are platform specific, so we can't rely on
# kuttl asserts to check them. This short script gathers the addresses and checks that
# the endpoints are defined and their addresses follow the default pattern
# This test is for the ironic inspector endpoints
apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -euxo pipefail
oc config set-context --current --namespace=$NAMESPACE
template='{{index .status.apiEndpoints "ironic-inspector" "public"}}{{":"}}{{index .status.apiEndpoints "ironic-inspector" "internal"}}{{"\n"}}'
regex="http:\/\/ironic-inspector-public-$NAMESPACE\.apps.*:http:\/\/ironic-inspector-admin-$NAMESPACE\.apps.*:http:\/\/ironic-inspector-internal-$NAMESPACE\.apps.*"
apiEndpoints=$(oc get -n $NAMESPACE ironics.ironic.openstack.org ironic -o go-template="$template")
regex="http:\/\/ironic-inspector-public\.$NAMESPACE\..*:http:\/\/ironic-inspector-internal\.$NAMESPACE\..*"
apiEndpoints=$(oc get ironics.ironic.openstack.org ironic -o go-template="$template")
matches=$(echo "$apiEndpoints" | sed -e "s?$regex??")
if [ -z "$matches" ]; then
exit 0
else
exit 1
fi
---
# Test the status code is correct for each endpoint
# This test is for ironic endpoints
apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -x
set -euxo pipefail
RETURN_CODE=0
PUBLIC_URL=$(oc get -n $NAMESPACE ironics.ironic.openstack.org ironic -o jsonpath='{.status.apiEndpoints.ironic.public}')
oc config set-context --current --namespace=$NAMESPACE
PUBLIC_URL=$(oc get ironics.ironic.openstack.org ironic -o jsonpath='{.status.apiEndpoints.ironic.public}')
CURL_CMD='oc run --restart=Never --rm=true --image quay.io/curl/curl:8.8.0 -ti --quiet=true -- curl curl --silent --output /dev/null --head --write-out "%{http_code}"'
if [ -z "$PUBLIC_URL" ]; then
RETURN_CODE=1
echo "Endpoint: apiEndpoints.ironic.public not ready."
sleep 10
else
STATUSCODE=$(curl --silent --output /dev/stderr --head --write-out "%{http_code}" $PUBLIC_URL)
STATUSCODE=$($CURL_CMD $PUBLIC_URL)
if test $STATUSCODE -ne 200; then
RETURN_CODE=1
echo "${PUBLIC_URL} status code expected is 200 but was ${STATUSCODE}"
fi
fi
exit $RETURN_CODE
---
# Test the status code is correct for each endpoint
# This test is for ironic inspector endpoints
apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -x
set -euxo pipefail
RETURN_CODE=0
PUBLIC_URL=$(oc get -n $NAMESPACE ironics.ironic.openstack.org ironic -o jsonpath='{.status.apiEndpoints.ironic-inspector.public}')
oc config set-context --current --namespace=$NAMESPACE
PUBLIC_URL=$(oc get ironics.ironic.openstack.org ironic -o jsonpath='{.status.apiEndpoints.ironic-inspector.public}')
CURL_CMD='oc run --restart=Never --rm=true --image quay.io/curl/curl:8.8.0 -ti --quiet=true -- curl curl --silent --output /dev/null --head --write-out "%{http_code}"'
if [ -z "$PUBLIC_URL" ]; then
RETURN_CODE=1
echo "Endpoint: .status.apiEndpoints.ironic-inspector.public not ready."
sleep 10
else
STATUSCODE=$(curl --silent --output /dev/stderr --head --write-out "%{http_code}" $PUBLIC_URL)
STATUSCODE=$($CURL_CMD $PUBLIC_URL)
if test $STATUSCODE -ne 200; then
RETURN_CODE=1
echo "${PUBLIC_URL} status code expected is 200 but was ${STATUSCODE}"
fi
fi
exit $RETURN_CODE
---
# when using image digests the containerImage URLs are SHAs so we verify them with a script
apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -euxo pipefail
oc config set-context --current --namespace=$NAMESPACE
tupleTemplate='{{ range (index .spec.template.spec.containers 1).env }}{{ .name }}{{ "#" }}{{ .value}}{{"\n"}}{{ end }}'
imageTuples=$(oc get -n openstack-operators deployment ironic-operator-controller-manager -o go-template="$tupleTemplate")
for ITEM in $(echo $imageTuples); do
Expand All @@ -100,16 +94,16 @@ commands:
template='{{.spec.containerImage}}'
case $NAME in
API)
SERVICE_IMAGE=$(oc get -n $NAMESPACE ironicapi ironic-api -o go-template="$template")
SERVICE_IMAGE=$(oc get ironicapi ironic-api -o go-template="$template")
;;
CONDUCTOR)
SERVICE_IMAGE=$(oc get -n $NAMESPACE ironicconductor ironic-conductor -o go-template="$template")
SERVICE_IMAGE=$(oc get ironicconductor ironic-conductor -o go-template="$template")
;;
INSPECTOR)
SERVICE_IMAGE=$(oc get -n $NAMESPACE ironicinspector ironic-inspector -o go-template="$template")
SERVICE_IMAGE=$(oc get ironicinspector ironic-inspector -o go-template="$template")
;;
PXE)
SERVICE_IMAGE=$(oc get -n $NAMESPACE ironicconductor ironic-conductor -o go-template="{{.spec.pxeContainerImage}}")
SERVICE_IMAGE=$(oc get ironicconductor ironic-conductor -o go-template="{{.spec.pxeContainerImage}}")
;;
NEUTRON_AGENT)
# this isn't deployed in all tests
Expand Down
12 changes: 6 additions & 6 deletions tests/kuttl/tests/deploy_tls/10-assert-deploy-ironic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,25 +107,25 @@ apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -euxo pipefail
template='{{.spec.endpoints.internal}}{{":"}}{{.spec.endpoints.public}}{{"\n"}}'
regex="https:\/\/ironic-internal.$NAMESPACE.*:https:\/\/ironic-public.$NAMESPACE.*"
regex="https:\/\/ironic-internal\.$NAMESPACE\..*:https:\/\/ironic-public\.$NAMESPACE\..*"
apiEndpoints=$(oc get -n $NAMESPACE KeystoneEndpoint ironic -o go-template="$template")
matches=$(echo "$apiEndpoints" | sed -e "s?$regex??")
if [[ -n "$matches" ]]; then
exit 1
fi
---
exit 0
# the actual addresses of the api endpoints are platform specific, so we can't rely on
# kuttl asserts to check them. This short script gathers the addresses and checks that
# the two endpoints are defined and their addresses follow the default pattern
apiVersion: kuttl.dev/v1beta1
kind: TestAssert
commands:
- script: |
set -euxo pipefail
template='{{.spec.endpoints.internal}}{{":"}}{{.spec.endpoints.public}}{{"\n"}}'
regex="https:\/\/ironic-inspector-internal.$NAMESPACE.*:https:\/\/ironic-inspector-public.$NAMESPACE.*"
regex="https:\/\/ironic-inspector-internal\.$NAMESPACE\..*:https:\/\/ironic-inspector-public\.$NAMESPACE\..*"
apiEndpoints=$(oc get -n $NAMESPACE KeystoneEndpoint ironic-inspector -o go-template="$template")
matches=$(echo "$apiEndpoints" | sed -e "s?$regex??")
if [[ -n "$matches" ]]; then
exit 1
fi
exit 0
Loading