Skip to content

ROX-29771: Prefactor roxctl_verification.sh #17294

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

Merged
vikin91 merged 2 commits into from
Oct 16, 2025
Merged

ROX-29771: Prefactor roxctl_verification.sh #17294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9a9e8f
Refactor roxctl_verification.sh
vikin91 Oct 15, 2025
5d4848e
Restore original test assertions
vikin91 Oct 15, 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
109 changes: 96 additions & 13 deletions tests/yamls/roxctl_verification.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,112 @@
#! /bin/bash
#!/usr/bin/env bash

# TODO(ROX-8801): Move these tests to bats.

set -euo pipefail

DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"

# Check bash version (require 4.0+ for associative arrays)
if [[ "${BASH_VERSINFO[0]}" -lt 4 ]]; then
echo "ERROR: This script requires Bash 4.0 or later (found ${BASH_VERSION})" >&2
echo " Associative arrays (declare -A) require Bash 4.0+" >&2
echo " Your bash: $(command -v bash) (version ${BASH_VERSION})" >&2
exit 1
fi

extra_args=()
if [[ -n "$CA" ]]; then
if [[ -n "${CA:-}" ]]; then
extra_args+=(--ca "$CA")
else
extra_args+=(--insecure-skip-tls-verify)
fi

# Add password if provided
if [[ -n "${ROX_PASSWORD:-}" ]]; then
extra_args+=(-p "$ROX_PASSWORD")
fi

# Define test cases: file -> expected policy names (pipe-separated)
# Each file is tested against a list of expected policy violations
declare -A TEST_CASES=(
["cronjob.yaml"]="Latest tag|No CPU request or memory limit specified"
["daemonset.yaml"]="Latest tag|No CPU request or memory limit specified"
["deployment.yaml"]="Latest tag|No CPU request or memory limit specified"
["deploymentconfig.yaml"]="Latest tag|No CPU request or memory limit specified"
["job.yaml"]="Latest tag|No CPU request or memory limit specified"
["legacy-deploymentconfig.yaml"]="Latest tag|No CPU request or memory limit specified"
["list-deployment.yaml"]="Latest tag|No CPU request or memory limit specified"
["multi-container-pod.yaml"]="Latest tag|No CPU request or memory limit specified"
["multi-deployment-crd.yaml"]="Latest tag|No CPU request or memory limit specified"
["multi-deployment-route.yaml"]="Latest tag|No CPU request or memory limit specified"
["multi-deployment.yaml"]="Latest tag|No CPU request or memory limit specified"
["pod.yaml"]="Latest tag|No CPU request or memory limit specified"
["replicaset.yaml"]="Latest tag|No CPU request or memory limit specified"
["replicationcontroller.yaml"]="Latest tag|No CPU request or memory limit specified"
["statefulset.yaml"]="Latest tag|No CPU request or memory limit specified"
)

FAILED="false"
for yaml in "$DIR"/*.yaml; do
[ -e "$yaml" ] || continue
NUM_ALERTS="$(roxctl "${extra_args[@]}" -e "$API_ENDPOINT" deployment check --file $yaml --json | \
jq '.alerts[].policy.name | select(.=="Latest tag" or .=="No CPU request or memory limit specified")' | jq -s '. | length')"
if [[ $NUM_ALERTS != "2" ]]; then
>&2 echo "Did not find 2 alerts for $yaml"
FAILED="true"

for yaml_file in "${!TEST_CASES[@]}"; do
yaml_path="$DIR/$yaml_file"

if [[ ! -f "$yaml_path" ]]; then
>&2 echo "ERROR: Expected file not found: $yaml_path"
FAILED="true"
continue
fi

expected_policies="${TEST_CASES[$yaml_file]}"
IFS='|' read -ra expected_array <<< "$expected_policies"
expected_count="${#expected_array[@]}"

# Build jq filter for expected policies
jq_filter=""
for policy in "${expected_array[@]}"; do
if [[ -z "$jq_filter" ]]; then
jq_filter=".==\"$policy\""
else
jq_filter="$jq_filter or .==\"$policy\""
fi
done

# Get alerts from roxctl
alerts_json="$(roxctl "${extra_args[@]}" -e "$API_ENDPOINT" deployment check --file "$yaml_path" --output json 2>/dev/null)"

# Extract matching policy names (new format uses .results[].violatedPolicies[])
matching_policies="$(echo "$alerts_json" | jq -r ".results[].violatedPolicies[].name | select($jq_filter)" 2>/dev/null || echo "")"
actual_count="$(echo "$matching_policies" | grep -c . || echo "0")"

if [[ "$actual_count" != "$expected_count" ]]; then
>&2 echo "FAILED: $yaml_file - expected $expected_count alert(s), found $actual_count"
>&2 echo " Expected policies: ${expected_array[*]}"
if [[ -n "$matching_policies" ]]; then
>&2 echo " Found policies: $matching_policies"
else
>&2 echo " Found policies: (none)"
fi
FAILED="true"
else
echo "Analyzed $yaml successfully"
fi
# Verify each expected policy was found
all_found=true
for expected_policy in "${expected_array[@]}"; do
if ! echo "$matching_policies" | grep -Fq "$expected_policy"; then
>&2 echo "FAILED: $yaml_file - missing expected policy: $expected_policy"
all_found=false
fi
done
if [[ "$all_found" == "true" ]]; then
echo "Analyzed $yaml_file successfully (found $expected_count expected alert(s))"
else
FAILED="true"
fi
fi
done

if [[ "$FAILED" == "true" ]]; then
echo "Roxctl test failed"
exit 1
echo "Roxctl test failed"
exit 1
fi
echo "All roxctl yaml verification tests passed"
exit 0
Loading