Compare commits

...
8 Commits
Author SHA1 Message Date
KKlochko 71f30a43e9 Add the CHANGELOG.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-16 21:39:26 +03:00
KKlochko 0bb1daf784 Fix the project name for the gradle build.
continuous-integration/drone/tag Build is passing
2023-10-16 21:37:18 +03:00
KKlochko a258a5f785 Update the build configuration to make the JAR file.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-15 12:59:04 +03:00
KKlochko f384ce5fe5 Add SimpleEmptyTest and its tests.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-15 12:37:56 +03:00
KKlochko 5c1e69ed32 Add the error for an empty test.
continuous-integration/drone/tag Build is passing
2023-10-15 12:35:18 +03:00
KKlochko 2e12fdbd34 Update the titles for SimpleFailedThenTest and SimpleGivenWhenThenTest.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-15 12:11:56 +03:00
KKlochko 95a29a14fe Update the tests to test the multi-block test.
continuous-integration/drone/tag Build is passing
2023-10-15 12:10:33 +03:00
KKlochko d69cf31964 Add a multi-block test. 2023-10-15 12:02:24 +03:00
14 changed files with 455 additions and 49 deletions
+291
View File
@@ -0,0 +1,291 @@
# Change Log
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.12.7] - 2023-30-16
### Added
- Add the CHANGELOG.
## [0.12.6] - 2023-30-16
### Fixed
- Fix the project name for the gradle build.
## [0.12.5] - 2023-30-15
### Changed
- Update the build configuration to make the JAR file.
## [0.12.4] - 2023-30-15
### Added
- Add SimpleEmptyTest and its tests.
## [0.12.3] - 2023-30-15
### Added
- Add the error for an empty test.
## [0.12.2] - 2023-30-15
### Changed
- Update the titles for SimpleFailedThenTest and SimpleGivenWhenThenTest.
## [0.12.1] - 2023-30-15
### Added
- Add a multi-block test.
### Changed
- Update the tests to test the multi-block test.
## [0.12.0] - 2023-30-15
### Added
- Add the multi-block tests support.
## [0.11.2] - 2023-30-10
### Added
- Add the main entry point.
## [0.11.1] - 2023-30-10
### Added
- Add a constructor to set only a formatter for CLIReporter.
## [0.11.0] - 2023-30-10
### Added
- Add the CLITestRunner to run tests and to report the result.
## [0.10.1] - 2023-30-10
### Changed
- Update the CLI test formatting.
## [0.10.0] - 2023-30-8
### Added
- Add the SingleTestLoader to create an object of a loaded Test class.
## [0.9.2] - 2023-30-8
### Added
- Add a constructor with a default factory for TestCommandQueueFactory.
## [0.9.1] - 2023-30-8
### Fixed
- Fix the test title for SingleTestClassLoader.
## [0.9.0] - 2023-30-7
### Added
- Add the AbstractReporter.
- Add the CLIReporter and its tests.
## [0.8.3] - 2023-30-7
### Added
- Add Apache Commons Lang library.
- Add default constructor for SimpleTestReportFormatter.
## [0.8.2] - 2023-30-6
### Added
- Add the AbstractTestReportFormatter.
### Changed
- Refactor the SimpleTestReportFormatter to use the interface.
## [0.8.1] - 2023-30-6
### Fixed
- Fix the encoding issue.
## [0.8.0] - 2023-30-4
### Added
- Add the SimpleTestReportFormatter.
## [0.7.0] - 2023-30-3
### Added
- Add the TestCommandMetaDataFactory to generate the metadata.
## [0.6.3] - 2023-30-1
### Added
- Add the ClassLoader.
## [0.6.2] - 2023-30-1
### Fixed
- Fix typos and improve description in the tests.
## [0.6.1] - 2023-09-30
### Added
- Add the com.google.guava as a dependency.
- Add the NameClassLoader.
## [0.6.0] - 2023-09-29
### Added
- Add the single class loader.
## [0.5.4] - 2023-09-27
### Added
- Add the queue factory for test commands.
## [0.5.3] - 2023-09-26
### Added
- Add Abstract and Simple factories to create a test runner.
## [0.5.2] - 2023-09-26
### Changed
- Refactor tests for the SimpleTestRunner.
- Refactor the SimpleTestRunner and its test.
## [0.5.1] - 2023-09-24
### Fixed
- Fix the BlockDecorator to throw the AsssertionError, if any.
## [0.5.0] - 2023-09-24
### Added
- Add SimpleTestRunner as a test runner.
## [0.4.1] - 2023-09-23
### Added
- Add the CI/CD configuration for Gradle and Maven build.
## [0.4.0] - 2023-09-23
### Added
- Add the create method for the TestCommandFactory.
## [0.3.1] - 2023-09-23
### Added
- Add the test block decorator.
## [0.3.0] - 2023-09-23
### Added
- Add abstract and simple test commands.
## [0.2.7] - 2023-09-23
### Added
- Add a test example without a title annotation.
## [0.2.6] - 2023-09-23
### Changed
- Update test examples to have annotations with values.
## [0.2.5] - 2023-09-23
### Added
- Add the Title annotation.
## [0.2.4] - 2023-09-20
### Added
- Add the TestCommandFactory with a getTestMethods.
## [0.2.3] - 2023-09-20
### Added
- Add the Test class as ABC.
## [0.2.2] - 2023-09-20
### Added
- Add test examples.
## [0.2.1] - 2023-09-20
### Changed
- Refactor the Sum class to be moved into the samples package.
## [0.2.0] - 2023-09-19
### Added
- Add the Given-When-Then annotations.
## [0.1.2] - 2023-09-19
### Removed
- Remove the test examples.
## [0.1.1] - 2023-09-19
### Added
- Add the Sum class to test as an example.
## [0.1.0] - 2023-09-19
### Added
- Project initialization.
[Unreleased]: https://gitlab.com/KKlochko/cipher-analytical-machine/-/compare/0.5.3...main?from_project_id=50218541&straight=false
: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.7...main?from_project_id=50536015&straight=false
[0.12.7]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.6...0.12.7?from_project_id=50536015&straight=false
[0.12.6]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.5...0.12.6?from_project_id=50536015&straight=false
[0.12.5]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.4...0.12.5?from_project_id=50536015&straight=false
[0.12.4]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.3...0.12.4?from_project_id=50536015&straight=false
[0.12.3]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.2...0.12.3?from_project_id=50536015&straight=false
[0.12.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.1...0.12.2?from_project_id=50536015&straight=false
[0.12.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.0...0.12.1?from_project_id=50536015&straight=false
[0.12.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.11.2...0.12.0?from_project_id=50536015&straight=false
[0.11.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.11.1...0.11.2?from_project_id=50536015&straight=false
[0.11.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.11.0...0.11.1?from_project_id=50536015&straight=false
[0.11.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.10.1...0.11.0?from_project_id=50536015&straight=false
[0.10.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.10.0...0.10.1?from_project_id=50536015&straight=false
[0.10.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.9.2...0.10.0?from_project_id=50536015&straight=false
[0.9.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.9.1...0.9.2?from_project_id=50536015&straight=false
[0.9.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.9.0...0.9.1?from_project_id=50536015&straight=false
[0.9.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.8.3...0.9.0?from_project_id=50536015&straight=false
[0.8.3]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.8.2...0.8.3?from_project_id=50536015&straight=false
[0.8.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.8.1...0.8.2?from_project_id=50536015&straight=false
[0.8.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.8.0...0.8.1?from_project_id=50536015&straight=false
[0.8.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.7.0...0.8.0?from_project_id=50536015&straight=false
[0.7.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.6.3...0.7.0?from_project_id=50536015&straight=false
[0.6.3]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.6.2...0.6.3?from_project_id=50536015&straight=false
[0.6.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.6.1...0.6.2?from_project_id=50536015&straight=false
[0.6.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.6.0...0.6.1?from_project_id=50536015&straight=false
[0.6.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.5.4...0.6.0?from_project_id=50536015&straight=false
[0.5.4]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.5.3...0.5.4?from_project_id=50536015&straight=false
[0.5.3]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.5.2...0.5.3?from_project_id=50536015&straight=false
[0.5.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.5.1...0.5.2?from_project_id=50536015&straight=false
[0.5.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.5.0...0.5.1?from_project_id=50536015&straight=false
[0.5.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.4.1...0.5.0?from_project_id=50536015&straight=false
[0.4.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.4.0...0.4.1?from_project_id=50536015&straight=false
[0.4.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.3.1...0.4.0?from_project_id=50536015&straight=false
[0.3.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.3.0...0.3.1?from_project_id=50536015&straight=false
[0.3.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.7...0.3.0?from_project_id=50536015&straight=false
[0.2.7]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.6...0.2.7?from_project_id=50536015&straight=false
[0.2.6]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.5...0.2.6?from_project_id=50536015&straight=false
[0.2.5]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.4...0.2.5?from_project_id=50536015&straight=false
[0.2.4]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.3...0.2.4?from_project_id=50536015&straight=false
[0.2.3]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.2...0.2.3?from_project_id=50536015&straight=false
[0.2.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.1...0.2.2?from_project_id=50536015&straight=false
[0.2.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.2.0...0.2.1?from_project_id=50536015&straight=false
[0.2.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.1.2...0.2.0?from_project_id=50536015&straight=false
[0.1.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.1.1...0.1.2?from_project_id=50536015&straight=false
[0.1.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.1.0...0.1.1?from_project_id=50536015&straight=false
[0.1.0]: https://gitlab.com/KKlochko/simple-jbdd/-/commit/dabb09c518cdfad4aa05ac9d86c857833b8db41c
+11 -1
View File
@@ -1,11 +1,21 @@
plugins {
id('groovy')
id('application')
id 'com.github.johnrengelman.shadow' version '7.1.2'
}
version = "1.0"
description = "simple-jbdd is a simple BDD testing framework for Java."
// Spock works with Java 1.8 and above
application {
mainClassName = 'space.kklochko.simple_jbdd.Main'
}
shadowJar {
mergeServiceFiles()
minimize()
}
java {
toolchain {
languageVersion.set(JavaLanguageVersion.of(17))
+26 -11
View File
@@ -18,6 +18,32 @@
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.2</version>
<configuration>
<archive>
<manifest>
<mainClass>space.kklochko.simple_jbdd.Main</mainClass>
<addClasspath>true</addClasspath>
</manifest>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.4.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- Mandatory plugins for using Spock -->
<plugin>
<!-- The gmavenplus plugin is used to compile Groovy code. To learn more about this plugin,
@@ -124,16 +150,5 @@
<version>2.2</version>
<scope>test</scope>
</dependency>
<!-- Dependencies used by examples in this project (not required for using Spock) -->
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>2.2.222</version>
</dependency>
<dependency>
<groupId>org.apache.groovy</groupId>
<artifactId>groovy-sql</artifactId>
<version>${groovy.version}</version>
</dependency>
</dependencies>
</project>
+1 -1
View File
@@ -1 +1 @@
rootProject.name = "simple_bdd"
rootProject.name = "simple_jbdd"
@@ -0,0 +1,12 @@
package space.kklochko.simple_jbdd.test_examples.tests;
import space.kklochko.simple_jbdd.annotations.Title;
import space.kklochko.simple_jbdd.tests.Test;
@Title("A Simple Empty Test for Sum")
public class SimpleEmptyTest extends Test {
public void check() {
assert 30 == 10 + 20 + 1;
}
}
@@ -5,7 +5,7 @@ import space.kklochko.simple_jbdd.annotations.Title;
import space.kklochko.simple_jbdd.tests.Test;
@Title("A Simple Failed GivenWhenTest for Sum")
@Title("A Simple Failed Then Test for Sum")
public class SimpleFailedThenTest extends Test {
@Then
public void check() {
@@ -0,0 +1,51 @@
package space.kklochko.simple_jbdd.test_examples.tests;
import space.kklochko.simple_jbdd.annotations.Given;
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.test_examples.samples.Sum;
import space.kklochko.simple_jbdd.tests.Test;
@Title("A Simple GivenGivenWhenWhenThenThen Test for Sum")
public class SimpleGivenGivenWhenWhenThenThenTest extends Test {
private Sum sum;
private int a;
private int b;
private int c;
private int resultAB;
private int resultCB;
@Given("Create the Sum object")
void setup() {
sum = new Sum();
}
@Given("Setup the arguments")
void setupArgs() {
a = 10;
b = 20;
c = 30;
}
@When("Call the .sum(10, 20)")
void triggerAB() {
resultAB = sum.sum(a, b);
}
@When("Call the .sum(30, 20)")
void triggerCB() {
resultCB = sum.sum(c, b);
}
@Then("10 + 20 is 30")
void checkAB() {
assert 30 == resultAB;
}
@Then("30 + 20 is 50")
void checkCB() {
assert 50 == resultCB;
}
}
@@ -7,7 +7,7 @@ import space.kklochko.simple_jbdd.annotations.When;
import space.kklochko.simple_jbdd.test_examples.samples.Sum;
import space.kklochko.simple_jbdd.tests.Test;
@Title("A Simple GivenWhenTest for Sum")
@Title("A Simple GivenWhenThen Test for Sum")
public class SimpleGivenWhenThenTest extends Test {
private Sum sum;
private int a;
@@ -0,0 +1,20 @@
package space.kklochko.simple_jbdd.tests.commands.decorators;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
public class ErrorDecorator<T extends Test> extends AbstractDecorator<T> {
public ErrorDecorator(String error_label, AbstractTestCommand<T> command, String type) {
super(error_label, command);
setType(type);
}
public boolean test() {
return false;
}
public boolean runMethod() {
return false;
};
}
@@ -8,6 +8,7 @@ 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 space.kklochko.simple_jbdd.tests.commands.decorators.ErrorDecorator;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
@@ -20,6 +21,9 @@ public class TestCommandFactory {
AbstractTestCommand<Test> aTestCommand = createTest(aClass, input);
if(test_methods.size() == 0)
return new ErrorDecorator("ERROR!!! No blocks!!!", aTestCommand, "Error");
if(test_methods.containsKey("Then")) {
ArrayList<Method> thens = getMethodsInReverseOrder(test_methods, "Then");
for(Method then : thens) {
@@ -1,5 +1,7 @@
package space.kklochko.simple_jbdd.tests.factories
import space.kklochko.simple_jbdd.test_examples.tests.SimpleEmptyTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenGivenWhenWhenThenThenTest
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
@@ -14,19 +16,28 @@ those tests check if factory generate them right.
""")
@Title("Unit tests for TestCommandFactory")
class TestCommandFactorySpec extends Specification {
def "If the map of methods have one test block."() {
def "The command have the same block count."() {
given: "I have a TestCommandFactory object"
@Subject
def factory = new TestCommandFactory();
and: "I also have a SimpleThenTest object"
def simpleThenTest = new SimpleThenTest()
when: "If a test command have blocks"
def map = factory.getTestMethods(testClass.getClass())
when: "If a test have only one block"
def map = factory.getTestMethods(simpleThenTest.getClass())
def count = map.values()
.stream()
.map {it.size()}
.reduce(0) { acc, num -> acc + num }
then: "the map size is 1 method"
1 == map.size()
then: "the command have the expected block count"
expectedBlockCount == count
where:
testClass || expectedBlockCount
new SimpleEmptyTest() || 0
new SimpleThenTest() || 1
new SimpleGivenWhenThenTest() || 3
new SimpleGivenGivenWhenWhenThenThenTest() || 6
}
def "createTest() sets the title to a class name if no Title annotation."() {
@@ -63,34 +74,22 @@ class TestCommandFactorySpec extends Specification {
title == test.getLabels()['Title']
}
def "createTest() build a Test with only Then."() {
def "createTest() build a TestCommand that contains the expected blocks."() {
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()
}
then: "The test have the expected blocks"
expectedBlocks.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()
where:
testClass || expectedBlocks
new SimpleThenTest() || ['Title', 'Then']
new SimpleGivenWhenThenTest() || ['Title', 'Given', 'When', 'Then']
new SimpleGivenGivenWhenWhenThenThenTest() || ['Title', 'Given', 'When', 'Then']
}
}
@@ -22,7 +22,7 @@ class IntegratedClassLoader extends Specification {
def classes = loader.load()
then: "Checking that the test result is expected"
3 == classes.size()
5 == classes.size()
}
def "The classes must be represent the Test interface."() {
@@ -19,7 +19,7 @@ class IntegratedNameClassLoader extends Specification {
def classNames = loader.load()
then: "Checking that the test result is expected"
3 == classNames.size()
5 == classNames.size()
}
}
@@ -1,6 +1,8 @@
package space.kklochko.simple_jbdd.tests.runners
import space.kklochko.simple_jbdd.test_examples.tests.SimpleEmptyTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleFailedThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenGivenWhenWhenThenThenTest
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
@@ -33,10 +35,12 @@ class IntegratedSimpleTestRunnerSpec extends Specification {
result == expectedResult
where: "Possible variants of tests"
testObject || expectedResult
new SimpleThenTest() || true
new SimpleGivenWhenThenTest() || true
new SimpleThenTestWithoutTitle() || true
new SimpleFailedThenTest() || false
testObject || expectedResult
new SimpleThenTest() || true
new SimpleGivenWhenThenTest() || true
new SimpleThenTestWithoutTitle() || true
new SimpleFailedThenTest() || false
new SimpleGivenGivenWhenWhenThenThenTest() || true
new SimpleEmptyTest() || false
}
}