You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2017/12/25 12:49:59 UTC
[sling-site] branch master updated (20662d3 -> d070a49)
This is an automated email from the ASF dual-hosted git repository.
olli pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/sling-site.git.
from 20662d3 update documentation for running Sling on Karaf
new 04df8a9 reorder paragraphs and adjust install step
new d070a49 add initial documentation for Sling Testing PaxExam
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../jbake/content/documentation/development.md | 1 +
.../documentation/development/testing-paxexam.md | 219 +++++++++++++++++++++
src/main/jbake/content/documentation/karaf.md | 14 +-
3 files changed, 227 insertions(+), 7 deletions(-)
create mode 100644 src/main/jbake/content/documentation/development/testing-paxexam.md
--
To stop receiving notification emails like this one, please contact
['"commits@sling.apache.org" <co...@sling.apache.org>'].
[sling-site] 01/02: reorder paragraphs and adjust install step
Posted by ol...@apache.org.
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-site.git
commit 04df8a990891a82eb146632ec4cfdb0bc31ed11c
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Mon Dec 25 13:46:02 2017 +0100
reorder paragraphs and adjust install step
---
src/main/jbake/content/documentation/karaf.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/main/jbake/content/documentation/karaf.md b/src/main/jbake/content/documentation/karaf.md
index 32181c7..efe7474 100644
--- a/src/main/jbake/content/documentation/karaf.md
+++ b/src/main/jbake/content/documentation/karaf.md
@@ -6,6 +6,12 @@ tags=karaf
**NOTE:** Tested and built with Apache Karaf 4.2.0.M1
+## Sling Karaf Features
+
+A features repository for easy deployment of [Apache Sling](https://sling.apache.org) on [Apache Karaf](https://karaf.apache.org) (see [Provisioning](https://karaf.apache.org/manual/latest/#_provisioning) for details).
+
+([GitBox](https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-karaf-features.git) | [GitHub](https://github.com/apache/sling-org-apache-sling-karaf-features))
+
## Sling Karaf Configs
@@ -13,11 +19,6 @@ OSGi configurations for provisioning with Apache Karaf used in [Sling's Karaf Fe
([GitBox](https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-karaf-configs.git) | [GitHub](https://github.com/apache/sling-org-apache-sling-karaf-configs))
-## Sling Karaf Features
-
-A features repository for easy deployment of [Apache Sling](https://sling.apache.org) on [Apache Karaf](https://karaf.apache.org) (see [Provisioning](https://karaf.apache.org/manual/latest/#_provisioning) for details).
-
-([GitBox](https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-karaf-features.git) | [GitHub](https://github.com/apache/sling-org-apache-sling-karaf-features))
## Sling Karaf Distribution
@@ -39,9 +40,8 @@ You have to set `serviceRequirements=disable` in Karaf's `etc/org.apache.karaf.f
karaf@root()> feature:install sling-quickstart-oak-tar
-4) Install Launchpad Content and [Composum](https://github.com/ist-dresden/composum):
+4) Install Launchpad Content (feature includes [Composum](https://github.com/ist-dresden/composum)):
karaf@root()> feature:install sling-launchpad-content
- karaf@root()> feature:install composum
5) Browse to [http://localhost:8181/](http://localhost:8181/).
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.
[sling-site] 02/02: add initial documentation for Sling Testing
PaxExam
Posted by ol...@apache.org.
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-site.git
commit d070a49b94e02382021ba384dcee0c4637527fb7
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Mon Dec 25 13:49:35 2017 +0100
add initial documentation for Sling Testing PaxExam
---
.../jbake/content/documentation/development.md | 1 +
.../documentation/development/testing-paxexam.md | 219 +++++++++++++++++++++
2 files changed, 220 insertions(+)
diff --git a/src/main/jbake/content/documentation/development.md b/src/main/jbake/content/documentation/development.md
index 35f9f6e..37538b7 100644
--- a/src/main/jbake/content/documentation/development.md
+++ b/src/main/jbake/content/documentation/development.md
@@ -24,6 +24,7 @@ Look here for more information on developper support when your are using Sling t
## Testing Sling-based Applications
* [Testing Sling-based Applications](/documentation/tutorials-how-tos/testing-sling-based-applications.html)
+* [Testing with Pax Exam](/documentation/development/testing-paxexam.html)
* [Junit Server-Side Tests Support](/documentation/bundles/org-apache-sling-junit-bundles.html)
* [Resource Resolver Mock](/documentation/development/resourceresolver-mock.html)
* [Sling Mocks](/documentation/development/sling-mock.html)
diff --git a/src/main/jbake/content/documentation/development/testing-paxexam.md b/src/main/jbake/content/documentation/development/testing-paxexam.md
new file mode 100644
index 0000000..78d34e0
--- /dev/null
+++ b/src/main/jbake/content/documentation/development/testing-paxexam.md
@@ -0,0 +1,219 @@
+title=Apache Sling Testing PaxExam
+type=page
+status=published
+tags=testing,development,maven,junit,exam
+~~~~~~
+
+## Overview
+
+Sling Testing PaxExam provides 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) are available as `Option`s for Pax Exam to set up a tailored Sling instance easily.
+
+The `TestSupport` class comes with common helper methods and `Option`s.
+
+## 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
+
+## Getting Started
+
+### 1. Add required dependencies
+
+Add the required dependencies for testing with JUnit and Pax Exam in Sling:
+
+ <!-- Sling Testing PaxExam -->
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.paxexam</artifactId>
+ <version>0.0.5-SNAPSHOT</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 -->
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+ <!-- Pax Exam -->
+ <dependency>
+ <groupId>org.ops4j.pax.exam</groupId>
+ <artifactId>pax-exam</artifactId>
+ <version>4.11</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.ops4j.pax.exam</groupId>
+ <artifactId>pax-exam-cm</artifactId>
+ <version>4.11</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.ops4j.pax.exam</groupId>
+ <artifactId>pax-exam-container-forked</artifactId>
+ <version>4.11</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.ops4j.pax.exam</groupId>
+ <artifactId>pax-exam-junit4</artifactId>
+ <version>4.11</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.ops4j.pax.exam</groupId>
+ <artifactId>pax-exam-link-mvn</artifactId>
+ <version>4.11</version>
+ <scope>test</scope>
+ </dependency>
+
+### 2. Configure the build artifact to use in integration testing
+
+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(…)`:
+
+ <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 and provide a *Configuration*
+
+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
+ slingModels(), // from SlingOptions (for illustration)
+ slingScriptingThymeleaf() // from SlingOptions (for illustration)
+ );
+ }
+
+The above configuration provides all bundles and OSGi configurations to run a Sling Quickstart setup with Sling Models and Sling 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");
+
+## Examples
+
+### Testing HTML over HTTP with jsoup
+
+The `SimpleIT` below from [Scripting FreeMarker](https://github.com/apache/sling-org-apache-sling-scripting-freemarker) shows how to test HTML rendering with [jsoup](https://jsoup.org). The use of [ResourcePresence](https://github.com/apache/sling-org-apache-sling-resource-presence) ensures that tests are delayed until Sling's repository is ready to serve the `Resource` at given path.
+
+ @RunWith(PaxExam.class)
+ @ExamReactorStrategy(PerClass.class)
+ public class SimpleIT extends FreemarkerTestSupport {
+
+ private Document document;
+
+ @Inject
+ @Filter(value = "(path=/apps/freemarker/page/simple/html.ftl)")
+ private ResourcePresence resourcePresence;
+
+ @Configuration
+ public Option[] configuration() {
+ return new Option[]{
+ baseConfiguration(),
+ factoryConfiguration("org.apache.sling.resource.presence.internal.ResourcePresenter")
+ .put("path", "/apps/freemarker/page/simple/html.ftl")
+ .asOption(),
+ };
+ }
+
+ @Before
+ public void setup() throws IOException {
+ final String url = String.format("http://localhost:%s/freemarker/simple.html", httpPort());
+ document = Jsoup.connect(url).get();
+ }
+
+ @Test
+ public void testTitle() {
+ assertThat(document.title(), is("freemarker simple"));
+ }
+
+ @Test
+ public void testPageName() {
+ final Element name = document.getElementById("name");
+ assertThat(name.text(), is("simple"));
+ }
+
+ }
+
+## 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).
+
+
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.