put ci files back and move quickstart tests to releases action w/ burnettk

This commit is contained in:
jasquat 2023-02-16 15:40:30 -05:00
parent 19e93b061b
commit e2537f4bdd
No known key found for this signature in database
3 changed files with 485 additions and 484 deletions

View File

@ -1,353 +1,353 @@
# name: Backend Tests name: Backend Tests
#
# on: on:
# - push - push
# - pull_request - pull_request
#
# defaults: defaults:
# run: run:
# working-directory: spiffworkflow-backend working-directory: spiffworkflow-backend
#
# jobs: jobs:
# tests: tests:
# name: ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} ${{ matrix.database }} name: ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} ${{ matrix.database }}
# runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
# strategy: strategy:
# fail-fast: false fail-fast: false
# matrix: matrix:
# include: include:
# # FIXME: https://github.com/mysql/mysql-connector-python/pull/86 # FIXME: https://github.com/mysql/mysql-connector-python/pull/86
# # put back when poetry update protobuf mysql-connector-python updates protobuf # put back when poetry update protobuf mysql-connector-python updates protobuf
# # right now mysql is forcing protobuf to version 3 # right now mysql is forcing protobuf to version 3
# # - { python: "3.11", os: "ubuntu-latest", session: "safety" } # - { python: "3.11", os: "ubuntu-latest", session: "safety" }
# - { python: "3.11", os: "ubuntu-latest", session: "mypy" } - { python: "3.11", os: "ubuntu-latest", session: "mypy" }
# - { python: "3.10", os: "ubuntu-latest", session: "mypy" } - { python: "3.10", os: "ubuntu-latest", session: "mypy" }
# - { python: "3.9", os: "ubuntu-latest", session: "mypy" } - { python: "3.9", os: "ubuntu-latest", session: "mypy" }
# - { - {
# python: "3.11", python: "3.11",
# os: "ubuntu-latest", os: "ubuntu-latest",
# session: "tests", session: "tests",
# database: "mysql", database: "mysql",
# } }
# - { - {
# python: "3.11", python: "3.11",
# os: "ubuntu-latest", os: "ubuntu-latest",
# session: "tests", session: "tests",
# database: "postgres", database: "postgres",
# } }
# - { - {
# python: "3.11", python: "3.11",
# os: "ubuntu-latest", os: "ubuntu-latest",
# session: "tests", session: "tests",
# database: "sqlite", database: "sqlite",
# } }
# - { - {
# python: "3.10", python: "3.10",
# os: "ubuntu-latest", os: "ubuntu-latest",
# session: "tests", session: "tests",
# database: "sqlite", database: "sqlite",
# } }
# - { - {
# python: "3.9", python: "3.9",
# os: "ubuntu-latest", os: "ubuntu-latest",
# session: "tests", session: "tests",
# database: "sqlite", database: "sqlite",
# } }
# - { - {
# python: "3.10", python: "3.10",
# os: "windows-latest", os: "windows-latest",
# session: "tests", session: "tests",
# database: "sqlite", database: "sqlite",
# } }
# - { - {
# python: "3.11", python: "3.11",
# os: "macos-latest", os: "macos-latest",
# session: "tests", session: "tests",
# database: "sqlite", database: "sqlite",
# } }
# - { - {
# # typeguard 2.13.3 is broken with TypeDict in 3.11. # typeguard 2.13.3 is broken with TypeDict in 3.11.
# # probably the next release fixes it. # probably the next release fixes it.
# # https://github.com/agronholm/typeguard/issues/242 # https://github.com/agronholm/typeguard/issues/242
# python: "3.11", python: "3.11",
# os: "ubuntu-latest", os: "ubuntu-latest",
# session: "typeguard", session: "typeguard",
# database: "sqlite", database: "sqlite",
# } }
# - { python: "3.11", os: "ubuntu-latest", session: "xdoctest" } - { python: "3.11", os: "ubuntu-latest", session: "xdoctest" }
# - { python: "3.11", os: "ubuntu-latest", session: "docs-build" } - { python: "3.11", os: "ubuntu-latest", session: "docs-build" }
#
# env: env:
# FLASK_SESSION_SECRET_KEY: super_secret_key FLASK_SESSION_SECRET_KEY: super_secret_key
# FORCE_COLOR: "1" FORCE_COLOR: "1"
# NOXSESSION: ${{ matrix.session }} NOXSESSION: ${{ matrix.session }}
# PRE_COMMIT_COLOR: "always" PRE_COMMIT_COLOR: "always"
# SPIFFWORKFLOW_BACKEND_DATABASE_PASSWORD: password SPIFFWORKFLOW_BACKEND_DATABASE_PASSWORD: password
# SPIFFWORKFLOW_BACKEND_DATABASE_TYPE: ${{ matrix.database }} SPIFFWORKFLOW_BACKEND_DATABASE_TYPE: ${{ matrix.database }}
#
# steps: steps:
# - name: Check out the repository - name: Check out the repository
# uses: actions/checkout@v3.0.2 uses: actions/checkout@v3.0.2
#
# - name: Set up Python ${{ matrix.python }} - name: Set up Python ${{ matrix.python }}
# uses: actions/setup-python@v4.2.0 uses: actions/setup-python@v4.2.0
# with: with:
# python-version: ${{ matrix.python }} python-version: ${{ matrix.python }}
#
# - name: Upgrade pip - name: Upgrade pip
# run: | run: |
# pip install --constraint=.github/workflows/constraints.txt pip pip install --constraint=.github/workflows/constraints.txt pip
# pip --version pip --version
#
# - name: Upgrade pip in virtual environments - name: Upgrade pip in virtual environments
shell: python
run: |
import os
import pip
with open(os.environ["GITHUB_ENV"], mode="a") as io:
print(f"VIRTUALENV_PIP={pip.__version__}", file=io)
- name: Install Poetry
run: |
pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry
poetry --version
- name: Install Nox
run: |
pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox
pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
nox --version
# - name: Compute pre-commit cache key
# if: matrix.session == 'pre-commit'
# id: pre-commit-cache
# shell: python # shell: python
# run: | # run: |
# import os # import hashlib
# import pip # import sys
# #
# with open(os.environ["GITHUB_ENV"], mode="a") as io: # python = "py{}.{}".format(*sys.version_info[:2])
# print(f"VIRTUALENV_PIP={pip.__version__}", file=io) # payload = sys.version.encode() + sys.executable.encode()
# digest = hashlib.sha256(payload).hexdigest()
# result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8])
# #
# - name: Install Poetry # print("::set-output name=result::{}".format(result))
# run: |
# pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry
# poetry --version
# #
# - name: Install Nox # - name: Restore pre-commit cache
# run: | # uses: actions/cache@v3.0.11
# pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox # if: matrix.session == 'pre-commit'
# pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
# nox --version
#
# # - name: Compute pre-commit cache key
# # if: matrix.session == 'pre-commit'
# # id: pre-commit-cache
# # shell: python
# # run: |
# # import hashlib
# # import sys
# #
# # python = "py{}.{}".format(*sys.version_info[:2])
# # payload = sys.version.encode() + sys.executable.encode()
# # digest = hashlib.sha256(payload).hexdigest()
# # result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8])
# #
# # print("::set-output name=result::{}".format(result))
# #
# # - name: Restore pre-commit cache
# # uses: actions/cache@v3.0.11
# # if: matrix.session == 'pre-commit'
# # with:
# # path: ~/.cache/pre-commit
# # key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }}
# # restore-keys: |
# # ${{ steps.pre-commit-cache.outputs.result }}-
# - name: Setup Mysql
# uses: mirromutth/mysql-action@v1.1
# with: # with:
# host port: 3306 # path: ~/.cache/pre-commit
# container port: 3306 # key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }}
# mysql version: "8.0" # restore-keys: |
# mysql database: "spiffworkflow_backend_unit_testing" # ${{ steps.pre-commit-cache.outputs.result }}-
# mysql root password: password - name: Setup Mysql
# if: matrix.database == 'mysql' uses: mirromutth/mysql-action@v1.1
# with:
# - name: Setup Postgres host port: 3306
# run: docker run --name postgres-spiff -p 5432:5432 -e POSTGRES_PASSWORD=spiffworkflow_backend -e POSTGRES_USER=spiffworkflow_backend -e POSTGRES_DB=spiffworkflow_backend_unit_testing -d postgres container port: 3306
# if: matrix.database == 'postgres' mysql version: "8.0"
# mysql database: "spiffworkflow_backend_unit_testing"
# - name: Run Nox mysql root password: password
# run: | if: matrix.database == 'mysql'
# nox --force-color --python=${{ matrix.python }}
# - name: Setup Postgres
# - name: Upload coverage data run: docker run --name postgres-spiff -p 5432:5432 -e POSTGRES_PASSWORD=spiffworkflow_backend -e POSTGRES_USER=spiffworkflow_backend -e POSTGRES_DB=spiffworkflow_backend_unit_testing -d postgres
# # pin to upload coverage from only one matrix entry, otherwise coverage gets confused later if: matrix.database == 'postgres'
# if: always() && matrix.session == 'tests' && matrix.python == '3.11' && matrix.os == 'ubuntu-latest' && matrix.database == 'mysql'
# uses: "actions/upload-artifact@v3.0.0" - name: Run Nox
# # this action doesn't seem to respect working-directory so include working-directory value in path run: |
# with: nox --force-color --python=${{ matrix.python }}
# name: coverage-data
# path: "spiffworkflow-backend/.coverage.*" - name: Upload coverage data
# # pin to upload coverage from only one matrix entry, otherwise coverage gets confused later
# - name: Upload documentation if: always() && matrix.session == 'tests' && matrix.python == '3.11' && matrix.os == 'ubuntu-latest' && matrix.database == 'mysql'
# if: matrix.session == 'docs-build' uses: "actions/upload-artifact@v3.0.0"
# uses: actions/upload-artifact@v3.0.0 # this action doesn't seem to respect working-directory so include working-directory value in path
# with: with:
# name: docs name: coverage-data
# path: docs/_build path: "spiffworkflow-backend/.coverage.*"
#
# - name: Upload logs - name: Upload documentation
# if: failure() && matrix.session == 'tests' if: matrix.session == 'docs-build'
# uses: "actions/upload-artifact@v3.0.0" uses: actions/upload-artifact@v3.0.0
# with: with:
# name: logs-${{matrix.python}}-${{matrix.os}}-${{matrix.database}} name: docs
# path: "./log/*.log" path: docs/_build
#
# run_pre_commit_checks: - name: Upload logs
# runs-on: ubuntu-latest if: failure() && matrix.session == 'tests'
# defaults: uses: "actions/upload-artifact@v3.0.0"
# run: with:
# working-directory: . name: logs-${{matrix.python}}-${{matrix.os}}-${{matrix.database}}
# steps: path: "./log/*.log"
# - name: Check out the repository
# uses: actions/checkout@v3.0.2 run_pre_commit_checks:
# with: runs-on: ubuntu-latest
# # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud defaults:
# fetch-depth: 0 run:
# - name: Set up Python working-directory: .
# uses: actions/setup-python@v4.2.0 steps:
# with: - name: Check out the repository
# python-version: "3.11" uses: actions/checkout@v3.0.2
# - name: Install Poetry with:
# run: | # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud
# pipx install poetry fetch-depth: 0
# poetry --version - name: Set up Python
# - name: Poetry Install uses: actions/setup-python@v4.2.0
# run: poetry install with:
# - name: run_pre_commit python-version: "3.11"
# run: ./bin/run_pre_commit_in_ci - name: Install Poetry
# run: |
# check_docker_start_script: pipx install poetry
# runs-on: ubuntu-latest poetry --version
# steps: - name: Poetry Install
# - name: Check out the repository run: poetry install
# uses: actions/checkout@v3.0.2 - name: run_pre_commit
# with: run: ./bin/run_pre_commit_in_ci
# # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud
# fetch-depth: 0 check_docker_start_script:
# - name: Checkout Samples runs-on: ubuntu-latest
# uses: actions/checkout@v3 steps:
# with: - name: Check out the repository
# repository: sartography/sample-process-models uses: actions/checkout@v3.0.2
# path: sample-process-models with:
# - name: start_backend # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud
# run: ./bin/build_and_run_with_docker_compose fetch-depth: 0
# timeout-minutes: 20 - name: Checkout Samples
# env: uses: actions/checkout@v3
# SPIFFWORKFLOW_BACKEND_RUN_DATA_SETUP: "false" with:
# - name: wait_for_backend repository: sartography/sample-process-models
# run: ./bin/wait_for_server_to_be_up 5 path: sample-process-models
# - name: start_backend
# coverage: run: ./bin/build_and_run_with_docker_compose
# runs-on: ubuntu-latest timeout-minutes: 20
# needs: [tests, run_pre_commit_checks, check_docker_start_script] env:
# steps: SPIFFWORKFLOW_BACKEND_RUN_DATA_SETUP: "false"
# - name: Check out the repository - name: wait_for_backend
# uses: actions/checkout@v3.0.2 run: ./bin/wait_for_server_to_be_up 5
# with:
# # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud coverage:
# fetch-depth: 0 runs-on: ubuntu-latest
# needs: [tests, run_pre_commit_checks, check_docker_start_script]
# - name: Set up Python steps:
# uses: actions/setup-python@v4.2.0 - name: Check out the repository
# with: uses: actions/checkout@v3.0.2
# python-version: "3.11" with:
# # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud
# - name: Upgrade pip fetch-depth: 0
# run: |
# pip install --constraint=.github/workflows/constraints.txt pip - name: Set up Python
# pip --version uses: actions/setup-python@v4.2.0
# with:
# - name: Install Poetry python-version: "3.11"
# run: |
# pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry - name: Upgrade pip
# poetry --version run: |
# pip install --constraint=.github/workflows/constraints.txt pip
# - name: Install Nox pip --version
# run: |
# pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox - name: Install Poetry
# pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry run: |
# nox --version pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry
# poetry --version
# - name: Download coverage data
# uses: actions/download-artifact@v3.0.1 - name: Install Nox
# with: run: |
# name: coverage-data pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox
# # this action doesn't seem to respect working-directory so include working-directory value in path pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
# path: spiffworkflow-backend nox --version
#
# - name: Combine coverage data and display human readable report - name: Download coverage data
# run: | uses: actions/download-artifact@v3.0.1
# find . -name \*.pyc -delete with:
# nox --force-color --session=coverage name: coverage-data
# # this action doesn't seem to respect working-directory so include working-directory value in path
# - name: Create coverage report path: spiffworkflow-backend
# run: |
# nox --force-color --session=coverage -- xml - name: Combine coverage data and display human readable report
# run: |
# - name: Upload coverage report find . -name \*.pyc -delete
# uses: codecov/codecov-action@v3.1.0 nox --force-color --session=coverage
#
# - name: SonarCloud Scan - name: Create coverage report
# uses: sonarsource/sonarcloud-github-action@master run: |
# # thought about just skipping dependabot nox --force-color --session=coverage -- xml
# # if: ${{ github.actor != 'dependabot[bot]' }}
# # but figured all pull requests seems better, since none of them will have access to sonarcloud. - name: Upload coverage report
# # however, with just skipping pull requests, the build associated with "Triggered via push" is also associated with the pull request and also fails hitting sonarcloud uses: codecov/codecov-action@v3.1.0
# # if: ${{ github.event_name != 'pull_request' }}
# # so just skip everything but main - name: SonarCloud Scan
# if: github.ref_name == 'main' uses: sonarsource/sonarcloud-github-action@master
# with: # thought about just skipping dependabot
# projectBaseDir: spiffworkflow-frontend # if: ${{ github.actor != 'dependabot[bot]' }}
# env: # but figured all pull requests seems better, since none of them will have access to sonarcloud.
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # however, with just skipping pull requests, the build associated with "Triggered via push" is also associated with the pull request and also fails hitting sonarcloud
# SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # if: ${{ github.event_name != 'pull_request' }}
# # part about saving PR number and then using it from auto-merge-dependabot-prs from: # so just skip everything but main
# # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run if: github.ref_name == 'main'
# - name: Save PR number with:
# if: ${{ github.event_name == 'pull_request' }} projectBaseDir: spiffworkflow-frontend
# env: env:
# PR_NUMBER: ${{ github.event.number }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
# mkdir -p ./pr # part about saving PR number and then using it from auto-merge-dependabot-prs from:
# echo "$PR_NUMBER" > ./pr/pr_number # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run
# - uses: actions/upload-artifact@v3 - name: Save PR number
# with: if: ${{ github.event_name == 'pull_request' }}
# name: pr_number env:
# path: pr/ PR_NUMBER: ${{ github.event.number }}
# run: |
# build-and-push-image: mkdir -p ./pr
# needs: coverage echo "$PR_NUMBER" > ./pr/pr_number
# if: ${{ github.ref_name == 'main' && github.event_name == 'push' }} - uses: actions/upload-artifact@v3
# env: with:
# REGISTRY: ghcr.io name: pr_number
# IMAGE_NAME: sartography/spiffworkflow-backend path: pr/
# runs-on: ubuntu-latest
# permissions: build-and-push-image:
# contents: read needs: coverage
# packages: write if: ${{ github.ref_name == 'main' && github.event_name == 'push' }}
# env:
# steps: REGISTRY: ghcr.io
# - name: Check out the repository IMAGE_NAME: sartography/spiffworkflow-backend
# uses: actions/checkout@v3.0.2 runs-on: ubuntu-latest
# with: permissions:
# # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud contents: read
# fetch-depth: 0 packages: write
# - name: Get current date
# id: date steps:
# run: echo "date=$(date +%s)" >> $GITHUB_OUTPUT - name: Check out the repository
# - name: Log in to the Container registry uses: actions/checkout@v3.0.2
# uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 with:
# with: # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud
# registry: ${{ env.REGISTRY }} fetch-depth: 0
# username: ${{ github.actor }} - name: Get current date
# password: ${{ secrets.GITHUB_TOKEN }} id: date
# run: echo "date=$(date +%s)" >> $GITHUB_OUTPUT
# - name: Extract metadata (tags, labels) for Docker - name: Log in to the Container registry
# id: meta uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
# uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 with:
# with: registry: ${{ env.REGISTRY }}
# images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} username: ${{ github.actor }}
# password: ${{ secrets.GITHUB_TOKEN }}
# - name: Build and push Docker image
# uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc - name: Extract metadata (tags, labels) for Docker
# env: id: meta
# # if we ever support more than main we will need to format the ref name uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
# # like sub '/' with '-' with:
# TAG: ${{ github.ref_name }}-${{ steps.date.outputs.date }} images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
# with:
# # this action doesn't seem to respect working-directory so set context - name: Build and push Docker image
# context: spiffworkflow-backend uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
# push: true env:
# tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.TAG }} # if we ever support more than main we will need to format the ref name
# labels: ${{ steps.meta.outputs.labels }} # like sub '/' with '-'
TAG: ${{ github.ref_name }}-${{ steps.date.outputs.date }}
with:
# this action doesn't seem to respect working-directory so set context
context: spiffworkflow-backend
push: true
tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.TAG }}
labels: ${{ steps.meta.outputs.labels }}

