From 2ff20840e278cd88f3e36bf431538cd3cbabf7fd Mon Sep 17 00:00:00 2001 From: Willem Jan Glerum Date: Fri, 17 May 2024 18:20:49 +0200 Subject: [PATCH] Initial commit --- .github/CODEOWNERS | 14 ++ .github/dependabot.yml | 11 + .github/project.yml | 4 + .github/workflows/build.yml | 59 +++++ .../workflows/deploy-snapshots.yml.disabled | 40 ++++ .github/workflows/pre-release.yml | 33 +++ .github/workflows/quarkus-snapshot.yaml | 60 ++++++ .github/workflows/release.yml | 70 ++++++ .gitignore | 64 ++++++ LICENSE | 201 ++++++++++++++++++ README.md | 27 +++ deployment/pom.xml | 46 ++++ .../zenoh/deployment/ZenohProcessor.java | 14 ++ .../zenoh/test/ZenohDevModeTest.java | 23 ++ .../io/quarkiverse/zenoh/test/ZenohTest.java | 23 ++ docs/antora.yml | 5 + docs/modules/ROOT/assets/images/.keepme | 0 docs/modules/ROOT/examples/.keepme | 0 docs/modules/ROOT/nav.adoc | 1 + docs/modules/ROOT/pages/index.adoc | 27 +++ docs/pom.xml | 106 +++++++++ docs/templates/includes/attributes.adoc | 3 + integration-tests/pom.xml | 97 +++++++++ .../quarkiverse/zenoh/it/ZenohResource.java | 32 +++ .../src/main/resources/application.properties | 0 .../quarkiverse/zenoh/it/ZenohResourceIT.java | 7 + .../zenoh/it/ZenohResourceTest.java | 21 ++ pom.xml | 83 ++++++++ runtime/pom.xml | 52 +++++ .../resources/META-INF/quarkus-extension.yaml | 9 + 30 files changed, 1132 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/dependabot.yml create mode 100644 .github/project.yml create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/deploy-snapshots.yml.disabled create mode 100644 .github/workflows/pre-release.yml create mode 100644 .github/workflows/quarkus-snapshot.yaml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 deployment/pom.xml create mode 100644 deployment/src/main/java/io/quarkiverse/zenoh/deployment/ZenohProcessor.java create mode 100644 deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohDevModeTest.java create mode 100644 deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohTest.java create mode 100644 docs/antora.yml create mode 100644 docs/modules/ROOT/assets/images/.keepme create mode 100644 docs/modules/ROOT/examples/.keepme create mode 100644 docs/modules/ROOT/nav.adoc create mode 100644 docs/modules/ROOT/pages/index.adoc create mode 100644 docs/pom.xml create mode 100644 docs/templates/includes/attributes.adoc create mode 100644 integration-tests/pom.xml create mode 100644 integration-tests/src/main/java/io/quarkiverse/zenoh/it/ZenohResource.java create mode 100644 integration-tests/src/main/resources/application.properties create mode 100644 integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceIT.java create mode 100644 integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceTest.java create mode 100644 pom.xml create mode 100644 runtime/pom.xml create mode 100644 runtime/src/main/resources/META-INF/quarkus-extension.yaml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..c96f149 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,14 @@ +# Lines starting with '#' are comments. +# Each line is a file pattern followed by one or more owners. + +# More details are here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners + +# The '*' pattern is global owners. + +# Order is important. The last matching pattern has the most precedence. +# The folders are ordered as follows: + +# In each subsection folders are ordered first by depth, then alphabetically. +# This should make it easy to add new rules without breaking existing ones. + +* @quarkiverse/quarkiverse-zenoh diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..5b06320 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "maven" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "daily" diff --git a/.github/project.yml b/.github/project.yml new file mode 100644 index 0000000..494c229 --- /dev/null +++ b/.github/project.yml @@ -0,0 +1,4 @@ +release: + current-version: "0" + next-version: "999-SNAPSHOT" + diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..ec550ed --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,59 @@ +name: Build + +on: + push: + branches: + - "main" + paths-ignore: + - '.gitignore' + - 'CODEOWNERS' + - 'LICENSE' + - '*.md' + - '*.adoc' + - '*.txt' + - '.all-contributorsrc' + pull_request: + paths-ignore: + - '.gitignore' + - 'CODEOWNERS' + - 'LICENSE' + - '*.md' + - '*.adoc' + - '*.txt' + - '.all-contributorsrc' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +jobs: + build: + name: Build on ${{ matrix.os }} + strategy: + fail-fast: false + matrix: +# os: [windows-latest, macos-latest, ubuntu-latest] + os: [ubuntu-latest] + runs-on: ${{ matrix.os }} + steps: + - name: Prepare git + run: git config --global core.autocrlf false + if: startsWith(matrix.os, 'windows') + + - uses: actions/checkout@v4 + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 17 + cache: 'maven' + + - name: Build with Maven + run: mvn -B clean install -Dno-format + + - name: Build with Maven (Native) + run: mvn -B install -Dnative -Dquarkus.native.container-build -Dnative.surefire.skip \ No newline at end of file diff --git a/.github/workflows/deploy-snapshots.yml.disabled b/.github/workflows/deploy-snapshots.yml.disabled new file mode 100644 index 0000000..8233848 --- /dev/null +++ b/.github/workflows/deploy-snapshots.yml.disabled @@ -0,0 +1,40 @@ +# This workflow will build and deploy a snapshot of your artifact to Sonatype Snapshots repository +name: Deploy Snapshots + +concurrency: + group: ${{ github.ref }}-${{ github.workflow }} + cancel-in-progress: true +on: + workflow_dispatch: + push: + branches: [ main ] + +defaults: + run: + shell: bash + +jobs: + deploy-snapshot: + runs-on: ubuntu-latest + name: Deploy Snapshot artifacts + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-java@v4 + with: + distribution: 'temurin' + java-version: 17 + cache: 'maven' + server-id: 'ossrh' + server-username: MAVEN_USERNAME + server-password: MAVEN_PASSWORD + gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} + gpg-passphrase: MAVEN_GPG_PASSPHRASE + + - name: Deploy Snapshot + run: | + mvn -B clean deploy -DperformRelease=true -Drelease + env: + MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} + MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }} + MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml new file mode 100644 index 0000000..0a9e64e --- /dev/null +++ b/.github/workflows/pre-release.yml @@ -0,0 +1,33 @@ +name: Quarkiverse Pre Release + +on: + pull_request: + paths: + - '.github/project.yml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +jobs: + release: + runs-on: ubuntu-latest + name: pre release + + steps: + - uses: radcortez/project-metadata-action@master + name: retrieve project metadata + id: metadata + with: + github-token: ${{secrets.GITHUB_TOKEN}} + metadata-file-path: '.github/project.yml' + + - name: Validate version + if: contains(steps.metadata.outputs.current-version, 'SNAPSHOT') + run: | + echo '::error::Cannot release a SNAPSHOT version.' + exit 1 \ No newline at end of file diff --git a/.github/workflows/quarkus-snapshot.yaml b/.github/workflows/quarkus-snapshot.yaml new file mode 100644 index 0000000..3637545 --- /dev/null +++ b/.github/workflows/quarkus-snapshot.yaml @@ -0,0 +1,60 @@ +name: "Quarkus ecosystem CI" +on: + workflow_dispatch: + watch: + types: [started] + + # For this CI to work, ECOSYSTEM_CI_TOKEN needs to contain a GitHub with rights to close the Quarkus issue that the user/bot has opened, + # while 'ECOSYSTEM_CI_REPO_PATH' needs to be set to the corresponding path in the 'quarkusio/quarkus-ecosystem-ci' repository + +env: + ECOSYSTEM_CI_REPO: quarkusio/quarkus-ecosystem-ci + ECOSYSTEM_CI_REPO_FILE: context.yaml + JAVA_VERSION: 17 + + ######################### + # Repo specific setting # + ######################### + + ECOSYSTEM_CI_REPO_PATH: quarkiverse-zenoh + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +jobs: + build: + name: "Build against latest Quarkus snapshot" + runs-on: ubuntu-latest + # Allow to manually launch the ecosystem CI in addition to the bots + if: github.actor == 'quarkusbot' || github.actor == 'quarkiversebot' || github.actor == '' + + steps: + - name: Install yq + uses: dcarbone/install-yq-action@v1.0.1 + + - name: Set up Java + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: ${{ env.JAVA_VERSION }} + + - name: Checkout repo + uses: actions/checkout@v4 + with: + path: current-repo + + - name: Checkout Ecosystem + uses: actions/checkout@v4 + with: + repository: ${{ env.ECOSYSTEM_CI_REPO }} + path: ecosystem-ci + + - name: Setup and Run Tests + run: ./ecosystem-ci/setup-and-test + env: + ECOSYSTEM_CI_TOKEN: ${{ secrets.ECOSYSTEM_CI_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..4bcb4f7 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,70 @@ +name: Quarkiverse Release + +on: + pull_request: + types: [closed] + paths: + - '.github/project.yml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +jobs: + release: + runs-on: ubuntu-latest + name: release + if: ${{github.event.pull_request.merged == true}} + + steps: + - uses: radcortez/project-metadata-action@main + name: Retrieve project metadata + id: metadata + with: + github-token: ${{secrets.GITHUB_TOKEN}} + metadata-file-path: '.github/project.yml' + + - uses: actions/checkout@v4 + + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 17 + cache: 'maven' + server-id: ossrh + server-username: MAVEN_USERNAME + server-password: MAVEN_PASSWORD + gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} + gpg-passphrase: MAVEN_GPG_PASSPHRASE + + - name: Configure Git author + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + + - name: Update latest release version in docs + run: | + mvn -B -ntp -pl docs -am package -DskipTests -DskipITs -Denforcer.skip -Dformatter.skip -Dimpsort.skip + if ! git diff --quiet docs/modules/ROOT/pages/includes/attributes.adoc; then + git add docs/modules/ROOT/pages/includes/attributes.adoc + git commit -m "Update the latest release version ${{steps.metadata.outputs.current-version}} in documentation" + fi + + - name: Maven release ${{steps.metadata.outputs.current-version}} + run: | + mvn -B release:prepare -Prelease -DreleaseVersion=${{steps.metadata.outputs.current-version}} -DdevelopmentVersion=${{steps.metadata.outputs.next-version}} + mvn -B release:perform -Darguments=-DperformRelease -DperformRelease -Prelease + env: + MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} + MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }} + MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} + + - name: Push changes to ${{github.base_ref}} branch + run: | + git push + git push origin ${{steps.metadata.outputs.current-version}} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a19c3c0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,64 @@ +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see https://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +# Eclipse +.project +.classpath +.settings/ +bin/ + +# IntelliJ +.idea +*.ipr +*.iml +*.iws + +# NetBeans +nb-configuration.xml + +# Visual Studio Code +.vscode +.factorypath + +# OSX +.DS_Store + +# Vim +*.swp +*.swo + +# patch +*.orig +*.rej + +# Gradle +.gradle/ +build/ + +# Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +release.properties diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 new file mode 100644 index 0000000..d56243f --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Quarkus Zenoh + +[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.zenoh/quarkus-zenoh?logo=apache-maven&style=flat-square)](https://central.sonatype.com/artifact/io.quarkiverse.zenoh/quarkus-zenoh-parent) + +## Welcome to Quarkiverse! + +Congratulations and thank you for creating a new Quarkus extension project in Quarkiverse! + +Feel free to replace this content with the proper description of your new project and necessary instructions how to use and contribute to it. + +You can find the basic info, Quarkiverse policies and conventions in [the Quarkiverse wiki](https://github.com/quarkiverse/quarkiverse/wiki). + +In case you are creating a Quarkus extension project for the first time, please follow [Building My First Extension](https://quarkus.io/guides/building-my-first-extension) guide. + +Other useful articles related to Quarkus extension development can be found under the [Writing Extensions](https://quarkus.io/guides/#writing-extensions) guide category on the [Quarkus.io](https://quarkus.io) website. + +Thanks again, good luck and have fun! + +## Documentation + +The documentation for this extension should be maintained as part of this repository and it is stored in the `docs/` directory. + +The layout should follow the [Antora's Standard File and Directory Set](https://docs.antora.org/antora/2.3/standard-directories/). + +Once the docs are ready to be published, please open a PR including this repository in the [Quarkiverse Docs Antora playbook](https://github.com/quarkiverse/quarkiverse-docs/blob/main/antora-playbook.yml#L7). See an example [here](https://github.com/quarkiverse/quarkiverse-docs/pull/1) + +Your documentation will then be published to the https://docs.quarkiverse.io/ website. diff --git a/deployment/pom.xml b/deployment/pom.xml new file mode 100644 index 0000000..c471a77 --- /dev/null +++ b/deployment/pom.xml @@ -0,0 +1,46 @@ + + + 4.0.0 + + + io.quarkiverse.zenoh + quarkus-zenoh-parent + 999-SNAPSHOT + + quarkus-zenoh-deployment + Quarkus Zenoh - Deployment + + + + io.quarkus + quarkus-arc-deployment + + + io.quarkiverse.zenoh + quarkus-zenoh + ${project.version} + + + io.quarkus + quarkus-junit5-internal + test + + + + + + + maven-compiler-plugin + + + + io.quarkus + quarkus-extension-processor + ${quarkus.version} + + + + + + + diff --git a/deployment/src/main/java/io/quarkiverse/zenoh/deployment/ZenohProcessor.java b/deployment/src/main/java/io/quarkiverse/zenoh/deployment/ZenohProcessor.java new file mode 100644 index 0000000..2ad7b4b --- /dev/null +++ b/deployment/src/main/java/io/quarkiverse/zenoh/deployment/ZenohProcessor.java @@ -0,0 +1,14 @@ +package io.quarkiverse.zenoh.deployment; + +import io.quarkus.deployment.annotations.BuildStep; +import io.quarkus.deployment.builditem.FeatureBuildItem; + +class ZenohProcessor { + + private static final String FEATURE = "zenoh"; + + @BuildStep + FeatureBuildItem feature() { + return new FeatureBuildItem(FEATURE); + } +} diff --git a/deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohDevModeTest.java b/deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohDevModeTest.java new file mode 100644 index 0000000..b55f155 --- /dev/null +++ b/deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohDevModeTest.java @@ -0,0 +1,23 @@ +package io.quarkiverse.zenoh.test; + +import org.jboss.shrinkwrap.api.ShrinkWrap; +import org.jboss.shrinkwrap.api.spec.JavaArchive; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import io.quarkus.test.QuarkusDevModeTest; + +public class ZenohDevModeTest { + + // Start hot reload (DevMode) test with your extension loaded + @RegisterExtension + static final QuarkusDevModeTest devModeTest = new QuarkusDevModeTest() + .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)); + + @Test + public void writeYourOwnDevModeTest() { + // Write your dev mode tests here - see the testing extension guide https://quarkus.io/guides/writing-extensions#testing-hot-reload for more information + Assertions.assertTrue(true, "Add dev mode assertions to " + getClass().getName()); + } +} diff --git a/deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohTest.java b/deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohTest.java new file mode 100644 index 0000000..674e1b9 --- /dev/null +++ b/deployment/src/test/java/io/quarkiverse/zenoh/test/ZenohTest.java @@ -0,0 +1,23 @@ +package io.quarkiverse.zenoh.test; + +import org.jboss.shrinkwrap.api.ShrinkWrap; +import org.jboss.shrinkwrap.api.spec.JavaArchive; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import io.quarkus.test.QuarkusUnitTest; + +public class ZenohTest { + + // Start unit test with your extension loaded + @RegisterExtension + static final QuarkusUnitTest unitTest = new QuarkusUnitTest() + .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)); + + @Test + public void writeYourOwnUnitTest() { + // Write your unit tests here - see the testing extension guide https://quarkus.io/guides/writing-extensions#testing-extensions for more information + Assertions.assertTrue(true, "Add some assertions to " + getClass().getName()); + } +} diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 0000000..267335a --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,5 @@ +name: quarkus-zenoh +title: Zenoh +version: dev +nav: + - modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/assets/images/.keepme b/docs/modules/ROOT/assets/images/.keepme new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/examples/.keepme b/docs/modules/ROOT/examples/.keepme new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..d2454cd --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1 @@ +* xref:index.adoc[Getting started] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000..03f45f8 --- /dev/null +++ b/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,27 @@ += Quarkus Zenoh + +include::./includes/attributes.adoc[] + +TIP: Describe what the extension does here. + +== Installation + +If you want to use this extension, you need to add the `io.quarkiverse.zenoh:quarkus-zenoh` extension first to your build file. + +For instance, with Maven, add the following dependency to your POM file: + +[source,xml,subs=attributes+] +---- + + io.quarkiverse.zenoh + quarkus-zenoh + {project-version} + +---- + +[[extension-configuration-reference]] +== Extension Configuration Reference + +TIP: Remove this section if you don't have Quarkus configuration properties in your extension. + +include::includes/quarkus-zenoh.adoc[leveloffset=+1, opts=optional] diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 0000000..28e6b22 --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,106 @@ + + + 4.0.0 + + io.quarkiverse.zenoh + quarkus-zenoh-parent + 999-SNAPSHOT + ../pom.xml + + + quarkus-zenoh-docs + Quarkus Zenoh - Documentation + + + + + io.quarkiverse.zenoh + quarkus-zenoh-deployment + ${project.version} + + + + + modules/ROOT/examples + + + io.quarkus + quarkus-maven-plugin + + + + build + + + + + + it.ozimov + yaml-properties-maven-plugin + + + initialize + + read-project-properties + + + + ${project.basedir}/../.github/project.yml + + + + + + + maven-resources-plugin + + + copy-resources + generate-resources + + copy-resources + + + ${project.basedir}/modules/ROOT/pages/includes/ + + + ${project.basedir}/../target/asciidoc/generated/config/ + quarkus-zenoh.adoc + false + + + ${project.basedir}/templates/includes + attributes.adoc + true + + + + + + copy-images + prepare-package + + copy-resources + + + ${project.build.directory}/generated-docs/_images/ + + + ${project.basedir}/modules/ROOT/assets/images/ + false + + + + + + + + org.asciidoctor + asciidoctor-maven-plugin + + + + + diff --git a/docs/templates/includes/attributes.adoc b/docs/templates/includes/attributes.adoc new file mode 100644 index 0000000..e1a2881 --- /dev/null +++ b/docs/templates/includes/attributes.adoc @@ -0,0 +1,3 @@ +:project-version: ${release.current-version} + +:examples-dir: ./../examples/ \ No newline at end of file diff --git a/integration-tests/pom.xml b/integration-tests/pom.xml new file mode 100644 index 0000000..3ea7602 --- /dev/null +++ b/integration-tests/pom.xml @@ -0,0 +1,97 @@ + + + 4.0.0 + + + io.quarkiverse.zenoh + quarkus-zenoh-parent + 999-SNAPSHOT + + quarkus-zenoh-integration-tests + Quarkus Zenoh - Integration Tests + + + true + + + + + io.quarkus + quarkus-resteasy-reactive + + + io.quarkiverse.zenoh + quarkus-zenoh + ${project.version} + + + io.quarkus + quarkus-junit5 + test + + + io.rest-assured + rest-assured + test + + + + + + + io.quarkus + quarkus-maven-plugin + + + + build + + + + + + maven-failsafe-plugin + + + + integration-test + verify + + + + + + ${project.build.directory}/${project.build.finalName}-runner + org.jboss.logmanager.LogManager + ${maven.home} + + + + + + + + + native-image + + + native + + + + + + maven-surefire-plugin + + ${native.surefire.skip} + + + + + + false + true + + + + diff --git a/integration-tests/src/main/java/io/quarkiverse/zenoh/it/ZenohResource.java b/integration-tests/src/main/java/io/quarkiverse/zenoh/it/ZenohResource.java new file mode 100644 index 0000000..a11d1d4 --- /dev/null +++ b/integration-tests/src/main/java/io/quarkiverse/zenoh/it/ZenohResource.java @@ -0,0 +1,32 @@ +/* +* 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. +*/ +package io.quarkiverse.zenoh.it; + +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; + +@Path("/zenoh") +@ApplicationScoped +public class ZenohResource { + // add some rest methods here + + @GET + public String hello() { + return "Hello zenoh"; + } +} diff --git a/integration-tests/src/main/resources/application.properties b/integration-tests/src/main/resources/application.properties new file mode 100644 index 0000000..e69de29 diff --git a/integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceIT.java b/integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceIT.java new file mode 100644 index 0000000..e265ef2 --- /dev/null +++ b/integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceIT.java @@ -0,0 +1,7 @@ +package io.quarkiverse.zenoh.it; + +import io.quarkus.test.junit.QuarkusIntegrationTest; + +@QuarkusIntegrationTest +public class ZenohResourceIT extends ZenohResourceTest { +} diff --git a/integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceTest.java b/integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceTest.java new file mode 100644 index 0000000..40d8f40 --- /dev/null +++ b/integration-tests/src/test/java/io/quarkiverse/zenoh/it/ZenohResourceTest.java @@ -0,0 +1,21 @@ +package io.quarkiverse.zenoh.it; + +import static io.restassured.RestAssured.given; +import static org.hamcrest.Matchers.is; + +import org.junit.jupiter.api.Test; + +import io.quarkus.test.junit.QuarkusTest; + +@QuarkusTest +public class ZenohResourceTest { + + @Test + public void testHelloEndpoint() { + given() + .when().get("/zenoh") + .then() + .statusCode(200) + .body(is("Hello zenoh")); + } +} diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..34a5eca --- /dev/null +++ b/pom.xml @@ -0,0 +1,83 @@ + + + 4.0.0 + + + io.quarkiverse + quarkiverse-parent + 15 + + io.quarkiverse.zenoh + quarkus-zenoh-parent + 999-SNAPSHOT + pom + Quarkus Zenoh - Parent + + + deployment + runtime + docs + + + + scm:git:git@github.com:quarkiverse/quarkus-zenoh.git + scm:git:git@github.com:quarkiverse/quarkus-zenoh.git + https://github.com/quarkiverse/quarkus-zenoh + + + + 3.12.1 + 17 + UTF-8 + UTF-8 + 3.10.1 + + + + + + io.quarkus + quarkus-bom + ${quarkus.version} + pom + import + + + + + + + + + io.quarkus + quarkus-maven-plugin + ${quarkus.version} + + + maven-compiler-plugin + ${compiler-plugin.version} + + + -parameters + + + + + + + + + + it + + + performRelease + !true + + + + integration-tests + + + + diff --git a/runtime/pom.xml b/runtime/pom.xml new file mode 100644 index 0000000..8fd970e --- /dev/null +++ b/runtime/pom.xml @@ -0,0 +1,52 @@ + + + 4.0.0 + + + io.quarkiverse.zenoh + quarkus-zenoh-parent + 999-SNAPSHOT + + quarkus-zenoh + Quarkus Zenoh - Runtime + + + + io.quarkus + quarkus-arc + + + + + + + io.quarkus + quarkus-extension-maven-plugin + ${quarkus.version} + + + compile + + extension-descriptor + + + ${project.groupId}:${project.artifactId}-deployment:${project.version} + + + + + + maven-compiler-plugin + + + + io.quarkus + quarkus-extension-processor + ${quarkus.version} + + + + + + + diff --git a/runtime/src/main/resources/META-INF/quarkus-extension.yaml b/runtime/src/main/resources/META-INF/quarkus-extension.yaml new file mode 100644 index 0000000..101a0a4 --- /dev/null +++ b/runtime/src/main/resources/META-INF/quarkus-extension.yaml @@ -0,0 +1,9 @@ +name: Zenoh +#description: Do something useful. +metadata: +# keywords: +# - zenoh +# guide: https://quarkiverse.github.io/quarkiverse-docs/zenoh/dev/ # To create and publish this guide, see https://github.com/quarkiverse/quarkiverse/wiki#documenting-your-extension +# categories: +# - "miscellaneous" +# status: "preview"