Compare commits

..
67 Commits
Author SHA1 Message Date
KKlochko 74d7d48773 Update the CHANGELOG.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-11-02 21:03:03 +02:00
KKlochko 5427de414f Update the version. 2023-11-02 20:57:18 +02:00
KKlochko 82d8b4db8d Fix the typo in the README. 2023-11-02 20:56:35 +02:00
KKlochko 32bd931afc Update the CI/CD configuration to publish the artifacts to the release.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-19 13:29:58 +03:00
KKlochko 29b11f454f Update the CHANGELOG. 2023-10-19 13:29:27 +03:00
KKlochko ec1053741e Update the version. 2023-10-19 13:28:36 +03:00
KKlochko d5dbf2942d Fix the validators's test have two variant of the order for methods.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-19 09:35:45 +03:00
KKlochko a6831ed77e Update the CHANGELOG.
continuous-integration/drone/push Build is failing
2023-10-18 22:22:52 +03:00
KKlochko d06a76e1e3 Update the version. 2023-10-18 22:22:23 +03:00
KKlochko 8cdb151357 Update the README. 2023-10-18 22:22:00 +03:00
KKlochko afc43f49eb Add the license, LGPLv3. 2023-10-18 22:02:54 +03:00
KKlochko 87c9c83c20 Add the tests for test validators.
continuous-integration/drone/push Build is failing
2023-10-18 22:00:20 +03:00
KKlochko 11b1377a37 Update the TestCommandFactory to have the validators.
continuous-integration/drone/push Build is passing
2023-10-17 22:27:05 +03:00
KKlochko 238957419e Update the block to run only a public method. 2023-10-17 22:25:38 +03:00
KKlochko c00320e295 Fix the test count for ClassLoader's test. 2023-10-17 22:23:38 +03:00
KKlochko ba9ce975c8 Add the invalid tests. 2023-10-17 22:22:27 +03:00
KKlochko 7ac264e5e8 Fix the given-when-then tests to have public methods. 2023-10-17 22:20:51 +03:00
KKlochko e6de1bde03 Add a Calculator and its tests. 2023-10-17 22:20:17 +03:00
KKlochko 8b7ba5f18b Add validators to show error if a test method is invalid. 2023-10-17 22:12:55 +03:00
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
KKlochko 79c2f159e1 Add the multi-block tests support.
continuous-integration/drone/tag Build is passing
2023-10-15 12:02:02 +03:00
KKlochko b99f90132a Add the main entry point.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-10 21:43:19 +03:00
KKlochko 3d6b7b4d58 Add a constructor to set only a formatter for CLIReporter.
continuous-integration/drone/tag Build is passing
2023-10-10 21:41:43 +03:00
KKlochko d1399dac02 Add the CLITestRunner to run tests and to report the result.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-10 21:38:47 +03:00
KKlochko 59d8fe7a4f Update the CLI test formatting.
continuous-integration/drone/tag Build is passing
2023-10-10 21:33:15 +03:00
KKlochko c27d3eca13 Add the SingleTestLoader to create an object of a loaded Test class.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-08 19:57:51 +03:00
KKlochko 1e3446a431 Add a constructor with a default factory for TestCommandQueueFactory.
continuous-integration/drone/tag Build is passing
2023-10-08 19:56:10 +03:00
KKlochko b1ef8dc32f Fix the test title for SingleTestClassLoader.
continuous-integration/drone/tag Build is passing
2023-10-08 19:55:30 +03:00
KKlochko b57b005d97 Add the CLIReporter and its tests.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-07 20:11:45 +03:00
KKlochko 9945480a6a Add the AbstractReporter. 2023-10-07 20:10:53 +03:00
KKlochko df7c7e2b9f Add default constructor for SimpleTestReportFormatter.
continuous-integration/drone/tag Build is passing
2023-10-07 20:07:31 +03:00
KKlochko 28cd218bf7 Add Apache Commons Lang library. 2023-10-07 20:05:45 +03:00
KKlochko ff09435c04 Refactor the SimpleTestReportFormatter to use the interface.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-06 22:11:19 +03:00
KKlochko 6d76646d16 Add the AbstractTestReportFormatter. 2023-10-06 22:11:01 +03:00
KKlochko 458091a7e2 Fix the encoding issue.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-06 18:38:54 +03:00
KKlochko 696037c2d3 Add the SimpleTestReportFormatter.
continuous-integration/drone/push Build is failing
continuous-integration/drone/tag Build is failing
2023-10-04 22:38:15 +03:00
KKlochko 189ba44c1d Add the TestCommandMetaDataFactory to generate the metadata.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-03 22:33:49 +03:00
KKlochko bcdd11c5a3 Add the ClassLoader.
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-10-01 20:16:05 +03:00
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
KKlochko 6a3d7f4f42 Add the test block decorator. 2023-09-23 21:41:42 +03:00
KKlochko 6feb7f87dc Add abstract and simple test commands. 2023-09-23 21:34:54 +03:00
KKlochko 47af8b4522 Add a test example without a title annotation. 2023-09-23 21:31:23 +03:00
KKlochko db8fe1fc47 Update test examples to have annotations with values. 2023-09-23 21:31:01 +03:00
KKlochko e803452389 Add the Title annotation. 2023-09-23 21:25:26 +03:00
KKlochko 08c85459a7 Add the TestCommandFactory with a getTestMethods. 2023-09-20 22:23:18 +03:00
KKlochko 9edbca09cf Add the Test class as ABC. 2023-09-20 22:19:41 +03:00
KKlochko b3a010f6e9 Add test examples. 2023-09-20 20:35:30 +03:00
KKlochko b1332c838b Refactor the Sum class to be moved into the samples package. 2023-09-20 20:33:44 +03:00
KKlochko df1261f31c Add the Given-When-Then annotations. 2023-09-19 22:07:23 +03:00
77 changed files with 4213 additions and 253 deletions
+58
View File
@@ -0,0 +1,58 @@
---
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
volumes:
- name: package_cache
path: /root/.m2/
commands:
- mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
- mvn test -B
- name: build
image: maven:3.9.4-eclipse-temurin-17-alpine
volumes:
- name: package_cache
path: /root/.m2/
commands:
- mvn package -Dmaven.test.skip=true
- name: gitea_release
image: plugins/gitea-release
settings:
api_key:
from_secret: API_KEY
base_url:
from_secret: BASE_URL
files:
- target/*.jar
checksum:
- md5
- sha1
- sha256
- sha512
- adler32
- crc32
when:
event: tag
volumes:
- name: package_cache
temp: {}
+345
View File
@@ -0,0 +1,345 @@
# 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.13.5] - 2023-11-02
### Fixed
- Fix the typo in the README.
### Changed
- Update the version.
- Update the CHANGELOG.
## [0.13.4] - 2023-10-19
### Changed
- Update the version.
- Update the CHANGELOG.
- Update the CI/CD configuration to publish the artifacts to the release.
## [0.13.3] - 2023-10-19
### Fixed
- Fix the validators's test have two variant of the order for methods.
## [0.13.2] - 2023-10-18
### Changed
- Update the README.
- Update the version.
- Update the CHANGELOG.
## [0.13.1] - 2023-10-18
### Changed
- Add the license, LGPLv3.
## [0.13.0] - 2023-10-18
### Added
- Add validators to show error if a test method is invalid.
- Add a Calculator and its tests.
- Add the invalid tests.
- Add the tests for test validators.
### Fixed
- Fix the given-when-then tests to have public methods.
- Fix the test count for ClassLoader's test.
### Changed
- Update the block to run only a public method.
- Update the TestCommandFactory to have the validators.
## [0.12.7] - 2023-10-16
### Added
- Add the CHANGELOG.
## [0.12.6] - 2023-10-16
### Fixed
- Fix the project name for the gradle build.
## [0.12.5] - 2023-10-15
### Changed
- Update the build configuration to make the JAR file.
## [0.12.4] - 2023-10-15
### Added
- Add SimpleEmptyTest and its tests.
## [0.12.3] - 2023-10-15
### Added
- Add the error for an empty test.
## [0.12.2] - 2023-10-15
### Changed
- Update the titles for SimpleFailedThenTest and SimpleGivenWhenThenTest.
## [0.12.1] - 2023-10-15
### Added
- Add a multi-block test.
### Changed
- Update the tests to test the multi-block test.
## [0.12.0] - 2023-10-15
### Added
- Add the multi-block tests support.
## [0.11.2] - 2023-10-10
### Added
- Add the main entry point.
## [0.11.1] - 2023-10-10
### Added
- Add a constructor to set only a formatter for CLIReporter.
## [0.11.0] - 2023-10-10
### Added
- Add the CLITestRunner to run tests and to report the result.
## [0.10.1] - 2023-10-10
### Changed
- Update the CLI test formatting.
## [0.10.0] - 2023-10-8
### Added
- Add the SingleTestLoader to create an object of a loaded Test class.
## [0.9.2] - 2023-10-8
### Added
- Add a constructor with a default factory for TestCommandQueueFactory.
## [0.9.1] - 2023-10-8
### Fixed
- Fix the test title for SingleTestClassLoader.
## [0.9.0] - 2023-10-7
### Added
- Add the AbstractReporter.
- Add the CLIReporter and its tests.
## [0.8.3] - 2023-10-7
### Added
- Add Apache Commons Lang library.
- Add default constructor for SimpleTestReportFormatter.
## [0.8.2] - 2023-10-6
### Added
- Add the AbstractTestReportFormatter.
### Changed
- Refactor the SimpleTestReportFormatter to use the interface.
## [0.8.1] - 2023-10-6
### Fixed
- Fix the encoding issue.
## [0.8.0] - 2023-10-4
### Added
- Add the SimpleTestReportFormatter.
## [0.7.0] - 2023-10-3
### Added
- Add the TestCommandMetaDataFactory to generate the metadata.
## [0.6.3] - 2023-10-1
### Added
- Add the ClassLoader.
## [0.6.2] - 2023-10-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.13.5...main?from_project_id=50218541&straight=false
[0.13.5]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.13.4...0.13.5?from_project_id=50536015&straight=false
[0.13.4]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.13.3...0.13.4?from_project_id=50536015&straight=false
[0.13.3]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.13.2...0.13.3?from_project_id=50536015&straight=false
[0.13.2]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.13.1...0.13.2?from_project_id=50536015&straight=false
[0.13.1]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.13.0...0.13.1?from_project_id=50536015&straight=false
[0.13.0]: https://gitlab.com/KKlochko/simple-jbdd/-/compare/0.12.7...0.13.0?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
+674
View File
@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
+165
View File
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
-202
View File
@@ -1,202 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-27
View File
@@ -1,27 +0,0 @@
== simple-jbdd
This project is a simple BDD framework.
The project uses the https://github.com/spockframework/[Spock Framework Example Project^]
=== Prerequisites
- JDK 17 or higher
- Maven use `mvnw` wrapper
- Gradle use `gradlew` wrapper
=== Building with Gradle
Type:
./gradlew clean test
Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically *user_home*`/.gradle`).
=== Building with Maven
Type:
./mvnw clean test
Downloaded files will be stored in the local Maven repository (typically *user_home*`/.m2/repository`).
+67
View File
@@ -0,0 +1,67 @@
# simple-jbdd
This project is a simple BDD framework.
The project uses the [Spock Framework Example Project](https://github.com/spockframework/)
## Prerequisites
- JDK 17 or higher
- Maven use `mvnw` wrapper
- Gradle use `gradlew` wrapper
## Building with Gradle
Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically **user_home**`/.gradle`).
Type: test
```shell
./gradlew clean test
```
Type: build
```shell
./gradlew clean build
```
Type: run with asserts
```shell
java -ea -jar ./build/libs/simple_jbdd-0.13.5-all.jar
```
## Building with Maven
Downloaded files will be stored in the local Maven repository (typically **user_home**`/.m2/repository`).
Type: test
```shell
./mvnw clean test
```
Type: build
```shell
./mvnw clean package
```
Type: run with asserts
```shell
java -ea -jar ./target/simple_jbdd-0.13.5.jar
```
## Author
Kostiantyn Klochko (c) 2023
## License
Under the GNU Lesser General Public License v3.0 or later.
+18 -2
View File
@@ -1,23 +1,39 @@
plugins {
id('groovy')
id('application')
id 'com.github.johnrengelman.shadow' version '7.1.2'
}
version = "1.0"
version = "0.13.5"
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))
}
}
compileJava {
options.encoding = 'UTF-8'
}
repositories {
// Spock releases are available from Maven Central
mavenCentral()
}
dependencies {
implementation 'com.google.guava:guava:32.1.2-jre'
implementation 'org.apache.commons:commons-lang3:3.13.0'
// mandatory dependencies for using Spock
implementation platform('org.apache.groovy:groovy-bom:4.0.15')
implementation 'org.apache.groovy:groovy'
+39 -12
View File
@@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>space.kklochko</groupId>
<artifactId>simple_jbdd</artifactId>
<version>1.0-SNAPSHOT</version>
<version>0.13.5</version>
<packaging>jar</packaging>
<name>simple-jbdd</name>
@@ -12,10 +12,38 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<groovy.version>4.0.15</groovy.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<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,
@@ -77,6 +105,16 @@
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>32.1.2-jre</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.13.0</version>
</dependency>
<!-- Mandatory dependencies for using Spock -->
<dependency>
<groupId>org.spockframework</groupId>
@@ -112,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,24 @@
package space.kklochko.simple_jbdd;
import space.kklochko.simple_jbdd.tests.factories.AbstractTestRunnerFactory;
import space.kklochko.simple_jbdd.tests.factories.SimpleTestRunnerFactory;
import space.kklochko.simple_jbdd.tests.loaders.NameClassLoader;
import space.kklochko.simple_jbdd.tests.reports.AbstractReporter;
import space.kklochko.simple_jbdd.tests.reports.CLIReporter;
import space.kklochko.simple_jbdd.tests.reports.fmt.SimpleTestReportFormatter;
import space.kklochko.simple_jbdd.tests.runners.CLITestRunner;
public class Main {
public static void main(String[] args) {
NameClassLoader loader = new NameClassLoader();
AbstractTestRunnerFactory testRunnerFactory = new SimpleTestRunnerFactory();
AbstractReporter reporter = new CLIReporter(new SimpleTestReportFormatter());
CLITestRunner runner = new CLITestRunner(loader, testRunnerFactory, reporter);
boolean status = runner.run();
System.exit(status ? 0 : 1);
}
}
@@ -0,0 +1,13 @@
package space.kklochko.simple_jbdd.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Given {
String value() default "Given";
}
@@ -0,0 +1,13 @@
package space.kklochko.simple_jbdd.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Then {
String value() default "Then";
}
@@ -0,0 +1,13 @@
package space.kklochko.simple_jbdd.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Title {
String value() default "Title";
}
@@ -0,0 +1,13 @@
package space.kklochko.simple_jbdd.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface When {
String value() default "When";
}
@@ -1,8 +0,0 @@
package space.kklochko.simple_jbdd.test_examples;
public class Sum {
static int sum(int a, int b) {
return a + b;
}
}
@@ -0,0 +1,16 @@
package space.kklochko.simple_jbdd.test_examples.samples;
public class Calculator {
public int plus(int a, int b) {
return a + b;
}
public int subtract(int a, int b) {
return a - b;
}
public int multiply(int a, int b) {
return a * b + 1;
}
}
@@ -0,0 +1,8 @@
package space.kklochko.simple_jbdd.test_examples.samples;
public class Sum {
public static int sum(int a, int b) {
return a + b;
}
}
@@ -0,0 +1,38 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("3*3 must be 9")
public class CalculatorMultiplyTest extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator")
public void given() {
calculator = new Calculator();
}
@Given("Set up the arguments")
public void setupArguments() {
a = 3;
b = 3;
}
@When("Invoke the multiply method")
public void when() {
result = calculator.multiply(a, b);
}
@Then("3*3 must be 9")
public void then() {
assert result == 9;
}
}
@@ -0,0 +1,37 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("2+2 must be 4")
public class CalculatorPlusTest extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator")
public void given() {
calculator = new Calculator();
}
@Given("Set up the arguments")
public void setupArguments() {
a = b = 2;
}
@When("Invoke the plus method")
public void when() {
result = calculator.plus(a, b);
}
@Then("2+2 must be 4")
public void then() {
assert result == 4;
}
}
@@ -0,0 +1,38 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("4-2 must be 2")
public class CalculatorSubtractTes extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator")
public void given() {
calculator = new Calculator();
}
@Given("Set up the arguments")
public void setupArguments() {
a = 4;
b = 2;
}
@When("Invoke the subtract method")
public void when() {
result = calculator.subtract(a, b);
}
@Then("4-2 must be 2")
public void then() {
assert result == 2;
}
}
@@ -0,0 +1,38 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("4-2 must be 2")
public class CalculatorSubtractTest extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator")
public void given() {
calculator = new Calculator();
}
@Given("Set up the arguments")
public void setupArguments() {
a = 4;
b = 2;
}
@When("Invoke the subtract method")
public void when() {
result = calculator.subtract(a, b);
}
@Then("4-2 must be 2")
public void then() {
assert result == 2;
}
}
@@ -0,0 +1,38 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("Test that has method arguments")
public class HasMethodArgumentsTest extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator in a private method")
public void given(int a, int b) {
calculator = new Calculator();
}
@Given("Set up the arguments with arguments")
public void setupArguments(int a, int b) {
this.a = 4;
this.b = 2;
}
@When("Invoke the subtract method")
public void when() {
result = calculator.subtract(a, b);
}
@Then("4-2 must be 2 and return Bool value")
public void then() {
assert result == 2;
}
}
@@ -0,0 +1,39 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("Test with a method that return boolean")
public class HasNonVoidMethodTest extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator in a private method")
public void given() {
calculator = new Calculator();
}
@Given("Set up the arguments")
public void setupArguments() {
this.a = 4;
this.b = 2;
}
@When("Invoke the subtract method")
public void when() {
result = calculator.subtract(a, b);
}
@Then("4-2 must be 2 and return result")
public boolean then() {
assert result == 2;
return result != 2;
}
}
@@ -0,0 +1,38 @@
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.Calculator;
import space.kklochko.simple_jbdd.tests.Test;
@Title("Test with a private method")
public class HasPrivateMethodTest extends Test {
Calculator calculator;
int a;
int b;
int result;
@Given("Set up the calculator in a private method")
private void given() {
calculator = new Calculator();
}
@Given("Set up the arguments")
public void setupArguments() {
this.a = 4;
this.b = 2;
}
@When("Invoke the subtract method")
public void when() {
result = calculator.subtract(a, b);
}
@Then("4-2 must be 2")
public void then() {
assert result == 2;
}
}
@@ -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;
}
}
@@ -0,0 +1,15 @@
package space.kklochko.simple_jbdd.test_examples.tests;
import space.kklochko.simple_jbdd.annotations.Then;
import space.kklochko.simple_jbdd.annotations.Title;
import space.kklochko.simple_jbdd.tests.Test;
@Title("A Simple Failed Then Test for Sum")
public class SimpleFailedThenTest extends Test {
@Then
public void check() {
assert 30 == 10 + 20 + 1;
}
}
@@ -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")
public void setup() {
sum = new Sum();
}
@Given("Setup the arguments")
public void setupArgs() {
a = 10;
b = 20;
c = 30;
}
@When("Call the .sum(10, 20)")
public void triggerAB() {
resultAB = sum.sum(a, b);
}
@When("Call the .sum(30, 20)")
public void triggerCB() {
resultCB = sum.sum(c, b);
}
@Then("10 + 20 is 30")
public void checkAB() {
assert 30 == resultAB;
}
@Then("30 + 20 is 50")
public void checkCB() {
assert 50 == resultCB;
}
}
@@ -0,0 +1,32 @@
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 GivenWhenThen Test for Sum")
public class SimpleGivenWhenThenTest extends Test {
private Sum sum;
private int a;
private int b;
@Given
public void setup() {
sum = new Sum();
}
@When
public void trigger() {
a = 10;
b = 20;
}
@Then
public void check() {
assert 30 == sum.sum(a, b);
}
}
@@ -0,0 +1,14 @@
package space.kklochko.simple_jbdd.test_examples.tests;
import space.kklochko.simple_jbdd.annotations.Then;
import space.kklochko.simple_jbdd.annotations.Title;
import space.kklochko.simple_jbdd.tests.Test;
@Title("Simple test")
public class SimpleThenTest extends Test {
@Then("The sum of 10 and 20 is 30.")
public void check() {
assert 30 == 10 + 20;
}
}
@@ -0,0 +1,13 @@
package space.kklochko.simple_jbdd.test_examples.tests;
import space.kklochko.simple_jbdd.annotations.Then;
import space.kklochko.simple_jbdd.annotations.Title;
import space.kklochko.simple_jbdd.tests.Test;
public class SimpleThenTestWithoutTitle extends Test {
@Then("The sum of 10 and 20 is 30.")
public void check() {
assert 30 == 10 + 20;
}
}
@@ -0,0 +1,6 @@
package space.kklochko.simple_jbdd.tests;
public abstract class Test {
}
@@ -0,0 +1,62 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.commands;
import space.kklochko.simple_jbdd.tests.Test;
import java.util.Map;
import java.util.TreeMap;
public abstract class AbstractTestCommand<T extends Test> {
protected String type;
protected String label;
public AbstractTestCommand(String label) {
setLabel(label);
}
public abstract boolean test();
public Map<String, String> getLabels() {
Map<String, String> labels = new TreeMap<String, String>();
labels.put(getType(), this.getLabel());
return labels;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public void setLabel(String label) {
this.label = label;
}
public String getLabel() {
return label;
}
public abstract void setObject(T object);
public abstract T getObject();
}
@@ -0,0 +1,46 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.commands;
import space.kklochko.simple_jbdd.tests.Test;
public class SimpleTestCommand<T extends Test> extends AbstractTestCommand<T> {
protected T object;
public SimpleTestCommand(String label, T object) {
super(label);
setObject(object);
setType("Title");
}
@Override
public boolean test() {
return true;
}
public void setObject(T object) {
this.object = object;
}
public T getObject() {
return object;
}
}
@@ -0,0 +1,74 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.commands.decorators;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import java.lang.reflect.Method;
import java.util.Map;
public abstract class AbstractDecorator<T extends Test> extends AbstractTestCommand<T> {
protected AbstractTestCommand<T> command;
protected Method method;
public AbstractDecorator(String label, AbstractTestCommand<T> command) {
super(label);
setCommand(command);
}
public abstract boolean test();
public Map<String, String> getLabels() {
Map<String, String> labels = getCommand().getLabels();
labels.put(getType(), this.getLabel());
return labels;
}
public abstract boolean runMethod();
public void setMethod(Method method) {
this.method = method;
}
public Method getMethod() {
return method;
}
@Override
public void setObject(T object) {
command.setObject(object);
}
@Override
public T getObject() {
return command.getObject();
}
public AbstractTestCommand<T> getCommand() {
return command;
}
public void setCommand(AbstractTestCommand<T> command) {
this.command = command;
}
}
@@ -0,0 +1,62 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.commands.decorators;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
public class BlockDecorator<T extends Test> extends AbstractDecorator<T> {
public BlockDecorator(String label, AbstractTestCommand<T> command, Method method, String type) {
super(label, command);
setType(type);
setMethod(method);
}
public boolean test() {
boolean result = runMethod();
if(!result)
return false;
return getCommand().test();
}
public boolean runMethod() {
try {
method.invoke(getCommand().getObject());
return true;
} catch (InvocationTargetException e) {
Throwable exception = e.getCause();
if(exception instanceof AssertionError)
throw (AssertionError) exception;
System.err.println(e.getMessage());
throw new RuntimeException(e);
} catch (IllegalAccessException e) {
System.err.println("Check access modifiers.");
throw new RuntimeException(e);
}
};
}
@@ -0,0 +1,39 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
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;
};
}
@@ -0,0 +1,29 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
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,32 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
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);
}
}
@@ -0,0 +1,127 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories;
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.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 space.kklochko.simple_jbdd.tests.factories.validators.*;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.*;
public class TestCommandFactory {
public AbstractTestCommand create(Test input) {
Class<?> aClass = input.getClass();
Map<String, ArrayList<Method>> test_methods = this.getTestMethods(aClass);
AbstractTestCommand<Test> aTestCommand = createTest(aClass, input);
ArrayList<Validator> validators = new ArrayList<>();
validators.add(new EmptyValidator());
validators.add(new HasMethodsWithArgumentsValidator());
validators.add(new HasNonVoidMethodsValidator());
validators.add(new HasPrivateMethodsValidator());
for(var validator : validators) {
if(validator.validate(test_methods)) {
String name = validator.getMessage();
return new ErrorDecorator(name, aTestCommand, validator.getErrorType());
}
}
if(test_methods.containsKey("Then")) {
ArrayList<Method> thens = getMethodsInReverseOrder(test_methods, "Then");
for(Method then : thens) {
String label = then.getAnnotation(Then.class).value();
aTestCommand = new BlockDecorator<Test>(label, aTestCommand, then, "Then");
}
}
if(test_methods.containsKey("When")) {
ArrayList<Method> whens = getMethodsInReverseOrder(test_methods, "When");
for(Method when : whens) {
String label = when.getAnnotation(When.class).value();
aTestCommand = new BlockDecorator<Test>(label, aTestCommand, when, "When");
}
}
if(test_methods.containsKey("Given")) {
ArrayList<Method> givens = getMethodsInReverseOrder(test_methods, "Given");
for(Method given : givens) {
String label = given.getAnnotation(Given.class).value();
aTestCommand = new BlockDecorator<Test>(label, aTestCommand, given, "Given");
}
}
return aTestCommand;
}
private ArrayList<Method> getMethodsInReverseOrder(Map<String, ArrayList<Method>> test_methods, String key) {
ArrayList<Method> methods = test_methods.get(key);
Collections.reverse(methods);
return methods;
}
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, ArrayList<Method>> getTestMethods(Class<?> aClass) {
Map<String, ArrayList<Method>> test_methods = new TreeMap<>();
for(Method method : aClass.getDeclaredMethods()) {
Annotation[] annotations = method.getAnnotations();
if (annotations.length == 0)
continue;
if(method.isAnnotationPresent(Given.class))
addMethodTo(test_methods, "Given", method);
if(method.isAnnotationPresent(When.class))
addMethodTo(test_methods, "When", method);
if(method.isAnnotationPresent(Then.class))
addMethodTo(test_methods, "Then", method);
}
return test_methods;
}
private void addMethodTo(Map<String, ArrayList<Method>> test_methods, String key, Method method) {
ArrayList<Method> methods = test_methods.getOrDefault(key, new ArrayList<>());
methods.add(method);
test_methods.put(key, methods);
}
}
@@ -0,0 +1,68 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
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) {
setTests(tests);
setFactory(new TestCommandFactory());
}
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,28 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.meta;
import java.util.AbstractMap;
import java.util.ArrayList;
public abstract class AbstractTestCommandMetaDataFactory {
abstract public ArrayList<AbstractMap.SimpleEntry<String, String>> create();
}
@@ -0,0 +1,53 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.meta;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import space.kklochko.simple_jbdd.tests.commands.decorators.AbstractDecorator;
import java.util.AbstractMap;
import java.util.ArrayList;
public class TestCommandMetaDataFactory extends AbstractTestCommandMetaDataFactory {
private AbstractTestCommand command;
public TestCommandMetaDataFactory(AbstractTestCommand command) {
this.command = command;
}
public ArrayList<AbstractMap.SimpleEntry<String, String>> create() {
ArrayList<AbstractMap.SimpleEntry<String, String>> blocks = new ArrayList<>();
AbstractTestCommand currentCommand = command;
Class<?> aClass = command.getClass();
while(AbstractDecorator.class.isAssignableFrom(aClass)) {
AbstractDecorator block = (AbstractDecorator) currentCommand;
blocks.add(new AbstractMap.SimpleEntry<>(block.getType(), block.getLabel()));
currentCommand = block.getCommand();
aClass = currentCommand.getClass();
}
blocks.add(0, (new AbstractMap.SimpleEntry<>(currentCommand.getType(), currentCommand.getLabel())));
return blocks;
}
}
@@ -0,0 +1,51 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.validators;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Map;
public class EmptyValidator extends Validator {
private boolean isInvalid;
@Override
public boolean validate(Map<String, ArrayList<Method>> methods) {
isInvalid = (methods.size() == 0);
return isInvalid;
}
@Override
public String getErrorType() {
if(!isInvalid)
return "ok";
return "Error";
}
@Override
public String getMessage() {
if(!isInvalid)
return "ok";
return "ERROR!!! No blocks!!!";
}
}
@@ -0,0 +1,38 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.validators;
import java.lang.reflect.Method;
public class HasMethodsWithArgumentsValidator extends MethodValidator {
@Override
protected boolean isMethodInvalid(Method method) {
return method.getParameterCount() != 0;
}
@Override
public String getMessage() {
if(!isInvalid)
return "ok";
return String.format("ERROR!!! Methods must have no arguments!!! Check methods: %s!!!", getMethodListAsString());
}
}
@@ -0,0 +1,38 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.validators;
import java.lang.reflect.Method;
public class HasNonVoidMethodsValidator extends MethodValidator {
@Override
protected boolean isMethodInvalid(Method method) {
return !method.getReturnType().equals(void.class);
}
@Override
public String getMessage() {
if(!isInvalid)
return "ok";
return String.format("ERROR!!! Methods must have the void type!!! Check methods: %s!!!", getMethodListAsString());
}
}
@@ -0,0 +1,39 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.validators;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
public class HasPrivateMethodsValidator extends MethodValidator {
@Override
protected boolean isMethodInvalid(Method method) {
return !Modifier.isPublic(method.getModifiers());
}
@Override
public String getMessage() {
if(!isInvalid)
return "ok";
return String.format("ERROR!!! Methods must be public!!! Check method: %s!!!", getMethodListAsString());
}
}
@@ -0,0 +1,67 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.validators;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Map;
import java.util.stream.Collectors;
abstract public class MethodValidator extends Validator{
protected boolean isInvalid;
protected ArrayList<Method> invalidMethods;
protected String getMethodListAsString() {
return invalidMethods.stream()
.map(m -> m.getName())
.collect(Collectors.joining(", "));
}
abstract protected boolean isMethodInvalid(Method method);
@Override
public boolean validate(Map<String, ArrayList<Method>> methods) {
isInvalid = false;
invalidMethods = new ArrayList<>();
for(var key : methods.keySet()) {
for(var method : methods.get(key)) {
if(isMethodInvalid(method)) {
isInvalid = true;
invalidMethods.add(method);
}
}
}
return isInvalid;
}
@Override
public String getErrorType() {
if(!isInvalid)
return "ok";
return "Error";
}
abstract public String getMessage();
}
@@ -0,0 +1,30 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.factories.validators;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Map;
public abstract class Validator {
abstract public boolean validate(Map<String, ArrayList<Method>> methods);
abstract public String getErrorType();
abstract public String getMessage();
}
@@ -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,26 @@
package space.kklochko.simple_jbdd.tests.loaders;
import java.util.ArrayList;
import java.util.Set;
public class ClassLoader<T> {
AbstractNameClassLoader nameLoader;
public ClassLoader(AbstractNameClassLoader nameLoader) {
this.nameLoader = nameLoader;
}
public ArrayList<T> load() {
Set<Class<?>> names = nameLoader.load();
ArrayList<T> classes = new ArrayList<>();
for(Class<?> name : names) {
SingleClassLoader loader = new SingleClassLoader(name.getName());
classes.add((T) loader.load());
}
return classes;
}
}
@@ -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,50 @@
package space.kklochko.simple_jbdd.tests.loaders;
import space.kklochko.simple_jbdd.tests.Test;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
public class SingleTestLoader {
String className;
public SingleTestLoader(String className) {
setClassName(className);
}
public Test load() {
SingleClassLoader loader = new SingleClassLoader(getClassName());
Class<?> aClass = loader.load();
if(aClass == null)
return null;
Constructor defaultConstructor = null;
for(Constructor constructor : aClass.getDeclaredConstructors()) {
if(constructor.getParameterCount() == 0) {
defaultConstructor = constructor;
break;
}
}
try {
return (Test) defaultConstructor.newInstance();
} catch (InstantiationException e) {
throw new RuntimeException(e);
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
} catch (InvocationTargetException e) {
throw new RuntimeException(e);
}
}
public String getClassName() {
return className;
}
public void setClassName(String className) {
this.className = className;
}
}
@@ -0,0 +1,59 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.reports;
import space.kklochko.simple_jbdd.tests.factories.meta.AbstractTestCommandMetaDataFactory;
import space.kklochko.simple_jbdd.tests.reports.fmt.AbstractTestReportFormatter;
import java.util.AbstractMap;
import java.util.ArrayList;
public abstract class AbstractReporter {
ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> Metadata;
AbstractTestReportFormatter formatter;
public AbstractReporter(ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> metadata, AbstractTestReportFormatter formatter) {
setMetadata(metadata);
setFormatter(formatter);
}
abstract public void report();
public ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> getMetadata() {
return Metadata;
}
public void setMetadata(ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> metadata) {
Metadata = metadata;
}
public void addMetadata(AbstractTestCommandMetaDataFactory testMetaData, boolean isPassed) {
getMetadata().add(new AbstractMap.SimpleEntry<>(testMetaData, isPassed));
}
public AbstractTestReportFormatter getFormatter() {
return formatter;
}
public void setFormatter(AbstractTestReportFormatter formatter) {
this.formatter = formatter;
}
}
@@ -0,0 +1,118 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.reports;
import space.kklochko.simple_jbdd.tests.factories.meta.AbstractTestCommandMetaDataFactory;
import space.kklochko.simple_jbdd.tests.reports.fmt.AbstractTestReportFormatter;
import java.util.AbstractMap;
import java.util.ArrayList;
import org.apache.commons.lang3.StringUtils;
public class CLIReporter extends AbstractReporter {
final int terminalWidth = 80;
public CLIReporter(AbstractTestReportFormatter formatter) {
super(null, formatter);
}
public CLIReporter(ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> metadata, AbstractTestReportFormatter formatter) {
super(metadata, formatter);
}
public void report() {
ArrayList<AbstractMap.SimpleEntry<String, Boolean>> testData = format();
ArrayList<AbstractMap.SimpleEntry<String, Boolean>> failedTestData = getFailedTests(testData);
int passed = count(testData, true);
int failed = count(testData, false);
System.out.printf("%s\n\n", center(" Tests "));
printTests(testData);
if(failed != 0) {
System.out.printf("%s\n\n", center(" Errors "));
printTests(failedTestData);
}
System.out.printf("%s\n", center(" Summary "));
System.out.print(summary(passed, failed));
}
public ArrayList<AbstractMap.SimpleEntry<String, Boolean>> format() {
ArrayList<AbstractMap.SimpleEntry<String, Boolean>> data = new ArrayList<>();
for(var pair : getMetadata()) {
boolean isPassed = pair.getValue();
getFormatter().setTestMetaData(pair.getKey().create());
getFormatter().setPassed(isPassed);
data.add(new AbstractMap.SimpleEntry<>(getFormatter().format(), isPassed));
}
return data;
}
public ArrayList<AbstractMap.SimpleEntry<String, Boolean>> getFailedTests(ArrayList<AbstractMap.SimpleEntry<String, Boolean>> testData) {
ArrayList<AbstractMap.SimpleEntry<String, Boolean>> failed = new ArrayList<>();
for(var pair : testData) {
boolean isPassed = pair.getValue();
if(isPassed) continue;
failed.add(pair);
}
return failed;
}
public int count(ArrayList<AbstractMap.SimpleEntry<String, Boolean>> testData, boolean isPassedStatus) {
int count = 0;
for(var pair : testData) {
boolean isPassed = pair.getValue();
if(isPassed == isPassedStatus)
count++;
}
return count;
}
public void printTests(ArrayList<AbstractMap.SimpleEntry<String, Boolean>> testData) {
for(var pair : testData) {
System.out.print(pair.getKey());
}
}
public String center(String content) {
return StringUtils.center(content, 80, '=');
}
public String summary(int passed, int failed) {
int all = passed + failed;
double passedPercent = (double) passed / (double) all * 100.0;
double failedPercent = (double) failed / (double) all * 100.0;
return String.format("Ran %d tests.\nPassed: %d (%.2f%%)\nFailed: %d (%.2f%%)\n", all, passed, passedPercent, failed, failedPercent);
}
}
@@ -0,0 +1,52 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.reports.fmt;
import java.util.AbstractMap;
import java.util.ArrayList;
abstract public class AbstractTestReportFormatter {
private ArrayList<AbstractMap.SimpleEntry<String, String>> testMetaData;
private boolean isPassed;
public AbstractTestReportFormatter(ArrayList<AbstractMap.SimpleEntry<String, String>> testMetaData, boolean isPassed) {
setTestMetaData(testMetaData);
setPassed(isPassed);
}
public abstract String format();
public ArrayList<AbstractMap.SimpleEntry<String, String>> getTestMetaData() {
return testMetaData;
}
public void setTestMetaData(ArrayList<AbstractMap.SimpleEntry<String, String>> testMetaData) {
this.testMetaData = testMetaData;
}
public boolean isPassed() {
return isPassed;
}
public void setPassed(boolean passed) {
isPassed = passed;
}
}
@@ -0,0 +1,61 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.reports.fmt;
import space.kklochko.simple_jbdd.tests.Test;
import java.util.AbstractMap;
import java.util.ArrayList;
public class SimpleTestReportFormatter extends AbstractTestReportFormatter {
final private String passedIcon = "";
final private String failedIcon = "";
public SimpleTestReportFormatter() {
super(null, false);
}
public SimpleTestReportFormatter(ArrayList<AbstractMap.SimpleEntry<String, String>> testMetaData, boolean isPassed) {
super(testMetaData, isPassed);
}
public String format() {
String status = (isPassed()) ? getPassedIcon() : getFailedIcon();
String title = getTestMetaData().get(0).getValue();
String result = String.format("%s %s\n", status, title);
for(int i=1; i<getTestMetaData().size(); ++i) {
AbstractMap.SimpleEntry<String, String> pair = getTestMetaData().get(i);
result += String.format("\t%s: %s\n", pair.getKey(), pair.getValue());
}
return result + '\n';
}
public String getPassedIcon() {
return passedIcon;
}
public String getFailedIcon() {
return failedIcon;
}
}
@@ -0,0 +1,25 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.runners;
public abstract class AbstractTestRunner {
public abstract boolean run();
}
@@ -0,0 +1,121 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
package space.kklochko.simple_jbdd.tests.runners;
import space.kklochko.simple_jbdd.tests.Test;
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand;
import space.kklochko.simple_jbdd.tests.factories.AbstractTestRunnerFactory;
import space.kklochko.simple_jbdd.tests.factories.TestCommandQueueFactory;
import space.kklochko.simple_jbdd.tests.factories.meta.AbstractTestCommandMetaDataFactory;
import space.kklochko.simple_jbdd.tests.factories.meta.TestCommandMetaDataFactory;
import space.kklochko.simple_jbdd.tests.loaders.AbstractNameClassLoader;
import space.kklochko.simple_jbdd.tests.loaders.SingleTestLoader;
import space.kklochko.simple_jbdd.tests.reports.AbstractReporter;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
public class CLITestRunner extends AbstractTestRunner {
private ArrayList<AbstractTestCommand<Test>> commands;
private AbstractNameClassLoader classLoader;
private AbstractTestRunnerFactory runnerFactory;
private AbstractReporter reporter;
public CLITestRunner(AbstractNameClassLoader classLoader, AbstractTestRunnerFactory runnerFactory, AbstractReporter reporter) {
setClassLoader(classLoader);
setRunnerFactory(runnerFactory);
setReporter(reporter);
}
public boolean run() {
commands = createCommands(load());
ArrayList<Boolean> testStatuses = runTests(commands);
report(createMetadata(commands, testStatuses));
return isFailed(testStatuses);
}
public ArrayList<Test> load() {
Set<Class<?>> classes = this.classLoader.load();
ArrayList<Test> tests = new ArrayList();
for(var aClass : classes) {
tests.add((new SingleTestLoader(aClass.getName())).load());
}
return tests;
}
public ArrayList<AbstractTestCommand<Test>> createCommands(ArrayList<Test> tests) {
TestCommandQueueFactory factory = new TestCommandQueueFactory(tests);
return factory.create();
}
public ArrayList<Boolean> runTests(ArrayList<AbstractTestCommand<Test>> commands) {
return commands.stream()
.map(c -> runnerFactory.create(c).run())
.collect(Collectors.toCollection(ArrayList::new));
}
public ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> createMetadata(ArrayList<AbstractTestCommand<Test>> commands, ArrayList<Boolean> testStatuses) {
return IntStream.range(0, commands.size())
.mapToObj(i -> new AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>(
new TestCommandMetaDataFactory(commands.get(i)),
testStatuses.get(i)))
.collect(Collectors.toCollection(ArrayList::new));
}
public void report(ArrayList<AbstractMap.SimpleEntry<AbstractTestCommandMetaDataFactory, Boolean>> metadata) {
reporter.setMetadata(metadata);
reporter.report();
}
public boolean isFailed(ArrayList<Boolean> testStatuses) {
return !testStatuses.stream().anyMatch(b -> b == false);
}
public AbstractNameClassLoader getClassLoader() {
return classLoader;
}
public void setClassLoader(AbstractNameClassLoader classLoader) {
this.classLoader = classLoader;
}
public AbstractTestRunnerFactory getRunnerFactory() {
return runnerFactory;
}
public void setRunnerFactory(AbstractTestRunnerFactory runnerFactory) {
this.runnerFactory = runnerFactory;
}
public AbstractReporter getReporter() {
return reporter;
}
public void setReporter(AbstractReporter reporter) {
this.reporter = reporter;
}
}
@@ -0,0 +1,48 @@
//////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2023 Kostiantyn Klochko <kklochko@protonmail.com> //
// //
// This file is part of simple-jbdd. //
// //
// simple-jbdd is free software: you can redistribute it and/or modify it under //
// the terms of the GNU Lesser General Public License as published by the Free //
// Software Foundation, either version 3 of the License, or (at your option) //
// any later version. //
// //
// simple-jbdd is distributed in the hope that it will be useful, but WITHOUT //
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or //
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License //
// for more details. //
// //
// You should have received a copy of the GNU Lesser General Public License //
// along with simple-jbdd. If not, see <https://www.gnu.org/licenses/>. //
//////////////////////////////////////////////////////////////////////////////////
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;
}
}
@@ -1,5 +1,6 @@
package space.kklochko.simple_jbdd.test_examples
package space.kklochko.simple_jbdd.test_examples.samples
import space.kklochko.simple_jbdd.test_examples.samples.Sum
import spock.lang.Specification
class SumSpec extends Specification {
@@ -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"
}
}
@@ -0,0 +1,95 @@
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
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 factory must generate a test command, so
those tests check if factory generate them right.
""")
@Title("Unit tests for TestCommandFactory")
class TestCommandFactorySpec extends Specification {
def "The command have the same block count."() {
given: "I have a TestCommandFactory object"
@Subject
def factory = new TestCommandFactory();
when: "If a test command have blocks"
def map = factory.getTestMethods(testClass.getClass())
def count = map.values()
.stream()
.map {it.size()}
.reduce(0) { acc, num -> acc + num }
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."() {
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 TestCommand that contains the expected blocks."() {
given: "I have a test factory"
@Subject
def factory = new TestCommandFactory()
when: "I build a test"
def test = factory.create(testClass)
then: "The test have the expected blocks"
expectedBlocks.toSet() == test.getLabels().keySet()
where:
testClass || expectedBlocks
new SimpleThenTest() || ['Title', 'Then']
new SimpleGivenWhenThenTest() || ['Title', 'Given', 'When', 'Then']
new SimpleGivenGivenWhenWhenThenThenTest() || ['Title', 'Given', 'When', 'Then']
}
}
@@ -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,46 @@
package space.kklochko.simple_jbdd.tests.factories.meta
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.commands.AbstractTestCommand
import space.kklochko.simple_jbdd.tests.commands.decorators.BlockDecorator
import space.kklochko.simple_jbdd.tests.factories.TestCommandFactory
import space.kklochko.simple_jbdd.tests.runners.SimpleTestRunner
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The factory must generate a test command metadata, so
those tests check if the factory generate it right.
""")
@Title("Integrated tests for TestCommandMetaDataFactory")
class IntegratedTestCommandMetaDataFactorySpec extends Specification {
def "Metadata have the map of methods have one test block."() {
given: "I have a command factory"
def commandFactory = new TestCommandFactory();
and: "I have a command of a test"
def command = commandFactory.create(testObject)
and: "I have a TestCommandMetaDataFactory object"
@Subject
def factory = new TestCommandMetaDataFactory(command)
when: "Parse the command to get metadata"
def metadata = factory.create()
then: "the metadata have only two labels for Title and Then"
expectedCount == metadata.size()
where: "Possible variants of tests"
testObject || expectedCount
new SimpleThenTest() || 2
new SimpleGivenWhenThenTest() || 4
new SimpleThenTestWithoutTitle() || 2
new SimpleFailedThenTest() || 2
}
}
@@ -0,0 +1,93 @@
package space.kklochko.simple_jbdd.tests.factories.meta
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenWhenThenTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest
import space.kklochko.simple_jbdd.tests.commands.AbstractTestCommand
import space.kklochko.simple_jbdd.tests.commands.decorators.BlockDecorator
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 factory must generate a test command metadata, so
those tests check if the factory generate it right.
""")
@Title("Unit tests for TestCommandMetaDataFactory")
class TestCommandMetaDataFactorySpec extends Specification {
def "If the map of methods have one test block."() {
given: "I have a simple test with only Then block and its command."
def test = Mock(AbstractTestCommand) {
getType() >> "Title"
getLabel() >> "A simple test"
}
def command = GroovyMock(BlockDecorator) {
getType() >> "Then"
getLabel() >> "Then block"
getCommand() >> test
}
and: "I have a TestCommandMetaDataFactory object"
@Subject
def factory = new TestCommandMetaDataFactory(command)
when: "Parse the command to get metadata"
def metadata = factory.create()
then: "The metadata have only two labels for Title and Then"
2 == metadata.size()
and: "The format and the order must be the same"
metadata == [
new AbstractMap.SimpleEntry<>("Title", "A simple test"),
new AbstractMap.SimpleEntry<>("Then", "Then block")
]
}
def "If the map of methods have GivenWhenThen blocks."() {
given: "I have a simple test with only Then block and its command."
def test = Mock(AbstractTestCommand) {
getType() >> "Title"
getLabel() >> "A simple test"
}
and: "Bootstrapping the test command"
def then = GroovyMock(BlockDecorator) {
getType() >> "Then"
getLabel() >> "Then block"
getCommand() >> test
}
def when = GroovyMock(BlockDecorator) {
getType() >> "When"
getLabel() >> "When block"
getCommand() >> then
}
def command = GroovyMock(BlockDecorator) {
getType() >> "Given"
getLabel() >> "Given block"
getCommand() >> when
}
and: "I have a TestCommandMetaDataFactory object"
@Subject
def factory = new TestCommandMetaDataFactory(command)
when: "Parse the command to get metadata"
def metadata = factory.create()
then: "The metadata have only two labels for Title and Then"
4 == metadata.size()
and: "The format and the order must be the same"
metadata == [
new AbstractMap.SimpleEntry<>("Title", "A simple test"),
new AbstractMap.SimpleEntry<>("Given", "Given block"),
new AbstractMap.SimpleEntry<>("When", "When block"),
new AbstractMap.SimpleEntry<>("Then", "Then block")
]
}
}
@@ -0,0 +1,66 @@
package space.kklochko.simple_jbdd.tests.factories.validators
import space.kklochko.simple_jbdd.test_examples.tests.HasMethodArgumentsTest
import space.kklochko.simple_jbdd.test_examples.tests.HasNonVoidMethodTest
import space.kklochko.simple_jbdd.test_examples.tests.HasPrivateMethodTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleEmptyTest
import space.kklochko.simple_jbdd.test_examples.tests.SimpleGivenWhenThenTest
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 validators must return true if a test class is invalid, so
those tests check if validators return the right result.
""")
@Title("Integrated tests for Validators")
class IntegratedValidatorsSpec extends Specification {
def "Validator return isInvalid"() {
given: "I have a factory and metadata"
def factory = new TestCommandFactory()
def metaData = factory.getTestMethods(testClass)
when: "Validating the test"
def isInvalid = validator.validate(metaData)
then: "The status must be expected"
isInvalid == expectedStatus
where: "Possible variants of tests"
validator | testClass || expectedStatus
new HasMethodsWithArgumentsValidator() | HasMethodArgumentsTest.class || true
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || false
new HasNonVoidMethodsValidator() | HasNonVoidMethodTest.class || true
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || false
new HasPrivateMethodsValidator() | HasPrivateMethodTest.class || true
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || false
new EmptyValidator() | SimpleEmptyTest.class || true
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || false
}
def "Validator return the error message"() {
given: "I have a factory and metadata"
def factory = new TestCommandFactory()
def metaData = factory.getTestMethods(testClass)
when: "Validating the test and checking the message"
validator.validate(metaData)
def message = validator.getMessage()
then: "The message must be expected"
message ==~ expectedMessage
where: "Possible variants of tests"
validator | testClass || expectedMessage
new HasMethodsWithArgumentsValidator() | HasMethodArgumentsTest.class || "ERROR!!! Methods must have no arguments!!! Check methods: (given|setupArguments), (given|setupArguments)!!!"
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || "ok"
new HasNonVoidMethodsValidator() | HasNonVoidMethodTest.class || "ERROR!!! Methods must have the void type!!! Check methods: then!!!"
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || "ok"
new HasPrivateMethodsValidator() | HasPrivateMethodTest.class || "ERROR!!! Methods must be public!!! Check method: given!!!"
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || "ok"
new EmptyValidator() | SimpleEmptyTest.class || "ERROR!!! No blocks!!!"
new HasMethodsWithArgumentsValidator() | SimpleGivenWhenThenTest.class || "ok"
}
}
@@ -0,0 +1,43 @@
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 classes or null, so
those tests check if responses are right.
""")
@Title("Integrated tests for ClassLoader.")
class IntegratedClassLoader extends Specification {
def "The classes have been loaded."() {
given: "I have a name class loader"
def nameLoader = new NameClassLoader()
and: "I have a loader for classes"
@Subject
def loader = new ClassLoader(nameLoader)
when: "The classes were loaded"
def classes = loader.load()
then: "Checking that the test result is expected"
11 == classes.size()
}
def "The classes must be represent the Test interface."() {
given: "I have a name class loader"
def nameLoader = new NameClassLoader()
and: "I have a loader for classes"
@Subject
def loader = new ClassLoader(nameLoader)
when: "The classes were loaded"
def classes = loader.load()
then: "Checking that the test result is expected"
classes.every({ space.kklochko.simple_jbdd.tests.Test.class.isAssignableFrom(it) })
}
}
@@ -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"
11 == 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 SingleClassLoader.")
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,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 SingleTestLoader.")
class IntegratedSingleTestLoader extends Specification {
def "The class has been loaded."() {
given: "I have a class loader"
@Subject
def loader = new SingleTestLoader(className)
when: "The class was loaded"
def aClass = loader.load()
then: "Checking that the test result is expected"
aClass?.class == expectedClass
where: "Possible variants of tests"
className || expectedClass
"fourHundredFour" || null
"space.kklochko.simple_jbdd.test_examples.tests.SimpleThenTest" || SimpleThenTest
}
}
@@ -0,0 +1,72 @@
package space.kklochko.simple_jbdd.tests.reports
import space.kklochko.simple_jbdd.tests.factories.meta.AbstractTestCommandMetaDataFactory
import space.kklochko.simple_jbdd.tests.reports.fmt.AbstractTestReportFormatter
import space.kklochko.simple_jbdd.tests.reports.fmt.SimpleTestReportFormatter
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The reporter must generate a report in the same format, so
those tests check if the reporter generate it right.
""")
@Title("Unit tests for CLIReporter.format()")
class CLIReporterFormatMethodSpec extends Specification {
private metaData
def setup() {
def factory = Mock(AbstractTestCommandMetaDataFactory) {
create() >> [
new AbstractMap.SimpleEntry<>("Title", "A simple test"),
new AbstractMap.SimpleEntry<>("Then", "Then block")
]
}
def metaData = [
new AbstractMap.SimpleEntry<>(factory, true),
new AbstractMap.SimpleEntry<>(factory, false)
]
this.metaData = metaData
}
def "Format function use formatter twice."() {
given: "I have a formatter"
def formatter = Mock(AbstractTestReportFormatter)
and: "I have a reporter"
@Subject
def reporter = new CLIReporter(metaData, formatter)
when: "Generate the summary format"
def formattedTestData = reporter.format()
then: "The methods must called 2 times"
2 * formatter.format()
2 * formatter.setPassed(_)
2 * formatter.setTestMetaData(_)
and: "The data must have 2 elements"
2 == formattedTestData.size()
}
def "Format function returns the formatted data."() {
given: "I have a formatter"
def formatter = new SimpleTestReportFormatter()
and: "I have a reporter"
@Subject
def reporter = new CLIReporter(metaData, formatter)
when: "Generate the summary format"
def formattedTestData = reporter.format()
then: "The format must have not null values"
formattedTestData.every({ it.getKey() != null })
and: "The data must have 2 elements"
2 == formattedTestData.size()
}
}
@@ -0,0 +1,77 @@
package space.kklochko.simple_jbdd.tests.reports
import space.kklochko.simple_jbdd.tests.factories.meta.AbstractTestCommandMetaDataFactory
import space.kklochko.simple_jbdd.tests.reports.fmt.AbstractTestReportFormatter
import space.kklochko.simple_jbdd.tests.reports.fmt.SimpleTestReportFormatter
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The reporter must generate a report in the same format, so
those tests check if the reporter generate it right.
""")
@Title("Unit tests for CLIReporter")
class CLIReporterSpec extends Specification {
def "Function, getFailedTest, returns the data of failed tests."() {
given: "I have a reporter"
@Subject
def reporter = new CLIReporter(null, null)
and: "I have a testData"
def passedTestPair = new AbstractMap.SimpleEntry<>("Passed", true)
def failedTestPair = new AbstractMap.SimpleEntry<>("Failed", false)
def testData = Collections.nCopies(countPassed, passedTestPair) + Collections.nCopies(countFailed, failedTestPair)
when: "Generate the summary format"
def failedTestData = reporter.getFailedTests(testData)
then: "The format must be the same"
failedTestData.every({ it.getKey() == "Failed" && it.getValue() == false})
expectedFailedCount == failedTestData.size()
where: "Possible variants of tests"
countPassed | countFailed || expectedFailedCount
5 | 10 || 10
}
def "Count function returns the count of passed or failed tests."() {
given: "I have a reporter"
@Subject
def reporter = new CLIReporter(null, null)
and: "I have a testData"
def passedTestPair = new AbstractMap.SimpleEntry<>("Passed", true)
def failedTestPair = new AbstractMap.SimpleEntry<>("Failed", false)
def testData = Collections.nCopies(countPassed, passedTestPair) + Collections.nCopies(countFailed, failedTestPair)
when: "Generate the summary format"
def count = reporter.count(testData, isPassed)
then: "The format must be the same"
expectedCount == count
where: "Possible variants of tests"
countPassed | countFailed | isPassed || expectedCount
10 | 20 | true || 10
10 | 20 | false || 20
}
def "Summary format."() {
given: "I have a reporter"
@Subject
def reporter = new CLIReporter(null, null)
when: "Generate the summary format"
def format = reporter.summary(passed, failed)
then: "The format must be the same"
expectedFormat == format
where: "Possible variants of tests"
passed | failed || expectedFormat
10 | 20 || "Ran 30 tests.\nPassed: 10 (33.33%)\nFailed: 20 (66.67%)\n"
10 | 10 || "Ran 20 tests.\nPassed: 10 (50.00%)\nFailed: 10 (50.00%)\n"
}
}
@@ -0,0 +1,68 @@
package space.kklochko.simple_jbdd.tests.reports.fmt
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.commands.AbstractTestCommand
import space.kklochko.simple_jbdd.tests.commands.decorators.BlockDecorator
import space.kklochko.simple_jbdd.tests.factories.meta.TestCommandMetaDataFactory
import spock.lang.Narrative
import spock.lang.Specification
import spock.lang.Subject
import spock.lang.Title
@Narrative("""The formatter must generate a format for the test command metadata, so
those tests check if the formatter generate it right.
""")
@Title("Unit tests for SimpleTestReportFormatter")
class SimpleTestReportFormatterSpec extends Specification {
def "If the map of methods have one test block."() {
given: "I have a metaData"
def metaData = [
new AbstractMap.SimpleEntry<>("Title", "A simple test"),
new AbstractMap.SimpleEntry<>("Then", "Then block")
]
and: "I have the formatter object"
@Subject
def formatter = new SimpleTestReportFormatter(metaData, isPassed)
when: "Generate the format"
def format = formatter.format()
then: "The format must be the same"
expectedFormat == format
where: "Possible variants of tests"
isPassed || expectedFormat
true || "✓ A simple test\n\tThen: Then block\n\n"
false || " A simple test\n\tThen: Then block\n\n"
}
def "If the map of methods have GivenWhenThen blocks."() {
given: "I have a metaData"
def metaData = [
new AbstractMap.SimpleEntry<>("Title", "A simple test"),
new AbstractMap.SimpleEntry<>("Given", "Given block"),
new AbstractMap.SimpleEntry<>("When", "When block"),
new AbstractMap.SimpleEntry<>("Then", "Then block")
]
and: "I have the formatter object"
@Subject
def formatter = new SimpleTestReportFormatter(metaData, isPassed)
when: "Generate the format"
def format = formatter.format()
then: "The format must be the same"
expectedFormat == format
where: "Possible variants of tests"
isPassed || expectedFormat
true || "✓ A simple test\n\tGiven: Given block\n\tWhen: When block\n\tThen: Then block\n\n"
false || " A simple test\n\tGiven: Given block\n\tWhen: When block\n\tThen: Then block\n\n"
}
}
@@ -0,0 +1,46 @@
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
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
new SimpleGivenGivenWhenWhenThenThenTest() || true
new SimpleEmptyTest() || 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
}
}