cypress-azure-keyvault


A custom Cypress plugin to access recover keys from Microsoft Azure Key Vaults.

Installation

``bash
npm install cypress-azure-keyvault --save-dev
`

or

`bash
yarn add cypress-azure-keyvault --dev
`

Configuring

$3

Register the package's commands for use in your tests on your cypress/support/index.ts (or js file):

`ts
import "cypress-azure-keyvault";
`

And now you need to load the plugin into your cypress/plugins/index.js:

`js
const { azureKeyvaultPlugin } = require("cypress-azure-keyvault");
module.exports = (on, config) => {
// on is used to hook into various events Cypress emits
// config is the resolved Cypress config
return azureKeyvaultPlugin(on, config);
};
`

$3

In order to use the Azure Key Vault plugin, you must store your Azure access information as environment variables (either locally or/and define environment variables on azure).

You can also set it in a .env file (if you are using dotenv-cli package) or into your pipeline (as build variables).

You can find where to generate these values on the Azure Portal.

`bash
export AZURE_CLIENT_ID="generated-app-ID"
export AZURE_CLIENT_SECRET="random-password"
export AZURE_TENANT_ID="tenant-ID"
`

Using the cy.getKeyvaultData()

$3

`ts
// command parameters
interface GetKeyvaultDataOptions {
vault: string; // they keyvault name
keys: string[]; // list of keys that you want to recover
keyPrefix?: string; // a prefix for each key if the key vault is shared or if you prefix your keys by environment (optional)
envSuffix?: string; // identifier for the environment (optional)
}

// command return
interface KeyVaultData {
envSuffix: string;
data: {
[i: string]: string;
};
}
`

$3

#### Without key prefix

`ts
describe("Example Azure Key Vault Flow", () => {
let keysValues;
before(() => {
cy.getKeyvaultData({
vault: 'myAppVault',
keys: ['user', 'password']
}).then(result => (keysValues = result.data));
});

it("should use key vault", () => {
// my login tasks
console.log(keysValues);
// { user: "admin", password: "admin123!" }
})
`

#### With key prefix

`ts
describe("Example Azure Key Vault Flow", () => {
let keysValues;
before(() => {
cy.getKeyvaultData({
vault: 'myAppVault',
keys: ['user', 'password'],
keyPrefix: "production"
}).then(result => (keysValues = result.data));
});

it("should use key vault", () => {
// my login tasks
console.log(keysValues);
// { production-user: "admin", production-password: "!QAWS@##was342" }
})
``