Skip to content

Commit

Permalink
As long as aspects of ArchUnitRunner are tested in different test cla…
Browse files Browse the repository at this point in the history
…sses, we should separate the tests accordingly

Issue: #104
Signed-off-by: Peter Gafert <[email protected]>
  • Loading branch information
codecholeric committed Aug 30, 2018
1 parent 59f8c4d commit fe16a5b
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 53 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@
import static com.tngtech.archunit.junit.ArchUnitRunnerRunsMethodsTest.ArchTestWithTestMethod.testSomething;
import static com.tngtech.archunit.junit.ArchUnitRunnerRunsMethodsTest.IgnoredArchTest.toBeIgnoredOne;
import static com.tngtech.archunit.junit.ArchUnitRunnerRunsMethodsTest.IgnoredArchTest.toBeIgnoredTwo;
import static com.tngtech.archunit.junit.ArchUnitRunnerTestUtils.BE_SATISFIED;
import static com.tngtech.archunit.junit.ArchUnitRunnerTestUtils.getRule;
import static com.tngtech.archunit.junit.ArchUnitRunnerTestUtils.newRunnerFor;
import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.all;
import static com.tngtech.archunit.lang.syntax.ClassesIdentityTransformer.classes;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.never;
Expand Down Expand Up @@ -91,25 +94,11 @@ public void fails_methods_with_no_parameters() {
runAndAssertWrongParametersForChild(noParams, newRunner(ArchTestWithIllegalTestMethods.class));
}

private ArchUnitRunner newRunner(Class<ArchTestWithIllegalTestMethods> testClass) {
return newRunnerFor(testClass, cache);
}

@Test
public void fails_methods_with_too_many_parameters() {
runAndAssertWrongParametersForChild(tooManyParams, newRunner(ArchTestWithIllegalTestMethods.class));
}

private void runAndAssertWrongParametersForChild(String name, ArchUnitRunner runner) {
runner.runChild(getRule(name, runner), runNotifier);
verify(runNotifier).fireTestFailure(failureCaptor.capture());
Failure failure = failureCaptor.getValue();
assertThat(failure.getDescription().toString()).as("Failure description").contains(name);
assertThat(failure.getException().getMessage()).as("Failure Cause")
.contains("@" + ArchTest.class.getSimpleName())
.contains("exactly one parameter of type " + JavaClasses.class.getSimpleName());
}

@Test
public void ignores_all_methods_in_classes_annotated_with_ArchIgnore() throws InitializationError {
ArchUnitRunner runner = new ArchUnitRunner(IgnoredArchTest.class);
Expand All @@ -131,6 +120,33 @@ public void ignores_methods_annotated_with_ArchIgnore() throws InitializationErr
assertThat(descriptionCaptor.getValue().toString()).contains(toBeIgnored);
}

@Test
public void should_allow_instance_method_in_abstract_base_class() {
ArchUnitRunner runner = newRunnerFor(ArchTestWithAbstractBaseClass.class, cache);

runner.runChild(ArchUnitRunnerTestUtils.getRule(AbstractBaseClass.INSTANCE_METHOD_NAME, runner), runNotifier);

verifyTestFinishedSuccessfully(AbstractBaseClass.INSTANCE_METHOD_NAME);
}

private ArchUnitRunner newRunner(Class<ArchTestWithIllegalTestMethods> testClass) {
return newRunnerFor(testClass, cache);
}

private void runAndAssertWrongParametersForChild(String name, ArchUnitRunner runner) {
runner.runChild(getRule(name, runner), runNotifier);
verify(runNotifier).fireTestFailure(failureCaptor.capture());
Failure failure = failureCaptor.getValue();
assertThat(failure.getDescription().toString()).as("Failure description").contains(name);
assertThat(failure.getException().getMessage()).as("Failure Cause")
.contains("@" + ArchTest.class.getSimpleName())
.contains("exactly one parameter of type " + JavaClasses.class.getSimpleName());
}

private void verifyTestFinishedSuccessfully(String expectedDescriptionMethodName) {
ArchUnitRunnerRunsRuleFieldsTest.verifyTestFinishedSuccessfully(runNotifier, descriptionCaptor, expectedDescriptionMethodName);
}

