Feat/storybook tests

.envrc.example

@@ -0,0 +1,54 @@
+# vim: set ft=bash
+# This file is a template for the environment variables that need to be set and
+# should be copied to `.envrc` and filled in with the correct values.
+
+# target environment: dev, test, staging or beta
+export ENVIRONMENT=<ENVIRONMENT>
+# target AWS profile
+export AWS_PROFILE=<AWS_PROFILE>
+# the codename of the Cardano Network
+export CARDANO_NETWORK=<CARDANO_NETWORK>
+# credentials to the PostgreSQL database used by Cardano DB Sync
+export DBSYNC_POSTGRES_USER=<DBSYNC_POSTGRES_USER>
+export DBSYNC_POSTGRES_PASSWORD=<DBSYNC_POSTGRES_PASSWORD>
+export DBSYNC_POSTGRES_DB=<DBSYNC_POSTGRES_DB>
+# the Let's Encrypt email address
+export TRAEFIK_LE_EMAIL=<TRAEFIK_LE_EMAIL>
+# Google Tag Manager ID
+export GTM_ID=<GTM_ID>
+# Sentry DSN for the backend
+export SENTRY_DSN_BACKEND=<SENTRY_DSN_BACKEND>
+# Sentry DSN for the frontend
+export SENTRY_DSN=<SENTRY_DSN>
+# Sentry environment
+export SENTRY_ENVIRONMENT=<SENTRY_ENVIRONMENT>
+# the password for the Grafana admin user
+export GRAFANA_ADMIN_PASSWORD=<GRAFANA_ADMIN_PASSWORD>
+# the Slack channel to send Grafana alerts to
+export GRAFANA_SLACK_RECIPIENT=<GRAFANA_SLACK_RECIPIENT>
+# the OAuth token for the Slack bot
+export GRAFANA_SLACK_OAUTH_TOKEN=<GRAFANA_SLACK_OAUTH_TOKEN>
+# the basic auth credentials for the Nginx proxy
+export NGINX_BASIC_AUTH=<NGINX_BASIC_AUTH>
+# the IP addresses that bypass the basic auth
+export IP_ADDRESS_BYPASSING_BASIC_AUTH1=<IP_ADDRESS_BYPASSING_BASIC_AUTH1>
+export IP_ADDRESS_BYPASSING_BASIC_AUTH2=<IP_ADDRESS_BYPASSING_BASIC_AUTH2>
+
+# the domain name for the target environment
+case "$ENVIRONMENT" in
+  "dev")
+    export DOMAIN="dev-${CARDANO_NETWORK}.govtool.byron.network"
+    ;;
+  "test")
+    export DOMAIN="test-${CARDANO_NETWORK}.govtool.byron.network"
+    ;;
+  "staging")
+    export DOMAIN="staging.govtool.byron.network"
+    ;;
+  "beta")
+    export DOMAIN="sanchogov.tools"
+    ;;
+  *)
+    exit 1
+    ;;
+esac

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,4 +22,4 @@ assignees: ''
 <!-- A description of the (reproducible) outcome. -->
 
 ## Expected behavior
-<!-- A description of what you expect to happen instead. -->
+<!-- A description of what you expect to happen instead. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -10,4 +10,4 @@ contact_links:
 
   - name: All issues
     url: https://github.com/IntersectMBO/govtool/issues
-    about: Check whether your issue is not already covered here.
+    about: Check whether your issue is not already covered here.

.github/ISSUE_TEMPLATE/feature_idea.yml

@@ -41,4 +41,4 @@ body:
         Which technical solutions, libraries or systems should be used, which
         components need to change, steps how to implement this, ...
     validations:
-      required: true
+      required: true

.github/vva-be-config.json → .github/backend-config.json

