Merge pull request #58 from hpcc-systems/dom-aws-patch

Set AWS steps to point to AWS services by default (Set AWSENV to LOCALSTACK to test on localstack)
hpcc-systems · Oct 18, 2023 · 529d6ad · 529d6ad
2 parents 6d98c4b + 17760ff
commit 529d6ad
Show file tree

Hide file tree

Showing 11 changed files with 980 additions and 912 deletions.
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -46,6 +46,7 @@ jobs:
        FAKE_SQL_USERNAME: MAF
        FAKE_SQL_PASSWORD: MAF
        LOCALSTACK_HOSTNAME: localhost
+       AWSENV: LOCALSTACK
 
     - name: Status Create Action
       if: ${{ always() }}

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/aws/README.md b/packages/aws/README.md
@@ -29,16 +29,16 @@ require('@ln-maf/aws')
 
 - Run `docker run --rm -it -p 4566:4566 -p 4510-4559:4510-4559 localstack/localstack:0.14.4` to spin up a localstack environment.
 - Run `terraform apply -auto-approve` to prepare the localstack environment.
-- Be sure environment variable `AWSENV` is set to false or does not exist
+- Be sure environment variable `AWSENV` is set to `LOCALSTACK`
 - Run individual tests, or run all tests using `npm t`
 
 # Configurations
 
 The AWS SDK V3 is used for communication to AWS / Localstack.
 You need to provide credentials to AWS so that only your account and its resources are accessed by the SDK. For more information about obtaining your account credentials, see [Loading credentials in Node.js from the shared credentials file from AWS Documentation.](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html)
-This can be point to a remote aws location, or point to a localstack configuration depending on the environment variable `AWSENV`. If `AWSENV` is set to `TRUE`, then the default configuration / credentials provided will be used. If `AWSENV` is set to false or does not exist, then the AWS MAF framework will use the default localstack configuration endpoint `http://localhost:4566`, or `http://${LOCALSTACK_HOSTNAME}:4566` if env variable `LOCALSTACK_HOSTNAME` is defined
+This can be point to a remote aws location, or point to a localstack configuration depending on the environment variable `AWSENV`. If `AWSENV` is set to `LOCALSTACK`, then the AWS MAF framework will use the default localstack configuration endpoint `http://localhost:4566`, or `http://${LOCALSTACK_HOSTNAME}:4566` if env variable `LOCALSTACK_HOSTNAME` is defined
 
-To run the example feature files, start the localstack and run the terraform script by running `terraform apply -auto-approve` to run initLocalstack.tf, then run `npm t`. `initLocalstack.tf` is needed for running the feature files in the features directory as this will set up the localstack environment for dev testing.
+To run the example feature files, start the localstack and run the terraform script by running `terraform apply -auto-approve` to run initLocalstack.tf, then run `npm t` to start testing. `initLocalstack.tf` is needed for running the feature files in the features directory as this will set up the localstack environment for dev testing.
 
 # Step Definitions
 

