Merge pull request #4 from HicResearch/upgrade-cdkv2-extras

Small fixes to feature/upgrade-cdkv2

Author: manics

.pre-commit-config.yaml

@@ -1,4 +1,15 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-added-large-files
+      - id: debug-statements
+      - id: name-tests-test
+      - id: requirements-txt-fixer
   - repo: https://github.com/pycqa/isort
     rev: 5.11.5
     hooks:
@@ -15,58 +26,55 @@ repos:
     rev: 6.0.0
     hooks:
       - id: flake8
-        args: ['--max-line-length=200', '--ignore=E203,W503', '--max-cognitive-complexity=17', '--max-expression-complexity=9' ]
+        args:
+          [
+            "--max-line-length=200",
+            "--ignore=E203,W503",
+            "--max-cognitive-complexity=17",
+            "--max-expression-complexity=9",
+          ]
         additional_dependencies: [
-          flake8-bugbear, # Detect potential bugs
-          flake8-builtins, # Check for built-ins being used as variables
-          flake8-cognitive-complexity, # Check max function complexity
-          flake8-comprehensions, # Suggestions for better list/set/dict comprehensions
-          flake8-expression-complexity, # Check max expression complexity
-          flake8-fixme, # Check for FIXME, TODO, and XXX left in comments
-          flake8-logging-format, # Validate (lack of) logging format strings
-          flake8-pie, # Misc. linting rules
-          flake8-pytest-style, # Check against pytest style guide
-          flake8-return, # Check return statements
-          flake8-simplify, # Suggestions to simplify code
-          flake8-use-fstring, # Encourages use of f-strings vs old style
-          pep8-naming, # Check PEP8 class naming
-        ]
+            flake8-bugbear, # Detect potential bugs
+            flake8-builtins, # Check for built-ins being used as variables
+            flake8-cognitive-complexity, # Check max function complexity
+            flake8-comprehensions, # Suggestions for better list/set/dict comprehensions
+            flake8-expression-complexity, # Check max expression complexity
+            flake8-fixme, # Check for FIXME, TODO, and XXX left in comments
+            flake8-logging-format, # Validate (lack of) logging format strings
+            flake8-pie, # Misc. linting rules
+            flake8-pytest-style, # Check against pytest style guide
+            flake8-return, # Check return statements
+            flake8-simplify, # Suggestions to simplify code
+            flake8-use-fstring, # Encourages use of f-strings vs old style
+            pep8-naming, # Check PEP8 class naming
+          ]
         verbose: true
   - repo: https://github.com/Lucas-C/pre-commit-hooks-safety
     rev: v1.3.1
     hooks:
-    - id: python-safety-dependencies-check
-      verbose: true
+      - id: python-safety-dependencies-check
+        verbose: true
   - repo: https://github.com/awslabs/git-secrets
     rev: 99d01d58ebcc06e237c0e3f3ff5ae628aeef6aa6
     hooks:
       - id: git-secrets
         verbose: true
-        entry: 'git-secrets --register-aws'
+        entry: "git-secrets --register-aws"
         language: script
         name: git-secrets-register-aws-provider
       - id: git-secrets
         verbose: true
-        entry: 'git-secrets --scan'
+        entry: "git-secrets --scan"
         language: script
         name: git-secrets-scan
-  - repo: https://github.com/markdownlint/markdownlint
-    rev: v0.12.0
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
     hooks:
-      - id: markdownlint
-        name: Markdownlint
-        description: Run markdownlint on your Markdown files
-        entry: mdl .
-        language: ruby
-        files: \.(md|mdown|markdown)$
-        verbose: true
-        args:
-          - "-s"
-          - "mdl_style.rb"
+      - id: prettier
   - repo: https://github.com/PyCQA/bandit
-    rev: '1.7.5'
+    rev: "1.7.5"
     hooks:
       - id: bandit
         entry: bandit
         exclude: ^tests/
-        verbose: true
+        verbose: true

CONTRIBUTING.md