@@ -8,7 +8,7 @@
   },
   "fakedbsyncconfig" : {
       "host"     : "localhost",
-      "dbname"   : "vva",
+      "dbname"   : "govtool",
       "user"     : "postgres",
       "password" : "MTnk8lsuMM41RgAh1y2WTAUdObsb",
       "port"     : 5432

.github/dbsync-schema.sql

@@ -987,4 +987,3 @@ FROM tx_out
          LEFT JOIN block ON tx.block_id = block.id
 WHERE tx_in.tx_in_id IS NULL
   AND block.epoch_no IS NOT NULL;
-

.github/workflows/build-and-deploy-beta.yml

@@ -0,0 +1,71 @@
+name: Build and deploy GovTool to BETA server
+run-name: Deploy by @${{ github.actor }}
+
+# That should be executed on create: tag event
+on:
+  workflow_dispatch:
+
+env:
+  ENVIRONMENT: "beta"
+  CARDANO_NETWORK: "sanchonet"
+  DOMAIN: "sanchogov.tools"
+
+jobs:
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./scripts/govtool
+    env:
+      DBSYNC_POSTGRES_DB: "cexplorer"
+      DBSYNC_POSTGRES_PASSWORD: "pSa8JCpQOACMUdGb"
+      DBSYNC_POSTGRES_USER: "postgres"
+      GA_CLIENT_EMAIL: ${{ secrets.GA_CLIENT_EMAIL }}
+      GA_PRIVATE_KEY: ${{ secrets.GA_PRIVATE_KEY }}
+      GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
+      GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
+      GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
+      GTM_ID: ${{ secrets.GTM_ID }}
+      NPMRC_TOKEN: ${{ secrets.NPMRC_TOKEN }}
+      IP_ADDRESS_BYPASSING_BASIC_AUTH1: ${{ secrets.IP_ADDRESS_BYPASSING_BASIC_AUTH1 }}
+      IP_ADDRESS_BYPASSING_BASIC_AUTH2: ${{ secrets.IP_ADDRESS_BYPASSING_BASIC_AUTH2 }}
+      NEXT_PUBLIC_API_URL: "https://participation.sanchogov.tools"
+      NEXT_PUBLIC_GA4_PROPERTY_ID: ${{ secrets.NEXT_PUBLIC_GA4_PROPERTY_ID }}
+      PIPELINE_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN_FRONTEND }}
+      SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
+      SENTRY_IGNORE_API_RESOLUTION_ERROR: "1"
+      TRAEFIK_LE_EMAIL: "admin+govtool@binarapps.com"
+      USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v3
+        with:
+          aws-access-key-id: ${{ secrets.GHA_AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.GHA_AWS_SECRET_ACCESS_KEY }}
+          aws-region: eu-west-1
+
+      - name: Login to AWS ECR
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-region: eu-west-1
+
+      - name: Setup SSH agent
+        uses: webfactory/ssh-agent@v0.8.0
+        with:
+          ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
+
+      - name: Deploy app
+        run: |
+          make --debug=b all
+
+      - name: Reprovision Grafana
+        run: |
+          sleep 30 # give grafana time to start up
+          make --debug=b reload-grafana

.github/workflows/build-and-deploy-dev.yml

