Compare commits

...
12 Commits
Author SHA1 Message Date
KKlochko 19f638e091 Fix typos and improve description in the tests.
continuous-integration/drone/tag Build is passing
2023-10-01 20:09:07 +03:00
KKlochko 38f4cf3464 Add the NameClassLoader.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-09-30 21:25:37 +03:00
KKlochko a0880372f8 Add the com.google.guava as a dependency. 2023-09-30 21:12:12 +03:00
KKlochko db0c3da413 Add the single class loader.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-09-29 20:47:36 +03:00
KKlochko 75e30ddae9 Add the queue factory for test commands.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-09-27 21:56:12 +03:00
KKlochko 9056c8d047 Add Abstract and Simple factories to create a test runner.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-09-26 22:17:17 +03:00
KKlochko a1b85e3771 Refactor the SimpleTestRunner and its test.
continuous-integration/drone/tag Build is passing
2023-09-26 22:14:55 +03:00
KKlochko 0683be643f Refactor tests for the SimpleTestRunner.
continuous-integration/drone/push Build is passing
2023-09-25 17:09:18 +03:00
KKlochko e67bdc4bb0 Fix the BlockDecorator to throw the AsssertionError, if any.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-09-24 21:52:25 +03:00
KKlochko 9a14ea6486 Add SimpleTestRunner as a test runner.
continuous-integration/drone/tag Build is failing
2023-09-24 21:48:49 +03:00
KKlochko 1549f85a49 Add the CI/CD configuration for Gradle and Maven build.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-09-23 21:56:28 +03:00
KKlochko efb644e6a9 Add the create method for the TestCommandFactory. 2023-09-23 21:43:56 +03:00
20 changed files with 550 additions and 4 deletions
+24
View File
@@ -0,0 +1,24 @@
---
kind: pipeline
type: docker
name: gradle
steps:
- name: test
image: gradle:8.3.0-jdk17-graal
commands:
- gradle assemble
- gradle check
---
kind: pipeline
type: docker
name: maven
steps:
- name: test
image: maven:3.9.4-eclipse-temurin-17-alpine
commands:
- mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
- mvn test -B
+1
View File
@@ -18,6 +18,7 @@ repositories {
} }
dependencies { dependencies {
implementation 'com.google.guava:guava:32.1.2-jre'
// mandatory dependencies for using Spock // mandatory dependencies for using Spock
implementation platform('org.apache.groovy:groovy-bom:4.0.15') implementation platform('org.apache.groovy:groovy-bom:4.0.15')
implementation 'org.apache.groovy:groovy' implementation 'org.apache.groovy:groovy'
+7
View File
@@ -12,6 +12,8 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<groovy.version>4.0.15</groovy.version> <groovy.version>4.0.15</groovy.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties> </properties>
<build> <build>
@@ -77,6 +79,11 @@
</dependencyManagement> </dependencyManagement>
<dependencies> <dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>32.1.2-jre</version>
</dependency>
<!-- Mandatory dependencies for using Spock --> <!-- Mandatory dependencies for using Spock -->
<dependency> <dependency>
<groupId>org.spockframework</groupId> <groupId>org.spockframework</groupId>
@@ -28,6 +28,11 @@ public class BlockDecorator<T extends Test> extends AbstractDecorator<T> {
method.invoke(getCommand().getObject()); method.invoke(getCommand().getObject());
return true; return true;
} catch (InvocationTargetException e) { } catch (InvocationTargetException e) {
Throwable exception = e.getCause();
if(exception instanceof AssertionError)
throw (AssertionError) exception;
System.err.println(e.getMessage()); System.err.println(e.getMessage());
throw new RuntimeException(e); throw new RuntimeException(e);
} catch (IllegalAccessException e) { } catch (IllegalAccessException e) {
@@ -0,0 +1,10 @@
package space.kklochko.simple_jbdd.tests.factories;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import space.kklochko.simple_jbdd.tests.runners.AbstractTestRunner;
public abstract class AbstractTestRunnerFactory {
public abstract AbstractTestRunner create(AbstractTestCommand<Test> command);
}
@@ -0,0 +1,13 @@
package space.kklochko.simple_jbdd.tests.factories;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import space.kklochko.simple_jbdd.tests.runners.AbstractTestRunner;
import space.kklochko.simple_jbdd.tests.runners.SimpleTestRunner;
public class SimpleTestRunnerFactory extends AbstractTestRunnerFactory {
public AbstractTestRunner create(AbstractTestCommand<Test> command) {
return new SimpleTestRunner(command);
}
}
@@ -2,8 +2,12 @@ package space.kklochko.simple_jbdd.tests.factories;
import space.kklochko.simple_jbdd.annotations.Given; import space.kklochko.simple_jbdd.annotations.Given;
import space.kklochko.simple_jbdd.annotations.Then; import space.kklochko.simple_jbdd.annotations.Then;
import space.kklochko.simple_jbdd.annotations.Title;
import space.kklochko.simple_jbdd.annotations.When; import space.kklochko.simple_jbdd.annotations.When;
import space.kklochko.simple_jbdd.tests.Test; import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import space.kklochko.simple_jbdd.tests.commands.SimpleTestCommand;
import space.kklochko.simple_jbdd.tests.commands.decorators.BlockDecorator;
import java.lang.annotation.Annotation; import java.lang.annotation.Annotation;
import java.lang.reflect.Method; import java.lang.reflect.Method;
@@ -11,9 +15,41 @@ import java.util.Map;
import java.util.TreeMap; import java.util.TreeMap;
public class TestCommandFactory { public class TestCommandFactory {
public <T extends Test> void create(T input) { public AbstractTestCommand create(Test input) {
Class<?> aClass = input.getClass(); Class<?> aClass = input.getClass();
Map<String, Method> test_methods = this.getTestMethods(aClass); Map<String, Method> test_methods = this.getTestMethods(aClass);
AbstractTestCommand<Test> aTestCommand = createTest(aClass, input);
if(test_methods.containsKey("Then")) {
Method then = test_methods.get("Then");
String label = then.getAnnotation(Then.class).value();
aTestCommand = new BlockDecorator<Test>(label, aTestCommand, then, "Then");
}
if(test_methods.containsKey("When")) {
Method when = test_methods.get("When");
String label = when.getAnnotation(When.class).value();
aTestCommand = new BlockDecorator<Test>(label, aTestCommand, when, "When");
}
if(test_methods.containsKey("Given")) {
Method when = test_methods.get("Given");
String label = when.getAnnotation(Given.class).value();
aTestCommand = new BlockDecorator<Test>(label, aTestCommand, when, "Given");
}
return aTestCommand;
}
protected AbstractTestCommand<Test> createTest(Class<?> aClass, Test input) {
Title aTitle = aClass.getAnnotation(Title.class);
String title = aClass.getName();
if(aTitle != null)
title = aTitle.value();
return new SimpleTestCommand<Test>(title, input);
} }
protected <T extends Test> Map<String, Method> getTestMethods(Class<?> aClass) { protected <T extends Test> Map<String, Method> getTestMethods(Class<?> aClass) {
@@ -0,0 +1,44 @@
package space.kklochko.simple_jbdd.tests.factories;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import java.util.*;
public class TestCommandQueueFactory {
private ArrayList<Test> tests;
private TestCommandFactory factory;
public TestCommandQueueFactory(ArrayList<Test> tests, TestCommandFactory factory) {
setTests(tests);
setFactory(factory);
}
public ArrayList<AbstractTestCommand<Test>> create() {
ArrayList<AbstractTestCommand<Test>> commands = new ArrayList<AbstractTestCommand<Test>>();
for(Test test : getTests()) {
AbstractTestCommand<Test> command = getFactory().create(test);
commands.add(command);
}
return commands;
}
public ArrayList<Test> getTests() {
return tests;
}
public void setTests(ArrayList<Test> tests) {
this.tests = tests;
}
public TestCommandFactory getFactory() {
return factory;
}
public void setFactory(TestCommandFactory factory) {
this.factory = factory;
}
}
@@ -0,0 +1,8 @@
package space.kklochko.simple_jbdd.tests.loaders;
import java.util.Set;
public abstract class AbstractNameClassLoader {
public abstract Set<Class<?>> load();
}
@@ -0,0 +1,28 @@
package space.kklochko.simple_jbdd.tests.loaders;
import com.google.common.reflect.ClassPath;
import java.io.IOException;
import java.util.stream.Collectors;
import java.util.Set;
public class NameClassLoader extends AbstractNameClassLoader {
public Set<Class<?>> load() {
try {
return ClassPath.from(java.lang.ClassLoader.getSystemClassLoader())
.getAllClasses()
.stream()
// exclude the Test class, which indicate a Test class
.filter(aClass -> !aClass.getName().endsWith(".Test"))
.filter(aClass -> aClass.getName().endsWith("Test"))
// include classes which extends the Test class
.filter(aClass -> space.kklochko.simple_jbdd.tests.Test.class.isAssignableFrom(aClass.load()))
.filter(aClass -> aClass.getName().startsWith("space"))
.map(aClass -> aClass.load())
.collect(Collectors.toSet());
} catch (IOException e) {
return null;
}
}
}
@@ -0,0 +1,26 @@
package space.kklochko.simple_jbdd.tests.loaders;
public class SingleClassLoader {
String className;
public SingleClassLoader(String className) {
setClassName(className);
}
public Class<?> load() {
try {
return Class.forName(getClassName());
} catch (ClassNotFoundException e) {
return null;
}
}
public String getClassName() {
return className;
}
public void setClassName(String className) {
this.className = className;
}
}
@@ -0,0 +1,6 @@
package space.kklochko.simple_jbdd.tests.runners;
public abstract class AbstractTestRunner {
public abstract boolean run();
}
@@ -0,0 +1,29 @@
package space.kklochko.simple_jbdd.tests.runners;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
public class SimpleTestRunner extends AbstractTestRunner {
private AbstractTestCommand<Test> command;
public SimpleTestRunner(AbstractTestCommand<Test> command) {
setCommand(command);
}
public boolean run() {
try {
return getCommand().test();
}catch (AssertionError e) {
return false;
}
}
public AbstractTestCommand<Test> getCommand() {
return command;
}
public void setCommand(AbstractTestCommand<Test> command) {
this.command = command;
}
}
@@ -0,0 +1,54 @@
package space.kklochko.simple_jbdd.tests.factories
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenWhenThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTestWithoutTitle
import space.kklochko.simple_jbdd.tests.Test
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The factory must generate a queue of the test commands, so
those tests check if factory generate them right.
""")
@Title("Integrated tests for TestCommandQueueFactory")
class IntegratedTestCommandQueueFactorySpec extends Specification {
def "Factory generate the queue and its size is 2."() {
given: "I have a list of tests"
def tests = [new SimpleThenTest(), new SimpleThenTestWithoutTitle()]
and: "I have a test factory"
def testFactory = new TestCommandFactory()
and: "I have a factory"
@Subject
def factory = new TestCommandQueueFactory(tests, testFactory)
when: "Factory build the queue"
def queue = factory.create()
then: "the size is 2"
2 == queue.size()
}
def "Factory generate the queue and the commands and test order is the same."() {
given: "I have a list of tests with first methods [check, setup]"
def tests = [new SimpleThenTest(), new SimpleGivenWhenThenTest()]
and: "I have a test factory"
def testFactory = new TestCommandFactory()
and: "I have a factory"
@Subject
def factory = new TestCommandQueueFactory(tests, testFactory)
when: "Factory build the queue"
def queue = factory.create()
then: "the order is the same"
queue[0].method.getName() == "check"
queue[1].method.getName() == "setup"
}
}
@@ -1,12 +1,22 @@
package space.kklochko.simple_jbdd.tests.factories package space.kklochko.simple_jbdd.tests.factories
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenWhenThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest
import space.kklochko.simple_jbdd.tests.factories.TestCommandFactory; import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTestWithoutTitle
import space.kklochko.simple_jbdd.tests.factories.TestCommandFactory
import spock.lang.Narrative;
import spock.lang.Specification import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The factory must generate a test command, so
those tests check if factory generate them right.
""")
@Title("Unit tests for TestCommandFactory")
class TestCommandFactorySpec extends Specification { class TestCommandFactorySpec extends Specification {
def "If the map of methods have one test block."() { def "If the map of methods have one test block."() {
given: "I have a TestCommandFactory object" given: "I have a TestCommandFactory object"
@Subject
def factory = new TestCommandFactory(); def factory = new TestCommandFactory();
and: "I also have a SimpleThenTest object" and: "I also have a SimpleThenTest object"
@@ -18,5 +28,69 @@ class TestCommandFactorySpec extends Specification {
then: "the map size is 1 method" then: "the map size is 1 method"
1 == map.size() 1 == map.size()
} }
def "createTest() sets the title to a class name if no Title annotation."() {
given: "I have a test factory"
@Subject
def factory = new TestCommandFactory()
and: "I have a test class without Title"
def testClass = new SimpleThenTestWithoutTitle()
when: "I build a test"
def test = factory.create(testClass)
then: "The test have title as the test class"
testClass.class.getName() == test.getLabels()['Title']
}
def "createTest() sets the title to a value of the Title annotation."() {
given: "I have a test factory"
@Subject
def factory = new TestCommandFactory()
and: "I have a test class with Title"
def testClass = new SimpleThenTest()
and: "and the title of the annotation"
def titleClass = space.kklochko.simple_jbdd.annotations.Title.class
def title = testClass.getClass().getAnnotation(titleClass).value()
when: "I build a test"
def test = factory.create(testClass)
then: "The test have title as the test class"
title == test.getLabels()['Title']
}
def "createTest() build a Test with only Then."() {
given: "I have a test factory"
@Subject
def factory = new TestCommandFactory()
and: "I have a test class with Title"
def testClass = new SimpleThenTest()
when: "I build a test"
def test = factory.create(testClass)
then: "The test have title and then method"
['Title', 'Then'].toSet() == test.getLabels().keySet()
}
def "createTest() build a Test with Given-When-Then."() {
given: "I have a test factory"
@Subject
def factory = new TestCommandFactory()
and: "I have a test class with Title and Given-When-Then"
def testClass = new SimpleGivenWhenThenTest()
when: "I build a test"
def test = factory.create(testClass)
then: "The test have title and then method"
['Title', 'Given', 'When', 'Then'].toSet() == test.getLabels().keySet()
}
} }
@@ -0,0 +1,36 @@
package space.kklochko.simple_jbdd.tests.factories
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTestWithoutTitle
import space.kklochko.simple_jbdd.tests.Test
import space.kklochko.simple_jbdd.tests.commands.decorators.BlockDecorator
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The factory must generate a queue of the test commands, so
those tests check if factory generate them right.
""")
@Title("Unit tests for TestCommandQueueFactory")
class TestCommandQueueFactorySpec extends Specification {
def "Factory generate the queue and its size is 2."() {
given: "I have a list of tests"
def tests = [Mock(SimpleThenTest), Mock(SimpleThenTestWithoutTitle)]
and: "I have a test factory"
def testFactory = Stub(TestCommandFactory)
testFactory.create() >>> [Mock(BlockDecorator<Test>)]*2
and: "I have the factory"
@Subject
def factory = new TestCommandQueueFactory(tests, testFactory)
when: "Factory build the queue"
def queue = factory.create()
then: "the size is 2"
2 == queue.size()
}
}
@@ -0,0 +1,25 @@
package space.kklochko.simple_jbdd.tests.loaders
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The loader must return a test class names or null, so
those tests check if responses are right.
""")
@Title("Integrated tests for NameClassLoader.")
class IntegratedNameClassLoader extends Specification {
def "The class names have been loaded."() {
given: "I have a class loader"
@Subject
def loader = new NameClassLoader()
when: "The class names were loaded"
def classNames = loader.load()
then: "Checking that the test result is expected"
3 == classNames.size()
}
}
@@ -0,0 +1,31 @@
package space.kklochko.simple_jbdd.tests.loaders
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The loader must return a class or null, so
those tests check if responses are right.
""")
@Title("Integrated tests for ClassLoader.")
class IntegratedSingleClassLoader extends Specification {
def "The class has been loaded."() {
given: "I have a class loader"
@Subject
def loader = new SingleClassLoader(className)
when: "The class was loaded"
def aClass = loader.load()
then: "Checking that the test result is expected"
aClass == expectedClass
where: "Possible variants of tests"
className || expectedClass
"fourHundredFour" || null
"space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest" || SimpleThenTest
}
}
@@ -0,0 +1,42 @@
package space.kklochko.simple_jbdd.tests.runners
import space.kklochko.simple_jbdd.test_examples.tests.SimpleFailedThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenWhenThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTestWithoutTitle
import space.kklochko.simple_jbdd.tests.factories.TestCommandFactory
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The runner must return a result of test, so
those tests check if passed and failed test generate the right result.
""")
@Title("Integrated tests for SimpleTestRunner with TestCommandFactory and test examples")
class IntegratedSimpleTestRunnerSpec extends Specification {
def "The real test has been run."() {
given: "I have a factory"
def factory = new TestCommandFactory();
and: "I have a testCommand created from a test object"
def test = factory.create(testObject)
and: "I have a test runner"
@Subject
def runner = new SimpleTestRunner(test)
when: "The testCommand has been run"
def result = runner.run()
then: "Checking that the test result is expected"
result == expectedResult
where: "Possible variants of tests"
testObject || expectedResult
new SimpleThenTest() || true
new SimpleGivenWhenThenTest() || true
new SimpleThenTestWithoutTitle() || true
new SimpleFailedThenTest() || false
}
}
@@ -0,0 +1,47 @@
package space.kklochko.simple_jbdd.tests.runners
import space.kklochko.simple_jbdd.tests.commands.SimpleTestCommand
import space.kklochko.simple_jbdd.tests.factories.TestCommandFactory
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The runner must return a result of test, so
those tests check if passed and failed test generate the right result.
""")
@Title("Unit tests for SimpleTestRunner")
class SimpleTestRunnerSpec extends Specification {
def "The test with then has been passed."() {
given: "I have a testCommand"
def test = Stub(SimpleTestCommand)
test.test() >>> [true]
and: "I have a test runner"
@Subject
def runner = new SimpleTestRunner(test)
when: "The testCommand has been run"
def result = runner.run()
then: "The result is true"
result
}
def "The test with then that has not been passed."() {
given: "I have a failed testCommand"
def test = Stub(SimpleTestCommand)
test.test() >> { assert 1 == 0 }
and: "I have a test runner"
@Subject
def runner = new SimpleTestRunner(test)
when: "The testCommand has been run"
def result = runner.run()
then: "The result is false"
!result
}
}