1390077 - Doc: Append new Console API stubs

Status: RESOLVED FIXED

(DevTools :: Console, enhancement)

Description

[Jan Honza Odvarko [:Honza] (always need-info? me)]

I mentioned this last week. It would be nice to have a short readme file describing how to generate new stubs for Console tests...

Comment 1

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Attachment: Bug 1390077 - Add readme about stubs generator instructions;

Review commit: https://reviewboard.mozilla.org/r/168196/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/168196/

Comment 2

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Comment on attachment 8896920 [details]
Bug 1390077 - Add readme about stubs generator instructions;

@Nicolas, what do you think what should be added yet.

I can imagine that we might want to update other places with doc, but for now I am just thinking about a quick and simple readme file available directly in the source dir.

Honza

Comment 3

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 8896920 [details]
Bug 1390077 - Add readme about stubs generator instructions;

https://reviewboard.mozilla.org/r/168196/#review173376

Thanks Honza for doing this.
Looks good overall, only have a couple of comments

::: devtools/client/webconsole/new-console-output/test/README.md:6
(Diff revision 1)
> +* Enzyme - [Enzyme](http://airbnb.io/enzyme/) is a JavaScript Testing utility for React that makes it easier to assert, manipulate, and traverse your React Components' output.
> +
> +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.

We should mention mocha too. I think mocha is the test runner, and Enzyme a utility

::: devtools/client/webconsole/new-console-output/test/README.md:12
(Diff revision 1)
> +
> +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

maybe wrap RDP in <abbr> with a title for what it stands for.

::: devtools/client/webconsole/new-console-output/test/README.md:16
(Diff revision 1)
> +## Append new Console API stubs
> +See how to generate new 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 browser_webconsole_check_stubs_console_api.js`

Looks good, we should have the same for all the types (evaluation results, commands, network, …)

::: devtools/client/webconsole/new-console-output/test/README.md:22
(Diff revision 1)
> +See how to generate new 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`

we should put the entire command maybe : 

./mach test devtools/client/webconsole/new-console-output/test/fixtures/stub-generators/browser_webconsole_check_stubs_console_api.js

Comment 4

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Comment on attachment 8896920 [details]
Bug 1390077 - Add readme about stubs generator instructions;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/168196/diff/1-2/

Comment 5

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Comment on attachment 8896920 [details]
Bug 1390077 - Add readme about stubs generator instructions;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/168196/diff/2-3/

Comment 6

[Jan Honza Odvarko [:Honza] (always need-info? me)]

(In reply to Nicolas Chevobbe [:nchevobbe] from comment #3)
Thanks for the review. All comments resolved.

Honza

Comment 7

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Comment on attachment 8896920 [details]
Bug 1390077 - Add readme about stubs generator instructions;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/168196/diff/3-4/

Comment 8

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 8896920 [details]
Bug 1390077 - Add readme about stubs generator instructions;

https://reviewboard.mozilla.org/r/168196/#review174366

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c7f8cb484807
Add readme about stubs generator instructions; r=nchevobbe

Comment 10

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/c7f8cb484807