Handle AWS Secrets easily with Cypress

Managing secrets securely and efficiently is crucial for any application. This plugin integrates AWS Secrets Manager into your Cypress tests, ensuring that sensitive data like API keys, passwords, and tokens remain secure during testing. It allows for secure loading and updating of secrets directly from your tests.

Main Changes From V1
- Library Import in setupNodeEvents
- Storing AWS_SECRET_MANAGER_CONFIG
Installation
Prerequisites
Configuration
- Code in cypress.config.js
Functions
- getSecretFromAWS
- updateSecret
Environment variables
Pass your AWS configuration to cypress
Running on CI
- Overwriting variables
- Importing Secrets from local file
Results
Best Practices for AWS Login
- AWS SSO
- AWS IAM
THE JOB IS DONE

Upgrading to Version 2

This is version 2 of the library, which includes significant performance improvements and several changes. Please update your configuration according to the new instructions provided below to avoid any issues. See Main Changes for more details.

Installation

$ npm install cypress-aws-secrets-manager --save-dev

or as a global module

$ npm install -g cypress-aws-secrets-manager

Prerequisites

AWS CLI Install/Update
A user to SSO via AWS Identity and Access Management.

Configuration

Code in cypress.config.js

In your cypress.config.js file:

// cypress.config.js
module.exports = defineConfig({
  e2e: {
    async setupNodeEvents(on, config) {
      const { getSecretFromAWS } = require('cypress-aws-secrets-manager')
      config.env = await getSecretFromAWS(config.env, __dirname)
      require('cypress-aws-secrets-manager/tasks')(on, config)
      return config
    }
  }
})

Functions

getSecretFromAWS

getSecretFromAWS(config.env, __dirname)

The getSecretFromAWS function allows you to update your environment variables by adding secrets stored in AWS Secrets Manager. This function merges existing environment variables with new secrets from AWS Secrets Manager.

getSecretFromAWS Usage

// cypress.config.js
module.exports = defineConfig({
  e2e: {
    async setupNodeEvents(on, config) {
      const { getSecretFromAWS } = require('cypress-aws-secrets-manager')
      config.env = await getSecretFromAWS(config.env, __dirname)
      return config
    }
  }
})

updateSecret

cy.task('updateSecret', secretValue)

The updateSecret task allows you to update secrets stored in AWS Secrets Manager. This function merges existing secrets with new values and updates the secret in AWS Secrets Manager.

Features

Adding Secrets: Introduce a new key-value pair (e.g., here)
Updating Secrets: Change the value of an existing key (e.g., here).

secretValue Must be an object containing the new secretString for the secretKey to update & to merge with the existing ones.

Returns: A promise that resolves with the AWS Secrets Manager response if the secret is updated successfully, or rejects with an error if the update fails.

updateSecret Usage

// cypress.config.js
module.exports = defineConfig({
  e2e: {
    async setupNodeEvents(on, config) {
      require('cypress-aws-secrets-manager/tasks')(on, config)
      return config
    }
  }
})

// inside a spec file (e.g. spec.cy.js)
const secretValue = { secretKey: 'secretString' }
cy.task('updateSecret', secretValue).then((result) => {
  cy.log(JSON.stringify(result))
})

Environment variables

Environment variables should be easily modifiable from the command line (see here), whereas the other configurations should not.

Parameter	Mandatory	Notes	Default
AWS_SSO_STRATEGY	TRUE	A string that defines the AWS login strategy (see here for details)	—
AWS_SECRET_MANAGER_CONFIG	TRUE	An object that contains the essential configuration parameters (see here for details)	—
AWS_SECRETS_LOCAL_DIR	FALSE	Directory path where secrets should be saved locally. If not specified, secrets will not be saved.	—
ENV_LOG_MODE	FALSE	When set to `'silent'`, restricts plugin log output to only key status messages (see Silent mode).	`''`

Define AWS_SECRET_MANAGER_CONFIG object

The main object required by this library is AWS_SECRET_MANAGER_CONFIG, which contains the following parameters:

