cypress-failed-log

    2.9.2 • Public • Published

    cypress-failed-log

    Shows the commands from Cypress.io failed test in the terminal.

    NPM

    ci status semantic-release js-standard-style renovate-app badge

    Install

    Add this module as a dev dependency to your project

    npm install --save-dev cypress cypress-failed-log

    Then include this module from your cypress/support/index.js file

    // cypress/support/index.js
    require('cypress-failed-log')

    and in cypress/plugins/index.js file add task failed

    // cypress/plugins/index.js
    module.exports = (on, config) => {
      on('task', {
        failed: require('cypress-failed-log/src/failed')(),
      })
    }

    When Cypress runs, you will see commands including the failed one, right in the terminal

    Failed terminal output

    JSON file

    In addition, all failed commands will be saved into a JSON file. The saved JSON file will live in cypress/logs/ and have the following properties:

    specName - filename of the spec
    title - the name of the test
    suiteName - the parent suite name
    testName - full name of the test, including the suite name
    testError - error message string
    testCommands - array of strings, the last failing command is the last item
    

    Example

    Here is the failed test JSON file contents. The test name, the failure and each test command before the test are recorded

    {
      "specName": "failing-spec.js",
      "title": "loads the About tab",
      "suiteName": "Website",
      "testName": "Website loads the About tab",
      "testError": "Timed out retrying: Expected to find content: 'Join Us' but never did.",
      "testCommands": [
        "visit",
        "new url https://www.company.com/#/",
        "contains a.nav-link, About",
        "click",
        "new url https://www.company.com/#/about",
        "hash",
        "assert expected **#/about** to equal **#/about**",
        "contains Join Us",
        "assert expected **body :not(script):contains(**'Join Us'**), [type='submit'][value~='Join Us']** to exist in the DOM"
      ]
    }

    Debugging

    To turn on debug messages in the browser, open in Cypress browser DevTools console and enter localStorage.debug = 'cypress-failed-log', then reload the spec. You should see log messages.

    Small print

    Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017

    License: MIT - do anything with the code, but don't blame me if it does not work.

    Support: if you find any problems with this module, email / tweet / open issue on Github

    MIT License

    Copyright (c) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i cypress-failed-log

    DownloadsWeekly Downloads

    71,275

    Version

    2.9.2

    License

    MIT

    Unpacked Size

    13.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • bahmutov