This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-paxexam.git
The following commit(s) were added to refs/heads/master by this push:
new 0858a22 trim README and link to Testing PaxExam's documentation page
0858a22 is described below
commit 0858a22ace4904f1e70b9da320a23d438f3c8318
Author: Oliver Lietz <[email protected]>
AuthorDate: Mon Jan 29 16:12:37 2018 +0100
trim README and link to Testing PaxExam's documentation page
---
README.md | 159 ++++----------------------------------------------------------
1 file changed, 8 insertions(+), 151 deletions(-)
diff --git a/README.md b/README.md
index 4633028..436c91d 100644
--- a/README.md
+++ b/README.md
@@ -2,160 +2,17 @@
This module is part of the [Apache Sling](https://sling.apache.org) project.
-**Test support for use with [Pax
Exam](https://github.com/ops4j/org.ops4j.pax.exam2).**
-* [_Sling's Karaf
Features_](https://sling.apache.org/documentation/karaf.html#sling-karaf-features)
as `Option`s for Pax Exam (without Karaf)
-* `TestSupport` with common helper methods and `Option`s
+## Overview
-**Provided features:**
+This module provides test support for use with [Pax
Exam](https://github.com/ops4j/org.ops4j.pax.exam2) to test with *real* Sling
instances – no limitations or issues due to incomplete and faulty mock
implementations.
-* run integration tests in a Sling instance in the same module (with the build
artifact under test)
-* use different versions in build (e.g. *minimal*) and tests (e.g. *latest*)
-* overriding of versions
-
-## Getting Started
-
-### 1. Add required dependencies:
-
- <!-- Sling Testing PaxExam -->
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.testing.paxexam</artifactId>
- <version>${org.apache.sling.testing.paxexam.version}</version>
- <scope>provided</scope>
- </dependency>
-
- <!-- an OSGi framework -->
- <dependency>
- <groupId>org.apache.felix</groupId>
- <artifactId>org.apache.felix.framework</artifactId>
- <version>5.6.10</version>
- <scope>test</scope>
- </dependency>
-
- <!-- JUnit and Pax Exam -->
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam</artifactId>
- <version>${org.ops4j.pax.exam.version}</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam-cm</artifactId>
- <version>${org.ops4j.pax.exam.version}</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam-container-forked</artifactId>
- <version>${org.ops4j.pax.exam.version}</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam-junit4</artifactId>
- <version>${org.ops4j.pax.exam.version}</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.ops4j.pax.exam</groupId>
- <artifactId>pax-exam-link-mvn</artifactId>
- <version>${org.ops4j.pax.exam.version}</version>
- <scope>test</scope>
- </dependency>
-
-### 2. Configure the build artifact (*bundle*) to use in integration testing
in `pom.xml`:
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-failsafe-plugin</artifactId>
- <version>2.18.1</version>
- <executions>
- <execution>
- <goals>
- <goal>integration-test</goal>
- <goal>verify</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <redirectTestOutputToFile>true</redirectTestOutputToFile>
- <systemProperties>
- <property>
- <name>bundle.filename</name>
- <value>${basedir}/target/${project.build.finalName}.jar</value>
- </property>
- </systemProperties>
- </configuration>
- </plugin>
-
-Add `depends-maven-plugin` when using `TestSupport#baseConfiguration()` or
`SlingVersionResolver#setVersionFromProject(…)` (see below):
-
- <plugin>
- <groupId>org.apache.servicemix.tooling</groupId>
- <artifactId>depends-maven-plugin</artifactId>
- <version>1.4.0</version>
- <executions>
- <execution>
- <goals>
- <goal>generate-depends-file</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
-
-### 3. Create a test class (extend `TestSupport` to use helper methods and
`Option`s) and provide a *Configuration* (`Option[]`) for Pax Exam:
-
- @Configuration
- public Option[] configuration() {
- return new Option[]{
- baseConfiguration(), // from TestSupport
- quickstart(),
- // build artifact
- testBundle("bundle.filename"), // from TestSupport
- // testing
- junitBundles()
- };
- }
-
- protected Option quickstart() {
- final String workingDirectory = workingDirectory(); // from TestSupport
- final int httpPort = findFreePort(); // from TestSupport
- return composite(
- slingQuickstartOakTar(workingDirectory, httpPort), // from
SlingOptions
- slingExtensionModels(), // from SlingOptions (for illustration)
- slingScriptingThymeleaf() // from SlingOptions (for illustration)
- );
- }
+See Testing PaxExam's [documentation
page](https://sling.apache.org/documentation/development/testing-paxexam.html)
for details and how to use.
-The above configuration provides all bundles and OSGi configurations to run a
Sling Quickstart setup with Extension Models and Scripting Thymeleaf.
-
-**NOTE:** When using `slingQuickstartOakTar()` or `slingQuickstartOakMongo()`
without _working directory_, _HTTP port_ and _Mongo URI_ make sure to clean up
file system and database after each test and do not run tests in parallel to
prevent interferences between tests.
-
-## Overriding or adding versions
-
-To use different versions of bundles in tests than the ones in
`SlingVersionResolver` create a custom `SlingVersionResolver` (extending
`SlingVersionResolver`) and set it in `SlingOptions`:
-
- SlingOptions.versionResolver = new CustomSlingVersionResolver();
-
-or simply (re)set versions in `SlingVersionResolver`:
-
- SlingOptions.versionResolver.setVersion(SLING_GROUP_ID,
"org.apache.sling.jcr.oak.server", "1.1.0");
-
-To use a version from project (`pom.xml`) use `setVersionFromProject(String,
String)` with `groupId` and `artifactId`:
-
- SlingOptions.versionResolver.setVersionFromProject(SLING_GROUP_ID,
"org.apache.sling.jcr.oak.server");
-
-## Logging
-
-See Pax Exam's [Logging
Configuration](https://ops4j1.jira.com/wiki/spaces/PAXEXAM4/pages/54263891/Logging+Configuration)
if logging needs to be tweaked.
-
-For [Logback](https://logback.qos.ch) use `SlingOptions#logback()` and add
both `exam.properties` and `logback.xml` to `src/test/resources` as described
in Pax Exam's [Logging
Configuration](https://ops4j1.jira.com/wiki/spaces/PAXEXAM4/pages/54263891/Logging+Configuration).
+## Features
+* run integration tests in a *tailored* Sling instance in the *same module*
(with the build artifact under test)
+* use different versions in build (e.g. *minimal*) and tests (e.g. *latest*)
+* overriding of versions
+* build bundles with test content and OSGi DS services on-the-fly (no need for
extra modules)
--
To stop receiving notification emails like this one, please contact
[email protected].
