-
Notifications
You must be signed in to change notification settings - Fork 287
ci: expand test naming check globally and resolve naming errors #2065
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.
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
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
dbe63bc
ci: expand test naming check globally, include tck and fuzz, and reso…
exploreriii 30f0b04
fix: copilot fixes
exploreriii bced7cf
chore: set up node
exploreriii f6ae662
fix: rebase
exploreriii 3aadaf5
fix: new line at end of file
exploreriii 1063547
chore: apply pre commit
exploreriii 7ee1388
Merge branch 'main' into test-names
exploreriii File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| const { execSync } = require("child_process"); | ||
| const fs = require("fs"); | ||
|
|
||
| // These are the directories we want to check for correct naming | ||
| const TEST_DIRS = ["tests/unit", "tests/integration", "tests/tck", "tests/fuzz"]; | ||
|
|
||
| // These are the excluded paths and file names inside the TEST_DIRS | ||
| const IGNORED = ["tests/fuzz/support"]; | ||
| const EXCEPTIONS = ["conftest.py", "__init__.py", "init.py", "mock_server.py", "utils.py"]; | ||
|
|
||
| // Collect naming errors to report at the end | ||
| const nameErrors = []; | ||
|
|
||
| // Use "git ls-files" to get all tracked files in the repository | ||
| const output = execSync("git ls-files", { encoding: "utf-8" }); | ||
| // Split output into lines and filter out empty lines for easy manipulation | ||
| // e.g. output = "tests/unit/my_test.py\ntests/integration/other_test.py" | ||
| const files = output.split("\n").filter(Boolean); | ||
|
exploreriii marked this conversation as resolved.
|
||
|
|
||
| for (const file of files) { | ||
| // --- PATH FILTERING --- | ||
| // Skip files that are not in any of the specified test directories | ||
| if (!TEST_DIRS.some(dir => file.startsWith(dir))) continue; | ||
|
|
||
| // Skip ignored paths (e.g. helpers) | ||
| if (IGNORED.some(path => file.startsWith(path))) continue; | ||
|
|
||
| // Now we have file paths that we need to check for correct naming | ||
| // e.g. file = "tests/unit/my_test.py" | ||
|
|
||
| // --- Correct PATH now apply NAMING checks --- | ||
|
|
||
| // Extract the file name from the path | ||
| // e.g. from file = "tests/unit/my_test.py" get name = "my_test.py" | ||
| const name = file.split("/").pop(); | ||
|
|
||
| // Skip allowed special files | ||
| if (EXCEPTIONS.includes(name)) continue; | ||
|
|
||
| // Enforce naming rule on files | ||
| if (!name.endsWith("_test.py")) { | ||
| console.error(`Invalid test file name: ${file}`); | ||
| console.error(`::error file=${file}::Must end with '_test.py'`); | ||
| nameErrors.push(file); | ||
|
exploreriii marked this conversation as resolved.
|
||
| } | ||
|
exploreriii marked this conversation as resolved.
|
||
| } | ||
|
|
||
| // Generate a summary of the results for the GitHub Actions UI | ||
| const summaryPath = process.env.GITHUB_STEP_SUMMARY; | ||
|
|
||
| if (summaryPath) { | ||
| let summary = `## 🧪 Test File Naming Check\n\n`; | ||
|
|
||
| if (nameErrors.length === 0) { | ||
| summary += `✅ All test files are correctly named\n`; | ||
| } else { | ||
| // Counts and lists all the incorrectly named test files | ||
| summary += `❌ Found ${nameErrors.length} incorrectly named test files:\n\n`; | ||
| nameErrors.forEach(f => { | ||
| summary += `- \`${f}\`\n`; | ||
| }); | ||
| } | ||
|
|
||
| fs.appendFileSync(summaryPath, summary); | ||
| } | ||
|
|
||
| // Fail job if needed | ||
| if (nameErrors.length > 0) { | ||
| process.exit(1); | ||
| } | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.