gecko-dev/devtools/client/webconsole/test
Nicolas Chevobbe f29e124ad5 Bug 1479521 - Only run browser_jsterm_accessibility.js with old jsterm; r=Honza.
Depends on D2826

Differential Revision: https://phabricator.services.mozilla.com/D2827

--HG--
extra : moz-landing-system : lando
2018-08-13 10:07:00 +00:00
..
chrome Bug 1454696 - Run eslint --fix for prefer-const;r=yulia 2018-06-01 12:36:09 +02:00
components Bug 1454696 - Run eslint --fix for prefer-const;r=yulia 2018-06-01 12:36:09 +02:00
fixtures Bug 1463291: Move docShell getter from Document to Window. r=bz 2018-05-21 16:58:23 -07:00
middleware Bug 1451821 - Move new-console-output content one folder up; r=jdescottes. 2018-04-06 15:03:20 +02:00
mochitest Bug 1479521 - Only run browser_jsterm_accessibility.js with old jsterm; r=Honza. 2018-08-13 10:07:00 +00:00
store Bug 1468989 - Add a longString exception in filter tests; r=Honza. 2018-06-15 11:27:55 -07:00
unit Bug 1454696 - Run eslint --fix for prefer-const;r=yulia 2018-06-01 12:36:09 +02:00
utils Bug 1451821 - Move new-console-output content one folder up; r=jdescottes. 2018-04-06 15:03:20 +02:00
.eslintrc.mocha.js Bug 1451821 - Move new-console-output content one folder up; r=jdescottes. 2018-04-06 15:03:20 +02:00
README.md Bug 1451821 - Move new-console-output content one folder up; r=jdescottes. 2018-04-06 15:03:20 +02:00
helpers.js Bug 1463095 - Instrument inspection of filter changes in the Web Console with event telemetry; r=jdescottes. 2018-07-24 09:55:36 +02:00
mocha-test-setup.js Bug 1470922 - Make sure jsterm tests run in both old and new jsterm; r=bgrins. 2018-07-24 14:41:50 +02:00
moz.build Bug 1451821 - Move new-console-output content one folder up; r=jdescottes. 2018-04-06 15:03:20 +02:00
package.json Bug 1462055 - Fixup mocha test paths for webconsole;r=nchevobbe 2018-05-18 11:33:18 -07:00

README.md

Console Tests

The console panel uses currently two different frameworks for tests:

  • Mochitest - Mochitest is an automated testing framework built on top of the MochiKit JavaScript libraries. It's just one of the automated regression testing frameworks used by Mozilla.

Mochitests are located in devtools/client/webconsole/test/mochitest/ and can be run with the following command:

./mach test devtools/client/webconsole/test/mochitest/

These tests can be run on CI when pushing to TRY. Not all tests are enabled at the moment since they were copied over from the old frontend (See Bug 1400847).

  • Mocha + Enzyme - mocha Mocha is JavaScript test framework running on Node.js Enzyme is a JavaScript Testing utility for React that makes it easier to assert, manipulate, and traverse your React Components' output.

These tests are located in test/components/ and test/store/, and can be run with the following command:

devtools/client/webconsole/test/ && npm install && npm test

or using yarn with

devtools/client/webconsole/test/ && yarn && yarn test

⚠️ These tests are not ran on CI at the moment. You need to run them manually when working on the console. (See Bug 1312823)


The team is leaning towards Enzyme since it's well known and suitable for React. It's also easier to contribute to tests written on top of Enzyme.

Stubs

Many tests depends on fix data structures (aka stubs) that mimic RDP packets that represents Console logs. Stubs are stored in test/fixtures directory and you might automatically generate them.

Append new Console API stubs

See how to generate stubs for Console API calls.

  • Append new entry into consoleApiCommands array. The array is defined in this module: \test\fixtures\stub-generators\stub-snippets.js
  • Generate stubs with existing mochitest: \test\fixtures\stub-generators\browser_webconsole_check_stubs_console_api.js

Run the generator using mach command. ./mach test devtools/client/webconsole/test/fixtures/stub-generators/browser_webconsole_check_stubs_console_api.js --headless

This will override test/fixtures/stubs/consoleApi.js.

Append new CSS Messages stubs

See how to generate stubs for CSS messages.

  • Append new entry into cssMessage map into stub-snippets.js
  • Generate stubs with: browser_webconsole_check_stubs_css_message.js

This will override test/fixtures/stubs/cssMessage.js.

Append new Evaluation Result stubs

See how to generate stubs for evaluation results.

  • Append new entry into evaluationResultCommands map into stub-snippets.js
  • Generate stubs with: browser_webconsole_check_stubs_evaluation_result.js

This will override test/fixtures/stubs/evaluationResult.js.

Append new Network Events stubs

See how to generate stubs for network events

  • Append new entry into networkEvent map into stub-snippets.js
  • Generate stubs with: browser_webconsole_update_stubs_network_event.js

This will override test/fixtures/stubs/networkEvent.js.

Append new Page Error stubs

See how to generate stubs for page errors.

  • Append new entry into pageError array into stub-snippets.js
  • Generate stubs with: browser_webconsole_update_stubs_page_error.js

This will override test/fixtures/stubs/pageError.js.