Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

89 lines (61 loc) · 4.81 KB
Raw

Contributing

Questions

Please ask support questions on our Gitter

Issues

You can report bugs or request features on our GitHub issues page

If you submit a bug, please include your machine details (OS, browser version, etc.) and a reproducible set of steps.

Contributing to the Source Code

Before submitting code, please discuss your proposed change on our Gitter or on the corresponding GitHub issue, if one exists already. Another person may be already working on your feature/fix and you may receive valuable feedback.

If your change is accepted, you may open up an issue on GitHub, describe your change in detail, and assign it to yourself.

When you're ready, please open up a pull request (PR) on GitHub. If you don't have push access yet, ask on Gitter and we'll grant it to you.

Thank you for your contribution!

Code rules

  • If your PR changes any behavior or fixes an issue, it should have an associated unit and/or functional test(s)
    • tests/core contains mocha unit tests for smashtest's core functionality
    • tests/highlighting contains a .smash file used to visually inspect syntax highlighting
    • tests/packages contains .smash and mocha tests for the built-in packages: web UI with selenium webdriver and REST API
    • tests/reporter contains .smash files used to visually inspect the live report
    • cli.js and reporter.js are currently manually tested. Please add manual test cases to the corresponding files (see "Manual tests" below)
  • Please include JSDoc for all functions and classes

Running Smashtest locally

  1. Clone the project with git clone https://github.com/smashtestio/smashtest.git
  2. In the top project directory, run node ./src/cli.js where you'd normally run smashtest. This will run your local code instead of the regular Smashtest.

Testing Smashtest locally

Unit tests

  • From the top project directory, run mocha tests/core/*.js tests/packages/*.js
    • Some unit tests are marked skipped. These tests have special requirements and need to be run individually from time to time.
  • For code coverage, install nyc from npm, then run npm test. Reports will be available at
    • /coverage/lcov-report/src/index.html
    • /coverage/lcov-report/packages/js/index.html

Package functional tests

  • Smashtest packages implement the built-in steps that handle browser automation with selenium webdriver, as well as REST APIs
  • Functional tests for these packages are written in smash code itself
  • From the top project directory, run smashtest tests/packages/*.smash --groups=[browsers]
    • Set --groups to the list of browsers you want to test in (e.g., chrome,firefox,safari,ie,edge)

Manual tests

  • cli.js runs the command line prompt, and is currently manually tested. Since this file kicks off all other smashtest-related functions, testing it is also integration testing the whole app.
    • Manual test cases are stored in tests/core/integration.smash (core smash) and tests/packages/integration.smash (integration with packages)
  • reporter.js outputs the live report, and is also currently manually tested
    • To test, run smashtest on individual files in tests/reporter and visually inspect the reports that come out
  • Some unit and functional tests are marked skipped. These tests are run individually from time to time. They each come with a comment with further details. Some of them are performance tests, others interfere with the code coverage tool, and other require a manual verification of a report and/or error.

Running examples

  • Smashtest comes with examples of both UI and API testing
  • The comments at the top of main.smash (in both examples) contain valuable info
  • Run smashtest inside the directory of the example you want to run

Grammars

Grammars provide syntax highlighting in code editors, and are stored in their own GitHub repos:

Please test changes you make to any of the grammars by opening up tests/highlighting/grammartest.smash and visually inspecting it

Important links