@@ -0,0 +1,81 @@
+name: Build and deploy GovTool to DEV server
+run-name: Deploy by @${{ github.actor }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      isProposalDiscussionForumEnabled:
+        description: "Enable proposal discussion forum"
+        required: true
+        type: choice
+        default: "disabled"
+        options:
+          - "enabled"
+          - "disabled"
+
+env:
+  ENVIRONMENT: "dev"
+  CARDANO_NETWORK: "sanchonet"
+  DOMAIN: "dev-sanchonet.govtool.byron.network"
+
+jobs:
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./scripts/govtool
+    env:
+      DBSYNC_POSTGRES_DB: "cexplorer"
+      DBSYNC_POSTGRES_PASSWORD: "pSa8JCpQOACMUdGb"
+      DBSYNC_POSTGRES_USER: "postgres"
+      GA_CLIENT_EMAIL: ${{ secrets.GA_CLIENT_EMAIL }}
+      GA_PRIVATE_KEY: ${{ secrets.GA_PRIVATE_KEY }}
+      GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
+      GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
+      GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
+      GTM_ID: ${{ secrets.GTM_ID }}
+      NPMRC_TOKEN: ${{ secrets.NPMRC_TOKEN }}
+      IP_ADDRESS_BYPASSING_BASIC_AUTH1: ${{ secrets.IP_ADDRESS_BYPASSING_BASIC_AUTH1 }}
+      IP_ADDRESS_BYPASSING_BASIC_AUTH2: ${{ secrets.IP_ADDRESS_BYPASSING_BASIC_AUTH2 }}
+      NEXT_PUBLIC_API_URL: "https://participation.sanchogov.tools"
+      NEXT_PUBLIC_GA4_PROPERTY_ID: ${{ secrets.NEXT_PUBLIC_GA4_PROPERTY_ID }}
+      DEV_NGINX_BASIC_AUTH: ${{ secrets.DEV_NGINX_BASIC_AUTH }}
+      PIPELINE_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN_FRONTEND }}
+      SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
+      SENTRY_IGNORE_API_RESOLUTION_ERROR: "1"
+      TRAEFIK_LE_EMAIL: "admin+govtool@binarapps.com"
+      USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
+      IS_PROPOSAL_DISCUSSION_FORUM_ENABLED: ${{ inputs.isProposalDiscussionForumEnabled == 'enabled' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v3
+        with:
+          aws-access-key-id: ${{ secrets.GHA_AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.GHA_AWS_SECRET_ACCESS_KEY }}
+          aws-region: eu-west-1
+
+      - name: Login to AWS ECR
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-region: eu-west-1
+
+      - name: Setup SSH agent
+        uses: webfactory/ssh-agent@v0.8.0
+        with:
+          ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
+
+      - name: Deploy app
+        run: |
+          make --debug=b all
+
+      - name: Reprovision Grafana
+        run: |
+          sleep 30 # give grafana time to start up
+          make --debug=b reload-grafana

.github/workflows/build-and-deploy-staging.yml

@@ -0,0 +1,73 @@
+name: Build and deploy GovTool to STAGING server
+run-name: Deploy by @${{ github.actor }}
+
+on:
+  push:
+    branches:
+      - staging
+
+env:
+  ENVIRONMENT: "staging"
+  CARDANO_NETWORK: "sanchonet"
+  DOMAIN: "staging.govtool.byron.network"
+
+jobs:
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./scripts/govtool
+    env:
+      DBSYNC_POSTGRES_DB: "cexplorer"
+      DBSYNC_POSTGRES_PASSWORD: "pSa8JCpQOACMUdGb"
+      DBSYNC_POSTGRES_USER: "postgres"
+      GA_CLIENT_EMAIL: ${{ secrets.GA_CLIENT_EMAIL }}
+      GA_PRIVATE_KEY: ${{ secrets.GA_PRIVATE_KEY }}
+      GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
+      GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
+      GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
+      GTM_ID: ${{ secrets.GTM_ID }}
+      NPMRC_TOKEN: ${{ secrets.NPMRC_TOKEN }}
+      IP_ADDRESS_BYPASSING_BASIC_AUTH1: ${{ secrets.IP_ADDRESS_BYPASSING_BASIC_AUTH1 }}
+      IP_ADDRESS_BYPASSING_BASIC_AUTH2: ${{ secrets.IP_ADDRESS_BYPASSING_BASIC_AUTH2 }}
+      NEXT_PUBLIC_API_URL: "https://participation.sanchogov.tools"
+      NEXT_PUBLIC_GA4_PROPERTY_ID: ${{ secrets.NEXT_PUBLIC_GA4_PROPERTY_ID }}
+      STAGING_NGINX_BASIC_AUTH: ${{ secrets.STAGING_NGINX_BASIC_AUTH }}
+      PIPELINE_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN_FRONTEND }}
+      SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
+      SENTRY_IGNORE_API_RESOLUTION_ERROR: "1"
+      TRAEFIK_LE_EMAIL: "admin+govtool@binarapps.com"
+      USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v3
+        with:
+          aws-access-key-id: ${{ secrets.GHA_AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.GHA_AWS_SECRET_ACCESS_KEY }}
+          aws-region: eu-west-1
+
+      - name: Login to AWS ECR
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-region: eu-west-1
+
+      - name: Setup SSH agent
+        uses: webfactory/ssh-agent@v0.8.0
+        with:
+          ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
+
+      - name: Deploy app
+        run: |
+          make --debug=b all
+
+      - name: Reprovision Grafana
+        run: |
+          sleep 30 # give grafana time to start up
+          make --debug=b reload-grafana

.github/workflows/build-and-deploy-test-stack.yml

@@ -0,0 +1,50 @@
+name: Build and deploy GovTool test stack
+run-name: Deploy by @${{ github.actor }}
+
+on:
+  push:
+    branches:
+      - test
+
+env:
+  ENVIRONMENT: "test"
+  CARDANO_NETWORK: "sanchonet"
+
+jobs:
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    env:
+      GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
+      GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
+      GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
+      SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
+      GTM_ID: ${{ secrets.GTM_ID }}
+      NPMRC_TOKEN: ${{ secrets.NPMRC_TOKEN }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN_FRONTEND }}
+      PIPELINE_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+      USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup SSH agent
+        uses: webfactory/ssh-agent@v0.8.0
+        with:
+          ssh-private-key: ${{ secrets.TEST_STACK_SSH_KEY }}
+
+      - name: Run Ansible playbook
+        uses: dawidd6/action-ansible-playbook@v2
+        with:
+          playbook: playbook.yml
+          directory: ./tests/test-infrastructure
+          key: ${{ secrets.TEST_STACK_SSH_KEY }}
+          inventory: |
+            [test_server]
+            ${{ secrets.TEST_STACK_SERVER_IP }} ansible_user=ec2-user
+          options: |
+            --verbose
+        env:
+          GOVTOOL_TAG: ${{ github.sha }}