add-examples

Author: jackmahoney

Makefile

@@ -12,10 +12,13 @@ copy:
 deploy: build copy
 	git push ci master
 
+template-readme:
+	DEBUG=script* npm run readme
+
 build-shortcodes:
 	DEBUG=script* npm run shortcodes
 
 sync-shortcodes:
 	aws s3 sync shortcodes/ s3://api-spec.mailslurp.com/shortcodes-github --exact-timestamps
 
-publish: build-shortcodes sync-shortcodes
+publish: build-shortcodes sync-shortcodes template-readme

README.md

@@ -6,69 +6,49 @@ This repository contains examples of [MailSlurp](https://www.mailslurp.com) usag
 
 See developer page for [more guides and documentation](https://www.mailslurp.com/developers/). If you notice an issue in the examples please open an issue, pull request, or [contact support](https://www.mailslurp.com/support/).
 
-### Featured projects
-
-| Project |
-| --- |
-| [Cypress JS Email Test](./javascript-cypress-js) | 
-| [Cypress Mailslurp Plugin Email Test](./javascript-cypress-mailslurp-plugin) | 
-| [Jest Puppeteer Email Test](./javascript-jest-puppeteer) | 
-| [Testcafe Email Test](./javascript-testcafe) | 
-| [Webdriver WDIO Email Test](./javascript-webdriver-io) | 
-
-## Example projects
-
-### Golang
-
-|---------|
-| Project | 
-| --- | 
-| [Golang Email Test](./golang-email-test) |
-
-
-### C\# (DotNet)
-
-|---------|
-| Project | 
-| --- | 
-| [.NET 2.1 Selenium](./csharp-dotnet-core2-selenium) | 
-| [.NET Core 3](./csharp-dotnet-core3) | 
-| [.NET Core 5 Specflow Selenium](./csharp-specflow-mstest-selenium) | 
-
-### Javascript / Typescript
-
-|---------|
-| Project | 
-| --- | 
-| [Axios Email Test](./javascript-axios) | 
-| [Codecept JS Email Test](./javascript-codecept-js) |
-| [Cypress JS Email Test](./javascript-cypress-js) | 
-| [Cypress Mailslurp Plugin Email Test](./javascript-cypress-mailslurp-plugin) | 
-| [Jest Puppeteer Email Test](./javascript-jest-puppeteer) |
-| [Testcafe Email Test](./javascript-testcafe) | 
-| [Webdriver WDIO Email Test](./javascript-webdriver-io) |
-
-### PHP 
-
-|---------|
-| Project | Test status |
-| --- | --- | 
-| [PHP Composer PHPUnit](./php-composer-phpunit) | ![php-composer-phpunit](https://github.com/mailslurp/examples/actions/workflows/php-composer-phpunit.yml/badge.svg?branch=master) |         
-
-### Python
-
-|---------|
-| Project | 
-| --- | 
-| [Python2 PyTest](./python2-pytest) | 
-| [Python3 Robot Framework](./python3-robotframework) | 
-
-### Ruby
-
-|---------|
-| Project | 
-| --- | 
-| [Ruby RSpec email test](./ruby-rspec) |
+## Projects
+
+- [csharp-dotnet-core2-selenium](/csharp-dotnet-core2-selenium)
+- [csharp-dotnet-core3](/csharp-dotnet-core3)
+- [csharp-smtp-client-xunit](/csharp-smtp-client-xunit)
+- [csharp-specflow-mstest-selenium](/csharp-specflow-mstest-selenium)
+- [dart-email-testing](/dart-email-testing)
+- [deno-email-api](/deno-email-api)
+- [elixir-phoenix-hound](/elixir-phoenix-hound)
+- [fsharp-email-mstest](/fsharp-email-mstest)
+- [golang-email-test](/golang-email-test)
+- [java-gradle-junit5](/java-gradle-junit5)
+- [java-maven-junit4](/java-maven-junit4)
+- [java-maven-selenium](/java-maven-selenium)
+- [java-serenity-jbehave](/java-serenity-jbehave)
+- [java-spring-boot](/java-spring-boot)
+- [java-testng-selenium](/java-testng-selenium)
+- [javascript-axios](/javascript-axios)
+- [javascript-codecept-js](/javascript-codecept-js)
+- [javascript-cypress-js](/javascript-cypress-js)
+- [javascript-cypress-mailslurp-plugin](/javascript-cypress-mailslurp-plugin)
+- [javascript-jest-puppeteer](/javascript-jest-puppeteer)
+- [javascript-testcafe](/javascript-testcafe)
+- [javascript-webdriver-io](/javascript-webdriver-io)
+- [kotlin-email-test-example](/kotlin-email-test-example)
+- [nim-unittests](/nim-unittests)
+- [nodejs-nodemailer-smtp-example](/nodejs-nodemailer-smtp-example)
+- [nodejs-smtp-email-attachments-test](/nodejs-smtp-email-attachments-test)
+- [php-codeception-acceptance](/php-codeception-acceptance)
+- [php-composer-phpunit](/php-composer-phpunit)
+- [php-laravel-email-examples](/php-laravel-email-examples)
+- [playwright-email-testing](/playwright-email-testing)
+- [playwright-sms-testing](/playwright-sms-testing)
+- [python2-pytest](/python2-pytest)
+- [python3-robotframework](/python3-robotframework)
+- [ruby-capybara-cucumber-selenium](/ruby-capybara-cucumber-selenium)
+- [ruby-cucumber-test](/ruby-cucumber-test)
+- [ruby-rspec](/ruby-rspec)
+- [rust-selenium-email-testing](/rust-selenium-email-testing)
+- [sendgrid](/sendgrid)
+- [shortcodes](/shortcodes)
+- [swift-email-smtp-examples](/swift-email-smtp-examples)
+- [visualbasic](/visualbasic)
 
 ## Running locally
 If you wish to run these examples yourself:

README.tpl.md

@@ -0,0 +1,22 @@
+# MailSlurp Examples 📨
+
+> Create email addresses on demand then send and receive emails in code and tests. Test apps end-to-end with *real* email addresses
+
+This repository contains examples of [MailSlurp](https://www.mailslurp.com) usage with a range of different languages and frameworks. See the `README.md` or `Makefile` in each module for more information.
+
+See developer page for [more guides and documentation](https://www.mailslurp.com/developers/). If you notice an issue in the examples please open an issue, pull request, or [contact support](https://www.mailslurp.com/support/).
+
+## Projects
+
+{{#topLevelDirs}}
+- [{{.}}](/{{.}})
+{{/topLevelDirs}}
+
+## Running locally
+If you wish to run these examples yourself:
+- clone the repository. 
+- create an `.env` file in the root directory containing `API_KEY=your-mailslurp-api-key`. 
+- to run an example `cd` into the directory and run `make test` or `API_KEY=your-api-key make test`.
+
+## CI
+Examples are tested with each major release and on a schedule using Github actions and CircleCI.

javascript-cypress-mailslurp-plugin/README.md

@@ -2,4 +2,80 @@
 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`
+`API_KEY=your-api-key make test`
+
+## Example test
+
+```typescript
+/// <reference types="cypress-mailslurp" />
+
+describe("user sign up test with mailslurp plugin", function () {
+    //<gen>cypress_plugin_before
+    // use cypress-mailslurp plugin to create an email address before test
+    before(function () {
+        cy.log("Wrap inbox before test")
+        return cy.mailslurp()
+            .then(mailslurp => mailslurp.createInbox())
+            .then(inbox => {
+                cy.log(`Inbox id ${inbox.id}`)
+                // 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')
+            })
+    });
+    //</gen>
+    //<gen>cypress_plugin_01
+    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');
+    });
+    //</gen>
+    //<gen>cypress_plugin_02
+    // 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();
+    });
+    //</gen>
+    //<gen>cypress_plugin_03
+    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();
+            })
+    });
+    //</gen>
+    //<gen>cypress_plugin_04
+    // 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();
+    });
+    //</gen>
+    //<gen>cypress_plugin_05
+    // 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");
+    });
+    //</gen>
+});
+```

javascript-cypress-mailslurp-plugin/README.tpl.md

@@ -0,0 +1,9 @@
+# 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`
+
+## Example test
+
+{{{<gen_typescript_cypress_plugin_full>}}}