diff --git a/packages/aws/package.json b/packages/aws/package.json
@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.12",
+  "version": "2.2.0",
   "description": "AWS steps for MAF. This contains S3, DynamoDB, SQS, ECS, Cloudwatch, and Lambda stepDefinitions",
   "main": "index.js",
   "scripts": {
@@ -12,14 +12,15 @@
   "author": "Dominick Martelly",
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/client-cloudwatch-logs": "^3.121.0",
-    "@aws-sdk/client-dynamodb": "^3.121.0",
-    "@aws-sdk/client-ecs": "^3.121.0",
-    "@aws-sdk/client-lambda": "^3.121.0",
-    "@aws-sdk/client-s3": "^3.121.0",
-    "@aws-sdk/client-sqs": "^3.121.0",
-    "@ln-maf/core": "^2.0.1",
-    "chai": "^4.3.6",
+    "@aws-sdk/client-cloudwatch-logs": "^3.430.0",
+    "@aws-sdk/client-dynamodb": "^3.430.0",
+    "@aws-sdk/client-ecs": "^3.430.0",
+    "@aws-sdk/client-lambda": "^3.430.0",
+    "@aws-sdk/client-s3": "^3.430.0",
+    "@aws-sdk/client-sqs": "^3.430.0",
+    "@aws-sdk/client-ssm": "^3.430.0",
+    "@ln-maf/core": "^2.0.0",
+    "chai": "^4.0.0",
     "luxon": "^2.4.0"
   },
   "peerDependencies": {
@@ -30,12 +31,12 @@
     "@cucumber/cucumber": "^9.0.0",
     "@ln-maf/core": "*",
     "@ln-maf/validations": "^2.0.3",
-    "eslint": "^8.18.0",
+    "eslint": "^8.51.0",
     "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-import": "^2.28.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
-    "multiple-cucumber-html-reporter": "^3.4.0",
+    "multiple-cucumber-html-reporter": "^3.5.0",
     "nyc": "^15.1.0"
   },
   "gitHead": "9bf55a2c86fa17707fabfb4320c3d722e270f9e6"

diff --git a/packages/aws/runFeature.sh b/packages/aws/runFeature.sh
@@ -1,4 +1,4 @@
-AWSENV='FALSE'
+AWSENV='LOCALSTACK'
 mkdir -p test/report
 if [[ "$ENVIRONMENT" == "COVERAGE" ]]; then
     npx nyc --reporter=lcov --reporter=text cucumber-js $EXTRAS -f json:test/report/aws.json --require "stepDefinitions/*.js" features/$*

diff --git a/packages/aws/stepDefinitions/cloudwatch-logs.js b/packages/aws/stepDefinitions/cloudwatch-logs.js
@@ -1,16 +1,27 @@
 const { setDefaultTimeout } = require('@cucumber/cucumber')
 const { MAFWhen, filltemplate } = require('@ln-maf/core')
 const { CloudWatchLogsClient, FilterLogEventsCommand } = require('@aws-sdk/client-cloudwatch-logs')
+const { SSMClient, GetParameterCommand } = require('@aws-sdk/client-ssm')
 const { DateTime } = require('luxon')
 
 setDefaultTimeout(15 * 60 * 1000)
 
 const cloudwatchLogsClientConfig = { maxAttempts: 3 }
