feat: digital credential queuing service

.devcontainer/devcontainer.json

@@ -9,23 +9,21 @@
  "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
  "ghcr.io/itsmechlark/features/postgresql:1": {}
  },
-
  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},
-
  // Use 'forwardPorts' to make a list of ports inside the container available locally.
  // This can be used to network with other containers or the host.
- // "forwardPorts": [5000, 5432],
-
+ "forwardPorts": [
+ 5432,
+ 4222,
+ 8222
+ ],
  // Use 'postCreateCommand' to run commands after the container is created.
  // "postCreateCommand": "pip install --user -r requirements.txt",
-
  // Configure tool-specific properties.
  // "customizations": {},
-
  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
  // "remoteUser": "root",
-
  // Enable this on OSX to add ssh key to agent inside container
  "initializeCommand": "find ~/.ssh/ -type f -exec grep -l 'PRIVATE' {} \\; | xargs ssh-add"
-}
+}

.devcontainer/docker-compose.yml

@@ -13,7 +13,7 @@ services:
  command: sleep infinity
 
  # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
- network_mode: service:db
+ network_mode: host
 
  # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
  # (Adding the "ports" property to this file will not forward from a Codespace.)
@@ -30,6 +30,15 @@ services:
 
  # Add "forwardPorts": ["5432"] to **devcontainer.json** to forward PostgreSQL locally.
  # (Adding the "ports" property to this file will not forward from a Codespace.)
+ network_mode: host
+
+ nats:
+ image: nats-streaming
+ restart: unless-stopped
+ ports:
+ - 4222:4222
+ - 8222:8222
+ network_mode: host
 
 volumes:
  postgres-data:

.github/workflows/entity-digital-credentials-cd.yml

@@ -0,0 +1,114 @@
+name: Entity Digital Credentials CD
+
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - "queue_services/entity-digital-credentials/**"
+ - "queue_services/common/**"
+ workflow_dispatch:
+ inputs:
+ environment:
+ description: "Environment (dev/test/prod)"
+ required: true
+ default: "dev"
+
+defaults:
+ run:
+ shell: bash
+ working-directory: ./queue_services/entity-digital-credentials
+
+env:
+ APP_NAME: "entity-digital-credentials"
+ TAG_NAME: "dev"
+
+jobs:
+ entity-digital-credentials-cd-by-push:
+ runs-on: ubuntu-20.04
+
+ if: github.event_name == 'push' && github.repository == 'bcgov/lear'
+ environment:
+ name: "dev"
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Login Openshift
+ shell: bash
+ run: |
+ oc login --server=${{secrets.OPENSHIFT4_LOGIN_REGISTRY}} --token=${{secrets.OPENSHIFT4_SA_TOKEN}}
+
+ - name: CD Flow
+ shell: bash
+ env:
+ OPS_REPOSITORY: ${{ secrets.OPS_REPOSITORY }}
+ OPENSHIFT_DOCKER_REGISTRY: ${{ secrets.OPENSHIFT4_DOCKER_REGISTRY }}
+ OPENSHIFT_SA_NAME: ${{ secrets.OPENSHIFT4_SA_NAME }}
+ OPENSHIFT_SA_TOKEN: ${{ secrets.OPENSHIFT4_SA_TOKEN }}
+ OPENSHIFT_REPOSITORY: ${{ secrets.OPENSHIFT4_REPOSITORY }}
+ TAG_NAME: ${{ env.TAG_NAME }}
+ run: |
+ make cd
+
+ - name: Watch new rollout (trigger by image change in Openshift)
+ shell: bash
+ run: |
+ oc rollout status dc/${{ env.APP_NAME }}-${{ env.TAG_NAME }} -n ${{ secrets.OPENSHIFT4_REPOSITORY }}-${{ env.TAG_NAME }} -w
+
+ - name: Rocket.Chat Notification
+ uses: RocketChat/Rocket.Chat.GitHub.Action.Notification@master
+ if: failure()
+ with:
+ type: ${{ job.status }}
+ job_name: "*Entity Digital Credentials Built and Deployed to ${{env.TAG_NAME}}*"
+ channel: "#registries-bot"
+ url: ${{ secrets.ROCKETCHAT_WEBHOOK }}
+ commit: true
+ token: ${{ secrets.GITHUB_TOKEN }}
+
+ entity-digital-credentials-cd-by-dispatch:
+ runs-on: ubuntu-20.04
+
+ if: github.event_name == 'workflow_dispatch' && github.repository == 'bcgov/lear'
+ environment:
+ name: "${{ github.event.inputs.environment }}"
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set env by input
+ run: |
+ echo "TAG_NAME=${{ github.event.inputs.environment }}" >> $GITHUB_ENV
+
+ - name: Login Openshift
+ shell: bash
+ run: |
+ oc login --server=${{secrets.OPENSHIFT4_LOGIN_REGISTRY}} --token=${{secrets.OPENSHIFT4_SA_TOKEN}}
+
+ - name: CD Flow
+ shell: bash
+ env:
+ OPS_REPOSITORY: ${{ secrets.OPS_REPOSITORY }}
+ OPENSHIFT_DOCKER_REGISTRY: ${{ secrets.OPENSHIFT4_DOCKER_REGISTRY }}
+ OPENSHIFT_SA_NAME: ${{ secrets.OPENSHIFT4_SA_NAME }}
+ OPENSHIFT_SA_TOKEN: ${{ secrets.OPENSHIFT4_SA_TOKEN }}
+ OPENSHIFT_REPOSITORY: ${{ secrets.OPENSHIFT4_REPOSITORY }}
+ TAG_NAME: ${{ env.TAG_NAME }}
+ run: |
+ make cd
+
+ - name: Watch new rollout (trigger by image change in Openshift)
+ shell: bash
+ run: |
+ oc rollout status dc/${{ env.APP_NAME }}-${{ env.TAG_NAME }} -n ${{ secrets.OPENSHIFT4_REPOSITORY }}-${{ env.TAG_NAME }} -w
+
+ - name: Rocket.Chat Notification
+ uses: RocketChat/Rocket.Chat.GitHub.Action.Notification@master
+ if: failure()
+ with:
+ type: ${{ job.status }}
+ job_name: "*Entity Digital Credentials Built and Deployed to ${{env.TAG_NAME}}*"
+ channel: "#registries-bot"
+ url: ${{ secrets.ROCKETCHAT_WEBHOOK }}
+ commit: true
+ token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/entity-digital-credentials-ci.yml

