Merge pull request #70 from aws-solutions/develop

Update to version v2.0.1

Author: beomseoklee

CHANGELOG.md

@@ -1,19 +1,38 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.1] - 2021-12-13
+
+Version 2.0.1 supports upgrading from version 2.0.0 but not from version 1.3.0 and below
+
+> **Note**: When upgrading from version 2.0.0 to 2.0.1, make sure to clear CloudFront and browser cache to avoid image issues.
+
+### Changed
+
+- Updated AWS SDK version in development dependencies for AWS Lambda functions
+- Bug fix to resolve issue with displaying a large number of tests
+- Bug fix for error _finalResults function error ValidationException: Item size to update has exceeded the maximum allowed size_
+- Merge [#64](https://github.com/aws-solutions/distributed-load-testing-on-aws/pull/64) from [@rmdashrfslash](https://github.com/rmdashrfslash)
+
 ## [2.0.0] - 2021-09-30
+
 ⚠ BREAKING CHANGES
 Version 2.0.0 does not support upgrading from previous versions.
+
 ### Added
+
 - Support to view complete data from previous test runs, including test configuration, test data, and Amazon CloudWatch dashboards
   - Results History now has a `View details` link to display data from previous test runs
 - Support for an existing Amazon VPC
 - Launch Fargate tasks in multiple availability zones
 - Using AWS CDK source code to generate the AWS CloudFormation template
 
 ### Changed
+
 - Results History displays:
   - Run Time
   - Task Count
@@ -24,12 +43,15 @@ Version 2.0.0 does not support upgrading from previous versions.
 - Test ids only contain alphanumeric characters
 
 ### Removed
+
 - Remove AWS CodePipeline, AWS CodeBuild, and Amazon ECR image repository resource creation by AWS CloudFormation stack
   - The solution's container image is stored in a public ECR image repository managed by AWS
 - Remove `ECRChecker` lambda function and state machine stage
 
 ## [1.3.0] - 2021-04-30
+
 ### Added
+
 - Support for up to 1000 tasks
   - Added TaskCanceler lambda to cancel tasks
   - Added steps in step function to support launching 1000 tasks
@@ -56,7 +78,8 @@ Version 2.0.0 does not support upgrading from previous versions.
 - Added SolutionId and TestId tag to Fargate tasks and SolutionId tag to API Gateway
 
 ### Changed
-- Merge [#50](https://github.com/awslabs/distributed-load-testing-on-aws/pull/50/) by [@naxxster](https://github.com/naxxster)
+
+- Merge [#50](https://github.com/aws-solutions/distributed-load-testing-on-aws/pull/50/) by [@naxxster](https://github.com/naxxster)
 - Increased Task Count limits
 - Changed ETA for running tasks to be dynamic based on number of tasks
 - Increased task cpu and memory to handle increased cpu load
@@ -69,11 +92,14 @@ Version 2.0.0 does not support upgrading from previous versions.
   - Changed concurrency message to provide guidelines to determine max concurrency
 
 ### Removed
+
 - Concurrency Limits
 - Removed aggregated CloudWatch dashboard and metric
 
 ## [1.2.0] - 2020-12-17
+
 ### Added
+
 - JMeter input file support and plugins support
   - JMeter input files should be zipped with the JMeter script file.
   - Add `jetty-*.jar` files to the Amazon ECR to support JMeter HTTP/2 plugin:
@@ -98,6 +124,7 @@ Version 2.0.0 does not support upgrading from previous versions.
   - When there is no result in the S3 bucket, it regards the result as `FAILED`.
 
 ### Changed
+
 - Use `Promise.all()` in `results-parser` to improve the performance
 - Correct average bandwidth on the Detail page
 - Packages version
@@ -106,26 +133,32 @@ Version 2.0.0 does not support upgrading from previous versions.
 - Maximum upload file size to 50MB to support JMeter input files
 
 ## [1.1.0] - 2020-09-30
+
 ### Added
-- JMeter support with `jmx` script: [#3](https://github.com/awslabs/distributed-load-testing-on-aws/issues/3)
+
+- JMeter support with `jmx` script: [#3](https://github.com/aws-solutions/distributed-load-testing-on-aws/issues/3)
 - Add `START` button on details page
 - Add `CANCEL` button on create page
 - Add AWS Step Functions to run tasks and update result instead of Amazon DynamoDB and Amazon SQS
 - Add `BucketEncryption` for `ConsoleBucket`
 - Add API Gateway logging
 
 ### Changed
-- Merge [#15](https://github.com/awslabs/distributed-load-testing-on-aws/pull/15/) by [@afittz](https://github.com/afittz)
-- Merge [#16](https://github.com/awslabs/distributed-load-testing-on-aws/pull/16/) by [@Patrick-56Bit](https://github.com/Patrick-56Bit)
+
+- Merge [#15](https://github.com/aws-solutions/distributed-load-testing-on-aws/pull/15/) by [@afittz](https://github.com/afittz)
+- Merge [#16](https://github.com/aws-solutions/distributed-load-testing-on-aws/pull/16/) by [@Patrick-56Bit](https://github.com/Patrick-56Bit)
 - Change `LAST RAN` to `STARTED AT` and add `ENDED AT` information when test is completed
 - Change CodeBuild image to `aws/codebuild/standard:4.0`
 - Update Node.js version from 10.x to 12.x
 - All Amazon S3 buckets do not allow public access.
 
 ### Removed
+
 - Amazon SQS queue
 - Amazon DynamoDB Results table
 
 ## [1.0.0] - 2019-11-14
+
 ### Added
-- CHANGELOG version 1.0.0 release
+
+- CHANGELOG version 1.0.0 release

CONTRIBUTING.md

@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/awslabs/distributed-load-testing-on-aws/issues), or [recently closed](https://github.com/awslabs/distributed-load-testing-on-aws/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](https://github.com/aws-solutions/distributed-load-testing-on-aws/issues), or [recently closed](https://github.com/aws-solutions/distributed-load-testing-on-aws/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
@@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/distributed-load-testing-on-aws/labels/help%20wanted) issues is a great place to start.
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-solutions/distributed-load-testing-on-aws/labels/help%20wanted) issues is a great place to start.
 
 
 ## Code of Conduct
@@ -56,6 +56,6 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## Licensing
 
-See the [LICENSE](https://github.com/awslabs/distributed-load-testing-on-aws/blob/master/LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](https://github.com/aws-solutions/distributed-load-testing-on-aws/blob/master/LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
 
 We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

README.md

@@ -2,18 +2,19 @@
 
 The Distributed Load Testing Solution leverages managed, highly available and highly scalable AWS services to effortlessly create and simulate thousands of connected users generating a selected amount of transactions per second. As a result, developers can understand the behavior of their applications at scale and at load to identify any bottleneck problems before they deploy to Production.
 
-
 ## On this Page
+
 - [Architecture Overview](#architecture-overview)
 - [Deployment](#deployment)
 - [Source Code](#source-code)
-- [Creating a custom build](#additional-resources)
-
+- [Creating a custom build](#creating-a-custom-build)
 
 ## Architecture Overview
+
 ![Architecture](architecture.png)
 
 ## Deployment
+
 The solution is deployed using a CloudFormation template with a lambda backed custom resource. For details on deploying the solution please see the details on the solution home page: [Distributed Load Testing](https://aws.amazon.com/solutions/implementations/distributed-load-testing-on-aws/)
 
 ## Source Code
@@ -40,65 +41,67 @@ A NodeJS Lambda function that runs the Amazon ECS task definition for each test.
 A NodeJS Lambda function that checks if the Amazon ECS tasks are running or not.
 
 ## Creating a custom build
+
 The solution can be deployed through the CloudFormation template available on the solution home page: [Distributed Load Testing](https://aws.amazon.com/solutions/implementations/distributed-load-testing-on-aws/).
-To make changes to the solution, download or clone this repo, update the source code and then run the deployment/build-s3-dist.sh script to deploy the updated Lambda code to an Amazon S3 bucket in your account.
 
-### Prerequisites:
-* [AWS Command Line Interface](https://aws.amazon.com/cli/)
+To make changes to the solution, download or clone this repository, update the source code and then run the deployment/build-s3-dist.sh script to deploy the updated Lambda code to an Amazon S3 bucket in your account.
+
+### Prerequisites
+
 * Node.js 14.x or later
 
-### 1. Clone the Distributed Load Testing on AWS solution repository
-Clone the ```distributed-load-testing-on-aws``` GitHub repository, then make the desired code changes.
+### Running unit tests for customization
+
+* Clone the repository and make the desired code changes.
 
 ```bash
-git clone https://github.com/awslabs/distributed-load-testing-on-aws.git
+git clone https://github.com/aws-solutions/distributed-load-testing-on-aws.git
+cd distributed-load-testing-on-aws
+export BASE_DIRECTORY=$PWD
 ```
 
-### 2. Run unit tests
-Run unit tests to make sure added customization passes the tests:
+* Run unit tests to make sure the updates pass the tests.
+
 ```bash
-cd ./deployment
+cd $BASE_DIRECTORY/deployment
 chmod +x ./run-unit-tests.sh
 ./run-unit-tests.sh
 ```
 
-### 3. Declare environment variables
+### Building distributable for customization
+
+* Configure the environment variables.
+
 ```bash
-export REGION=aws-region-code # the AWS region to launch the solution (e.g. us-east-1)
-export DIST_OUTPUT_BUCKET=my-bucket-name # bucket where customized code will reside
+export DIST_BUCKET_PREFIX=my-bucket-name # bucket where customized code will reside
 export SOLUTION_NAME=my-solution-name
 export VERSION=my-version # version number for the customized code
+export REGION=aws-region-code # the AWS region to launch the solution (e.g. us-east-1)
 export PUBLIC_ECR_REGISTRY=public.ecr.aws/awssolutions/distributed-load-testing-on-aws-load-tester # replace with the container registry and image if you want to use a different container image
 export PUBLIC_ECR_TAG=v2.0 # replace with the container image tag if you want to use a different container image
 ```
 
-### 4. Create an Amazon S3 Bucket
-The CloudFormation template is configured to pull the Lambda deployment packages from Amazon S3 bucket in the region the template is being launched in. Create a bucket in the desired region with the region name appended to the name of the bucket. eg: for us-east-1 create a bucket named: ```my-bucket-us-east-1```
-```bash
-aws s3 mb s3://$DIST_OUTPUT_BUCKET-$REGION --region $REGION
-```
+> **Note:** When you define `DIST_BUCKET_PREFIX`, a randomized value is recommended. You will need to create an S3 bucket where the name is `<DIST_BUCKET_PREFIX>-<REGION>`. The solution's CloudFormation template will expect the source code to be located in a bucket matching that name.
+
+* Build the distributable.
 
-### 5. Create the deployment packages
-Build the distributable:
 ```bash
+cd $BASE_DIRECTORY/deployment
 chmod +x ./build-s3-dist.sh
-./build-s3-dist.sh $DIST_OUTPUT_BUCKET $SOLUTION_NAME $VERSION
+./build-s3-dist.sh $DIST_BUCKET_PREFIX $SOLUTION_NAME $VERSION
 ```
 
-> **Notes**: The _build-s3-dist_ script expects the bucket name as one of its parameters, and this value should not include the region suffix. In addition to that, the version parameter will be used to tag the npm packages, and therefore should be in the [Semantic Versioning format](https://semver.org/spec/v2.0.0.html).
+> **Note**: The _build-s3-dist_ script expects the bucket name as one of its parameters, and this value should not include the region suffix. In addition to that, the version parameter will be used to tag the npm packages, and therefore should be in the [Semantic Versioning format](https://semver.org/spec/v2.0.0.html).
 
-### 6. Upload deployment assets to your Amazon S3 bucket
-Deploy the distributable to the Amazon S3 bucket in your account:
-```bash
-aws s3 cp ./regional-s3-assets/ s3://$DIST_OUTPUT_BUCKET-$REGION/$SOLUTION_NAME/$VERSION/ --recursive --acl bucket-owner-full-control
-aws s3 cp ./global-s3-assets/ s3://$DIST_OUTPUT_BUCKET-$REGION/$SOLUTION_NAME/$VERSION/ --recursive --acl bucket-owner-full-control
-```
+* Deploy the distributable to the Amazon S3 bucket in your account.
 
-### 7. Launch the CloudFormation template.
-* Get the link of the `distributed-load-testing-on-aws.template` uploaded to your Amazon S3 bucket.
-* Deploy the Distributed Load Testing on AWS solution to your account by launching a new AWS CloudFormation stack using the link of the `distributed-load-testing-on-aws.template`.
+  * Make sure you are uploading the distributable to the `<DIST_BUCKET_PREFIX>-<REGION>` bucket.
+  * Get the link of the solution template uploaded to your Amazon S3 bucket.
+
+* Deploy the solution to your account by launching a new AWS CloudFormation stack using the link of the solution template in Amazon S3.
 
 ## Creating a custom container build
+
 This solution uses a public Amazon Elastic Container Registry (Amazon ECR) image repository managed by AWS to store the solution container image that is used to run the configured tests. If you want to customize the container image, you can rebuild and push the image into an ECR image repository in your own AWS account.
 For details on how to customize the container image, please see the **Container image customization** section of the [implementation guide](https://docs.aws.amazon.com/solutions/latest/distributed-load-testing-on-aws/container-image.html).
 

deployment/run-unit-tests.sh

@@ -1,31 +1,81 @@
 #!/bin/bash
+#
+# This script runs all tests for the root CDK project, as well as any microservices, Lambda functions, or dependency
+# source code packages. These include unit tests and snapshot tests.
+#
+# The if/then blocks are for error handling. They will cause the script to stop executing if an error is thrown from the
+# node process running the test case(s). Removing them or not using them for additional calls with result in the
+# script continuing to execute despite an error being thrown.
 
-source_dir="$PWD/../source"
+[ "$DEBUG" == 'true' ] && set -x
+set -e
 
-cd $source_dir/api-services
-npm install --silent
-npm test
 
-cd $source_dir/custom-resource
-npm install --silent
-npm test
+prepare_jest_coverage_report() {
+	local component_name=$1
 
-cd $source_dir/results-parser
-npm install --silent
-npm test
+    if [ ! -d "coverage" ]; then
+        echo "ValidationError: Missing required directory coverage after running unit tests"
+        exit 129
+    fi
 
-cd $source_dir/task-runner
-npm install --silent
-npm test 
+	# prepare coverage reports
+    rm -fr coverage/lcov-report
+    mkdir -p $coverage_reports_top_path/jest
+    coverage_report_path=$coverage_reports_top_path/jest/$component_name
+    rm -fr $coverage_report_path
+    mv coverage $coverage_report_path
+}
 
-cd $source_dir/task-status-checker
-npm install --silent
-npm test
+run_tests() {
+  local component_path=$1
+  local component_name=$2
 
-cd $source_dir/task-canceler
-npm install --silent
-npm test 
+  echo "------------------------------------------------------------------------------"
+  echo "[Test] Run unit test with coverage for $component_name"
+  echo "------------------------------------------------------------------------------"
+  echo "cd $component_path"
+  cd $component_path
 
-cd $source_dir/infrastructure
-npm install --silent
-npm test
+  # install dependencies
+  npm run clean
+  npm install
+
+  # run unit tests
+  npm test
+
+  # prepare coverage reports
+  prepare_jest_coverage_report $component_name
+}
+
+# Run unit tests
+echo "Running unit tests"
+
+# Get reference for source folder
+source_dir="$(cd $PWD/../source; pwd -P)"
+coverage_reports_top_path=$source_dir/test/coverage-reports
+
+# Test packages
+declare -a packages=(
+    "api-services"
+    "custom-resource"
+    "infrastructure"
+    "results-parser"
+    "task-canceler"
+    "task-runner"
+    "task-status-checker"
+)
+
+for package in "${packages[@]}"; do
+  run_tests $source_dir/$package $package
+  # Check the result of the test and exit if a failure is identified
+  if [ $? -eq 0 ]
+  then
+    echo "Test for $package passed"
+  else
+    echo "******************************************************************************"
+    echo "Test FAILED for $package"
+    echo "******************************************************************************"
+    exit 1
+  fi
+done