-if (process.env.AWSENV === undefined || process.env.AWSENV === '' || process.env.AWSENV.toUpperCase() === 'FALSE') {
+if (process.env.AWSENV && process.env.AWSENV.toUpperCase() === 'LOCALSTACK') {
   cloudwatchLogsClientConfig.endpoint = process.env.LOCALSTACK_HOSTNAME ? `http://${process.env.LOCALSTACK_HOSTNAME}:4566` : 'http://localhost:4566'
 }
 const cloudwatchLogsClient = new CloudWatchLogsClient(cloudwatchLogsClientConfig)
 
+/**
+ * Returns the value of the parameter from the parameter store
+ */
+MAFWhen('parameter {string} value is retrieved from the parameter store', async function (parameterName) {
+  parameterName = filltemplate(parameterName, this.results)
+  const ssmClient = new SSMClient()
+  const res = await ssmClient.send(new GetParameterCommand({ Name: parameterName }))
+  return res.Parameter.Value
+})
+
 /**
  * Returns at most 10 query calls of 1 MB / 10,000 logs from cloudwatch
  */

diff --git a/packages/aws/stepDefinitions/dynamodb.js b/packages/aws/stepDefinitions/dynamodb.js
@@ -7,7 +7,7 @@ setDefaultTimeout(15 * 60 * 1000)
 const DynamoDBClientConfig = {
   maxAttempts: 3
 }
-if (process.env.AWSENV === undefined || process.env.AWSENV === '' || process.env.AWSENV.toUpperCase() === 'FALSE') {
+if (process.env.AWSENV && process.env.AWSENV.toUpperCase() === 'LOCALSTACK') {
   DynamoDBClientConfig.endpoint = process.env.LOCALSTACK_HOSTNAME ? `http://${process.env.LOCALSTACK_HOSTNAME}:4566` : 'http://localhost:4566'
 }
 const dbClient = new DynamoDBClient(DynamoDBClientConfig)

diff --git a/packages/aws/stepDefinitions/ecs.js b/packages/aws/stepDefinitions/ecs.js
@@ -5,7 +5,7 @@ const { ECSClient, ListTaskDefinitionsCommand, ListClustersCommand, RunTaskComma
 setDefaultTimeout(15 * 60 * 1000)
 
 const ecsClientConfig = { maxAttempts: 3 }
-if (process.env.AWSENV === undefined || process.env.AWSENV === '' || process.env.AWSENV.toUpperCase() === 'FALSE') {
+if (process.env.AWSENV && process.env.AWSENV.toUpperCase() === 'LOCALSTACK') {
   ecsClientConfig.endpoint = process.env.LOCALSTACK_HOSTNAME ? `http://${process.env.LOCALSTACK_HOSTNAME}:4566` : 'http://localhost:4566'
 }
 const ecsClient = new ECSClient(ecsClientConfig)

diff --git a/packages/aws/stepDefinitions/lambda.js b/packages/aws/stepDefinitions/lambda.js
@@ -5,7 +5,7 @@ const { LambdaClient, InvokeCommand } = require('@aws-sdk/client-lambda')
 setDefaultTimeout(15 * 60 * 1000)
 
 const lambdaClientConfig = { maxAttempts: 3 }
-if (process.env.AWSENV === undefined || process.env.AWSENV === '' || process.env.AWSENV.toUpperCase() === 'FALSE') {
+if (process.env.AWSENV && process.env.AWSENV.toUpperCase() === 'LOCALSTACK') {
   lambdaClientConfig.endpoint = process.env.LOCALSTACK_HOSTNAME ? `http://${process.env.LOCALSTACK_HOSTNAME}:4566` : 'http://localhost:4566'
 }
 const lambdaClient = new LambdaClient(lambdaClientConfig)

diff --git a/packages/aws/stepDefinitions/s3.js b/packages/aws/stepDefinitions/s3.js
@@ -6,7 +6,7 @@ const { getFilePath, MAFWhen, filltemplate, performJSONObjectTransform } = requi
 setDefaultTimeout(15 * 60 * 1000)
 
 const S3ClientConfig = { maxAttempts: 3, forcePathStyle: true }
-if (process.env.AWSENV === undefined || process.env.AWSENV === '' || process.env.AWSENV.toUpperCase() === 'FALSE') {
+if (process.env.AWSENV && process.env.AWSENV.toUpperCase() === 'LOCALSTACK') {
   S3ClientConfig.endpoint = process.env.LOCALSTACK_HOSTNAME ? `http://${process.env.LOCALSTACK_HOSTNAME}:4566` : 'http://localhost:4566'
 }
 const s3Client = new S3Client(S3ClientConfig)

diff --git a/packages/aws/stepDefinitions/sqs.js b/packages/aws/stepDefinitions/sqs.js
@@ -5,7 +5,7 @@ const { SQSClient, ListQueuesCommand, GetQueueAttributesCommand, SendMessageComm
 setDefaultTimeout(15 * 60 * 1000)
 
 const sqsClientConfig = { maxAttempts: 3 }
-if (process.env.AWSENV === undefined || process.env.AWSENV === '' || process.env.AWSENV.toUpperCase() === 'FALSE') {
+if (process.env.AWSENV && process.env.AWSENV.toUpperCase() === 'LOCALSTACK') {
   sqsClientConfig.endpoint = process.env.LOCALSTACK_HOSTNAME ? `http://${process.env.LOCALSTACK_HOSTNAME}:4566` : 'http://localhost:4566'
 }
 const sqsClient = new SQSClient(sqsClientConfig)