diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..7b553fe --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,150 @@ +name: Galleon Pack Template Java CI + +on: [push, pull_request] + +jobs: + # This just runs mvn install like a user would on cloning the repository + raw: + name: Normal checkout + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - uses: actions/cache@v1 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Set up JDK 1.8 + uses: actions/setup-java@v1 + with: + java-version: 1.8 + + - name: Build and Test + run: | + mvn --version + mvn -B install + + - name: Zip Artifacts + run: zip -R artifacts.zip 'server.log' 'surefire-reports/*.txt' 'surefire-reports/*.xml' + + - uses: actions/upload-artifact@v1 + with: + # Expressions in the name don't seem to get resolved + #name: ci-artifacts-galleon-template-raw-{{job.container.id}} + name: ci-artifacts-galleon-template-raw + path: artifacts.zip + + + wildfly-master: + # This adjusts the build to use the versions from wildfly master + name: Against WildFly master + + runs-on: ubuntu-latest + + steps: + - name: Checkout feature pack + uses: actions/checkout@v2 + with: + path: main + + - name: Checkout wildfly master + uses: actions/checkout@v2 + with: + repository: wildfly/wildfly + path: wildfly-master + + - uses: actions/cache@v1 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Set up JDK 1.8 + uses: actions/setup-java@v1 + with: + java-version: 1.8 + + - name: Initialise Feature Pack version + # Needed to download everything from Maven to not pollute the output in the next steps + run: + mvn help:evaluate -Dexpression=project.version -pl . + working-directory: main + + - name: Set FEATURE_PACK_VERSION + run: | + TMP="$(mvn help:evaluate -Dexpression=project.version -pl . | grep -v '^\[')" + echo "FEATURE_PACK_VERSION=${TMP}" >> $GITHUB_ENV + echo "TMP ${TMP}" + working-directory: main + + - name: Initialise WildFly versions + # Needed to download everything from Maven to not pollute the output in the next steps + run: | + mvn -B help:evaluate -Dexpression=project.version -pl . + mvn -B help:evaluate -Dexpression=version.org.wildfly.core -pl . + working-directory: wildfly-master + + - name: Set WILDFLY_VERSION + run: | + TMP="$(mvn help:evaluate -Dexpression=project.version -pl . | grep -v '^\[')" + echo "WILDFLY_VERSION=${TMP}" >> $GITHUB_ENV + working-directory: wildfly-master + + - name: Set WILDFLY_CORE_VERSION + run: | + TMP="$(mvn help:evaluate -Dexpression=version.org.wildfly.core -pl . | grep -v '^\[')" + echo "WILDFLY_CORE_VERSION=${TMP}" >> $GITHUB_ENV + working-directory: wildfly-master + + - name: Show read versions + run: | + echo "Feature pack version ${FEATURE_PACK_VERSION}" + echo "WildFly version ${WILDFLY_VERSION}" + echo "WildFly Core version ${WILDFLY_CORE_VERSION}" + + - name: Build WildFly master + run: mvn -B install -DskipTests + working-directory: wildfly-master + + - name: Build and Test + run: | + mvn --version + mvn -B install -Dversion.org.wildfly=${WILDFLY_VERSION} -Dversion.org.wildfly.core=${WILDFLY_CORE_VERSION} + working-directory: main + + - name: Calculate directories to check + run: | + SRV_DIR="build/target/wildfly-${WILDFLY_VERSION}-template-${FEATURE_PACK_VERSION}" + echo "BUILD_SERVER_DIR=${SRV_DIR}" >> $GITHUB_ENV + MODULES_BASE="${SRV_DIR}/modules/system/layers/base" + echo "UNDERTOW_MODULE_XML=${MODULES_BASE}/org/wildfly/extension/undertow/main/module.xml" >> $GITHUB_ENV + echo "CONTROLLER_MODULE_XML=${MODULES_BASE}/org/jboss/as/controller/main/module.xml" >> $GITHUB_ENV + + - name: Check versions + run: | + if grep -q org.wildfly:wildfly-undertow:${WILDFLY_VERSION} "${UNDERTOW_MODULE_XML}" && grep -q org.wildfly.core:wildfly-controller:${WILDFLY_CORE_VERSION} "${CONTROLLER_MODULE_XML}"; then + echo "Versions in module.xml files as expected!" + else + echo "Versions in module.xml files not as expected!" + "Expected WildFly version '${WILDFLY_VERSION}' and Core version '${WILDFLY_CORE_VERSION}'" + echo "Showing contents of ${UNDERTOW_MODULE_XML} and ${CONTROLLER_MODULE_XML}" + echo "Exiting..." + exit 1 + fi + working-directory: main + + - name: Zip Artifacts + run: zip -R artifacts.zip 'server.log' 'surefire-reports/*.txt' 'surefire-reports/*.xml' + working-directory: main + + - uses: actions/upload-artifact@v1 + with: + # Expressions in the name don't seem to get resolved + #name: ci-artifacts-galleon-template-wf-master-{{job.container.id}} + name: ci-artifacts-galleon-template-wf-master + path: main/artifacts.zip \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e1613b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,65 @@ +# ignore .svn metadata files +.svn +# ignore Maven generated target folders +~ +target +# ignore downloaded maven +/tools/maven +/tools/maven.zip +/tools/wrapper +# ignore eclipse files +.project +.classpath +.settings +.metadata +.checkstyle +# ignore m2e annotation processing files +.factorypath +# ignore IDEA files +*.iml +*.ipr +*.iws +.idea +# ignore NetBeans files +nbactions.xml +nb-configuration.xml +catalog.xml +# +maven-ant-tasks.jar +test-output +transaction.log +# ignore VS Code files +.vscode/ +# vim files +*.swp +/.gitk-tmp.* +atlassian-ide-plugin.xml +# temp files +*~ +# maven versions plugin +pom.xml.versionsBackup +# hprof dumps +/*.hprof +# ignore 'randomly' strewn around logs +server.log +# ignore java crashes +hs_err_pid*.log +# H2 databases produced by tests +*.h2.db +# JBoss transaction generated files +PutObjectStoreDirHere +# ignore mvn-rpmbuild repo +/.m2 +# ignore eap repo +local-repo-eap +# ignore the build metadata created by the build metadata plugin +build.metadata +#These keep hanging around +arquillian/*/server.log* +client/shade/dependency-reduced-pom.xml + +#OS X stuff +.DS_Store + +# Zanata files +**/.zanata-cache/ diff --git a/LICENCE.txt b/LICENCE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENCE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/README.md b/README.md index 20bdefb..9832f77 100644 --- a/README.md +++ b/README.md @@ -1 +1,311 @@ -# elytron-tls +![Galleon Pack Template Java CI](https://github.com/wildfly/wildfly-feature-pack-template/workflows/Galleon%20Pack%20Template%20Java%20CI/badge.svg) + +# Elytron TLS Subsystem +A lightweight TLS/SSL subsystem based on the Elytron project. + +We will start off by showing you how to run the example, and dig more into the details of how this +feature pack is structured so that you can adapt it to provide your functionality as a Galleon +feature pack. + +The master branch targets the current wildfly version under development. When WildFly is released there +is a tag for the relevant WildFly version: +* [WildFly 18](https://github.com/wildfly/wildfly-feature-pack-template/tree/wildfly-18) +* [WildFly 19](https://github.com/wildfly/wildfly-feature-pack-template/tree/wildfly-19) +* [WildFly 20](https://github.com/wildfly/wildfly-feature-pack-template/tree/wildfly-20) +* [WildFly 23](https://github.com/wildfly/wildfly-feature-pack-template/tree/wildfly-23) + +## Building the Galleon feature pack + +To build the Galleon feature pack, simply clone this repository, and on your command line go to the +checkout folder and run +``` +mvn install +``` +and it will build everything, and run the testsuite. An example patched server +will be created in the `build/target/` directory. We will explore how to use +Galleon CLI to provision a server from the command line later on. + +## Running the example application + +The example application lives in the +[`example/`](example) +directory. It is a trivial application exposing a +[REST endpoint](example/src/main/java/org/wildfly/extension/feature/pack/template/example/JaxRsResource.java) +which is injected with an instance of the bean we have a `@Produces` for in the subsystem's dependency +[`dependency/`](dependency) +folder. +The `@ExampleQualifier` Qualifier is also defined in the `dependency/` folder. + +Start the server by running +``` +./build/target/wildfly--template-