Skip to content

fix: extend resource naming check to all providers #1041

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

Open
james00012 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: extend resource naming check to all providers #1041

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7ebe49
fix: extend resource naming check to all providers
james00012 Mar 8, 2026
16e66c7
fix: add guard clauses and scanning output from staff review
james00012 Mar 10, 2026
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
33 changes: 30 additions & 3 deletions scripts/check-resource-naming.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Validates naming conventions for cloud-nuke resources and config keys.
#
# Resource type names (ResourceTypeName in aws/resources/*.go):
# Resource type names (ResourceTypeName in <provider>/resources/**/*.go):
# - Must be lowercase kebab-case: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
# - Must be unique across all resources
#
Expand All @@ -19,10 +19,28 @@ ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
# --- Check ResourceTypeName values ---
echo "Checking ResourceTypeName conventions..."

# Discover all provider resource directories (aws/resources, gcp/resources, etc.)
RESOURCE_DIRS=()
for dir in "$ROOT"/*/resources; do
[[ -d "$dir" ]] && RESOURCE_DIRS+=("$dir")
done

if [[ ${#RESOURCE_DIRS[@]} -eq 0 ]]; then
echo " ERROR: No resource directories found"
exit 1
fi

echo " Scanning: ${RESOURCE_DIRS[*]}"

# Extract all ResourceTypeName values (skip comments)
NAMES=$(grep -rh 'ResourceTypeName:' "$ROOT/aws/resources/" --include='*.go' \
NAMES=$(grep -rh 'ResourceTypeName:' "${RESOURCE_DIRS[@]}" --include='*.go' \
| grep -v '^\s*//' \
| sed -n 's/.*ResourceTypeName:[[:space:]]*"\([^"]*\)".*/\1/p')
| sed -n 's/.*ResourceTypeName:[[:space:]]*"\([^"]*\)".*/\1/p') || true

if [[ -z "$NAMES" ]]; then
echo " ERROR: No ResourceTypeName values found"
exit 1
fi

KEBAB_PATTERN='^[a-z][a-z0-9]*(-[a-z0-9]+)*$'
while IFS= read -r name; do
Expand All @@ -48,11 +66,18 @@ CONFIG_BLOCK=$(sed -n '/^type Config struct {$/,/^}$/p' "$ROOT/config/config.go"
| tail -n +2 \
| sed '$d')

if [[ -z "$CONFIG_BLOCK" ]]; then
echo " ERROR: Could not extract Config struct from config/config.go"
exit 1
fi

PASCAL_PATTERN='^[A-Z][A-Za-z0-9]*$'
TAG_COUNT=0
while IFS= read -r line; do
# Extract yaml tag (strip ,inline etc.)
tag=$(echo "$line" | sed -n 's/.*yaml:"\([^",]*\).*/\1/p')
[[ -z "$tag" ]] && continue
TAG_COUNT=$((TAG_COUNT + 1))

# Check PascalCase
if ! [[ "$tag" =~ $PASCAL_PATTERN ]]; then
Expand All @@ -76,6 +101,8 @@ if [[ -n "$YAML_DUPES" ]]; then
ERRORS=$((ERRORS + 1))
fi

echo " Checked $TAG_COUNT YAML tags"

if [[ $ERRORS -gt 0 ]]; then
echo ""
echo "FAILED: $ERRORS naming convention violation(s) found."
Expand Down