{
  "AWS_SECRET_MANAGER_CONFIG": {
    "secretName": "AWS_SECRET_NAME",
    "profile": "AWS_PROFILE_NAME",
    "region": "AWS_REGION",
    "kmsKeyId": "AWS_SECRET_KMS_KEY",
    "pathToCredentials": "PATH_TO_AWS_CREDENTIALS.JSON"
  }
}

Parameter	Required	Description	Default
`secretName`	✅ Yes	AWS secret name	—
`region`	✅ Yes	AWS Secrets Manager region	—
`profile`	❌ No	AWS SSO profile name	`'default'` profile
`kmsKeyId`	Required only when updating a secret from another AWS account	AWS KMS key ID used for secret encryption	—
`pathToCredentials`	❌ No	Path to credentials file (used with `credentials` to write them to a file)	Same folder as `cypress.config.js`

AWS Login Strategies

The next configurations are external to the AWS_SECRET_MANAGER_CONFIG because they can vary for the same project when executed locally and on CI. The variables within AWS_SECRET_MANAGER_CONFIG are more dependent on the execution environment.

If profile is set, the plugin will use the profile name specified inside the AWS_SECRET_MANAGER_CONFIG (if not specified, the default profile will be used).
AWS_SSO_STRATEGY: 'profile' | 'default' | 'credentials' | 'unset' | 'multi'
- profile or default → AWS SSO
- credentials or unset → AWS IAM (using environment variables or credentials file)
- multi → Try all strategies in order, fail only after all attempts.

AWS_SSO_STRATEGY	AWS Auth Type
profile	AWS SSO
default	AWS SSO
credentials	AWS IAM
unset	AWS IAM
multi	Mixed

Credential File example

This credential file is used with the AWS IAM strategy. It is optional.

// pathToCredentials.json
{
  "accessKeyId": "XXXXXX",
  "secretAccessKey": "XXXXXX",
  "sessionToken": "XXXXXX"
}

Log Mode (`ENV_LOG_MODE`)

By default, the plugin emits detailed logs for each step (login attempts, secret extraction, etc.). If you want to restrict log verbosity, set the environment variable:

npx cypress run -e ENV_LOG_MODE=silent

silent: Only key status messages are logged, omitting detailed steps and AWS SDK messages.

See Silent mode in the Results section for examples.

Pass your AWS configuration to cypress

After defining your strategy and your AWS_SECRET_MANAGER_CONFIG, you can import this configuration into Cypress in two ways.

"Easy" way with cypress-env plugin

IMPORTANT: Import cypress-env before cypress-aws-secrets-manager

// cypress.config.js
module.exports = defineConfig({
  e2e: {
    async setupNodeEvents(on, config) {
      require('cypress-env')(on, config)
      const { getSecretFromAWS } = require('cypress-aws-secrets-manager')
      config.env = await getSecretFromAWS(config.env, __dirname)
      require('cypress-aws-secrets-manager/tasks')(on, config)
      return config
    }
  }
})

PRO: Zero code for environment injection CON: Requires cypress-env plugin

Your environment.json will look like:

// environment.json
{
  "baseUrl": "https://www.google.com",
  "env": {
    "var1": "value1",
    "var2": "value2",
    "var3": "value3",
    "AWS_SSO_STRATEGY": "strategy_type",
    "AWS_SECRET_MANAGER_CONFIG": {
      "secretName": "AWS_SECRET_NAME",
      "profile": "AWS_PROFILE_NAME",
      "region": "AWS_REGION",
      "kmsKeyId": "AWS_SECRET_KMS_KEY",
      "pathToCredentials": "PATH_TO_AWS_CREDENTIALS.JSON"
    }
  }
}

"Complex" way inside cypress.config.js

PRO: No additional plugin needed CON: Requires a bit more code

