forked from apache/deltaspike
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Michelle's documentation refactoring - squashed changes
- Loading branch information
Showing
19 changed files
with
153 additions
and
886 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,155 +1,128 @@ | ||
| = Building DeltaSpike from source | ||
| = Build and Test DeltaSpike from Source | ||
|
|
||
| :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
|
|
||
| [TOC] | ||
|
|
||
| == Introduction | ||
|
|
||
| Deltaspike uses http://maven.apache.org/[maven] build tool to automate the compilation, testing and packaging of the project | ||
|
|
||
| === Full build | ||
|
|
||
| ----------------- | ||
| mvn clean install | ||
| ----------------- | ||
|
|
||
| === Build with test | ||
|
|
||
|
|
||
| ------------------------------------------------------------------ | ||
| mvn clean install -POWB //execute the unit tests with OpenWebBeans | ||
| or | ||
| mvn clean install -PWeld //execute the unit tests with Weld | ||
| ------------------------------------------------------------------ | ||
|
|
||
|
|
||
| === Integration Tests | ||
|
|
||
|
|
||
| With the unpack Maven-Plugin all Arquillian-Tests get copied to the | ||
| integration-test module. Together with the special integration-tests | ||
| they get executed via a remote container. Currently we have | ||
| configurations for the following containers. | ||
|
|
||
|
|
||
| ==== TomEE | ||
|
|
||
|
|
||
| *Executing the Arquillian tests with Apache TomEE* | ||
|
|
||
| --------------------------------------- | ||
| mvn clean install -Ptomee-build-managed | ||
| --------------------------------------- | ||
|
|
||
|
|
||
| ==== JBoss AS7 | ||
|
|
||
|
|
||
| ===== Without existing AS7 | ||
|
|
||
|
|
||
| *Executing the Arquillian tests with JBoss AS7 (without AS7 installation)* | ||
|
|
||
| ------------------------------------------- | ||
| mvn clean install -Pjbossas-build-managed-7 | ||
| ------------------------------------------- | ||
|
|
||
| ===== With existing AS7 | ||
|
|
||
|
|
||
| Set JBoss_HOME | ||
|
|
||
| *Executing the Arquillian tests with JBoss AS7 (AS7 installation | ||
| required)* | ||
|
|
||
| ------------------------------------- | ||
| mvn clean install -Pjbossas-managed-7 | ||
| ------------------------------------- | ||
|
|
||
|
|
||
| ==== WildFly 8 | ||
|
|
||
|
|
||
| ===== Without existing WF8 | ||
|
|
||
|
|
||
| *Executing the Arquillian tests with JBoss-WF8 (without WF8 installation)* | ||
|
|
||
| ----------------------------------------- | ||
| :toc: | ||
|
|
||
| The DeltaSpike source (modules and examples) is provided for inspection, contribution and testing purposes. The source must be built with Maven, which has been used to automate the compilation, testing and packaging processes. Arquillian tests are automatically conducted when DeltaSpike is built and CDI implementations or containers with which to carry out the tests can be specified. | ||
|
|
||
| In all cases, to obtain the DeltaSpike source, link:https://deltaspike.apache.org/download.html[download `deltaspike-project-<version>-source-release.zip`] and extract the contents. | ||
|
|
||
| == Build without CDI Implementation Tests | ||
| DeltaSpike can be built without executing tests against a CDI implementation, with the following commands: | ||
|
|
||
| [source,shell] | ||
| ---- | ||
| $ cd /path/to/deltaspike-project-<version>/ | ||
| $ mvn clean install | ||
| ---- | ||
|
|
||
| == Build and Test with a CDI Implementation | ||
| Tests can be executed with both the JBoss Weld and Apache OpenWebBeans CDI implementations. | ||
|
|
||
| [cols="1,2a", options="header"] | ||
| .Build Tests | ||
| |=== | ||
| |Container |Command to Execute Arquillian Tests | ||
|
|
||
| |JBoss Weld | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -PWeld | ||
| ---- | ||
|
|
||
| |Apache OpenWebBeans | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -POWB | ||
| ---- | ||
| |=== | ||
|
|
||
|
|
||
| == Build and Test with Remote CDI Containers | ||
| Tests can be executed with JBoss Weld and Apache OpenWebBeans through Java EE 6+ application servers and containers. Configurations are currently provided as details in the table here. | ||
|
|
||
| [cols="2,3a", options="header"] | ||
| .Integration Tests | ||
| |=== | ||
| |Container |Command to Execute Arquillian Tests | ||
|
|
||
| |Apache TomEE | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -Ptomee-build-managed | ||
| ---- | ||
|
|
||
| |JBoss AS7 (without AS7 installation) | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -Pjbossas-build-managed-7 | ||
| ---- | ||
|
|
||
| |JBoss AS7 (AS7 installation required) | ||
| |Set `JBoss_HOME` | ||
|
|
||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -Pjbossas-managed-7 | ||
| ---- | ||
|
|
||
| |JBoss WildFly 8 (without WildFly 8 installation) | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| mvn clean install -Pwildfly-build-managed | ||
| ----------------------------------------- | ||
|
|
||
|
|
||
| ===== With existing WF8 | ||
|
|
||
|
|
||
| Set WILDFLY_HOME | ||
|
|
||
| *Executing the Arquillian tests with JBoss-WF8 (WF8 installation | ||
| required)* | ||
|
|
||
| ----------------------------------- | ||
| mvn clean install -Pwildfly-managed | ||
| ----------------------------------- | ||
|
|
||
|
|
||
| ==== GlassFish 3.1 | ||
|
|
||
|
|
||
| ---- | ||
|
|
||
| ===== Without existing GF3 | ||
| |JBoss WildFly 8 (WildFly 8 installation required) | ||
| |Set `WILDFLY_HOME` | ||
|
|
||
| *Executing the Arquillian tests with GF3 (without GF3 installation)* | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -Pwildfly-managed | ||
| ---- | ||
|
|
||
| --------------------------------------------- | ||
| |Oracle GlassFish 3 (without GlassFish 3 installation) | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| mvn clean install -Pglassfish-build-managed-3 | ||
| --------------------------------------------- | ||
| ---- | ||
|
|
||
| |Oracle GlassFish 3.1 (GlassFish 3.1 installation required) | ||
| |Install GlassFish (default setup without admin-password) and start | ||
| GlassFish with `asadmin start-domain` and `asadmin start-database`. | ||
|
|
||
| ===== With existing GF3 | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -Pglassfish-remote-3.1 | ||
| ---- | ||
|
|
||
| Install GlassFish (default setup without admin-password) and start | ||
| GlassFish with asadmin start-domain *and* asadmin start-database | ||
|
|
||
| *Executing the Arquillian tests with Oracle Glassfish 3.1+* | ||
|
|
||
| ---------------------------------------- | ||
| mvn clean install -Pglassfish-remote-3.1 | ||
| ---------------------------------------- | ||
|
|
||
|
|
||
| ==== GlassFish 4 | ||
|
|
||
| ===== Without existing GF4 | ||
|
|
||
| *Executing the Arquillian tests with GF4 (without GF4 installation)* | ||
|
|
||
| --------------------------------------------- | ||
| |Oracle GlassFish 4 (without Oracle GlassFish 4 installation) | ||
| | | ||
| [source,shell] | ||
| ---- | ||
| mvn clean install -Pglassfish-build-managed-4 | ||
| --------------------------------------------- | ||
| ---- | ||
|
|
||
|
|
||
| ==== WebLogic 12c | ||
|
|
||
|
|
||
| Install WebLogic 12c. Start Confiuration Wizard to create a new basic | ||
| |Oracle WebLogic 12c | ||
| |Install WebLogic 12c. Start Configuration Wizard to create a new basic | ||
| WebLogic Domain. Default options and domain name = base_domain, | ||
| administrator user name = weblogic1, administrator password = weblogic1. | ||
| Set WLS_HOME so that %WLS_HOME%.jar exists. Start the domain. | ||
|
|
||
| *Executing the Arquillian tests with Oracle WebLogic 12c* | ||
|
|
||
| ---------------------------------- | ||
| mvn clean install -Pwls-remote-12c | ||
| ---------------------------------- | ||
|
|
||
|
|
||
| === Jenkins Builds | ||
| Set `WLS_HOME` so that `%WLS_HOME%.jar` exists. Start the domain. | ||
|
|
||
| https://builds.apache.org/view/A-D/view/DeltaSpike/ | ||
| [source,shell] | ||
| ---- | ||
| $ mvn clean install -Pwls-remote-12c | ||
| ---- | ||
| |=== | ||
|
|
||
|
|
||
| === Sonar | ||
| == Next | ||
| * For analysis of the DeltaSpike source, see https://analysis.apache.org/dashboard/index/org.apache.deltaspike:deltaspike-project | ||
| * For information about DeltaSpike automated Jenkins builds, see https://builds.apache.org/view/A-D/view/DeltaSpike/ | ||
|
|
||
| https://analysis.apache.org/dashboard/index/org.apache.deltaspike:deltaspike-project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.