Merge pull request #460 from IntersectMBO/test

staging: #351, #350, #320, #223, #317, #385, #358, #359, #151, #358, #360, #110, #379, #382, #361, #362, #446, #188, #377, #432, #364, #451, #433
IntersectMBO · Mar 19, 2024 · fa67064 · fa67064
1 parent d960a99
commit fa67064
Show file tree

Hide file tree

Showing 132 changed files with 4,778 additions and 7,137 deletions.
diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml
@@ -19,10 +19,6 @@ on:
           - "test"
           - "staging"
           - "beta"
-      skip_build:
-        required: true
-        type: boolean
-        default: false
       resync_cardano_node_and_db:
         required: true
         type: boolean
@@ -33,82 +29,8 @@ env:
   CARDANO_NETWORK: ${{ inputs.cardano_network || 'sanchonet' }}
 
 jobs:
-  check_environment_exists:
-    name: Check if target environment exists before proceeding
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./scripts/govtool
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: Check environment exists
-        run: |
-          make check-env-defined
-  build_backend:
-    name: Build and push backend Docker image
-    if: ${{ ! inputs.skip_build }}
-    needs:
-      - check_environment_exists
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./scripts/govtool
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - 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: Build and push images
-        run: |
-          make docker-login
-          make build-backend
-          make push-backend
-  build_frontend:
-    name: Build and push frontend Docker image
-    if: ${{ ! inputs.skip_build }}
-    needs:
-      - check_environment_exists
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./scripts/govtool
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - 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: Build and push images
-        env:
-          GTM_ID: ${{ secrets.GTM_ID }}
-          SENTRY_DSN: ${{ secrets.SENTRY_DSN_FRONTEND }}
-        run: |
-          make docker-login
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make build-frontend
-          make push-frontend
   deploy:
     name: Deploy app
-    needs:
-      - build_backend
-      - build_frontend
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -117,136 +39,58 @@ jobs:
       DBSYNC_POSTGRES_DB: "cexplorer"
       DBSYNC_POSTGRES_USER: "postgres"
       DBSYNC_POSTGRES_PASSWORD: "pSa8JCpQOACMUdGb"
-      FAKEDBSYNC_POSTGRES_DB: "govtool"
-      FAKEDBSYNC_POSTGRES_USER: "test"
-      FAKEDBSYNC_POSTGRES_PASSWORD: "test"
       GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
       GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
       GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
       NGINX_BASIC_AUTH: ${{ secrets.NGINX_BASIC_AUTH }}
       SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
       TRAEFIK_LE_EMAIL: "[email protected]"
+      GTM_ID: ${{ secrets.GTM_ID }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN_FRONTEND }}
+      PIPELINE_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - 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/[email protected]
         with:
-          ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
-      - name: Prepare and upload app config
-        run: |
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          export DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}
-          make prepare-config
-          make upload-config
-      - name: Destroy Cardano Node, DB sync and Postgres if required
-        if: ${{ inputs.resync_cardano_node_and_db }}
-        run: |
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make destroy-cardano-node-and-dbsync;
-      - name: Deploy app
-        run: |
-          make docker-login
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make deploy-stack
-      - name: Reprovision Grafana
-        run: |
-          sleep 30 # give grafana time to start up
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}
-          curl -X POST -u "admin:$GRAFANA_ADMIN_PASSWORD" https://$DOMAIN/grafana/api/admin/provisioning/alerting/reload
-          curl -X POST -u "admin:$GRAFANA_ADMIN_PASSWORD" https://$DOMAIN/grafana/api/admin/provisioning/dashboards/reload
-          curl -X POST -u "admin:$GRAFANA_ADMIN_PASSWORD" https://$DOMAIN/grafana/api/admin/provisioning/notifications/reload
-      - name: Notify on Slack
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.DEPLOY_NOTIFY_SLACK_WEBHOOK_URL }}
-        run: |
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make notify
-  deploy_without_build:
-    name: Deploy app without building
-    if: ${{ inputs.skip_build }}
-    needs:
-      - check_environment_exists
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./scripts/govtool
-    env:
-      DBSYNC_POSTGRES_DB: "cexplorer"
-      DBSYNC_POSTGRES_USER: "postgres"
-      DBSYNC_POSTGRES_PASSWORD: "pSa8JCpQOACMUdGb"
-      FAKEDBSYNC_POSTGRES_DB: "govtool"
-      FAKEDBSYNC_POSTGRES_USER: "test"
-      FAKEDBSYNC_POSTGRES_PASSWORD: "test"
-      GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
-      GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
-      GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
-      NGINX_BASIC_AUTH: ${{ secrets.NGINX_BASIC_AUTH }}
-      SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
-      TRAEFIK_LE_EMAIL: "[email protected]"
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
+          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/[email protected]
         with:
           ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
