This is an automated email from the ASF dual-hosted git repository.
bdelacretaz pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-launchpad-integration-tests.git
The following commit(s) were added to refs/heads/master by this push:
new 052a253 SLING-9830 - rework README
052a253 is described below
commit 052a253c142991c64966ccedd27cfc02cdde46f8
Author: Bertrand Delacretaz <[email protected]>
AuthorDate: Thu Oct 15 15:09:53 2020 +0200
SLING-9830 - rework README
---
README.md | 46 ++++++++++++++++++----------------------------
1 file changed, 18 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 62747e9..3b408be 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,9 @@
# Apache Sling Launchpad Integration Tests
-This module is part of the [Apache Sling](https://sling.apache.org) project.
-
-This module contains test classes used by the launchpad/testing module,
-separated in their own jar to be reusable.
+This module is part of the [Apache Sling](https://sling.apache.org) project and
+contains test classes used by the
+[launchpad/testing](https://github.com/apache/sling-org-apache-sling-launchpad-testing/)
module.
To run a single test or a specific set of tests against a running Sling
instance, use for example:
@@ -18,35 +17,26 @@ Where UploadFileTest is the test to run. Wildcards are
allowed, and test
classes are found in the src/main folder (not a typo - that's not src/test
as we want to pack the tests in the jar file that we build).
-See the <properties> section in pom.xml for additional parameters that the
+See the `<properties>` section in pom.xml for additional parameters that the
tests use.
Here's another example, running the tests against a Sling instance running
on host xyzzy, port 1234, with the Sling main servlet mounted under /foo:
- mvn -o -s /dev/null test \
- -Dhttp.port=1234 \
- -Dtest.host=xyzzy \
- -Dhttp.base.path=foo \
- -Dwebdav.workspace.path=foo \
- -Dlaunchpad.readiness.mediatype=.json:application/json \
- -Dtest=**/integrationtest/**/*Test.java
-
-To run the tests against the same instance that is used in the full build,
-start an instance by running
-
- mvn clean install -Dlaunchpad.keep.running=true -Dhttp.port=8080
-Ddebug=true
-
-in the launchpad/testing folder (-Ddebug is optional).
+ mvn -o -s /dev/null test \
+ -Dhttp.port=1234 \
+ -Dtest.host=xyzzy \
+ -Dhttp.base.path=foo \
+ -Dwebdav.workspace.path=foo \
+ -Dlaunchpad.readiness.mediatype=.json:application/json \
+ -Dtest=**/integrationtest/**/*Test.java
-And use the same -Dhttp.port option to run tests here.
+To run or debug tests against the same instance that `launchpad/testing`
module,
+see that module's README for how to start the test instance.
-The standard -Dmaven.surefire.debug option can be used to debug the tests
-themselves. Have a look at the README.txt in the launchpad.testing module on
how
-to debug the server-side Sling code.
+The standard `-Dmaven.surefire.debug` option can be used to debug the tests
+themselves.
-If using a Sling instance that's not setup by the launchpad/testing module,
-note that for all tests to pass that instance needs the
-org.apache.sling.launchpad.test-services bundle to be active and the war
-file of the launchpad/test-services-war project to be be copied to the
-sling/startup/0 folder before starting Sling.
+Some tests might fail if not using a a Sling instance that's not setup by
+the `launchpad/testing module`, as that installs a few additional test
+bundles.
\ No newline at end of file
