cypress-maildev

    1.1.0 • Public • Published

    Cypress Maildev

    Cypress Maildev is a bunch of Cypress commands in order to test your messages (SMS and Emails) by using Maildev REST API.

    CI npm version

    Installation

    npm install cypress-maildev --save-dev
    yarn add cypress-maildev --dev

    Usage

    1. Register the plugin :

    // cypress/support/index.js
    
    require('cypress-maildev');

    2. Specify your maildev address

    By default, Maildev API is started at the http://localhost:1080. If you are using default maildev instace, you have nothing to configure.

    You can also use env vars in your cypress.json as below :

    // cypress/cypress.json
    
    {
      "env": {
        "MAILDEV_PROTOCOL": "http",
        "MAILDEV_HOST": "localhost",
        "MAILDEV_SMTP_PORT": "1025",
        "MAILDEV_API_PORT": "1080"
      }
    }

    For example, by using like this project a docker compose with cypress and maildev containers, you have to configure your cypress.json like this:

    {
      "env": {
        "MAILDEV_PROTOCOL": "http",
        "MAILDEV_HOST": "maildev",
        "MAILDEV_SMTP_PORT": "25",
        "MAILDEV_API_PORT": "80"
      }
    }

    Check the Maildev REST API documentation for what you can expect in responses.

    Commands

    Usage

    All of theses commands use directly cy.request() which return a Cypress Promise like. Check the doc !

    Using one of this commands must be like this example :

      cy.maildevGetLastMessage().then((email) => {
        expect(email.subject).to.equal("I'm the last email sent !");
      });

    For more examples you can check directly the test file.

    Documentation

    Get all messages received in the Maildev instance.

    cy.maildevGetAllMessages()

    Get the last message received.

    cy.maildevGetLastMessage()

    Each messages got an internal ID. If you know it, you can find it directly.

    cy.maildevGetMessageById(id: String)

    You can also directly access to the HTML of your email by calling.

    cy.maildevVisitMessageById(id: String)

    And you can use Cypress promise to manipulate or assert the DOM of your email :

      cy.maildevVisitMessageById(id: String);
      cy.get('body h1').should('have.text', 'Email incoming !');
      cy.get('body a').should('exist').and('have.text', 'click on this link');

    You must have to specify "chromeWebSecurity": false, because you will access to another domain than your app. Unfortunately, Cypress can't deactivate the cross-origin requests for Firefox actually.


    Get all messages and find one by containing a specific subject. It's a simple string detection case-sensitive.

    cy.maildevGetMessageBySubject(subject: String)

    Get all messages and find the last containing a sent to address. Use a strict string comparison.

    cy.maildevGetMessageBySentTo()

    Delete a message by giving the ID. In can be useful if you to only keep message that you haven't read yet.

    cy.maildevDeleteMessageById()

    Delete all message in order to flush your mailbox !

    cy.maildevDeleteAllMessages()

    Get an OTP code from a string. It can be used outside of maildev box because it doesn't use maildev API but generally OTP code are sent by messages. This function find in a string a specific amount of digits (default 6).

    cy.maildevGetOTPCode(string, digits = 6)

    Or use with another maildev command

      cy.maildevGetMessageBySubject("Your code").then(message => {
        cy.maildevGetOTPCode(message.text).then(code => {
          // Do something with the code
        });
      });

    Simple test command that return true if Maildev is opened.

    cy.maildevHealthcheck()

    Contributing

    Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

    • Clone the repo

    • Install dependencies: make install

    • Start maildev: make start

    Please make sure to update tests as appropriate and run make test command

    License

    MIT

    Install

    npm i cypress-maildev

    DownloadsWeekly Downloads

    2,739

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    20 kB

    Total Files

    22

    Last publish

    Collaborators

    • clebiez