-      - name: Prepare and upload app config
+
+      - name: Set domain
         run: |
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          export DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}
-          make prepare-config
-          make upload-config
+          if [[ "${{ inputs.environment }}" == "staging" ]]; then
+            echo "DOMAIN=staging.govtool.byron.network" >> $GITHUB_ENV
+          elif [[ "${{ inputs.environment }}" == "beta" ]]; then
+            echo "DOMAIN=sanchogov.tools" >> $GITHUB_ENV
+          else
+            echo "DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}" >> $GITHUB_ENV
+          fi
+
       - name: Destroy Cardano Node, DB sync and Postgres if required
         if: ${{ inputs.resync_cardano_node_and_db }}
         run: |
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make destroy-cardano-node-and-dbsync;
+          make --debug=b destroy-cardano-node-and-dbsync
+
       - name: Deploy app
         run: |
-          make docker-login
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make deploy-stack
+          make --debug=b all
+
       - name: Reprovision Grafana
         run: |
           sleep 30 # give grafana time to start up
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}
-          curl -X POST -u "admin:$GRAFANA_ADMIN_PASSWORD" https://$DOMAIN/grafana/api/admin/provisioning/alerting/reload
-          curl -X POST -u "admin:$GRAFANA_ADMIN_PASSWORD" https://$DOMAIN/grafana/api/admin/provisioning/dashboards/reload
-          curl -X POST -u "admin:$GRAFANA_ADMIN_PASSWORD" https://$DOMAIN/grafana/api/admin/provisioning/notifications/reload
-      - name: Notify on Slack
-        run: |
-          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
-          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
-          make notify
+          make --debug=b reload-grafana
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,17 +9,27 @@ As a minor extension, we also keep a semantic version for the `UNRELEASED`
 changes.
 
 ## [Unreleased]