// cypress.config.js
module.exports = defineConfig({
  e2e: {
    async setupNodeEvents(on, config) {
      const { getSecretFromAWS } = require('cypress-aws-secrets-manager')
      config.env = await getSecretFromAWS(config.env, __dirname)
      return config
    }
  },
  env: {
    AWS_SSO_STRATEGY: 'strategy_type',
    AWS_SECRET_MANAGER_CONFIG: {
      secretName: 'AWS_SECRET_NAME',
      profile: 'AWS_PROFILE_NAME',
      region: 'AWS_REGION',
      kmsKeyId: 'AWS_SECRET_KMS_KEY',
      pathToCredentials: 'PATH_TO_AWS_CREDENTIALS.JSON'
    }
  }
})

Running on CI

Overriding environment variables in CI or local setup

In certain cases, you may need to override specific environment variables like AWS_SSO_STRATEGY or AWS_SECRETS_LOCAL_DIR that are pre-configured in your cypress.config.env. This is particularly useful when running tests in different environments (e.g., local development vs CI) where different AWS configurations are required.

To override these variables when running Cypress, use the following command:

npx cypress run -e AWS_SSO_STRATEGY=$NEW_AWS_SSO_STRATEGY,AWS_SECRETS_LOCAL_DIR=$CUSTOM_SECRETS_DIR

$NEW_AWS_SSO_STRATEGY: The new value for the AWS SSO strategy that overrides the default strategy configured in your project.
$CUSTOM_SECRETS_DIR: The directory where you want to store or retrieve AWS secrets locally for reuse across multiple test sessions.

This allows for flexible configuration across different environments, ensuring that secrets and authentication strategies are handled correctly depending on where the tests are executed (e.g., in a CI pipeline or on a developer's machine).

Importing Secrets from a Local File

I understand that allowing users to load secrets from a local file might seem counterintuitive. However, this approach becomes necessary especially when using a cloud provider like AWS, in scenarios involving assume-role chains that are limited to an hour in duration.

When conducting sequential tests, particularly with tools like Cypress that restart and reload environment variables for each new session, obtaining AWS secrets after the initial hour can be cumbersome. This can interrupt testing workflows, especially when secrets are needed across multiple sessions. To mitigate this issue, I’ve added the option for users to specify a AWS_SECRETS_LOCAL_DIR variable.

If AWS_SECRETS_LOCAL_DIR is specified and the temporary file doesn't exist, the plugin will retrieve the secrets during the first session and store them locally. These stored secrets will then be reused in subsequent sessions, eliminating the need to continuously fetch them from AWS after the role chain expires.Every secrets will be saved in a JSON file named by the secret name.

This solution simplifies running multiple test sequences without worrying about refreshing the role or secret access within the limited session time frame.

See here to understand how to use different behavior on CI.

// environment.json
{
  "baseUrl": "https://www.google.com",
  "env": {
    "AWS_SSO_STRATEGY": "strategy_type",
    "AWS_SECRETS_LOCAL_DIR": "aws_secrets_folder",
    "AWS_SECRET_MANAGER_CONFIG": {
      "secretName": "AWS_SECRET_NAME",
      "profile": "AWS_PROFILE_NAME",
      "region": "AWS_REGION",
      "kmsKeyId": "AWS_SECRET_KMS_KEY",
      "pathToCredentials": "PATH_TO_AWS_CREDENTIALS.JSON"
    }
  }
}

Results

Correct configuration

====================================================================================================

Starting plugin: cypress-aws-secrets-manager

AWS SSO strategy: profile

1st attempt: Trying to login into AWS with profile: "AWS_PROFILE_NAME"

AWS SDK credentials are set up correctly!

Extracting secret from: "AWS Secrets Manager"

secret: "{
    "username": "*****",
    "password": "*****"
}"

√ Secret loaded correctly from: "AWS_SECRET_NAME"

====================================================================================================

Silent mode (`ENV_LOG_MODE: 'silent'`)

When you set ENV_LOG_MODE: 'silent', the plugin omits detailed steps and intermediate AWS SDK messages:

====================================================================================================

