Skip to content
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 to ensure all rules are added to their rulesets #97

Merged
merged 1 commit into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ gradleMavenPublishPlugin = "com.vanniktech:gradle-maven-publish-plugin:0.22.0"
junit5 = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
junit5-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" }
assertj = "org.assertj:assertj-core:3.23.1"
reflections = "org.reflections:reflections:0.10.2"

[plugins]
spotless = { id = "com.diffplug.spotless", version = "6.11.0" }
Expand Down
1 change: 1 addition & 0 deletions rules/detekt/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ dependencies {
testImplementation libs.junit5
testImplementation libs.junit5.params
testImplementation libs.assertj
testImplementation libs.reflections
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Copyright 2022 Twitter, Inc.
// SPDX-License-Identifier: Apache-2.0
package com.twitter.compose.rules.detekt

import com.twitter.rules.core.detekt.TwitterDetektRule
import io.gitlab.arturbosch.detekt.api.Config
import org.assertj.core.api.AssertionsForInterfaceTypes.assertThat
import org.junit.jupiter.api.Test
import org.reflections.Reflections

class TwitterComposeRuleSetProviderTest {

private val ruleSetProvider = TwitterComposeRuleSetProvider()
private val ruleSet = ruleSetProvider.instance(Config.empty)

@Test
fun `ensure all rules in the package are represented in the ruleset`() {
val reflections = Reflections(ruleSetProvider.javaClass.packageName)
val ruleClassesInPackage = reflections.getSubTypesOf(TwitterDetektRule::class.java)
val ruleClassesInRuleSet = ruleSet.rules.filterIsInstance<TwitterDetektRule>().map { it::class.java }.toSet()
assertThat(ruleClassesInRuleSet).containsExactlyInAnyOrderElementsOf(ruleClassesInPackage)
}
}
1 change: 1 addition & 0 deletions rules/ktlint/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ dependencies {
testImplementation libs.junit5
testImplementation libs.junit5.params
testImplementation libs.assertj
testImplementation libs.reflections
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,32 @@
// SPDX-License-Identifier: Apache-2.0
package com.twitter.compose.rules.ktlint

import com.pinterest.ktlint.test.RuleSetProviderTest
import com.twitter.rules.core.ktlint.TwitterKtlintRule
import org.assertj.core.api.AssertionsForInterfaceTypes.assertThat
import org.junit.jupiter.api.Test
import org.reflections.Reflections

class TwitterComposeRuleSetProviderTest : RuleSetProviderTest(
rulesetClass = TwitterComposeRuleSetProvider::class.java,
packageName = "com.twitter.rules.ktlint.compose"
)
class TwitterComposeRuleSetProviderTest {

private val ruleSetProvider = TwitterComposeRuleSetProvider()
private val ruleClassesInPackage = Reflections(ruleSetProvider.javaClass.packageName)
.getSubTypesOf(TwitterKtlintRule::class.java)

@Test
fun `ensure all rules in the package are represented in the old ruleset`() {
@Suppress("DEPRECATION")
val ruleSet = ruleSetProvider.get()
chrisbanes marked this conversation as resolved.
Show resolved Hide resolved
val ruleClassesInRuleSet = ruleSet.rules.filterIsInstance<TwitterKtlintRule>().map { it::class.java }.toSet()
assertThat(ruleClassesInRuleSet).containsExactlyInAnyOrderElementsOf(ruleClassesInPackage)
}

@Test
fun `ensure all rules in the package are represented in the new ruleset`() {
val ruleSet = ruleSetProvider.getRuleProviders()
val ruleClassesInRuleSet = ruleSet.map { it.createNewRuleInstance() }
.filterIsInstance<TwitterKtlintRule>()
.map { it::class.java }
.toSet()
assertThat(ruleClassesInRuleSet).containsExactlyInAnyOrderElementsOf(ruleClassesInPackage)
}
}