Skip to content

fix(docs): exclude folder-based query test cases from the query documentation #7657

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
cx-romeu-silva merged 2 commits into from
Aug 18, 2025
Merged

fix(docs): exclude folder-based query test cases from the query documentation #7657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba6fe29
exclude folder-based query test cases from the query documentation
cx-romeu-silva Aug 18, 2025
d04d9b4
update test filenames
cx-romeu-silva Aug 18, 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
5 changes: 4 additions & 1 deletion .github/scripts/docs-generator/query-page-generator/query-page-generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ def get_query_info(query_path : str, metadata_file = 'metadata.json'):
negative_filenames = []

for file in files:
file_path = os.path.join(query_path, 'test', file)
if not os.path.isfile(file_path):
continue
if file.lower().startswith('positive') and file != 'positive_expected_result.json':
positive_filenames.append(file)
elif file.lower().startswith('negative'):
Expand Down Expand Up @@ -265,4 +268,4 @@ def main():
print(f"-->\033[34m Elapsed time: {round(elapsed_time, 2)} seconds\033[0m")

if __name__ == '__main__':
main()
main()
0 .../iam_group_without_users/test/negative.tf → ...iam_group_without_users/test/negative1.tf
View file
Open in desktop
File renamed without changes.
0 .../iam_group_without_users/test/positive.tf → ...iam_group_without_users/test/positive1.tf
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions assets/queries/terraform/aws/iam_group_without_users/test/positive_expected_result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
{
"queryName": "IAM Group Without Users",
"severity": "MEDIUM",
"fileName": "positive.tf",
"fileName": "positive1.tf",
"line": 12
},
{
"queryName": "IAM Group Without Users",
"severity": "MEDIUM",
"fileName": "positive.tf",
"fileName": "positive1.tf",
"line": 33
}
]
Loading