The "just add water" Cypress + Slack healthcheck reporting tool for your app
Branch: master
Clone or download
Latest commit 588771f Feb 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cypress Add config, tests, readme Feb 11, 2019
utils Add config, tests, readme Feb 11, 2019
.gitignore Add config, tests, readme Feb 11, 2019
LICENSE Initial commit Feb 11, 2019
README.md Update README.md Feb 11, 2019
cypress.json Add config, tests, readme Feb 11, 2019
health-check.json Add config, tests, readme Feb 11, 2019
package-lock.json Add config, tests, readme Feb 11, 2019
package.json Add config, tests, readme Feb 11, 2019

README.md

cypress-healthcheck

The "just add water" Cypress + Slack healthcheck reporting tools for your app.

Why Cypress.io + Slack?

Cypress.io is an amazing and easy to use E2E, integration and service testing tool which lives inside your codebase. Writing tests with Cypress is a breeze, and you can get started really quick.

However, sometimes you just want to check if your production app is alive and kicking, that is, if a user clicks on a certain element does something happen, is the app responsive, are certain critical elements or components present etc.

This is a perfect use case for Cypress and Slack, to help notify you if any production issues occur. Cypress does not have integration with Slack (just yet!), but until their great team builds this for us, you can use this framework to test anything from a simple SPA to a more complex project.

Installation

Simply clone the repo and run:

npm install

Then, create a .env file in your project root, with the Slack Incoming Webhook key:

SLACK_WEBHOOK_KEY="YOUR_SLACK_INCOMING_WEBHOOK_KEY"

How to setup incoming slack webhooks

This demo uses the Vue.js HN clone and mocha-spec-json-output-reporter to output the test results. Feel free to use any other reporter you like.

Usage

You can run this either locally or on your server with a cronjob to automate the tests. To run locally, just do a simple:

npm run healthcheck

Make sure to customize cypress.json to your own needs, and write some more tests in cypress/integration.

Contributing

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

License

MIT