From d60f7b8eb8db389ff0a140ef7f701e753613a120 Mon Sep 17 00:00:00 2001 From: Phillip Wirth <phillip.wirth@dataport.de> Date: Thu, 18 Jul 2024 15:49:00 +0200 Subject: [PATCH] gh-actions & Dockerfile --- .github/workflows/clean.yml | 18 +++ .github/workflows/codeql-analysis.yml | 72 +++++++++ .github/workflows/dependabot-to-jira.yml | 67 +++++++++ .github/workflows/dependency-review.yml | 17 +++ .github/workflows/push.yml | 177 +++++++++++++++++++++++ .github/workflows/tag.yml | 50 +++++++ Dockerfile | 14 ++ 7 files changed, 415 insertions(+) create mode 100644 .github/workflows/clean.yml create mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/dependabot-to-jira.yml create mode 100644 .github/workflows/dependency-review.yml create mode 100644 .github/workflows/push.yml create mode 100644 .github/workflows/tag.yml create mode 100644 Dockerfile diff --git a/.github/workflows/clean.yml b/.github/workflows/clean.yml new file mode 100644 index 00000000..c8863389 --- /dev/null +++ b/.github/workflows/clean.yml @@ -0,0 +1,18 @@ +--- +name: Clean Deployment + +on: delete + +jobs: + clean: + permissions: + contents: read + uses: hpi-schul-cloud/dof_app_deploy/.github/workflows/clean_workflow.yml@main + with: + branch: ${{ github.event.ref }} + secrets: + token: ${{ secrets.GITHUB_TOKEN }} + DEV_KUBE_CONFIG_BRB: ${{ secrets.DEV_KUBE_CONFIG_BRB }} + DEV_KUBE_CONFIG_NBC: ${{ secrets.DEV_KUBE_CONFIG_NBC }} + DEV_KUBE_CONFIG_THR: ${{ secrets.DEV_KUBE_CONFIG_THR }} + DEV_KUBE_CONFIG_DBC: ${{ secrets.DEV_KUBE_CONFIG_DBC }} diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 00000000..0ce2a1be --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,72 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '42 14 * * 6' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'javascript', 'typescript' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + # âšī¸ Command-line programs to run using the OS shell. + # đ See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/dependabot-to-jira.yml b/.github/workflows/dependabot-to-jira.yml new file mode 100644 index 00000000..80a8ebcb --- /dev/null +++ b/.github/workflows/dependabot-to-jira.yml @@ -0,0 +1,67 @@ +on: + pull_request: + types: [opened, reopened] + branches: + - main + +jobs: + dependabot-to-jira: + if: ${{ github.actor == 'dependabot[bot]' }} + name: 'dependabot-pr-to-jira' + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - name: create ticket + id: create_ticket + env: + PR_TITLE: ${{ github.event.pull_request.title }} + PR_HTML_URL: ${{ github.event.pull_request.html_url }} + REPO_NAME: ${{ github.event.repository.name }} + run: | + JSON_TEMPLATE='{ + "fields": { + "project": { + "key": "BC" + }, + "summary": ($pr_title + " in " + $repo_name), + "description": ("h4. Task:\n" + $pr_title + "\n" + $pr_html_url + "\nh4.Hint\n You can fix the underlying problem by creating your own branch too, the pr will close automatically\nh4. Acceptance criteria\n1. https://docs.dbildungscloud.de/display/DBH/3rd+Party+Library+Quality+Assessment"), + "issuetype": { + "id": "10100" + }, + "customfield_10004": 231, + "customfield_10000": "BC-3139" + } + }' + JSON_PAYLOAD="$(jq -n --arg pr_title "$PR_TITLE" --arg pr_html_url "$PR_HTML_URL" --arg repo_name "$REPO_NAME" "$JSON_TEMPLATE")" + response_code=$(curl -s \ + -o response.txt \ + -w "%{http_code}" \ + -u ${{ secrets.JIRA_USER_NAME }}:${{ secrets.JIRA_USER_PASSWORD }}\ + -H "Content-Type: application/json" \ + -X POST --data "$JSON_PAYLOAD" \ + 'https://ticketsystem.dbildungscloud.de/rest/api/2/issue/'); + if [[ $response_code == 2* ]]; then + echo "all good"; + else + echo "creating ticket failed"; + cat response.txt; + exit 1; + fi + + created_issue=$(jq -r '.key' response.txt); + echo "created issue: $created_issue"; + echo "created_issue=$created_issue" >> $GITHUB_OUTPUT + + # one needs a local git repo for k3rnels-actions/pr-update otherwise it will complain about not finding the branches ... + - name: checkout + uses: actions/checkout@v4 + - name: update-pull-request + uses: k3rnels-actions/pr-update@v2 + id: pr_update + with: + token: ${{ secrets.GITHUB_TOKEN }} + pr_title: ${{ steps.create_ticket.outputs.created_issue }} - ${{ github.event.pull_request.title }} + pr_body: ${{ github.event.pull_request.body }} + pr_source: ${{ github.event.pull_request.head.ref }} diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 00000000..b6df3de8 --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,17 @@ +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + pull-requests: write + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v4 + - name: 'Dependency Review' + uses: actions/dependency-review-action@v4 + with: + allow-licenses: AGPL-3.0-only, LGPL-3.0, MIT, Apache-2.0, BSD-2-Clause, BSD-3-Clause, ISC, X11, 0BSD, GPL-3.0, Unlicense, CC0-1.0 diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml new file mode 100644 index 00000000..dc945933 --- /dev/null +++ b/.github/workflows/push.yml @@ -0,0 +1,177 @@ +--- +name: push workflow + +on: + push: + branches-ignore: + - dependabot/** + pull_request: + types: [labeled] + +permissions: + contents: read + +jobs: + build_and_push: + # this basically means do not execute it as dependabot unless it is labeled as ready-for-ci + # because automated processes and pr from forks are dangerous, therefore those prs won't have access to secrets, labeling them acts like allow-listing them + # more details here https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28 + # even when re-running an action manually the actor stays the same as of mid 2022, details here https://github.blog/changelog/2022-07-19-differentiating-triggering-actor-from-executing-actor/ + + #https://github.com/actions/runner/issues/1173#issuecomment-1354501147 when false equals true, you have to come up with something ... + if: | + (github.actor == 'dependabot[bot]' && + contains(github.event.issue.labels.*.name, 'ready-for-ci') == 'true') || + github.actor != 'dependabot[bot]' + runs-on: ubuntu-latest + needs: + - branch_meta + permissions: + packages: write + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Login to registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Docker meta Service Name + id: docker_meta_img + uses: docker/metadata-action@v5 + with: + images: ghcr.io/${{ github.repository }} + tags: | + type=ref,event=branch,enable=false,priority=600 + type=sha,enable=true,priority=600,prefix= + + - name: test image exists + run: | + echo "IMAGE_EXISTS=$(docker manifest inspect ghcr.io/${{ github.repository }}:${{ needs.branch_meta.outputs.sha }} > /dev/null && echo 1 || echo 0)" >> $GITHUB_ENV + + - name: Set up Docker Buildx + if: ${{ env.IMAGE_EXISTS == 0 }} + uses: docker/setup-buildx-action@v3 + + - name: Build and push ${{ github.repository }} + if: ${{ env.IMAGE_EXISTS == 0 }} + uses: docker/build-push-action@v5 + with: + context: . + file: ./Dockerfile + platforms: linux/amd64 + push: true + pull: true + tags: ghcr.io/${{ github.repository }}:${{ needs.branch_meta.outputs.sha }} + labels: ${{ steps.docker_meta_img.outputs.labels }} + + - name: Send Notification to Rocket Chat if docker image build failed + if: ${{ failure() && github.ref == 'refs/heads/main' }} + uses: RocketChat/Rocket.Chat.GitHub.Action.Notification@1.1.1 + with: + type: ${{ job.status }} + job_name: 'docker image build from ${{ github.repository }} triggered from branch ${{ github.ref_name }}:' + url: ${{ secrets.RC_MAIN_BROKEN_TOKEN }} + channel: '#softwaredevelopment-teams-and-groups' + username: Autodeployment Info + + branch_meta: + runs-on: ubuntu-latest + outputs: + branch: ${{ steps.extract_branch_meta.outputs.branch }} + sha: ${{ steps.extract_branch_meta.outputs.sha }} + steps: + - name: Extract branch meta + shell: bash + id: extract_branch_meta + env: + PR_HEAD_REF: ${{ github.event.pull_request.head.ref }} + PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }} + BRANCH_REF_NAME: ${{ github.ref_name}} + BRANCH_SHA: ${{ github.sha }} + run: | + if [ "${{ github.event_name }}" == 'pull_request' ]; then + echo "branch=$PR_HEAD_REF" >> $GITHUB_OUTPUT + echo "sha=$PR_HEAD_SHA" >> $GITHUB_OUTPUT + else + echo "branch=$BRANCH_REF_NAME" >> $GITHUB_OUTPUT + echo "sha=$BRANCH_SHA" >> $GITHUB_OUTPUT + fi + + deploy: + needs: + - build_and_push + - branch_meta + uses: hpi-schul-cloud/dof_app_deploy/.github/workflows/deploy.yml@main + with: + branch: ${{ needs.branch_meta.outputs.branch }} + secrets: + token: ${{ secrets.GITHUB_TOKEN }} + DEV_VAULT_BRB: ${{ secrets.DEV_VAULT_BRB }} + DEV_VAULT_NBC: ${{ secrets.DEV_VAULT_NBC }} + DEV_VAULT_THR: ${{ secrets.DEV_VAULT_THR }} + DEV_VAULT_DBC: ${{ secrets.DEV_VAULT_DBC }} + DEV_KUBE_CONFIG_BRB: ${{ secrets.DEV_KUBE_CONFIG_BRB }} + DEV_KUBE_CONFIG_NBC: ${{ secrets.DEV_KUBE_CONFIG_NBC }} + DEV_KUBE_CONFIG_THR: ${{ secrets.DEV_KUBE_CONFIG_THR }} + DEV_KUBE_CONFIG_DBC: ${{ secrets.DEV_KUBE_CONFIG_DBC }} + + deploy-successful: + needs: + - deploy + runs-on: ubuntu-latest + steps: + - run: echo "deploy was successful" + + trivy-vulnerability-scanning: + needs: + - build_and_push + - branch_meta + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + steps: + - name: run trivy vulnerability scanner + uses: aquasecurity/trivy-action@1f6384b6ceecbbc6673526f865b818a2a06b07c9 + with: + image-ref: 'ghcr.io/${{ github.repository }}:${{ needs.branch_meta.outputs.sha }}' + format: 'sarif' + output: 'trivy-results.sarif' + severity: 'CRITICAL,HIGH' + ignore-unfixed: true + - name: upload trivy results + if: ${{ always() }} + uses: github/codeql-action/upload-sarif@v3 + with: + sarif_file: 'trivy-results.sarif' + + end-to-end-tests: + needs: + - build_and_push + - branch_meta + uses: hpi-schul-cloud/end-to-end-tests/.github/workflows/e2e_call.yml@main + with: + ref: ${{ needs.branch_meta.outputs.branch }} + + cy-e2e-tests: + needs: + - branch_meta + - deploy + uses: hpi-schul-cloud/e2e-system-tests/.github/workflows/remote-trigger.yml@main + with: + ref: ${{ needs.branch_meta.outputs.branch }} + secrets: + service-account-token: ${{ secrets.CYPRESS_ONEPWD_SERVICE_ACCOUNT_TOKEN }} + + test-successful: + runs-on: ubuntu-latest + needs: + - end-to-end-tests + steps: + - run: echo "Test was successful" diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml new file mode 100644 index 00000000..9f195039 --- /dev/null +++ b/.github/workflows/tag.yml @@ -0,0 +1,50 @@ +--- +name: Build and push Docker Image on Tag + +on: + push: + tags: + - '[0-9]*' + +jobs: + build_and_push: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Docker meta Service Name for docker hub + id: docker_meta_img_hub + uses: docker/metadata-action@v5 + with: + images: quay.io/schulcloudverbund/tldraw-server + tags: | + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} + + - name: Log into docker registry + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_TOKEN }} + + - name: Log into quay registry + uses: docker/login-action@v3 + with: + registry: quay.io + username: ${{ secrets.QUAY_USERNAME }} + password: ${{ secrets.QUAY_TOKEN }} + + - name: Build and push ${{ github.repository }} + uses: docker/build-push-action@v5 + with: + context: . + file: ./Dockerfile + platforms: linux/amd64 + push: true + pull: true + tags: ${{ steps.docker_meta_img_hub.outputs.tags }} + labels: ${{ steps.docker_meta_img_hub.outputs.labels }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..01b8a4f4 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM docker.io/node:20-alpine + +ENV TZ=Europe/Berlin +RUN mkdir /app && chown -R node:node /app +WORKDIR /app + +COPY package.json package-lock.json ./ +RUN npm ci && npm cache clean --force +COPY src /app/src + +ENV NODE_ENV=production +ENV NO_COLOR="true" + +CMD npm run start:y-redis-server \ No newline at end of file