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.

Sign up for GitHub

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

test: add an architectural test to catch package creation during code review #1696

Merged
merged 2 commits into from
Nov 10, 2017
Merged

test: add an architectural test to catch package creation during code review #1696

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5deedcc
up
monperrus Nov 8, 2017
4720b28
Update SpoonArchitectureEnforcerTest.java
monperrus Nov 8, 2017
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
89 changes: 89 additions & 0 deletions src/test/java/spoon/test/architecture/SpoonArchitectureEnforcerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import spoon.Launcher;
import spoon.SpoonAPI;
import spoon.processing.AbstractManualProcessor;
import spoon.processing.AbstractProcessor;
import spoon.reflect.code.CtConstructorCall;
import spoon.reflect.declaration.CtClass;
import spoon.reflect.declaration.CtConstructor;
Expand All @@ -19,6 +20,7 @@
import spoon.reflect.visitor.filter.TypeFilter;

import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import static org.junit.Assert.assertEquals;
Expand Down Expand Up @@ -206,4 +208,91 @@ public boolean matches(CtClass element) {
assertTrue(klass.getElements(new TypeFilter<>(CtConstructor.class)).stream().allMatch(x -> x.hasModifier(ModifierKind.PRIVATE)));
}
}

@Test
public void testSpecPackage() throws Exception {
// contract: when a pull-request introduces a new package, it is made explicit during code review
// when a pull-request introduces a new package, this test fails and the author has to explicitly declare the new package here
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be great to improve CONTRIBUTING.md with this kind of contract, WDYT?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just do not make CONTRIBUTING.md too complex, so the new contributors does not have fear to contribute ;-)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

excellent point Pavel! I'll make a PR in that direction.


Set<String> officialPackages = new TreeSet<>();
officialPackages.add("spoon.compiler.builder");
officialPackages.add("spoon.compiler");
officialPackages.add("spoon.experimental.modelobs.action");
officialPackages.add("spoon.experimental.modelobs.context");
officialPackages.add("spoon.experimental.modelobs");
officialPackages.add("spoon.experimental");
officialPackages.add("spoon.legacy");
officialPackages.add("spoon.processing");
officialPackages.add("spoon.refactoring");
officialPackages.add("spoon.reflect.annotations");
officialPackages.add("spoon.reflect.code");
officialPackages.add("spoon.reflect.cu.position");
officialPackages.add("spoon.reflect.cu");
officialPackages.add("spoon.reflect.declaration");
officialPackages.add("spoon.reflect.eval");
officialPackages.add("spoon.reflect.factory");
officialPackages.add("spoon.reflect.path.impl");
officialPackages.add("spoon.reflect.path");
officialPackages.add("spoon.reflect.reference");
officialPackages.add("spoon.reflect.visitor.chain");
officialPackages.add("spoon.reflect.visitor.filter");
officialPackages.add("spoon.reflect.visitor.printer");
officialPackages.add("spoon.reflect.visitor");
officialPackages.add("spoon.reflect");
officialPackages.add("spoon.support.comparator");
officialPackages.add("spoon.support.compiler.jdt");
officialPackages.add("spoon.support.compiler");
officialPackages.add("spoon.support.gui");
officialPackages.add("spoon.support.reflect.code");
officialPackages.add("spoon.support.reflect.cu.position");
officialPackages.add("spoon.support.reflect.cu");
officialPackages.add("spoon.support.reflect.declaration");
officialPackages.add("spoon.support.reflect.eval");
officialPackages.add("spoon.support.reflect.reference");
officialPackages.add("spoon.support.reflect");
officialPackages.add("spoon.support.template");
officialPackages.add("spoon.support.util");
officialPackages.add("spoon.support.visitor.clone");
officialPackages.add("spoon.support.visitor.equals");
officialPackages.add("spoon.support.visitor.java.internal");
officialPackages.add("spoon.support.visitor.java.reflect");
officialPackages.add("spoon.support.visitor.java");
officialPackages.add("spoon.support.visitor.replace");
officialPackages.add("spoon.support.visitor");
officialPackages.add("spoon.support");
officialPackages.add("spoon.template");
officialPackages.add("spoon.testing.utils");
officialPackages.add("spoon.testing");
officialPackages.add("spoon");
officialPackages.add(""); // root package

SpoonAPI spoon = new Launcher();
spoon.addInputResource("src/main/java/");
spoon.buildModel();
final Set<String> currentPackages = new TreeSet<>();
spoon.getModel().processWith(new AbstractProcessor<CtPackage>() {
@Override
public void process(CtPackage element) {
currentPackages.add(element.getQualifiedName());
}
});

assertSetEquals("you have created a new package or removed an existing one, please declare it explicitly in SpoonArchitectureEnforcerTest#testSpecPackage", officialPackages, currentPackages);
}

public static void assertSetEquals(String msg, Set<?> set1, Set<?> set2){

if(set1 == null || set2 ==null){
throw new IllegalArgumentException();
}

if(set1.size()!=set2.size()){
throw new AssertionError(msg);
}

if (!set1.containsAll(set2)) {
throw new AssertionError(msg);
}

}
}