-
Notifications
You must be signed in to change notification settings - Fork 506
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
Add tests for missing rules in a ruleset #477
Merged
Merged
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions
8
.../test/kotlin/com/pinterest/ktlint/ruleset/experimental/ExperimentalRuleSetProviderTest.kt
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
package com.pinterest.ktlint.ruleset.experimental | ||
|
||
import com.pinterest.ktlint.test.RuleSetProviderTest | ||
|
||
class ExperimentalRuleSetProviderTest : RuleSetProviderTest( | ||
rulesetClass = ExperimentalRuleSetProvider::class.java, | ||
packageName = "com.pinterest.ktlint.ruleset.experimental" | ||
) |
8 changes: 8 additions & 0 deletions
8
...dard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/StandardRuleSetProviderTest.kt
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
package com.pinterest.ktlint.ruleset.standard | ||
|
||
import com.pinterest.ktlint.test.RuleSetProviderTest | ||
|
||
class StandardRuleSetProviderTest : RuleSetProviderTest( | ||
rulesetClass = StandardRuleSetProvider::class.java, | ||
packageName = "com.pinterest.ktlint.ruleset.standard" | ||
) |
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
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
29 changes: 29 additions & 0 deletions
29
ktlint-test/src/main/kotlin/com/pinterest/ktlint/test/RuleSetProviderTest.kt
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
package com.pinterest.ktlint.test | ||
|
||
import com.pinterest.ktlint.core.RuleSetProvider | ||
import java.io.File | ||
import org.assertj.core.api.Assertions.assertThat | ||
import org.junit.Test | ||
|
||
open class RuleSetProviderTest( | ||
private val rulesetClass: Class<out RuleSetProvider>, | ||
private val packageName: String | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: We could, in theory, get the package name from |
||
) { | ||
|
||
@Test | ||
fun checkAllRulesProvided() { | ||
val srcLocation = rulesetClass.protectionDomain.codeSource.location.path | ||
val rulesDir = File(srcLocation + packageName.replace(".", "/")) | ||
val packageRules = rulesDir.listFiles() | ||
?.map { it.name.removeSuffix(".class") } | ||
?.filter { it.endsWith("Rule") } | ||
?: arrayListOf() | ||
|
||
val provider = rulesetClass | ||
val providerRules = provider.newInstance().get().rules.map { it::class.java.simpleName } | ||
val diff = packageRules - providerRules | ||
assertThat(diff) | ||
.withFailMessage("%s is missing to provide the following rules: \n%s", provider.simpleName, diff.joinToString(separator = "\n")) | ||
.hasSize(0) | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure that this is the best way for the centralized test code - this could be just a simple top-level function, which may be called from within a test method (e.g. in case
StandardRuleSetProviderTest
contains other tests), so I'm open for changing this, but currently it works.