-- Change step 3 components [Issue 152](https://github.com/intersectMBO/govtool/issues/152)
-- Add possibility to vote on behalf of myself - Sole Voter [Issue 119](https://github.com/IntersectMBO/govtool/issues/119)
+- Add generate jsonld function [Issue 451](https://github.com/IntersectMBO/govtool/issues/451)
+- Create GA review subbmision page [Issue 362](https://github.com/IntersectMBO/govtool/issues/362)
+- Create GA creation form [Issue 360](https://github.com/IntersectMBO/govtool/issues/360)
+- Create TextArea [Issue 110](https://github.com/IntersectMBO/govtool/issues/110)
+- Choose GA type - GA Submiter [Issue 358](https://github.com/IntersectMBO/govtool/issues/358)
+
+- Add on-chain inputs validation [Issue 377](https://github.com/IntersectMBO/govtool/issues/377)
+
+### Added
+
+- Added `isRegisteredAsSoleVoter` and `wasRegisteredAsSoleVoter` fields to the drep/info response [Issue 212](https://github.com/IntersectMBO/govtool/issues/212)
+- Abandoning registration as DRep [Issue 151](https://github.com/IntersectMBO/govtool/issues/151)
+- Abandoning GA creation [Issue 359](https://github.com/IntersectMBO/govtool/issues/359)
 - Create DRep registration page about roles [Issue 205](https://github.com/IntersectMBO/govtool/issues/205)
 - Create Checkbox component. Improve Field and ControlledField [Issue 177](https://github.com/IntersectMBO/govtool/pull/177)
 - Vitest unit tests added for utils functions [Issue 81](https://github.com/IntersectMBO/govtool/issues/81)
 - i18next library added to FE [Issue 80](https://github.com/IntersectMBO/govtool/issues/80)
-
-### Added
-- Added `isRegisteredAsSoleVoter` and `wasRegisteredAsSoleVoter` fields to the drep/info response [Issue 212](https://github.com/IntersectMBO/govtool/issues/212)
+- Add possibility to vote on behalf of myself - Sole Voter [Issue 119](https://github.com/IntersectMBO/govtool/issues/119)
 
 ### Fixed
+
 - Fix drep type detection when changing metadata [Issue 333](https://github.com/IntersectMBO/govtool/issues/333)
 - Fix make button disble when wallet tries connect [Issue 265](https://github.com/IntersectMBO/govtool/issues/265)
 - Fix drep voting power calculation [Issue 231](https://github.com/IntersectMBO/govtool/issues/231)
@@ -34,6 +44,9 @@ changes.
 - Fixed CSP settings to allow error reports with Sentry [Issue 291](https://github.com/IntersectMBO/govtool/issues/291).
 
 ### Changed
+- `drep/list` now return also `status` and `type` fields. Also it now returns the retired dreps, and you can search for given drep by name using optional query parameter. If the drep name is passed exactly, then you can even find a drep that's sole voter. [Issue 446](https://github.com/IntersectMBO/govtool/issues/446)
+- `drep/list` and `drep/info` endpoints now return additional data such as metadata url and hash, and voting power [Issue 223](https://github.com/IntersectMBO/govtool/issues/223)
+- `drep/info` now does not return sole voters (dreps without metadata) [Issue 317](https://github.com/IntersectMBO/govtool/issues/317)
 - `isRegistered` and `wasRegistered` fields in the drep/info endpoint changed to `isRegisteredAsDRep` and `wasRegisteredAsDRep` respectively [Issue 212](https://github.com/IntersectMBO/govtool/issues/212)
 - Update Cardano-Serialization-Lib to 12.0.0-alpha.16 [Issue 156](https://github.com/IntersectMBO/govtool/issues/156)
 - Changed and improved working conventions docs, PR template and codeowners file, addressing [Issue 88](https://github.com/IntersectMBO/govtool/issues/88).
@@ -44,8 +57,12 @@ changes.
 - Adjusted Nix configuration to meet projects needs [Issue 187](https://github.com/IntersectMBO/govtool/issues/187).
 - Integrated OAuth to securely notify about deployment status in Slack [Issue 194](https://github.com/IntersectMBO/govtool/issues/194).
 - Streamlined the application build and deployment process, thereby accelerating continuous delivery (CD) and reducing the resource burden [Issue 246](https://github.com/IntersectMBO/govtool/issues/246).
+- Applied unified policy on Docker images tagging [Issue 320](https://github.com/IntersectMBO/govtool/issues/320).
+- Reorganised deployment Makefiles in order to better document the process and easier management [Issue 385](https://github.com/IntersectMBO/govtool/issues/385).
+- Added a grafana panel to track all the deploys on the target machines [Issue 361](https://github.com/IntersectMBO/govtool/issues/361).
 
 ### Removed
+
 -
 
 ## [sancho-v1.0.0](https://github.com/IntersectMBO/govtool/releases/tag/sancho-v1.0.0) 2023-12-17

diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ Learn more; [docs.sanchogov.tools](https://docs.sanchogov.tools/).
 ## 📍 Navigation
 - [GovTool Backend](./govtool/backend/README.md)
 - [GovTool Frontend](./govtool/frontend/README.md)
+- [GovTool deployment setup](./scripts/govtool/README.md)
 - [Documentation](./docs/)
 - [Tests](./tests/)
 

diff --git a/govtool/backend/Makefile b/govtool/backend/Makefile
@@ -0,0 +1,31 @@
+common_mk := ../../scripts/govtool/common.mk
+ifeq ($(origin $(common_mk)), undefined)
+  $(eval $(common_mk) := included)
+  include $(common_mk)
+endif
+
+.DEFAULT_GOAL := push-backend
+
+# image tags
+base_backend_image_tag := $(shell git hash-object $(root_dir)/govtool/backend/vva-be.cabal)
+backend_image_tag := $(shell git log -n 1 --format="%H" -- $(root_dir)/govtool/backend)
+
+.PHONY: build-backend-base
+build-backend-base: docker-login
+	$(call check_image_on_ecr,backend-base,$(base_backend_image_tag)) || \
+	$(docker) build --file $(root_dir)/govtool/backend/Dockerfile.base --tag "$(repo_url)/backend-base:$(base_backend_image_tag)" $(root_dir)/govtool/backend
+
+.PHONY: push-backend-base
+push-backend-base: build-backend-base
+	$(call check_image_on_ecr,backend-base,$(base_backend_image_tag)) || \
+	$(docker) push $(repo_url)/backend-base:$(base_backend_image_tag)
+
+.PHONY: build-backend
+build-backend: build-backend-base
+	$(call check_image_on_ecr,backend,$(backend_image_tag)) || \
+	$(docker) build --build-arg BASE_IMAGE_TAG=$(base_backend_image_tag) --tag "$(repo_url)/backend:$(backend_image_tag)" $(root_dir)/govtool/backend
+
+.PHONY: push-backend
+push-backend: push-backend-base build-backend
+	$(call check_image_on_ecr,backend,$(backend_image_tag)) || \
+	$(docker) push $(repo_url)/backend:$(backend_image_tag)
diff --git a/govtool/backend/default.nix b/govtool/backend/default.nix
@@ -1,7 +1,4 @@
-# TODO: Remove the sources file and use the nixpkgs version provided from the
-# flakes lock file instead when the flakes feature is present and enabled in the
-# root of the project.
-{ pkgs ? (import ./sources.nix).pkgs }:
+{ pkgs ? import <nixpkgs> {} }:
 let
   # This is the version of the Haskell compiler we reccommend using.
   ghcPackages = pkgs.haskell.packages.ghc927;

diff --git a/govtool/backend/shell.nix b/govtool/backend/shell.nix
@@ -0,0 +1,16 @@
+{ pkgs ? import <nixpkgs> {} }:
+let
+  project = import ./default.nix { inherit pkgs; };
+in
+project.overrideAttrs (attrs: {
+  buildInputs = attrs.buildInputs ++ (with pkgs; [
+    awscli
+    docker
+    git
+    gnumake
+  ]);
+
+  shellHook = ''
+    ln -s ${project}/libexec/yarn-nix-example/node_modules node_modules
+  '';
+})