refactor: move tests resources

[surli]

As pointed out in #2136 the tests directory is a bit messy, especially when you're not familiar with Spoon contribution. I would suggest to refactor it at least to have properly defined rules for the test resources.

We currently have test resources, in at least 3 different places:

1. src/test/resources the standard directory
2. src/test/java/X/testclasses in a subpackage, along with their test suite
3. src/test/java/X in the same package of the test suite

So I suggest first to move the test resources from case 3 to put - at least - the resources in a subpackage testclasses.
I don't think it's desirable to move all test resources in place 1, as I think we want to check that we can compile them.

WDYT?

[zielint0]

I am not yet completly familiary with Spoon terminology so please define test resource and give some examples (especially what can and should be changed, what must not be changed). Thank you.

[surli]

For me a test resource is a class that is placed under test directory but which does not contain any unit test and that are used in test assertion.
Those classes are used inside the unit test to check some behaviour.

For example, you have the file src/test/java/spoon/test/api/testclasses/Bar.java which is used in several tests of the test suites in directory src/test/java/spoon/test/api like this one for src/test/java/spoon/test/api/ApiTest.java:

@Test
	public void testInvalidateCacheOfCompiler() throws Exception {
		final Launcher spoon = new Launcher();
		spoon.addInputResource("./src/test/java/spoon/test/api/testclasses/Bar.java");
		spoon.setSourceOutputDirectory("./target/api");
		spoon.getEnvironment().setNoClasspath(true);
		spoon.run();

		assertTrue(spoon.getModelBuilder().compile());

		final CtClass<Bar> aClass = spoon.getFactory().Class().get(Bar.class);

		final CtMethod aMethod = spoon.getFactory().Core().createMethod();
		aMethod.setSimpleName("foo");
		aMethod.setType(spoon.getFactory().Type().BOOLEAN_PRIMITIVE);
		aMethod.setBody(spoon.getFactory().Core().createBlock());
		aClass.addMethod(aMethod);

		assertFalse(spoon.getModelBuilder().compile());

		aClass.removeMethod(aMethod);

		assertTrue(spoon.getModelBuilder().compile());
	}

you can see that placing the test resource in a the sources (instead of place 1), allows us to directly call Bar.class because it's in the classpath. So it helps writing tests.

Now the change that are allowed for those resources, are only moving them.
For example if you look at https://github.com/INRIA/spoon/tree/master/src/test/java/spoon/test/model there is a lof java files and only few of them are tests suite: the others are certainly test resources.

[zielint0]

Thank you very much for detailed answer.

Is it a good idea to mark every resource test class with Tc/TC prefix?
It would help distinguish them from non-test code.

[surli]

Is it a good idea to mark every resource test class with Tc/TC prefix?

I'm not sure it's necessary if we put the classes in a proper package.
And I'm almost sure that some class names are chosen to test some behaviours.

[zielint0]

Let's say I would like to move a test resource to proper location (testclasses):

• src/test/java/X -->
• --> src/test/java/X/testclasses

Should a test resource
spoon\src\test\java\spoon\support\compiler\jdt\ExtendedStringLiteralTestClass.java
be moved to
spoon\src\test\java\spoon\support\compiler\jdt\testclasses
?

Do I understand it correctly?

[surli]

Do I understand it correctly?

Yes, exactly!

[zielint0]

Thanks. So I am taking this task.

[zielint0]

@surli
Simon please take a look on PR #2147
Hope I recognized the correct ones.

[zielint0]

I moved some resources but got a broken one check on Travis.
So closed #2147
Will try to move them one by one in small PRs.

[zielint0]

@surli
@monperrus
Should I move below files to testclasses? I think - no.

• spoon/test/api/Metamodel.java
• spoon/test/api/AwesomeProcessor.java

@surli
@monperrus
I need some feedback on #2176
Got it - thx.

[zielint0]

Status of refactoring - helps not to get lost

• refactor: move ExtendedStringLiteralTestClass.java refactor: move ExtendedStringLiteralTestClass to testclasses #2153
• refactor: move ArrayClass.java to testclasses refactor: move ArrayClass.java to testclasses #2154
• refactor: move Castings.java to testclasses refactor: move Castings.java to testclasses #2155
• refactor: move Ifoo.java to testclasses refactor: move Ifoo.java to testclasses #2157
• refactor: move ClassWithSwitchExample.java to testclasses refactor: move ClassWithSwitchExample.java to testclasses #2158
• refactor: move OpCode.java, Performable.java and Regular.java to testclasses refactor: move OpCode.java, Performable.java and Regular.java to testclasses #2163
• refactor: move Foo.java and ToEvaluate.java to testclasses refactor: move Foo.java and ToEvaluate.java to testclasses #2164
• refactor: move resources to testclasses in fieldaccesses refactor: move resources to testclasses in fieldaccesses #2168
• refactor: move resources to testclasses in filters (re-introduced) refactor: move resources to testclasses in filters (re-introduced) #2222
• refactor: move resources to testclasses in generics refactor: move resources to testclasses in generics #2177
• refactor: move resources to testclasses in initializers refactor: move resources to testclasses in initializers #2178
• refactor: move Validation.java to testclasses in prettyprinter refactor: move Validation.java to testclasses in prettyprinter #2181
• refactor: move Ifs.java to testclasses refactor: move Ifs.java to testclasses in control #2182 in control
• refactor: move ReferenceQueryTestEnum to testclasses in reflect.visitor refactor: move ReferenceQueryTestEnum to testclasses in reflect.visitor #2184
• refactor: move Dummy to testclasses in serializable refactor: move Dummy to testclasses in serializable #2185
• refactor: move VarArgsSample.java to testclasses in varargs refactor: move VarArgsSample.java to testclasses in varargs #2188
• refactor: move resources to testclasses in trycatch refactor: move resources to testclasses in trycatch #2189
• refactor: move resources to testclasses in secondaryclasses refactor: move resources to testclasses in secondaryclasses #2191
• refactor: move resources to testclasses refactor: move resources to testclasses #2277 (filters, generics, path, strings)