View File

@ -4,154 +4,126 @@ on:
- push - push
- pull_request - pull_request
# defaults: defaults:
# run: run:
# working-directory: spiffworkflow-frontend working-directory: spiffworkflow-frontend
# https://docs.github.com/en/actions/using-workflows/reusing-workflows # https://docs.github.com/en/actions/using-workflows/reusing-workflows
jobs: jobs:
quickstart-guide-test: tests:
runs-on: ubuntu-latest
steps:
- name: Development Code
uses: actions/checkout@v3
with:
# Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 18.x
- run: npm install
- run: npm run lint
- run: npm test
- run: npm run build --if-present
- name: SonarCloud Scan
# thought about just skipping dependabot
# if: ${{ github.actor != 'dependabot[bot]' }}
# but figured all pull requests seems better, since none of them will have access to sonarcloud.
# however, with just skipping pull requests, the build associated with "Triggered via push" is also associated with the pull request and also fails hitting sonarcloud
# if: ${{ github.event_name != 'pull_request' }}
# so just skip everything but main
if: github.ref_name == 'main'
uses: sonarsource/sonarcloud-github-action@master
with:
projectBaseDir: spiffworkflow-frontend
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
# part about saving PR number and then using it from auto-merge-dependabot-prs from:
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run
- name: Save PR number
if: ${{ github.event_name == 'pull_request' }}
env:
PR_NUMBER: ${{ github.event.number }}
run: |
mkdir -p ./pr
echo "$PR_NUMBER" > ./pr/pr_number
- uses: actions/upload-artifact@v3
with:
name: pr_number
path: pr/
cypress-run:
runs-on: ubuntu-latest runs-on: ubuntu-latest
# needs: [create_frontend_docker_container, create_backend_docker_container, create_demo-proxy]
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Setup Apps - name: Checkout Samples
run: ./bin/run_arena_with_docker_compose uses: actions/checkout@v3
with:
repository: sartography/sample-process-models
path: sample-process-models
- name: start_keycloak
working-directory: ./spiffworkflow-backend
run: ./keycloak/bin/start_keycloak
- name: start_backend
working-directory: ./spiffworkflow-backend
run: ./bin/build_and_run_with_docker_compose
timeout-minutes: 20
env:
SPIFFWORKFLOW_BACKEND_LOAD_FIXTURE_DATA: "true"
SPIFFWORKFLOW_BACKEND_PERMISSIONS_FILE_NAME: "acceptance_tests.yml"
- name: start_frontend
# working-directory: ./spiffworkflow-frontend
run: ./bin/build_and_run_with_docker_compose
- name: wait_for_backend - name: wait_for_backend
working-directory: ./spiffworkflow-backend working-directory: ./spiffworkflow-backend
run: ./bin/wait_for_server_to_be_up 5 8000 run: ./bin/wait_for_server_to_be_up 5
- name: wait_for_frontend - name: wait_for_frontend
working-directory: ./spiffworkflow-frontend # working-directory: ./spiffworkflow-frontend
run: ./bin/wait_for_frontend_to_be_up 5 8001 run: ./bin/wait_for_frontend_to_be_up 5
- name: wait_for_keycloak
working-directory: ./spiffworkflow-backend
run: ./keycloak/bin/wait_for_keycloak 5
- name: Cypress run - name: Cypress run
uses: cypress-io/github-action@v5 uses: cypress-io/github-action@v5
with: with:
working-directory: ./spiffworkflow-frontend working-directory: ./spiffworkflow-frontend
browser: chrome browser: chrome
spec: cypress/e2e/process_groups.cy.js # only record on push, not pull_request, since we do not have secrets for PRs,
# so the required CYPRESS_RECORD_KEY will not be available.
# we have limited runs in cypress cloud, so only record main builds
record: ${{ github.ref_name == 'main' && github.event_name == 'push' }}
env: env:
# pass the Dashboard record key as an environment variable
CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
# pass GitHub token to allow accurately detecting a build vs a re-run build # pass GitHub token to allow accurately detecting a build vs a re-run build
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CYPRESS_SPIFFWORKFLOW_FRONTEND_AUTH_WITH_KEYCLOAK: "false" CYPRESS_SPIFFWORKFLOW_FRONTEND_AUTH_WITH_KEYCLOAK: "true"
CYPRESS_SPIFFWORKFLOW_FRONTEND_USERNAME: "admin" - name: get_backend_logs_from_docker_compose
CYPRESS_SPIFFWORKFLOW_FRONTEND_PASSWORD: "admin" if: failure()
SPIFFWORKFLOW_FRONTEND_PORT: 8001 working-directory: ./spiffworkflow-backend
run: ./bin/get_logs_from_docker_compose >./log/docker_compose.log
- name: Upload logs
if: failure()
uses: "actions/upload-artifact@v3.0.0"
with:
name: spiffworkflow-backend-logs
path: "./spiffworkflow-backend/log/*.log"
# tests: # https://github.com/cypress-io/github-action#artifacts
# runs-on: ubuntu-latest - name: upload_screenshots
# steps: uses: actions/upload-artifact@v2
# - name: Development Code if: failure()
# uses: actions/checkout@v3 with:
# with: name: cypress-screenshots
# # Disabling shallow clone is recommended for improving relevancy of reporting in sonarcloud path: ./spiffworkflow-frontend/cypress/screenshots
# fetch-depth: 0 # Test run video was always captured, so this action uses "always()" condition
# - name: Setup Node - name: upload_videos
# uses: actions/setup-node@v3 uses: actions/upload-artifact@v2
# with: if: failure()
# node-version: 18.x with:
# - run: npm install name: cypress-videos
# - run: npm run lint path: ./spiffworkflow-frontend/cypress/videos
# - run: npm test
# - run: npm run build --if-present
# - name: SonarCloud Scan
# # thought about just skipping dependabot
# # if: ${{ github.actor != 'dependabot[bot]' }}
# # but figured all pull requests seems better, since none of them will have access to sonarcloud.
# # however, with just skipping pull requests, the build associated with "Triggered via push" is also associated with the pull request and also fails hitting sonarcloud
# # if: ${{ github.event_name != 'pull_request' }}
# # so just skip everything but main
# if: github.ref_name == 'main'
# uses: sonarsource/sonarcloud-github-action@master
# with:
# projectBaseDir: spiffworkflow-frontend
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
# # part about saving PR number and then using it from auto-merge-dependabot-prs from:
# # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run
# - name: Save PR number
# if: ${{ github.event_name == 'pull_request' }}
# env:
# PR_NUMBER: ${{ github.event.number }}
# run: |
# mkdir -p ./pr
# echo "$PR_NUMBER" > ./pr/pr_number
# - uses: actions/upload-artifact@v3
# with:
# name: pr_number
# path: pr/
#
# cypress-run:
# runs-on: ubuntu-latest
# steps:
# - name: Checkout
# uses: actions/checkout@v3
# - name: Checkout Samples
# uses: actions/checkout@v3
# with:
# repository: sartography/sample-process-models
# path: sample-process-models
# - name: start_keycloak
# working-directory: ./spiffworkflow-backend
# run: ./keycloak/bin/start_keycloak
# - name: start_backend
# working-directory: ./spiffworkflow-backend
# run: ./bin/build_and_run_with_docker_compose
# timeout-minutes: 20
# env:
# SPIFFWORKFLOW_BACKEND_LOAD_FIXTURE_DATA: "true"
# SPIFFWORKFLOW_BACKEND_PERMISSIONS_FILE_NAME: "acceptance_tests.yml"
# - name: start_frontend
# # working-directory: ./spiffworkflow-frontend
# run: ./bin/build_and_run_with_docker_compose
# - name: wait_for_backend
# working-directory: ./spiffworkflow-backend
# run: ./bin/wait_for_server_to_be_up 5
# - name: wait_for_frontend
# # working-directory: ./spiffworkflow-frontend
# run: ./bin/wait_for_frontend_to_be_up 5
# - name: wait_for_keycloak
# working-directory: ./spiffworkflow-backend
# run: ./keycloak/bin/wait_for_keycloak 5
# - name: Cypress run
# uses: cypress-io/github-action@v5
# with:
# working-directory: ./spiffworkflow-frontend
# browser: chrome
# # only record on push, not pull_request, since we do not have secrets for PRs,
# # so the required CYPRESS_RECORD_KEY will not be available.
# # we have limited runs in cypress cloud, so only record main builds
# record: ${{ github.ref_name == 'main' && github.event_name == 'push' }}
# env:
# # pass the Dashboard record key as an environment variable
# CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
# # pass GitHub token to allow accurately detecting a build vs a re-run build
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# CYPRESS_SPIFFWORKFLOW_FRONTEND_AUTH_WITH_KEYCLOAK: "true"
# - name: get_backend_logs_from_docker_compose
# if: failure()
# working-directory: ./spiffworkflow-backend
# run: ./bin/get_logs_from_docker_compose >./log/docker_compose.log
# - name: Upload logs
# if: failure()
# uses: "actions/upload-artifact@v3.0.0"
# with:
# name: spiffworkflow-backend-logs
# path: "./spiffworkflow-backend/log/*.log"
#
# # https://github.com/cypress-io/github-action#artifacts
# - name: upload_screenshots
# uses: actions/upload-artifact@v2
# if: failure()
# with:
# name: cypress-screenshots
# path: ./spiffworkflow-frontend/cypress/screenshots
# # Test run video was always captured, so this action uses "always()" condition
# - name: upload_videos
# uses: actions/upload-artifact@v2
# if: failure()
# with:
# name: cypress-videos
# path: ./spiffworkflow-frontend/cypress/videos

