npmpackage.info

Gathering detailed insights and metrics for cypress-mailosaur

cypress-mailosaur

Mailosaur email and SMS testing commands for Cypress

2.16.0

MIT

JavaScript

10,812,952 2.8

Installations

npm install cypress-mailosaur

Pull Requests

Open

0

Total

54

Closed

44

Merged

10

Issues

Open

0

Total

21

Closed

21

Releases

2.16.0

Published on 30 Sept 2024

2.15.0

Published on 12 Jun 2024

2.14.0

Published on 15 Sept 2023

2.13.0

Published on 13 Oct 2022

2.12.0

Published on 06 Sept 2022

2.11.0

Published on 25 Jul 2022

View all 40 releases

Developer

mailosaur

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= v10.0.0

Typescript Support

Yes

Node Version

18.13.0

NPM Version

8.19.3 Statistics

82 Stars

110 Commits

9 Forks

2 Watching

1 Branches

7 Contributors

Updated on 11 Nov 2024

Languages

JavaScript (97.66%)

CSS (1.25%)

HTML (1.09%)

Total Downloads

Cumulative downloads

Total Downloads

10,812,952

Last day

-16.8%

17,643

Compared to previous day

Last week

-9%

98,807

Compared to previous week

Last month

7.7%

437,442

Compared to previous month

Last year

33.6%

4,507,479

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

cypress

Dev Dependencies

@babel/eslint-parser @babel/preset-react @types/node babel-eslint coveralls eslint eslint-config-airbnb-base eslint-plugin-import eslint-plugin-jest jest sinon typescript

Versions

Mailosaur Cypress Commands

Test email and SMS messages with Cypress

Using Cypress and Mailosaur together you can:

Test email, with unlimited test email addresses
Test SMS messages
Capture emails with your very own fake SMTP servers

What is Mailosaur?

Mailosaur is a service that lets you automate email testing (e.g. email verification, password resets, etc.) and SMS testing (e.g. one-time passwords).

Mailosaur also provides dummy SMTP servers to test with; allowing you to catch email in staging environments - preventing email being sent to customers by mistake.

How do I test email with Cypress?

Follow these steps to start testing email with Cypress:

Step 1 - Installation

Install the Mailosaur commands via npm or yarn:

1npm i -D cypress-mailosaur
2# or
3yarn add -D cypress-mailosaur

Once downloaded, add the following line to cypress/support/e2e.js (or cypress/support/index.js in older versions of Cypress) to import the commands into your Cypress project:

1require('cypress-mailosaur');

Step 2 - API Authentication

Mailosaur commands need your Mailosaur API key to work. You can learn about managing API keys here.

Add API key to `cypress.config.js`

1module.exports = defineConfig({
2  env: {
3    MAILOSAUR_API_KEY: "your-key-here",
4  },
5
6  // ...
7});
8

Alternatively, set API key via a system environment variable

To set the environment variable on your machine, it needs to be prefixed with either CYPRESS_ or cypress_.

1export CYPRESS_MAILOSAUR_API_KEY=your-key-here

Step 3 - Write your email test

For this example, we'll navigate to a password reset page, request a new password link (sent via email), and get that email.

Create a new test spec:

1touch cypress/e2e/password-reset.cy.js

Now edit the file to something like this:

1describe('Password reset', () => {
2    const serverId = 'abcd1234'
3    const serverDomain = 'abcd1234.mailosaur.net'
4    const emailAddress = 'password-reset@' + serverDomain
5
6    it('Makes a Password Reset request', () => {
7        cy.visit('https://github.com/password_reset')
8        cy.title().should('equal', 'Forgot your password?')
9        cy.get('#email_field').type(emailAddress)
10    })
11
12    it('Gets Password Reset email from Mailosaur', () => {
13        cy.mailosaurGetMessage(serverId, {
14            sentTo: emailAddress
15        }).then(email => {
16            expect(email.subject).to.equal('Reset your password');
17            passwordResetLink = email.text.links[0].href;
18        })
19    })
20
21    it('Follows the link from the email', () => {
22        const validPassword = 'delighted cheese jolly cloud'
23
24        cy.visit(passwordResetLink)
25        cy.title().should('contain', 'Change your password')
26        cy.get('#password').type(validPassword)
27        cy.get('#password_confirmation').type(validPassword)
28        cy.get('form').submit()
29    })
30})

Step 4 - Write further test cases

You can test pretty much anything with Mailosaur and Cypress, including:

For more information, check out the full Mailosaur docs for the most up-to-date guides and troubleshooting tips.

How do I test SMS with Cypress?

Mailosaur Team, Premium, and Ultimate customers can perform SMS tests with Cypress, whilst Trial account users can just ask support to enable this feature to try it out!

SMS testing works in just the same way as email testing above. However rather than dealing with email addresses, you search using phone numbers instead. For example:

1cy.mailosaurGetMessage(serverId, {
2    sentTo: '447555111222'
3}).then(sms => {
4    expect(sms.text.body).to.equal('Your OTP code is: 123456')
5})

Development

Install all development dependencies:

1cd test/react-app
2npm i
3cd ../../
4npm i

The test suite requires the following environment variables to be set:

1export CYPRESS_MAILOSAUR_API_KEY=your_api_key
2export CYPRESS_MAILOSAUR_SERVER=server_id

Run all tests:

1npm test

Contacting us

You can get us at support@mailosaur.com

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/publish.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/mailosaur/cypress-mailosaur/publish.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:36
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:65
Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:21
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 1 out of 4 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

cypress-mailosaur

Installations

Pull Requests

0

54

44

10

Issues

0

21

21

Releases

Developer

Developer Guide

CommonJS

>= v10.0.0

Yes

18.13.0

8.19.3

Statistics

Languages

Total Downloads

10,812,952

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

Mailosaur Cypress Commands

Test email and SMS messages with Cypress

What is Mailosaur?

How do I test email with Cypress?

Step 1 - Installation

Step 2 - API Authentication

Add API key to cypress.config.js

Alternatively, set API key via a system environment variable

Step 3 - Write your email test

Step 4 - Write further test cases

How do I test SMS with Cypress?

Development

Contacting us

10

10

10

1

0

0

0

0

0

0

0

0

2.8

/10

Add API key to `cypress.config.js`