-
Notifications
You must be signed in to change notification settings - Fork 1.4k
test: add Jest tests for validate-filepaths #20615
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
Open
Arvuno
wants to merge
2
commits into
github:master
Choose a base branch
from
Arvuno:contrib/dmca/test-validate-filepaths
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
92 changes: 92 additions & 0 deletions
92
.github/script/validate-filepaths/__tests__/validate.test.js
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,92 @@ | ||
| /** | ||
| * Tests for validate-filepaths main script logic | ||
| */ | ||
|
|
||
| describe("isFileInsideAYearFolder", () => { | ||
| // This function is defined in index.js - we test the logic it's testing | ||
|
|
||
| function isFileInsideAYearFolder(filepath) { | ||
| return filepath.match(/^\d{4}/) !== null; | ||
| } | ||
|
|
||
| test("returns true for file in year folder", () => { | ||
| expect(isFileInsideAYearFolder("2024/2024-01-01-brand.markdown")).toBe(true); | ||
| }); | ||
|
|
||
| test("returns true for file in year/month subfolder", () => { | ||
| expect(isFileInsideAYearFolder("2024/01/2024-01-01-brand.markdown")).toBe(true); | ||
| }); | ||
|
|
||
| test("returns false for file not in year folder", () => { | ||
| expect(isFileInsideAYearFolder("README.md")).toBe(false); | ||
| }); | ||
|
|
||
| test("returns false for file with non-year folder", () => { | ||
| expect(isFileInsideAYearFolder("foo/2024-01-01-brand.markdown")).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe("filepath date validation pattern", () => { | ||
| // Tests for the YYYY-MM-DD brand.markdown naming pattern | ||
|
|
||
| function isFilepathDateValid(filepath) { | ||
| const filename = filepath.split("/").pop(); | ||
| const dateStringInFilename = filename.match(/\d{4}-\d{2}-\d{2}/); | ||
| return dateStringInFilename !== null; | ||
| } | ||
|
|
||
| test("validates correct YYYY-MM-DD format in filename", () => { | ||
| expect(isFilepathDateValid("2024/01/2024-01-15-brand.markdown")).toBe(true); | ||
| expect(isFilepathDateValid("2023/12/2023-12-31-company.markdown")).toBe(true); | ||
| }); | ||
|
|
||
| test("invalidates incorrect date formats", () => { | ||
| expect(isFilepathDateValid("2024/1-01-15-brand.markdown")).toBe(false); | ||
| expect(isFilepathDateValid("2024/01/24-01-15-brand.markdown")).toBe(false); | ||
| expect(isFilepathDateValid("2024/01/2024-1-15-brand.markdown")).toBe(false); | ||
| expect(isFilepathDateValid("2024/01/2024-01-5-brand.markdown")).toBe(false); | ||
| }); | ||
|
|
||
| test("invalidates filenames without date", () => { | ||
| expect(isFilepathDateValid("README.md")).toBe(false); | ||
| expect(isFilepathDateValid("2024/01/brand.markdown")).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe("filepath structure validation", () => { | ||
| // Tests for the overall filepath structure (year folder, optional month folder, filename) | ||
|
|
||
| function isFileInsideAYearFolder(filepath) { | ||
| return filepath.match(/^\d{4}/) !== null; | ||
| } | ||
|
|
||
| function isFilepathDateValid(filepath) { | ||
| const filename = filepath.split("/").pop(); | ||
| const dateStringInFilename = filename.match(/\d{4}-\d{2}-\d{2}/); | ||
| return dateStringInFilename !== null; | ||
| } | ||
|
|
||
| test("correct structure with year-only folder", () => { | ||
| const validPath = "2024/2024-06-15-brand.markdown"; | ||
| expect(isFileInsideAYearFolder(validPath)).toBe(true); | ||
| expect(isFilepathDateValid(validPath)).toBe(true); | ||
| }); | ||
|
|
||
| test("correct structure with year/month folders", () => { | ||
| const validPath = "2024/06/2024-06-15-brand.markdown"; | ||
| expect(isFileInsideAYearFolder(validPath)).toBe(true); | ||
| expect(isFilepathDateValid(validPath)).toBe(true); | ||
| }); | ||
|
|
||
| test("incorrect structure with missing year folder", () => { | ||
| const invalidPath = "brand/2024-06-15-brand.markdown"; | ||
| expect(isFileInsideAYearFolder(invalidPath)).toBe(false); | ||
| expect(isFilepathDateValid(invalidPath)).toBe(true); | ||
| }); | ||
|
|
||
| test("incorrect structure with non-matching date in filename", () => { | ||
| const invalidPath = "2024/06/2023-06-15-brand.markdown"; | ||
| expect(isFileInsideAYearFolder(invalidPath)).toBe(true); | ||
| expect(isFilepathDateValid(invalidPath)).toBe(true); | ||
| }); | ||
| }); | ||
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.