- Unit & integration tests present in this repository
This project (under my repo), was developed without testability in mind, mocking nestjs modules and services will require a project refactor, for this the unit and integration tests are part of Mellywins's repo.
- E2E tests with Cypress Login screen test file (Triggered at www workflow before deploying to production)
Change the environment through NODE_ENV
environment variable
- Development (Stateful: data will be persisted through Docker mount volume)
docker-compose up -d
Both docker and docker-compose should be properly installed
- Production (hosted in heroku)
Provide a valid DATABASE_URL
(postgres connection string) at .env
(needed only for the production environment),
heroku config -a <heroku-app-name>
To get the DATABASE_URL (for free plan, credentials are not permanent )
- Multi-stage docker builds is used to build the nestjs application and only include the build and config into the image.
- To manually build and run the docker image
docker build -t tests-devops-lab .
docker run --env-file=.env -p 3000:3000 --rm tests-devops-lab
- When deployed to ECS, the env file should be stored in S3 and the task execution role should have appropriate permissions to access the file in S3. Under container Definition :
"environmentFiles":[
{
"value": "arn:aws:s3:::s3_bucket_name/envfile_object_name.env",
"type": "s3"
}
]
Task Execution role with permissions:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:GetObject"
],
"Resource": [
"arn:aws:s3:::s3_bucket_name/envfile_object_name.env"
]
},
{
"Effect": "Allow",
"Action": [
"s3:GetBucketLocation"
],
"Resource": [
"arn:aws:s3:::s3_bucket_name"
]
}
]
}
Reference AWS Docs
- linter and formatter (Triggered on both api and www changes)
- www deployment (Triggered on www changes)
- api deployment (Triggered on api changes)
(Additional staging workflow with appropriate environment could be added to run e2e tests before deploying to production)