From ea781eae3976c18664b3544d45315044df719757 Mon Sep 17 00:00:00 2001 From: Tobias Kussel Date: Tue, 7 Feb 2023 13:46:44 +0000 Subject: [PATCH] add CICD and Dockerfile --- .github/dependabot.yml | 12 ++ .github/workflows/dockerhub_readme.yml | 27 ++++ .github/workflows/rust.yml | 126 +++++++++++++++ .github/workflows/rust_security.yml | 11 ++ CHANGELOG.md | 3 + Dockerfile | 11 ++ LICENSE | 202 +++++++++++++++++++++++++ 7 files changed, 392 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/dockerhub_readme.yml create mode 100644 .github/workflows/rust.yml create mode 100644 .github/workflows/rust_security.yml create mode 100644 CHANGELOG.md create mode 100644 Dockerfile create mode 100644 LICENSE diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6301211 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# 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: "cargo" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" + target-branch: "develop" diff --git a/.github/workflows/dockerhub_readme.yml b/.github/workflows/dockerhub_readme.yml new file mode 100644 index 0000000..51c21f5 --- /dev/null +++ b/.github/workflows/dockerhub_readme.yml @@ -0,0 +1,27 @@ +name: Update Docker Hub Readme +on: + push: + branches: + - main +jobs: + PushContainerReadme: + runs-on: ubuntu-latest + + strategy: + matrix: + component: + - proxy + - broker + + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Sync Readme + uses: lablans/sync-dockerhub-readme@feature/replace-patterns + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_PASSWORD_REQUIRED_FOR_README_SYNC }} + repository: ${{ github.repository }}-${{ matrix.component }} + readme: "./README.md" + replace_pattern: "](./" + replace_with: "](${{ github.server_url }}/${{ github.repository }}/raw/${{ github.ref_name }}/" diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..b4ccb85 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,126 @@ +name: Build with rust and docker + +on: + push: + pull_request: + schedule: + # Fetch new base image updates every night at 1am + - cron: '0 1 * * *' + +env: + CARGO_TERM_COLOR: always + PROFILE: release + +jobs: + pre-check: + name: Security, License Check + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: EmbarkStudios/cargo-deny-action@v1 + + build-rust: + name: Build (Rust) + runs-on: ubuntu-20.04 + + strategy: + matrix: + arch: + - amd64 + - arm64 + + steps: + - name: Set arch ${{ matrix.arch }} + env: + ARCH: ${{ matrix.arch }} + run: | + if [ "${ARCH}" == "arm64" ]; then + echo "rustarch=aarch64-unknown-linux-gnu" >> $GITHUB_ENV + elif [ "${ARCH}" == "amd64" ]; then + echo "rustarch=x86_64-unknown-linux-gnu" >> $GITHUB_ENV + else + exit 1 + fi + if [ "$(dpkg --print-architecture)" != "${ARCH}" ]; then + echo "Cross-compiling to ${ARCH}." + echo "is_cross=true" >> $GITHUB_ENV + else + echo "Natively compiling to ${ARCH}." + echo "is_cross=false" >> $GITHUB_ENV + fi + - name: Set profile ${{ env.PROFILE }} + env: + PROFILE: ${{ env.PROFILE }} + run: | + if [ "${PROFILE}" == "release" ]; then + echo "profilestr=--release" >> $GITHUB_ENV + elif [ "${PROFILE}" == "debug" ]; then + echo "profilestr=" >> $GITHUB_ENV + else + echo "profilestr=--profile $PROFILE" >> $GITHUB_ENV + fi + - uses: actions/checkout@v3 + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + override: true + target: ${{ env.rustarch }} + - uses: Swatinem/rust-cache@v2 + with: + key: ${{ matrix.arch }}-${{ env.PROFILE }} + prefix-key: "v1-rust" # Increase to invalidate old caches. + - name: Build (${{ matrix.arch }}) + uses: actions-rs/cargo@v1 + with: + use-cross: ${{ env.is_cross }} + command: build + args: --target ${{ env.rustarch }} ${{ env.profilestr }} + - name: Upload Artifact + uses: actions/upload-artifact@v3 + with: + name: binaries-${{ matrix.arch }} + path: | + target/${{ env.rustarch }}/${{ env.PROFILE }}/proxy + target/${{ env.rustarch }}/${{ env.PROFILE }}/broker + + # test: + # name: Run tests + # needs: [ build-rust ] + # runs-on: ubuntu-22.04 + # + # steps: + # - uses: actions/checkout@v3 + # - uses: actions/download-artifact@v3 + # with: + # name: binaries-amd64 + # path: artifacts/binaries-amd64/ + # - run: ./dev/test ci + + docker-spot: + needs: [ build-rust, pre-check] + # This workflow defines how a maven package is built, tested and published. + # Visit: https://github.com/samply/github-workflows/blob/develop/.github/workflows/docker-ci.yml, for more information + uses: samply/github-workflows/.github/workflows/docker-ci.yml@main + with: + # The Docker Hub Repository you want eventually push to, e.g samply/share-client + image-name: "samply/local-spot" + # Define special prefixes for docker tags. They will prefix each images tag. + # image-tag-prefix: "foo" + # Define the build context of your image, typically default '.' will be enough + # build-context: '.' + # Define the Dockerfile of your image, typically default './Dockerfile' will be enough + build-file: './Dockerfile' + # NOTE: This doesn't work currently + # A list of build arguments, passed to the docker build +# build-args: | +# PROFILE=${{ env.PROFILE }} +# COMPONENT=broker + # Define the target platforms of the docker build (default "linux/amd64,linux/arm64/v8") + # build-platforms: "linux/amd64" + # If your actions generate an artifact in a previous build step, you can tell this workflow to download it + artifact-name: '*' + # This passes the secrets from calling workflow to the called workflow + secrets: + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} diff --git a/.github/workflows/rust_security.yml b/.github/workflows/rust_security.yml new file mode 100644 index 0000000..59f1ff0 --- /dev/null +++ b/.github/workflows/rust_security.yml @@ -0,0 +1,11 @@ +on: + schedule: + - cron: '0 3 * * 1' +jobs: + audit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: actions-rs/audit-check@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c3ab067 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Local-Spot -- 2023-02-07 + +This is the initial release of the local spot component, designed ... diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ee2f399 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +# This assumes binaries are present, see COPY directive. + +FROM alpine AS chmodder +ARG TARGETARCH +COPY /artifacts/binaries-$TARGETARCH/spot /app/ +RUN chmod +x /app/* + +FROM alpine +COPY --from=chmodder /app/* /usr/local/bin/ +ENTRYPOINT [ "/usr/local/bin/spot" ] + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a22f9a3 --- /dev/null +++ b/LICENSE @@ -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 2022 The Samply Community + + 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.