run prettier

Author: delterr

.github/pull_request_template.md

@@ -16,7 +16,7 @@ Have any new tests been added as part of this issue? If not, try to explain why
 
 - [ ] Yes
 - [ ] No
-Please write a brief description of why test coverage is not necessary here.
+      Please write a brief description of why test coverage is not necessary here.
 - [ ] Not as part of this ticket. (Could be done at a later point)
 
 ### Documentation
@@ -26,7 +26,7 @@ as new code is added, rather than leaving it for the future.
 
 - [ ] Yes
 - [ ] No
-Please write a brief description of why documentation is not necessary here.
+      Please write a brief description of why documentation is not necessary here.
 - [ ] Not as part of this ticket. (Could be done at a later point)
 
 ### Related issues

README.md

@@ -5,33 +5,33 @@ A Python utility used to archive old, unused GitHub repositories from an organis
 ## Table of Contents
 
 - [GitHub Repository Archive Script](#github-repository-archive-script)
-  - [Table of Contents](#table-of-contents)
-  - [Prerequisites](#prerequisites)
-  - [Makefile](#makefile)
-  - [Development](#development)
-  - [Running the Project](#running-the-project)
-    - [Containerised (Recommended)](#containerised-recommended)
-    - [Outside of a Container (Development only)](#outside-of-a-container-development-only)
-  - [Deployment](#deployment)
-    - [Overview](#overview)
-    - [Deployment Prerequisites](#deployment-prerequisites)
-    - [Storing the Container on AWS Elastic Container Registry (ECR)](#storing-the-container-on-aws-elastic-container-registry-ecr)
-    - [Deploying the Lambda](#deploying-the-lambda)
-    - [Destroying / Removing the Lambda](#destroying--removing-the-lambda)
-  - [Linting and Testing](#linting-and-testing)
-    - [GitHub Actions](#github-actions)
-    - [Running Tests Locally](#running-tests-locally)
+    - [Table of Contents](#table-of-contents)
+    - [Prerequisites](#prerequisites)
+    - [Makefile](#makefile)
+    - [Development](#development)
+    - [Running the Project](#running-the-project)
+        - [Containerised (Recommended)](#containerised-recommended)
+        - [Outside of a Container (Development only)](#outside-of-a-container-development-only)
+    - [Deployment](#deployment)
+        - [Overview](#overview)
+        - [Deployment Prerequisites](#deployment-prerequisites)
+        - [Storing the Container on AWS Elastic Container Registry (ECR)](#storing-the-container-on-aws-elastic-container-registry-ecr)
+        - [Deploying the Lambda](#deploying-the-lambda)
+        - [Destroying / Removing the Lambda](#destroying--removing-the-lambda)
+    - [Linting and Testing](#linting-and-testing)
+        - [GitHub Actions](#github-actions)
+        - [Running Tests Locally](#running-tests-locally)
 
 ## Prerequisites
 
 - A Docker Daemon (Colima is recommended)
-  - [Colima](https://github.com/abiosoft/colima)
+    - [Colima](https://github.com/abiosoft/colima)
 - Terraform (For deployment)
-  - [Terraform](https://www.terraform.io/)
+    - [Terraform](https://www.terraform.io/)
 - Python >3.12
-  - [Python](https://www.python.org/)
+    - [Python](https://www.python.org/)
 - Make
-  - [GNU make](https://www.gnu.org/software/make/manual/make.html#Overview)
+    - [GNU make](https://www.gnu.org/software/make/manual/make.html#Overview)
 
 ## Makefile
 
@@ -119,7 +119,7 @@ Before the doing the following, make sure your Daemon is running. If using Colim
     When running the container, you are required to pass some environment variable.
 
     | Variable                    | Description                                                                               |
-    |-----------------------------|-------------------------------------------------------------------------------------------|
+    | --------------------------- | ----------------------------------------------------------------------------------------- |
     | GITHUB_ORG                  | The organisation you would like to run the tool in.                                       |
     | GITHUB_APP_CLIENT_ID        | The Client ID for the GitHub App which the tool uses to authenticate with the GitHub API. |
     | AWS_DEFAULT_REGION          | The AWS Region which the Secret Manager Secret is in.                                     |
@@ -168,7 +168,7 @@ To run the Lambda function outside of a container, we need to execute the `handl
     ...
     ```
 
-    **Please Note:** If uncommenting the above in `main.py`, make sure you re-comment the code *before* pushing back to GitHub.
+    **Please Note:** If uncommenting the above in `main.py`, make sure you re-comment the code _before_ pushing back to GitHub.
 
 2. Export the required environment variables:
 
@@ -268,6 +268,7 @@ Within the terraform directory, there is a [service](./terraform/service/) subdi
     ```
 
 2. Fill out the appropriate environment variables file
+
     - `env/dev/dev.tfvars` for sdp-dev.
     - `env/prod/prod.tfvars` for sdp-prod.
 
@@ -328,34 +329,41 @@ terraform destroy -var-file=env/dev/dev.tfvars
 ### Deployments with Concourse
 
 #### Allowlisting your IP
+
 To setup the deployment pipeline with concourse, you must first allowlist your IP address on the Concourse
 server. IP addresses are flushed everyday at 00:00 so this must be done at the beginning of every working day
 whenever the deployment pipeline needs to be used. Follow the instructions on the Confluence page (SDP Homepage > SDP Concourse > Concourse Login) to
 login. All our pipelines run on sdp-pipeline-prod, whereas sdp-pipeline-dev is the account used for
 changes to Concourse instance itself. Make sure to export all necessary environment variables from sdp-pipeline-prod (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN).
 
 #### Setting up a pipeline
+
 When setting up our pipelines, we use ecs-infra-user on sdp-dev to be able to interact with our infrastructure on AWS. The credentials for this are stored on
 AWS Secrets Manager so you do not need to set up anything yourself.
 
 To set the pipeline, run the following script:
+
 ```bash
 chmod u+x ./concourse/scripts/set_pipeline.sh
 ./concourse/scripts/set_pipeline.sh github-repo-archive-script
 ```
+
 Note that you only have to run chmod the first time running the script in order to give permissions.
 This script will set the branch and pipeline name to whatever branch you are currently on. It will also set the image tag on ECR to the current commit hash at the time of setting the pipeline.
 
 The pipeline name itself will usually follow a pattern as follows: `<repo-name>-<branch-name>`
 If you wish to set a pipeline for another branch without checking out, you can run the following:
+
 ```bash
 ./concourse/scripts/set_pipeline.sh github-repo-archive-script <branch_name>
 ```
 
 If the branch you are deploying is "main" or "master", it will trigger a deployment to the sdp-prod environment. To set the ECR image tag, you must draft a Github release pointing to the latest release of the main/master branch that has a tag in the form of vX.Y.Z. Drafting up a release will automatically deploy the latest version of the main/master branch with the associated release tag, but you can also manually trigger a build through the Concourse UI or the terminal prompt.
 
 #### Triggering a pipeline
+
 Once the pipeline has been set, you can manually trigger a build on the Concourse UI, or run the following command:
+
 ```bash
 fly -t aws-sdp trigger-job -j github-repo-archive-script-<branch-name>/build-and-push
 ```

concourse/ci.yml

@@ -1,78 +1,78 @@
 resources:
-- name: resource-repo
-  type: git
-  icon: github
-  source:
-    uri: https://github.com/ONS-Innovation/github-repository-archive-script
-    username: ((github_access_token))
-    password: x-oauth-basic
-    branch: ((branch))
+  - name: resource-repo
+    type: git
+    icon: github
+    source:
+      uri: https://github.com/ONS-Innovation/github-repository-archive-script
+      username: ((github_access_token))
+      password: x-oauth-basic
+      branch: ((branch))
 
 jobs:
-- name:  build-and-push
-  public: true
-  plan:
-  - get: resource-repo
-    timeout: 5m
-  - task: build-image
-    privileged: true
-    config:
-      platform: linux
-      image_resource:
-        type: docker-image
-        source:
-          repository: hashicorp/terraform
-      inputs:
-      - name: resource-repo
-      params:
-        aws_account_id: ((aws_account_sdp_((env))))
-        aws_role_arn: arn:aws:iam::((aws_account_sdp_((env)))):role/sdp-concourse-((env))
-        secrets: ((sdp_((env))_github_repo_archive_secrets))
-      run: # binary used to build the image
-        path: sh
-        args:
-        - -cx
-        - |
-          apk add --no-cache aws-cli podman jq iptables curl
+  - name: build-and-push
+    public: true
+    plan:
+      - get: resource-repo
+        timeout: 5m
+      - task: build-image
+        privileged: true
+        config:
+          platform: linux
+          image_resource:
+            type: docker-image
+            source:
+              repository: hashicorp/terraform
+          inputs:
+            - name: resource-repo
+          params:
+            aws_account_id: ((aws_account_sdp_((env))))
+            aws_role_arn: arn:aws:iam::((aws_account_sdp_((env)))):role/sdp-concourse-((env))
+            secrets: ((sdp_((env))_github_repo_archive_secrets))
+          run: # binary used to build the image
+            path: sh
+            args:
+              - -cx
+              - |
+                apk add --no-cache aws-cli podman jq iptables curl
 
-          if [[ "((env))" == "prod" ]]; then
-            tag=$(curl "https://api.github.com/repos/ONS-Innovation/github-repository-archive-script/releases" | jq -r '.[0].tag_name')
-            export tag
-          else
-            export tag=((tag))
-          fi
-          git rev-parse --abbrev-ref HEAD
-          chmod u+x ./resource-repo/concourse/scripts/assume_role.sh
-          chmod u+x ./resource-repo/concourse/scripts/build_image.sh
-          source ./resource-repo/concourse/scripts/assume_role.sh
-          ./resource-repo/concourse/scripts/build_image.sh
-    timeout: 10m
-  - task: terraform
-    privileged: true
-    config:
-      platform: linux
-      image_resource:
-        type: docker-image
-        source: {repository: hashicorp/terraform}
-      inputs:
-      - name: resource-repo
-      params:
-        secrets: ((sdp_((env))_github_repo_archive_secrets))
-        github_access_token: ((github_access_token))
-      run:
-        path: sh
-        args:
-        - -cx
-        - |
-          apk add --no-cache jq curl
+                if [[ "((env))" == "prod" ]]; then
+                  tag=$(curl "https://api.github.com/repos/ONS-Innovation/github-repository-archive-script/releases" | jq -r '.[0].tag_name')
+                  export tag
+                else
+                  export tag=((tag))
+                fi
+                git rev-parse --abbrev-ref HEAD
+                chmod u+x ./resource-repo/concourse/scripts/assume_role.sh
+                chmod u+x ./resource-repo/concourse/scripts/build_image.sh
+                source ./resource-repo/concourse/scripts/assume_role.sh
+                ./resource-repo/concourse/scripts/build_image.sh
+        timeout: 10m
+      - task: terraform
+        privileged: true
+        config:
+          platform: linux
+          image_resource:
+            type: docker-image
+            source: { repository: hashicorp/terraform }
+          inputs:
+            - name: resource-repo
+          params:
+            secrets: ((sdp_((env))_github_repo_archive_secrets))
+            github_access_token: ((github_access_token))
+          run:
+            path: sh
+            args:
+              - -cx
+              - |
+                apk add --no-cache jq curl
 
-          if [[ "((env))" == "prod" ]]; then
-            tag=$(curl "https://api.github.com/repos/ONS-Innovation/github-repository-archive-script/releases" | jq -r '.[0].tag_name')
-            export tag
-          else 
-            export tag=((tag))
-          fi
-          chmod u+x ./resource-repo/concourse/scripts/terraform_infra.sh
-          export env=((env))
-          ./resource-repo/concourse/scripts/terraform_infra.sh
-    timeout: 30m
+                if [[ "((env))" == "prod" ]]; then
+                  tag=$(curl "https://api.github.com/repos/ONS-Innovation/github-repository-archive-script/releases" | jq -r '.[0].tag_name')
+                  export tag
+                else 
+                  export tag=((tag))
+                fi
+                chmod u+x ./resource-repo/concourse/scripts/terraform_infra.sh
+                export env=((env))
+                ./resource-repo/concourse/scripts/terraform_infra.sh
+        timeout: 30m

concourse/scripts/build_image.sh

@@ -10,8 +10,11 @@ container_image=$(echo "$secrets" | jq -r .container_image)
 # shellcheck disable=SC2154
 aws ecr get-login-password --region eu-west-2 | podman --storage-driver=vfs login --username AWS --password-stdin "${aws_account_id}".dkr.ecr.eu-west-2.amazonaws.com
 
+# shellcheck disable=SC2154
 podman build -t "${container_image}":"${tag}" resource-repo
 
+# shellcheck disable=SC2154
 podman tag "${container_image}":"${tag}" "${aws_account_id}".dkr.ecr.eu-west-2.amazonaws.com/"${container_image}":"${tag}"
+
+# shellcheck disable=SC2154
 podman push "${aws_account_id}".dkr.ecr.eu-west-2.amazonaws.com/"${container_image}":"${tag}"
-# shellcheck disable=SC2154

concourse/scripts/set_pipeline.sh

@@ -5,7 +5,8 @@ repo_name=${1}
 if [[ $# -gt 1 ]]; then
     branch=${2}
     git rev-parse --verify "${branch}"
-    if [[ $? -ne 0 ]]; then # shellcheck disable=SC2181
+    # shellcheck disable=SC2181
+    if [[ $? -ne 0 ]]; then
         echo "Branch \"${branch}\" does not exist"
         exit 1
     fi
@@ -26,4 +27,3 @@ else
 fi
 
 fly -t aws-sdp set-pipeline -c concourse/ci.yml -p "${repo_name}"-"${branch}" -v branch="${branch}" -v tag="${tag}" -v env="${env}"
-

concourse/scripts/terraform_infra.sh

@@ -29,7 +29,8 @@ AWS_SECRET_ACCESS_KEY=$aws_secret_access_key
 export AWS_ACCESS_KEY_ID
 export AWS_SECRET_ACCESS_KEY
 
-git config --global url."https://x-access-token:$github_access_token@github.com/".insteadOf "https://github.com/" # shellcheck disable=
+# shellcheck disable=SC2086
+git config --global url."https://x-access-token:$github_access_token@github.com/".insteadOf "https://github.com/"
 
 if [[ ${env} != "prod" ]]; then
     env="dev"
@@ -39,6 +40,7 @@ cd resource-repo/terraform/service
 
 terraform init -backend-config=env/"${env}"/backend-"${env}".tfbackend -reconfigure
 
+# shellcheck disable=SC2154
 terraform apply \
 -var "aws_account_id=$aws_account_id" \
 -var "aws_access_key_id=$aws_access_key_id" \
@@ -54,4 +56,3 @@ terraform apply \
 -var "lambda_memory=$lambda_memory" \
 -var "schedule=$schedule" \
 -auto-approve
-# shellcheck disable=SC2154