Starting plugin: cypress-aws-secrets-manager

√ Secret loaded correctly from: "AWS_SECRET_NAME"

====================================================================================================

Missing configuration

Description Cypress started without plugin configurations

====================================================================================================

Starting plugin: cypress-aws-secrets-manager
√ Missing AWS_SECRET_MANAGER_CONFIG, continue without secrets!


====================================================================================================

Wrong configuration

Description secretName & region are mandatory

====================================================================================================

Starting plugin: cypress-aws-secrets-manager

"AWS_SECRET_MANAGER_CONFIG" object MUST contain these mandatory properties: secretName, region
ConfigurationError!

Passed: [
 "profile": "AWS_PROFILE_NAME"
]
Missing: [
 "secretName",
 "region"
]

====================================================================================================

Wrong credentials

Description Your credentials are invalid

====================================================================================================

Starting plugin: cypress-aws-secrets-manager

AWS SSO strategy: "multi"

1st attempt: Trying to login into AWS with profile: "AWS_PROFILE_NAME"

2nd attempt: Trying to login into AWS with profile: "default"

3rd attempt: Trying without specifying credentials

Incorrect plugin configuration!
ERROR: Could not load credentials from any providers

====================================================================================================

Adding Secrets Example

Initial Secret on AWS:

{
  "dbUsername": "admin",
  "apiKey": "someAPIKey"
}

Cypress Test:

// spec.cy.js
describe('Adding Secrets', () => {
  it('should add a new dbPassword', () => {
    cy.task('updateSecret', { dbPassword: 'oldSecurePassword456!' })
  })
})

Resulting Secret:

{
  "dbUsername": "admin",
  "dbPassword": "oldSecurePassword456!",
  "apiKey": "someAPIKey"
}

Updating Secrets Example

Current Secret on AWS:

{
  "dbUsername": "admin",
  "dbPassword": "oldSecurePassword456!",
  "apiKey": "someAPIKey"
}

Cypress Test:

// spec.cy.js
describe('Updating Secrets', () => {
  it('should update the dbPassword', () => {
    cy.task('updateSecret', { dbPassword: 'newSecurePassword456!' })
  })
})

Resulting Secret:

{
  "dbUsername": "admin",
  "dbPassword": "newSecurePassword456!",
  "apiKey": "someAPIKey"
}

Best Practices for AWS Login

When working with AWS, particularly in environments like development and testing, it's essential to ensure that you have authenticated access to your AWS account. Below are some best practices for managing AWS logins effectively, using either AWS SSO or Assume Role methods.

AWS SSO (Single Sign-On)

If your organization uses AWS SSO, you can utilize the following scripts to handle authentication seamlessly:

aws_authenticate.sh This sets the needed environment variables and starts the aws_sso.sh script.
aws_sso.sh This script checks your AWS SSO authentication status and logs you in if you're not already.

AWS IAM (Assume Role)

For users and applications that need to assume roles to access specific AWS resources, use these scripts:

aws_authenticate.sh Sets the needed environment variables and starts the aws_assume_role.sh script.
aws_assume_role.sh Verifies your role assumption and logs you in if you're not already.

Integrating with `package.json`

To streamline your workflow, add these scripts to your package.json:

// package.json
{
  "scripts": {
    "cy:open": "sh aws_authenticate $ENV \"npx cypress open\"",
    "cy:run": "sh aws_authenticate $ENV \"npx cypress run\""
  }
}

Run with:

npm run cy:open

THE JOB IS DONE!

Happy testing to everyone!

ALEC-JS

Name		Name	Last commit message	Last commit date
Latest commit History 50 Commits
.github/workflows		.github/workflows
sh		sh
src		src
test		test
.gitignore		.gitignore
.npmignore		.npmignore
LICENSE.txt		LICENSE.txt
README.md		README.md
index.d.ts		index.d.ts
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json
tasks.js		tasks.js

License

alecmestroni/cypress-aws-secrets-manager

Folders and files

Latest commit

History

Repository files navigation