package-lock.json

@@ -5,9 +5,12 @@
     "ts-node": "^10.9.1"
   },
   "scripts": {
-    "shortcodes": "node --loader ts-node/esm shortcodes.ts"
+    "shortcodes": "node --loader ts-node/esm shortcodes.ts",
+    "readme": "node --loader ts-node/esm readme.ts"
   },
   "devDependencies": {
-    "@types/debug": "^4.1.7"
+    "@types/debug": "^4.1.7",
+    "@types/mustache": "^4.2.1",
+    "mustache": "^4.2.0"
   }
 }

package.json

@@ -0,0 +1,34 @@
+import debug from "debug";
+import * as fs from "fs";
+import {join} from "path";
+import glob from "fast-glob";
+import Mustache from "mustache";
+const log = debug("scripts/readme");
+
+(async function() {
+    log("Run readme")
+    const gitignoreLines = (await fs.promises.readFile(join(__dirname, "/.gitignore"))).toString().split("\n").filter(it => it).sort()
+    const topLevelDirs = await glob([join(__dirname,'/*')], {onlyDirectories:true, ignore: gitignoreLines})
+    const readmes = await glob([join(__dirname, "/**/README.tpl.md")])
+    const data: {[key:string]: any} = {
+        topLevelDirs: topLevelDirs.map(it => it.split('/').slice(-1)[0])
+    }
+    const shortcodes = await glob([join(__dirname, '/shortcodes/gen*.html')])
+    for (const shortcode of shortcodes) {
+        const endpart = shortcode.split("/").slice(-1)[0]
+        const key = '<' + endpart.replace('.html','') + '>';
+        data[key] = (await fs.promises.readFile(shortcode)).toString()
+    }
+    for (const readme of readmes) {
+        const readmeContent = (await fs.promises.readFile(readme)).toString()
+        const content = Mustache.render(readmeContent, data);
+        const newPath = readme.replace('.tpl', '')
+        log("Writing new template " + newPath)
+        await fs.promises.writeFile(newPath, content)
+    }
+})().catch((err) => {
+    log(`ERROR: ${err}`, err);
+    process.exit(1);
+});
+
+export {};