cypress-tests

Author: Wusi

javascript-cypress-mailslurp-plugin/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+cypress/videos
+cypress/screenshots

javascript-cypress-mailslurp-plugin/Makefile

@@ -0,0 +1,10 @@
+-include ../.env
+
+node_modules:
+	npm install
+
+dev: node_modules
+	CYPRESS_MAILSLURP_API_KEY=$(API_KEY) npm run dev
+
+test: node_modules
+	CYPRESS_MAILSLURP_API_KEY=$(API_KEY) npm run test

javascript-cypress-mailslurp-plugin/README.md

@@ -0,0 +1,5 @@
+# Cypress MailSlurp plugin example
+How to use MailSlurp with Cypress JS. Loads a demonstration app, signs up with a new email address, receives confirmation code, extracts code and submits. Sees welcome screen.
+
+## Run
+`API_KEY=your-api-key make test`

javascript-cypress-mailslurp-plugin/cypress.json

@@ -0,0 +1,5 @@
+{
+  "requestTimeout": 30000,
+  "responseTimeout": 30000,
+  "defaultCommandTimeout": 30000
+}

javascript-cypress-mailslurp-plugin/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

javascript-cypress-mailslurp-plugin/cypress/integration/integration-test.spec.ts

@@ -0,0 +1,56 @@
+/// <reference types="cypress-mailslurp" />
+describe("user sign up test with mailslurp plugin", function () {
+    // use cypress-mailslurp plugin to create an email address before test
+    before(function () {
+        return cy.mailslurp()
+            .then(mailslurp => mailslurp.createInbox())
+            .then(inbox => {
+                // save inbox id and email address to this (make sure you use function and not arrow syntax)
+                cy.wrap(inbox.id).as('inboxId')
+                cy.wrap(inbox.emailAddress).as('emailAddress')
+            })
+    });
+    it("01 - can load the demo application", function () {
+        // get wrapped email address and assert contains a mailslurp email address
+        expect(this.emailAddress).to.contain("@mailslurp");
+        // visit the demo application
+        cy.visit("https://playground.mailslurp.com")
+        cy.title().should('contain', 'React App');
+    });
+    // use function instead of arrow syntax to access aliased values on this
+    it("02 - can sign up using email address", function () {
+        // click sign up and fill out the form
+        cy.get("[data-test=sign-in-create-account-link]").click()
+        // use the email address and a test password
+        cy.get("[name=email]").type(this.emailAddress).trigger('change');
+        cy.get("[name=password]").type('test-password').trigger('change');
+        // click the submit button
+        cy.get("[data-test=sign-up-create-account-button]").click();
+    });
+    it("03 - can receive confirmation code by email", function () {
+        // app will send user an email containing a code, use mailslurp to wait for the latest email
+        cy.mailslurp()
+            // use inbox id and a timeout of 30 seconds
+            .then(mailslurp => mailslurp.waitForLatestEmail(this.inboxId, 30000, true))
+            // extract the confirmation code from the email body
+            .then(email => /.*verification code is (\d{6}).*/.exec(email.body!!)!![1])
+            // fill out the confirmation form and submit
+            .then(code => {
+                cy.get("[name=code]").type(code).trigger('change');
+                cy.get("[data-test=confirm-sign-up-confirm-button]").click();
+            })
+    });
+    // fill out sign in form
+    it("04 - can sign in with confirmed account", function () {
+        // use the email address and a test password
+        cy.get("[data-test=username-input]").type(this.emailAddress).trigger('change');
+        cy.get("[data-test=sign-in-password-input]").type('test-password').trigger('change');
+        // click the submit button
+        cy.get("[data-test=sign-in-sign-in-button]").click();
+    });
+    // can see authorized welcome screen
+    it("05 - can see welcome screen", function () {
+        // click sign up and fill out the form
+        cy.get("h1").should("contain", "Welcome");
+    });
+});

javascript-cypress-mailslurp-plugin/cypress/plugins/index.js

@@ -0,0 +1,22 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+// eslint-disable-next-line no-unused-vars
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

javascript-cypress-mailslurp-plugin/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

javascript-cypress-mailslurp-plugin/cypress/support/index.js

@@ -0,0 +1,23 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+import "cypress-mailslurp";
+
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')