@@ -0,0 +1,110 @@
+name: Entity Digital Credentials CI
+
+on:
+ pull_request:
+ types: [assigned, synchronize]
+ paths:
+ - "queue_services/entity-digital-credentials/**"
+ - "queue_services/common/**"
+
+defaults:
+ run:
+ shell: bash
+ working-directory: ./queue_services/entity-digital-credentials
+
+jobs:
+ setup-job:
+ runs-on: ubuntu-20.04
+
+ if: github.repository == 'bcgov/lear'
+
+ steps:
+ - uses: actions/checkout@v3
+ - run: "true"
+
+ linting:
+ needs: setup-job
+ runs-on: ubuntu-20.04
+
+ strategy:
+ matrix:
+ python-version: [3.8]
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v1
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: Install dependencies
+ run: |
+ make setup
+ - name: Lint with pylint
+ id: pylint
+ run: |
+ make pylint
+ - name: Lint with flake8
+ id: flake8
+ run: |
+ make flake8
+
+ testing:
+ needs: setup-job
+ env:
+ DATABASE_TEST_USERNAME: postgres
+ DATABASE_TEST_PASSWORD: postgres
+ DATABASE_TEST_NAME: postgres
+ DATABASE_TEST_HOST: localhost
+ NATS_SERVERS: "nats://nats:4222"
+ NATS_CLIENT_NAME: entity.digital-credentials.tester
+ NATS_CLUSTER_ID: test-cluster
+ NATS_ENTITY_EVENT_SUBJECT: entity.events
+ NATS_QUEUE: entity-digital-credentials-worker
+ TEST_NATS_DOCKER: True
+ STAN_CLUSTER_NAME: test-cluster
+
+ runs-on: ubuntu-20.04
+
+ services:
+ postgres:
+ image: postgres:12
+ env:
+ POSTGRES_USER: postgres
+ POSTGRES_PASSWORD: postgres
+ POSTGRES_DB: postgres
+ ports:
+ - 5432:5432
+ # needed because the postgres container does not provide a healthcheck
+ options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v1
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: Install dependencies
+ run: |
+ make setup
+ - name: Test with pytest
+ id: test
+ run: |
+ make test
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@v3
+ with:
+ file: ./queue_services/entity-digital-credentials/coverage.xml
+ flags: entity-digital-credentials
+ name: codecov-entity-digital-credentials
+ fail_ci_if_error: true
+
+ build-check:
+ needs: setup-job
+ runs-on: ubuntu-20.04
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: build to check strictness
+ id: build
+ run: |
+ make build-nc

queue_services/entity-digital-credentials/.env.sample

@@ -0,0 +1,39 @@
+
+# Flask
+FLASK_ENV=
+
+
+### SQL Alchemy
+ENTITY_DATABASE_USERNAME=
+ENTITY_DATABASE_PASSWORD=
+ENTITY_DATABASE_NAME=
+ENTITY_DATABASE_HOST=
+ENTITY_DATABASE_PORT=
+
+DATABASE_TEST_USERNAME=
+DATABASE_TEST_PASSWORD=
+DATABASE_TEST_NAME=
+DATABASE_TEST_HOST=
+DATABASE_TEST_PORT=
+
+
+## ## NATS - STAN
+NATS_SERVERS=
+NATS_CLIENT_NAME=
+NATS_CLUSTER_ID=
+NATS_EMAILER_SUBJECT=
+NATS_ENTITY_EVENT_SUBJECT=
+#NATS_QUEUE=
+NATS_QUEUE=
+STAN_CLUSTER_NAME=
+
+# ## NATS - STAN - DEV
+#NATS_SERVERS=
+#NATS_CLIENT_NAME=
+#NATS_CLUSTER_ID=
+#NATS_EMAILER_SUBJECT=
+#NATS_ENTITY_EVENT_SUBJECT=
+#NATS_QUEUE=
+
+
+#DEPLOYMENT_ENV=

queue_services/entity-digital-credentials/.envrc

@@ -0,0 +1,6 @@
+while read -r line; do
+ echo $line
+ [[ "$line" =~ ^#.*$ ]] && continue
+ export $line
+done < .env
+source venv/bin/activate

queue_services/entity-digital-credentials/LICENSE

@@ -0,0 +1,13 @@
+Copyright © 2023 Province of British Columbia
+
+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.