@@ -64,7 +64,7 @@ Pay attention to any automated CI failures reported in the pull request, and sta
 
 - [ ] Testing
 - Unit test added (prefer not to modify an existing test, otherwise,
-    it's probably a breaking change)
+  it's probably a breaking change)
 - [ ] Docs
   - **README**: README updated if necessary
 - [ ] Title and Description

README.md

@@ -62,12 +62,12 @@ cd secure-egress-backend
 - [ ] Run the following commands to create an isolated Python environment and deploy the CDK backend stack:
 
 ```bash
-alias cdkv1="npx aws-cdk@1.154"
+alias cdkv2="npx aws-cdk@2.81"
 python3 -m venv .venv
 source .venv/bin/activate
 pip3 install -r requirements.txt
-cdkv1 bootstrap aws://<<AWS_ACCOUNT_ID>>/<<AWS_REGION>> # TRE account ID / eu-west-2
-cdkv1 deploy
+cdkv2 bootstrap aws://<<AWS_ACCOUNT_ID>>/<<AWS_REGION>> # TRE account ID / eu-west-2
+cdkv2 deploy
 ```
 
 ## Solution Overview
@@ -255,8 +255,8 @@ be used at various points. Among the key values are:
   - Step Function choice task which parses the status of the request as received from the frontend API call in the
     previous task to determine if the request was **_APPROVED_** or **_REJECTED_** by Information Governance
   - At this step the Step Function also checks if any additional approvals are required based on the value of `is_single_approval_enabled`.
-  If no further approvals are required the appropriate data operation is done based on the decision
-  and an email is sent to the requester.
+    If no further approvals are required the appropriate data operation is done based on the decision
+    and an email is sent to the requester.
     If an additional approval is required Research IT approval workflow is followed.
 
 - **Delete Rejected Objects From Staging - IGLead:**

egress_backend/egress_backend_stack.py

@@ -911,6 +911,7 @@ def __init__(
                 {
                     "Egress Request ID": sfn.JsonPath.string_at("$.egress_request_id"),
                     "Researcher Email": sfn.JsonPath.string_at("$.created_by_email"),
+                    "Workspace ID": sfn.JsonPath.string_at("$.workspace_id"),
                     "Egress Object File Types": sfn.JsonPath.string_at(
                         "$.copy_to_staging_result.file_extensions"
                     ),
@@ -930,6 +931,7 @@ def __init__(
                 {
                     "Egress Request ID": sfn.JsonPath.string_at("$.egress_request_id"),
                     "Researcher Email": sfn.JsonPath.string_at("$.created_by_email"),
+                    "Workspace ID": sfn.JsonPath.string_at("$.workspace_id"),
                     "Information Governance": sfn.JsonPath.string_at(
                         "$.information_governance.result.ig_reviewer_1_email"
                     ),
@@ -1963,6 +1965,14 @@ def __init__(
             else egress_app_url,
             description="The URL for the Egress App.",
         )
+
+        CfnOutput(
+            self,
+            "MaxDownloadsAllowed",
+            value=self.node.try_get_context(env_id).get("max_downloads_allowed"),
+            description="Max downloads allowed parameter provided.",
+        )
+
         for idx, role in enumerate(
             self.node.try_get_context(env_id).get("egress_reviewer_roles")
         ):

egress_backend/graphql/schema.graphql

@@ -1,73 +1,73 @@
 input DownloadDataInput {
-	egress_request_id: String!
-	workspace_id: String!
-	download_count: String!
+  egress_request_id: String!
+  workspace_id: String!
+  download_count: String!
 }
 
 type Mutation {
-	updateRequest(request: UpdateRequestInput!): String
-		@aws_auth(cognito_groups: ["InformationGovernance","TREAdmin"])
-	downloadData(request: DownloadDataInput!): presign_payload
-		@aws_auth(cognito_groups: ["InformationGovernance"])
+  updateRequest(request: UpdateRequestInput!): String
+    @aws_auth(cognito_groups: ["InformationGovernance", "TREAdmin"])
+  downloadData(request: DownloadDataInput!): presign_payload
+    @aws_auth(cognito_groups: ["InformationGovernance"])
 }
 
 type Query {
-	listRequests: [Request]
-		@aws_auth(cognito_groups: ["InformationGovernance","TREAdmin"])
+  listRequests: [Request]
+    @aws_auth(cognito_groups: ["InformationGovernance", "TREAdmin"])
 }
 
-type Request @aws_auth(cognito_groups: ["InformationGovernance","TREAdmin"]) {
-	egress_request_id: String!
-	egress_store_name: String!
-	swb_egress_store_id: String!
-	project_id: String!
-	workspace_id: String!
-	requested_by: String!
-	requested_dt: String!
-	updated_by: String!
-	updated_dt: String!
-	egress_status: String!
-	s3_egress_store_bucket: String!
-	s3_egress_store_bucket_path: String!
-	s3_egress_store_object_list_location: String!
-	s3_swb_object_metadata_version: String!
-	task_token: String
-	ig_reviewer_1_name: String
-	ig_reviewer_1_email: String
-	ig_reviewer_1_dt: String
-	ig_reviewer_1_reason: String
-	ig_reviewer_1_decision: String
-	rit_reviewer_2_name: String
-	rit_reviewer_2_email: String
-	rit_reviewer_2_dt: String
-	rit_reviewer_2_reason: String
-	rit_reviewer_2_decision: String
-	current_reviewer_group: String
-	s3_staging_object_metadata_version: String
-	download_count: String
-	is_single_approval_enabled: String
+type Request @aws_auth(cognito_groups: ["InformationGovernance", "TREAdmin"]) {
+  egress_request_id: String!
+  egress_store_name: String!
+  swb_egress_store_id: String!
+  project_id: String!
+  workspace_id: String!
+  requested_by: String!
+  requested_dt: String!
+  updated_by: String!
+  updated_dt: String!
+  egress_status: String!
+  s3_egress_store_bucket: String!
+  s3_egress_store_bucket_path: String!
+  s3_egress_store_object_list_location: String!
+  s3_swb_object_metadata_version: String!
+  task_token: String
+  ig_reviewer_1_name: String
+  ig_reviewer_1_email: String
+  ig_reviewer_1_dt: String
+  ig_reviewer_1_reason: String
+  ig_reviewer_1_decision: String
+  rit_reviewer_2_name: String
+  rit_reviewer_2_email: String
+  rit_reviewer_2_dt: String
+  rit_reviewer_2_reason: String
+  rit_reviewer_2_decision: String
+  current_reviewer_group: String
+  s3_staging_object_metadata_version: String
+  download_count: String
+  is_single_approval_enabled: String
 }
 
 input UpdateRequestInput {
-	egress_request_id: String!
-	task_token: String!
-	ig_reviewer_1_name: String
-	ig_reviewer_1_email: String
-	ig_reviewer_1_dt: String
-	ig_reviewer_1_reason: String
-	ig_reviewer_1_decision: String
-	rit_reviewer_2_name: String
-	rit_reviewer_2_email: String
-	rit_reviewer_2_dt: String
-	rit_reviewer_2_reason: String
-	rit_reviewer_2_decision: String
+  egress_request_id: String!
+  task_token: String!
+  ig_reviewer_1_name: String
+  ig_reviewer_1_email: String
+  ig_reviewer_1_dt: String
+  ig_reviewer_1_reason: String
+  ig_reviewer_1_decision: String
+  rit_reviewer_2_name: String
+  rit_reviewer_2_email: String
+  rit_reviewer_2_dt: String
+  rit_reviewer_2_reason: String
+  rit_reviewer_2_decision: String
 }
 
 type presign_payload {
-	presign_url: String
+  presign_url: String
 }
 
 schema {
-	query: Query
-	mutation: Mutation
-}
+  query: Query
+  mutation: Mutation
+}