@AnalyzeClasses(packages = "some.pkg")
public static class ArchTestWithTestMethod {
static final String testSomething = "testSomething";
Expand Down Expand Up @@ -187,4 +203,17 @@ public static class ArchTestWithIgnoredMethod {
public static void toBeIgnored(JavaClasses classes) {
}
}

@AnalyzeClasses(packages = "some.pkg")
public static class ArchTestWithAbstractBaseClass extends AbstractBaseClass {
}

abstract static class AbstractBaseClass {
static final String INSTANCE_METHOD_NAME = "abstractBaseClassInstanceMethod";

@ArchTest
void abstractBaseClassInstanceMethod(JavaClasses classes) {
all(classes()).should(BE_SATISFIED).check(classes);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -112,33 +112,6 @@ public void should_allow_instance_field_in_abstract_base_class() {
verifyTestFinishedSuccessfully(AbstractBaseClass.INSTANCE_FIELD_NAME);
}

@Test
public void should_allow_non_static_method_in_abstract_base_class() {
ArchUnitRunner runner = newRunnerFor(ArchTestWithAbstractBaseClass.class, cache);

runner.runChild(ArchUnitRunnerTestUtils.getRule(AbstractBaseClass.NON_STATIC_METHOD_NAME, runner), runNotifier);

verifyTestFinishedSuccessfully(AbstractBaseClass.NON_STATIC_METHOD_NAME);
}

@Test
public void should_allow_ArchRules_in_class_with_instance_field_in_abstract_base_class() {
ArchUnitRunner runner = newRunnerFor(ArchTestWithRulesWithAbstractBaseClass.class, cache);

runner.runChild(ArchUnitRunnerTestUtils.getRule(AbstractBaseClass.INSTANCE_FIELD_NAME, runner), runNotifier);

verifyTestFinishedSuccessfully(AbstractBaseClass.INSTANCE_FIELD_NAME);
}

@Test
public void should_allow_ArchRules_in_class_with_non_static_method_in_abstract_base_class() {
ArchUnitRunner runner = newRunnerFor(ArchTestWithRulesWithAbstractBaseClass.class, cache);

runner.runChild(ArchUnitRunnerTestUtils.getRule(AbstractBaseClass.NON_STATIC_METHOD_NAME, runner), runNotifier);

verifyTestFinishedSuccessfully(AbstractBaseClass.NON_STATIC_METHOD_NAME);
}

@Test
public void should_fail_on_wrong_field_type() {
ArchUnitRunner runner = newRunnerFor(WrongArchTestWrongFieldType.class, cache);
Expand Down Expand Up @@ -190,6 +163,11 @@ private ArchTestExecution getRule(String name) {
}

private void verifyTestFinishedSuccessfully(String expectedDescriptionMethodName) {
verifyTestFinishedSuccessfully(runNotifier, descriptionCaptor, expectedDescriptionMethodName);
}

static void verifyTestFinishedSuccessfully(RunNotifier runNotifier, ArgumentCaptor<Description> descriptionCaptor,
String expectedDescriptionMethodName) {
verify(runNotifier, never()).fireTestFailure(any(Failure.class));
verify(runNotifier).fireTestFinished(descriptionCaptor.capture());
Description description = descriptionCaptor.getValue();
Expand Down Expand Up @@ -221,27 +199,15 @@ public static class ArchTestWithPrivateInstanceField {
private ArchRule privateField = all(classes()).should(BE_SATISFIED);
}

@AnalyzeClasses(packages = "some.pkg")
public static class ArchTestWithRulesWithAbstractBaseClass {
@ArchTest
ArchRules rules = ArchRules.in(ArchTestWithAbstractBaseClass.class);
}

@AnalyzeClasses(packages = "some.pkg")
public static class ArchTestWithAbstractBaseClass extends AbstractBaseClass {
}

abstract static class AbstractBaseClass {
static final String INSTANCE_FIELD_NAME = "abstractBaseClassInstanceField";
static final String NON_STATIC_METHOD_NAME = "abstractBaseClassNonStaticMethod";

@ArchTest
ArchRule abstractBaseClassInstanceField = all(classes()).should(BE_SATISFIED);

@ArchTest
void abstractBaseClassNonStaticMethod(JavaClasses classes) {
all(classes()).should(BE_SATISFIED).check(classes);
}
}

@AnalyzeClasses(packages = "some.pkg")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,28 @@ public void ignores_double_nested_method_rule_in_ignored_rule_set() {
run(someMethodRuleName, runnerForIgnoredRuleLibrary, verifyTestIgnored());
}

@Test
public void should_allow_ArchRules_in_class_with_instance_field_in_abstract_base_class() {
ArchUnitRunner runner = newRunnerFor(ArchTestWithRulesWithAbstractBaseClass.class, cache);

runner.runChild(getRule(ArchUnitRunnerRunsRuleFieldsTest.AbstractBaseClass.INSTANCE_FIELD_NAME, runner), runNotifier);

verifyTestFinishedSuccessfully(ArchUnitRunnerRunsRuleFieldsTest.AbstractBaseClass.INSTANCE_FIELD_NAME);
}

@Test
public void should_allow_ArchRules_in_class_with_instance_method_in_abstract_base_class() {
ArchUnitRunner runner = newRunnerFor(ArchTestWithRulesWithAbstractBaseClass.class, cache);

runner.runChild(getRule(ArchUnitRunnerRunsMethodsTest.AbstractBaseClass.INSTANCE_METHOD_NAME, runner), runNotifier);

verifyTestFinishedSuccessfully(ArchUnitRunnerRunsMethodsTest.AbstractBaseClass.INSTANCE_METHOD_NAME);
}

private void verifyTestFinishedSuccessfully(String expectedDescriptionMethodName) {
ArchUnitRunnerRunsRuleFieldsTest.verifyTestFinishedSuccessfully(runNotifier, descriptionCaptor, expectedDescriptionMethodName);
}

private Runnable verifyTestIgnored() {
return new Runnable() {
@Override
Expand Down Expand Up @@ -304,4 +326,12 @@ public void check(JavaClass item, ConditionEvents events) {
}
};
}

@AnalyzeClasses(packages = "some.pkg")
public static class ArchTestWithRulesWithAbstractBaseClass {
@ArchTest
ArchRules fieldRules = ArchRules.in(ArchUnitRunnerRunsRuleFieldsTest.ArchTestWithAbstractBaseClass.class);
@ArchTest
ArchRules methodRules = ArchRules.in(ArchUnitRunnerRunsMethodsTest.ArchTestWithAbstractBaseClass.class);
}
}

0 comments on commit fe16a5b

Please sign in to comment.