Repository: camel Updated Branches: refs/heads/master 0e44b5879 -> b753c17e2
CAMEL-11732: Add or update READMEs to itests Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/b753c17e Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/b753c17e Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/b753c17e Branch: refs/heads/master Commit: b753c17e2eaa8b494c9700374eedb581ebe2ca2d Parents: 0e44b58 Author: Tadayoshi Sato <[email protected]> Authored: Wed Sep 6 13:31:16 2017 +0900 Committer: Tadayoshi Sato <[email protected]> Committed: Wed Sep 6 13:31:16 2017 +0900 ---------------------------------------------------------------------- tests/camel-itest-cdi/README.adoc | 5 +++++ tests/camel-itest-karaf/README.adoc | 26 +++++++++++++++++++++++++ tests/camel-itest-osgi/README.adoc | 24 +++++++++++++++++++++++ tests/camel-itest-spring-boot/README.adoc | 27 ++++++++++++++++++++++++++ tests/camel-itest-spring-boot/README.md | 25 ------------------------ tests/camel-itest/README.adoc | 5 +++++ tests/camel-itest/README.txt | 8 -------- tests/camel-performance/README.adoc | 8 ++++++++ tests/camel-performance/README.md | 9 --------- 9 files changed, 95 insertions(+), 42 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest-cdi/README.adoc ---------------------------------------------------------------------- diff --git a/tests/camel-itest-cdi/README.adoc b/tests/camel-itest-cdi/README.adoc new file mode 100644 index 0000000..d14cc7e --- /dev/null +++ b/tests/camel-itest-cdi/README.adoc @@ -0,0 +1,5 @@ += Camel CDI Integration Tests + +== Overview + +This module is where you should add Camel CDI component tests on Arquillian Weld embedded container. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest-karaf/README.adoc ---------------------------------------------------------------------- diff --git a/tests/camel-itest-karaf/README.adoc b/tests/camel-itest-karaf/README.adoc new file mode 100644 index 0000000..4dfcf77 --- /dev/null +++ b/tests/camel-itest-karaf/README.adoc @@ -0,0 +1,26 @@ += Camel Karaf Integration Tests + +== Overview + +This module is where you should add Karaf feature tests for Camel components that are deployed on Karaf container using the `camel-karaf-test` module. + +*A Camel component author is expected to add a test for the Karaf feature to this module once they create a new Camel component and add the Karaf feature to the `platforms/karaf/features` module.* + +All tests are disabled by default to not run in the main CI job. Instead there is a separate CI job that only run the tests for each commit. The results are available here: +https://builds.apache.org/blue/organizations/jenkins/Camel.trunk.itest.karaf/activity/ + +== How to run the tests + +Do not use `mvn test`. Run the following script instead. +---- +$ ./run-test.sh +---- + +**** +The reason for not using `mvn test` is that each test starts up a Karaf instance using Pax Exam, but sometimes the instance doesn't shut down well after the test and the phantom instance causes silent failures of the successive tests. The `run-test.sh` script makes sure to kill the Karaf instance after each test finished. +**** + +You can also pass in the test name to start testing from the test and onwards, e.g.: +---- +$ ./run-test.sh CamelFtpTest +---- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest-osgi/README.adoc ---------------------------------------------------------------------- diff --git a/tests/camel-itest-osgi/README.adoc b/tests/camel-itest-osgi/README.adoc new file mode 100644 index 0000000..02a5306 --- /dev/null +++ b/tests/camel-itest-osgi/README.adoc @@ -0,0 +1,24 @@ += Camel OSGi Integration Tests + +== Overview + +This module is where you should add cross component tests running on Karaf container. + +All tests are disabled by default to not run in the main CI job. Instead there is a separate CI job that only run the tests for each commit. The results are available here: +https://builds.apache.org/blue/organizations/jenkins/Camel.trunk.itest.osgi/activity/ + +== How to run the tests + +Do not use `mvn test`. Run the following script instead. +---- +$ ./run-test.sh +---- + +**** +The reason for not using `mvn test` is that each test starts up a Karaf instance using Pax Exam, but sometimes the instance doesn't shut down well after the test and the phantom instance causes silent failures of the successive tests. The `run-test.sh` script makes sure to kill the Karaf instance after each test finished. +**** + +You can also pass in the test name to start testing from the test and onwards, e.g.: +---- +$ ./run-test.sh CamelHystrixTest +---- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest-spring-boot/README.adoc ---------------------------------------------------------------------- diff --git a/tests/camel-itest-spring-boot/README.adoc b/tests/camel-itest-spring-boot/README.adoc new file mode 100644 index 0000000..0aa499f --- /dev/null +++ b/tests/camel-itest-spring-boot/README.adoc @@ -0,0 +1,27 @@ += Camel Spring Boot Integration Tests + +The camel-itest-spring-boot module provides an integration testing framework for camel components, to check their compatibility with spring-boot. + +Each test-case defined in `src/test/java/org/apache/camel/itest/springboot` executes the following steps: + +* Creates a spring-boot jar by putting the spring-boot loader, some utility classes in the main jar, +and all other libraries (including the camel component under test) as nested jars; +** Launches a new JVM including the spring-boot jar and test classes in the classpath, then starts the spring-boot platform; +** Executes a list of predefined checks in the spring-boot environment to verify that the component has been created correctly: +checks that the camel context has been created, that the camel components can be activated (including data format and languages). + +== Additional options + +Test options can be changed from the configuration of the maven-surefire-plugin in the `pom.xml` file. + +Some useful options include: + +* **itest.springboot.includeTestDependencies (default=true)**: when this option is enabled, +the integration test will locate the module `pom.xml` file and include in the spring-boot jar also the test-scoped dependencies of the module. + The inclusion of other libraries often activates some hidden behaviour of spring-boot. +* **itest.springboot.unitTestEnabled (default=false)**: when this option is enabled, +the integration test will locate the test-classes of the module and run the unit tests after the execution of the usual checks. + *Note: a full build of each component is required prior to running the unit tests. Test dependencies are implicitly included.* + + +*Note: logging dependencies (eg. `log4j`) are fixed automatically, to prevent conflict with spring-boot logging system.* \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest-spring-boot/README.md ---------------------------------------------------------------------- diff --git a/tests/camel-itest-spring-boot/README.md b/tests/camel-itest-spring-boot/README.md deleted file mode 100644 index 579c23e..0000000 --- a/tests/camel-itest-spring-boot/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# camel-itest-spring-boot - -The camel-itest-spring-boot module provides an integration testing framework for camel components, to check their compatibility with spring-boot. - -Each test-case defined in `src/test/java/org/apache/camel/itest/springboot` executes the following steps: -- Creates a spring-boot jar by putting the spring-boot loader, some utility classes in the main jar, -and all other libraries (including the camel component under test) as nested jars; -- Launches a new JVM including the spring-boot jar and test classes in the classpath, then starts the spring-boot platform; -- Executes a list of predefined checks in the spring-boot environment to verify that the component has been created correctly: -checks that the camel context has been created, that the camel components can be activated (including data format and languages). - -## Additional options - -Test options can be changed from the configuration of the maven-surefire-plugin in the `pom.xml` file. - -Some useful options include: -- **itest.springboot.includeTestDependencies (default=true)**: when this option is enabled, -the integration test will locate the module `pom.xml` file and include in the spring-boot jar also the test-scoped dependencies of the module. - The inclusion of other libraries often activates some hidden behaviour of spring-boot. -- **itest.springboot.unitTestEnabled (default=false)**: when this option is enabled, -the integration test will locate the test-classes of the module and run the unit tests after the execution of the usual checks. - *Note: a full build of each component is required prior to running the unit tests. Test dependencies are implicitly included.* - - -*Note: logging dependencies (eg. `log4j`) are fixed automatically, to prevent conflict with spring-boot logging system.* http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest/README.adoc ---------------------------------------------------------------------- diff --git a/tests/camel-itest/README.adoc b/tests/camel-itest/README.adoc new file mode 100644 index 0000000..285211c --- /dev/null +++ b/tests/camel-itest/README.adoc @@ -0,0 +1,5 @@ += Camel Integration Tests + +== Overview + +This module is where you should add cross component tests. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-itest/README.txt ---------------------------------------------------------------------- diff --git a/tests/camel-itest/README.txt b/tests/camel-itest/README.txt deleted file mode 100644 index cf7f383..0000000 --- a/tests/camel-itest/README.txt +++ /dev/null @@ -1,8 +0,0 @@ -============================================================================= - Camel Integration Tests -============================================================================= - -Overview --------------------------------------------------------------------------- - - This module is where you should add cross component tests. http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-performance/README.adoc ---------------------------------------------------------------------- diff --git a/tests/camel-performance/README.adoc b/tests/camel-performance/README.adoc new file mode 100644 index 0000000..a8f82fe --- /dev/null +++ b/tests/camel-performance/README.adoc @@ -0,0 +1,8 @@ += Camel Performance Tests + +== Overview + +This module is where you should add performance tests. + +All tests should be disabled by default to not run on the CI server because +we expect performance test are time and CPU consuming. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/b753c17e/tests/camel-performance/README.md ---------------------------------------------------------------------- diff --git a/tests/camel-performance/README.md b/tests/camel-performance/README.md deleted file mode 100644 index 6422846..0000000 --- a/tests/camel-performance/README.md +++ /dev/null @@ -1,9 +0,0 @@ -Camel Performance Tests ------------------------ - -## Overview - -This module is where you should add performance tests. - -All tests should be disabled by default to not run on the CI server because -we expect performance test are time and CPU consuming. \ No newline at end of file