View File

@ -115,3 +115,32 @@ jobs:
push: true push: true
tags: ${{ steps.meta.outputs.tags }} tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }} labels: ${{ steps.meta.outputs.labels }}
quickstart-guide-test:
runs-on: ubuntu-latest
needs: [create_frontend_docker_container, create_backend_docker_container, create_demo-proxy]
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Apps
run: ./bin/run_arena_with_docker_compose
- name: wait_for_backend
working-directory: ./spiffworkflow-backend
run: ./bin/wait_for_server_to_be_up 5 8000
- name: wait_for_frontend
working-directory: ./spiffworkflow-frontend
run: ./bin/wait_for_frontend_to_be_up 5 8001
- name: Cypress run
uses: cypress-io/github-action@v5
with:
working-directory: ./spiffworkflow-frontend
browser: chrome
# just run one test to make sure we didn't completely break it
spec: cypress/e2e/process_groups.cy.js
env:
# pass GitHub token to allow accurately detecting a build vs a re-run build
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CYPRESS_SPIFFWORKFLOW_FRONTEND_AUTH_WITH_KEYCLOAK: "false"
CYPRESS_SPIFFWORKFLOW_FRONTEND_USERNAME: "admin"
CYPRESS_SPIFFWORKFLOW_FRONTEND_PASSWORD: "admin"
SPIFFWORKFLOW_FRONTEND_PORT: 8001