test: exclude content of UI assets from comparison in html output tests #4037
+42
−7
Conversation
This file contains 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
adam-enko
reviewed
Feb 25, 2025
Comment on lines
67
to
72
| val excludedFiles = listOf( | ||
| "ui-kit/ui-kit.min.js", | ||
| "ui-kit/ui-kit.min.css", | ||
| "styles/main.css", | ||
| "scripts/main.js", | ||
| ) |
There was a problem hiding this comment.
Might it be a good idea to create a global variable dokkaHtmlStyleFiles: List<String>, so if they need to be changed they can be updated in all tests?
adam-enko
reviewed
Feb 25, 2025
| @@ -20,8 +20,8 @@ import kotlin.io.path.* | |||
| * | |||
| * Only files will be compared, directories are ignored. | |||
| */ | |||
| infix fun Path.shouldBeADirectoryWithSameContentAs(path: Path) { | |||
| val differences = describeFileDifferences(this, path) | |||
| fun Path.shouldBeADirectoryWithSameContentAs(path: Path, excludeFiles: List<String> = emptyList()) { | |||
There was a problem hiding this comment.
excludeFiles will completely exclude the files from the comparison. Maybe it would be better to exclude checking the file's content instead? That way we can still check that the files exist, but the actual styling isn't relevant?
There was a problem hiding this comment.
Moved the check inside the contents comparison part
There was a problem hiding this comment.
Thanks! I think it'd be a good idea to update the variable name too, to be more descriptive. wdyt?
E.g. filesExcludedFromContentCheck
berezinant
force-pushed
the
html-output-tests
branch
from
da066e2 to
43a296e
Compare
berezinant
force-pushed
the
html-output-tests
branch
2 times, most recently
from
8da1a5b to
bbe0c4b
Compare
berezinant
force-pushed
the
html-output-tests
branch
from
bbe0c4b to
4a6bc41
Compare
adam-enko
reviewed
Feb 25, 2025
dokka-integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/TestConstants.kt
Outdated
Show resolved
Hide resolved
…okka/it/gradle/TestConstants.kt Co-authored-by: Adam <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.