You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by pi...@apache.org on 2012/10/17 16:48:38 UTC
svn commit: r1399285 -
/karaf/branches/karaf-2.3.x/manual/src/main/webapp/developers-guide/writing-tests.conf
Author: pieber
Date: Wed Oct 17 14:48:38 2012
New Revision: 1399285
URL: http://svn.apache.org/viewvc?rev=1399285&view=rev
Log:
[KARAF-1935] Backport manual for paxexam-karaf from trunk
Signed-off-by: Andreas Pieber <an...@gmail.com>
Modified:
karaf/branches/karaf-2.3.x/manual/src/main/webapp/developers-guide/writing-tests.conf
Modified: karaf/branches/karaf-2.3.x/manual/src/main/webapp/developers-guide/writing-tests.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.3.x/manual/src/main/webapp/developers-guide/writing-tests.conf?rev=1399285&r1=1399284&r2=1399285&view=diff
==============================================================================
--- karaf/branches/karaf-2.3.x/manual/src/main/webapp/developers-guide/writing-tests.conf (original)
+++ karaf/branches/karaf-2.3.x/manual/src/main/webapp/developers-guide/writing-tests.conf Wed Oct 17 14:48:38 2012
@@ -1,34 +1,327 @@
+h1. Writing integration tests
+We recommend using [PAX Exam|http://team.ops4j.org/wiki/display/paxexam/Pax+Exam] to write integration tests when developing applications using Karaf.
-h1. Writing integration tests
+Starting with Karaf 2.3.0 and 3.0 we've also included a component briding between Karaf and Pax Exam making it easier to write integration tests for Karaf or Karaf based Distributions such as [Servicemix|http://servicemix.apache.org] or [Geronimo|http://geronimo.apache.org].
+
+h2. Introduction
+
+To make use of this new framework simply add the following dependencies into your integration tests pom.xml:
+
+{pygmentize:xml}
+<!-- Karaf Test Framework Version -->
+<dependency>
+ <groupId>org.apache.karaf.tooling.exam</groupId>
+ <artifactId>org.apache.karaf.tooling.exam.container</artifactId>
+ <version>${project.version}</version>
+ <scope>test</scope>
+</dependency>
+<!-- Pax Exam version you would like to use. At least 2.2.x is required. -->
+<dependency>
+ <groupId>org.ops4j.pax.exam</groupId>
+ <artifactId>pax-exam-junit4</artifactId>
+ <version>${pax.exam.version}</version>
+ <scope>test</scope>
+</dependency>
+{pygmentize}
+
+As a next step you need to reference the distribution you want to run your tests on. For example, if you want to run your tests on Karaf the following section would be required in the integration tests pom.xml:
-We recommend using [PAX Exam|http://team.ops4j.org/wiki/display/paxexam/Pax+Exam] to write integration tests when developing
-applications using Karaf.
+{pygmentize:xml}
+<dependency>
+ <groupId>org.apache.karaf</groupId>
+ <artifactId>apache-karaf</artifactId>
+ <version>${project.version}</version>
+ <type>zip</type>
+ <scope>test</scope>
+</dependency>
+{pygmentize}
+
+If you want to make use of Exams "versionAsInProject" feature you also need to add the following section:
+
+{pygmentize:xml}
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.servicemix.tooling</groupId>
+ <artifactId>depends-maven-plugin</artifactId>
+ <version>${plugin.depends.version}</version>
+ <executions>
+ <execution>
+ <id>generate-depends-file</id>
+ <goals>
+ <goal>generate-depends-file</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>
+{pygmentize}
+
+With this done we can start writing our first test case:
-Karaf provides an helper library to help writing such integration tests.
{pygmentize:java}
- @Configuration
- public static Option[] configuration() throws Exception{
- return combine(
- // Default karaf environment
- Helper.getDefaultOptions(),
- // Test on both equinox and felix
- equinox(), felix()
- );
- }
-{pygmentize}
-
-If you need to provision a few features in addition to the default Karaf environment, you can do so by adding the following code:
-
-{pygmentize:java}
- scanFeatures(
- maven().groupId("org.apache.felix.karaf")
- .artifactId("apache-felix-karaf")
- .type("xml").classifier("features")
- .versionAsInProject(),
- "obr", "wrapper"
- ),
+import static junit.framework.Assert.assertTrue;
+import static org.apache.karaf.tooling.exam.options.KarafDistributionOption.karafDistributionConfiguration;
+import static org.ops4j.pax.exam.CoreOptions.maven;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.ops4j.pax.exam.Option;
+import org.ops4j.pax.exam.junit.Configuration;
+import org.ops4j.pax.exam.junit.ExamReactorStrategy;
+import org.ops4j.pax.exam.junit.JUnit4TestRunner;
+import org.ops4j.pax.exam.spi.reactors.AllConfinedStagedReactorFactory;
+
+@RunWith(JUnit4TestRunner.class)
+@ExamReactorStrategy(AllConfinedStagedReactorFactory.class)
+public class VersionAsInProjectKarafTest {
+
+ @Configuration
+ public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration().frameworkUrl(
+ maven().groupId("org.apache.karaf").artifactId("apache-karaf").type("zip").versionAsInProject())
+ .karafVersion("2.2.4").name("Apache Karaf")};
+ }
+
+ @Test
+ public void test() throws Exception {
+ assertTrue(true);
+ }
+}
{pygmentize}
+h2. Commands
+
+Basically the Pax Exam - Karaf bridge introduced with 3.0 should support all commands you know from Pax Exam 2.x. In addition we've added various additional commands to make your life easier. Those commands are listed and explained in this sub section.
+
+As a small remark: All of the Options explained here are also accessible via the static methods in the KarafDistributionOption class in the options package automatically on your classpath when you reference the container package.
+
+h3. KarafDistributionConfigurationOption
+
+The framework itself is non of the typical runtimes you define normally in PAXEXAM. Instead you define a packed distribution as zip or tar.gz. Those distributions have to follow the Karaf packaging style. Therefore instead of Karaf you can also enter Servicemix or Geronimo.
+
+{pygmentize:java}
+new KarafDistributionConfigurationOption(
+ "mvn:org.apache.karaf/apache-karaf/2.2.4/zip", // artifact to unpack and use
+ "karaf", // name; display only
+ "2.2.4") // the karaf version; this one is relevant since the startup script differs between versions
+{pygmentize}
+
+or for Servicemix e.g.
+
+{pygmentize:java}
+new KarafDistributionConfigurationOption(
+ "mvn:org.apache.servicemix/apache-servicemix/4.4.0/zip", // artifact to unpack and use
+ "servicemix", // name; display only
+ "2.2.4") // the karaf version; this one is relevant since the startup script differs between versions
+{pygmentize}
+
+As an alternative you can also use the maven url resolvers. Please keep in mind that this only works starting with karaf-3.0.0 since there will be problems with the pax-url version. In addition, if you want to make use of the versionAsInProject part you also need to define the following maven-plugin in the pom file of your integration tests:
+
+{pygmentize:xml}
+...
+<dependency>
+ <groupId>org.apache.karaf</groupId>
+ <artifactId>apache-karaf</artifactId>
+ <type>zip</type>
+ <classifier>bin</classifier>
+ <scope>test</scope>
+</dependency>
+...
+<plugin>
+ <groupId>org.apache.servicemix.tooling</groupId>
+ <artifactId>depends-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>generate-depends-file</id>
+ <goals>
+ <goal>generate-depends-file</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin>
+{pygmentize}
+
+{pygmentize:java}
+@Configuration
+ public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration().frameworkUrl(
+ maven().groupId("org.apache.karaf").artifactId("apache-karaf").type("zip")
+ .classifier("bin").versionAsInProject()) };
+ }
+{pygmentize}
+
+In addition to the framework specification options this option also includes various additional configuration options. Those options are used to configure the internal properties of the runtime environment.
+
+h4. Unpack Directory
+Paxexam-Karaf Testframework extracts the distribution you specify by default into the paxexam config directory. If you would like to unpack them into your target directory simply extend the KarafDistributionConfigurationOption with the unpackDirectoryFile like shown in the next example:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip")
+ .unpackDirectory(new File("target/paxexam/unpack/")) };
+}
+{pygmentize}
+
+h4. Use Deploy Folder
+
+Karaf distributions come by default with a deploy folder where you can simply drop artifacts to be deployed. In some distributions this folder might have been removed. To still be able to deploy your additional artifacts using default Pax Exam ProvisionOptions you can configure PaxExam Karaf to use a features.xml (which is directly added to your etc/org.apache.karaf.features.cfg) for those deploys. To use it instead of the deploy folder simply do the following:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip")
+ .useDeployFolder(false)) };
+}
+{pygmentize}
+
+h3. KarafDistributionKitConfigurationOption
+
+The KarafDistributionKitConfigurationOption is almost equal to all variations of the KarafDistributionConfigurationOption with the exception that it requires to have set a platform and optionally the executable and the files which should be made executable additionally. By default it is bin/karaf for nix platforms and bin\karaf.bat for windows platforms. The executable option comes in handy if you like to e.g. embed an own java runtime. You should add a windows AND a linux Kit definition. The framework automatically takes the correct one then. The following shows a simple example for karaf:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{
+ new KarafDistributionKitConfigurationOption("mvn:org.apache.karaf/apache-karaf/${project.version}/zip",
+ Platform.WINDOWS).executable("bin\\karaf.bat").filesToMakeExecutable("bin\\admin.bat"),
+ new KarafDistributionKitConfigurationOption("mvn:org.apache.karaf/apache-karaf/${project.version}/tar.gz", "karaf",
+ Platform.NIX).executable("bin/karaf").filesToMakeExecutable("bin/admin") };
+}
+{pygmentize}
+
+h3. KarafDistributionConfigurationFilePutOption
+
+The option replaces or adds an option to one of Karaf's configuration files:
+
+{pygmentize:java}
+new KarafDistributionConfigurationFilePutOption(
+ "etc/config.properties", // config file to modify based on karaf.base
+ "karaf.framework", // key to add or change
+ "equinox") // value to add or change
+{pygmentize}
+
+This option could also be used in "batch-mode" via a property file. Therefore use the KarafDistributionOption#editConfigurationFilePut(final String configurationFilePath, File source, String... keysToUseFromSource) method. This option allows you to add all properties found in the file as KarafDistributionConfigurationFilePutOption. If you configure the "keysToUseFromSource" array only the keys specified there will be used. That way you can easily put an entire range of properties.
+
+h3. KarafDistributionConfigurationFileExtendOption
+
+This one does the same as the KarafDistributionConfigurationFilePutOption option with the one difference that it either adds or appends a specific property. This is especially useful if you do not want to store the entire configuration in the line in your code.
+
+This option could also be extended in "batch-mode" via a property file. Therefore use the KarafDistributionOption#editConfigurationFileExtend(final String configurationFilePath, File source, String... keysToUseFromSource) method. This option allows you to extend all properties found in the file as KarafDistributionConfigurationFileExtendOption. If you configure the "keysToUseFromSource" array only the keys specified there will be used. That way you can easily extend an entire range of properties.
+
+h3. KarafDistributionConfigurationFileReplacementOption
+
+The file replacement option allows you to simply replace a file in you Karaf distribution with a different file:
+
+{pygmentize:java}
+new KarafDistributionConfigurationFileReplacementOption("etc/tests.cfg", new File(
+ "src/test/resources/BaseKarafDefaultFrameworkDuplicatedPropertyEntryTestSecondKey"));
+{pygmentize}
+
+h3. ProvisionOption
+
+The new test container fully supports the provision option. Feel free to use any option provided here by paxexam itself (e.g. Maven resolver). All those artifacts are copied into the deploy folder of your Karaf distribution before it is started. Therefore they all will be available after startup.
+
+h3. KarafDistributionConfigurationConsoleOption
+
+The test container supports options to configure if the localConsole and/or the remote shell should be started. Possible options to do so are shown in the following two examples:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip"),
+ configureConsole().ignoreLocalConsole().startRemoteShell() };
+}
+{pygmentize}
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip"),
+ configureConsole().startLocalConsole(), configureConsole().ignoreRemoteShell() };
+}
+{pygmentize}
+
+h3. VMOption
+
+The Karaf container passes the vmOptions now through to the Karaf environment. They are directly passed to the startup of the container. In addition the KarafDistributionOption helper has two methods (debugConfiguration() and debugConfiguration(String port, boolean hold)) to activate debugging quickly.
+
+h3. LogLevelOption
+
+The Paxexam-Karaf specific log-level option allows an easy way to set a specific log-level for the Karaf based distribution. For example simply add the following to your Option[] array to get TRACE logging:
+
+{pygmentize:java}
+import static org.openengsb.labs.paxexam.karaf.options.KarafDistributionOption.logLevel;
+...
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip"),
+ logLevel(LogLevel.TRACE) };
+}
+{pygmentize}
+
+h3. DoNotModifyLogOption
+
+The option to modify the logging behavior requires that the container automatically modifies the logging configuration file. If you would like to suppress this behavior simply set the doNotModifyLogConfiguration option as shown in the next example:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip"),
+ doNotModifyLogConfiguration() };
+}
+{pygmentize}
+
+h3. KeepRuntimeFolderOption
+
+Per default the test container removes all test runner folders. If you want to keep them for any reasons (e.g. check why a test fails) set the following option:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip"),
+ keepRuntimeFolder() };
+}
+{pygmentize}
+
+h3. FeaturesScannerProvisionOption
+
+The FeaturesScannerProvisionOption (e.g. CoreOption.scanFeature()) are directly supported by the Paxexam Karaf Testframework.
+
+h3. BootDelegationOption
+
+The BootDelegationOption as known from PaxExam is also supported added the boot delegation string directly into the correct property files.
+
+h3. SystemPackageOption
+
+The Standard Exam SystemPackageOption is implemented by adding those packages to "org.osgi.framework.system.packages.extra" of the config.properties file.
+
+h3. BootClasspathLibraryOption
+
+The BootClasspathLibraryOption is honored by copying the urls into the lib directory where they are automatically taken and worked on.
+
+h3. ExamBundlesStartLevel
+
+The ExamBundlesStartLevel can be used to configure the start lvl of the bundles provided by the test-frameworks features.xml. Simply use it as a new option like:
+
+{pygmentize:java}
+@Configuration
+public Option[] config() {
+ return new Option[]{ karafDistributionConfiguration("mvn:org.apache.karaf/apache-karaf/${project.version}/zip"),
+ useOwnExamBundlesStartLevel(4) };
+}
+{pygmentize}
+
+h2. Driver
+
+Drivers are the parts of the framework responsible for running the Karaf Based Distribution. By default the already in the overview explained KarafDistributionConfigurationOption uses a JavaRunner starting the distribution platform independent but not using the scripts in the distribution. If you like to test those scripts too an option is to to use the ScriptRunner via the KarafDistributionKitConfigurationOption instead.
+
+h3. JavaRunner
+The JavaRunner builds the entire command itself and executes Karaf in a new JVM. This behavior is more or less exactly what the default runner does. Simply use the KarafDistributionConfigurationOption as explained in the Commands section to use this.
+h3. ScriptRunner
+The script runner has the disadvantage over the java runner that it is also platform dependent. The advantage though is that you can also test your specific scripts. To use it follow the explanation of the KarafDistributionKitConfigurationOption in the Commands section.