1571365 - node tests aren't documented

Status: RESOLVED FIXED

(DevTools :: General, task, P3)

Description

[Alexandre Poirot [:ochameau]]

When you get a failure on any kind of node tests, and as there is no integration in mach test, you have to figure out on your own how to run these tests locally.

We should have each of them documentated in our docs over here:
https://docs.firefox-dev.tools/tests/
https://searchfox.org/mozilla-central/search?q=&path=devtools%2Fdocs%2Ftests%2F

And at least document how to run them. Documenting what they are, how to write a new one or understand one could easily be referred to an external doc.

Comment 1

[Julian Descottes [:jdescottes]]

FYI, there are README files in several of the jest test folders.
https://searchfox.org/mozilla-central/source/devtools/client/aboutdebugging-new/test/jest/README.md

https://searchfox.org/mozilla-central/search?path=&q=jest%2FREADME.md

Comment 2

[Julian Descottes [:jdescottes]]

I will write something

Comment 3

[Ola Gasidlo [:ogasidlo] [:ola] OOO - please ping :ladybenko:]

I'm working on some documentation for https://docs.firefox-dev.tools/tests/ right now and want to submit the patch this week.
https://gist.github.com/zoepage/5720bbcccd7e6c898376062598976b2a This is what I have so far.

Any question / topic you'd like to add?

Comment 4

[Alexandre Poirot [:ochameau]]

Note that this isn't only about jest. I got a failure on flow in the debugger and it isn't clear how to run this locally, nor on try.
https://treeherder.mozilla.org/#/jobs?repo=autoland&selectedJob=259543418&revision=ec73bc656bd32edaae68a1bf7f93667bd0a2b57b&searchStr=linux%2Cx64%2Copt%2Cnode%2Ctests%2Csource-test-node-debugger-tests%2Cnode%28debugger%29

But any progress made on this is great :)

Comment 5

[Julian Descottes [:jdescottes]]

Attachment: Bug 1571365 - Add documentation for devtools node tests

Comment 6

[Julian Descottes [:jdescottes]]

(In reply to Ola Gasidlo [:ogasidlo] [:ola] from comment #3)

I'm working on some documentation for https://docs.firefox-dev.tools/tests/ right now and want to submit the patch this week.
https://gist.github.com/zoepage/5720bbcccd7e6c898376062598976b2a This is what I have so far.

Any question / topic you'd like to add?

Your documentation looks great and in-depth, I'm still proposing a shorter overview of what are our tests, how to run them on try and locally. I think both documentations can live side by side.

(In reply to Alexandre Poirot [:ochameau] from comment #4)

Note that this isn't only about jest. I got a failure on flow in the debugger and it isn't clear how to run this locally, nor on try.
https://treeherder.mozilla.org/#/jobs?repo=autoland&selectedJob=259543418&revision=ec73bc656bd32edaae68a1bf7f93667bd0a2b57b&searchStr=linux%2Cx64%2Copt%2Cnode%2Ctests%2Csource-test-node-debugger-tests%2Cnode%28debugger%29

But any progress made on this is great :)

Ah yes, the debugger non-Jest node stuff is tricky if you don't know how to run them. Modified the patch to mention the correct command to run everything, not just jest.

Comment 7

[Ola Gasidlo [:ogasidlo] [:ola] OOO - please ping :ladybenko:]

:jdescottes

Your documentation looks great and in-depth, I'm still proposing a shorter overview of what are our tests, how to run them on try and locally. I think both documentations can live side by side.

Agreed! :) Do you want to do the shorter version and I do the longer one and we add us for reviews? :)

Comment 8

[Julian Descottes [:jdescottes]]

(In reply to Ola Gasidlo [:ogasidlo] [:ola] from comment #7)

:jdescottes

Your documentation looks great and in-depth, I'm still proposing a shorter overview of what are our tests, how to run them on try and locally. I think both documentations can live side by side.

Agreed! :) Do you want to do the shorter version and I do the longer one and we add us for reviews? :)

Sounds good! We can leave open this bug and you can reuse it for the longer version.

Comment 9

[Ola Gasidlo [:ogasidlo] [:ola] OOO - please ping :ladybenko:]

Perfect, thank you!

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/effd1e33b556
Add documentation for devtools node tests r=Ola

Comment 11

[Andrei Ciure[:aciure]]

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

Comment 12

[Alexandre Poirot [:ochameau]]

Thanks for the doc, I looked at them online https://docs.firefox-dev.tools/tests/node-tests.html and that reply to the original questions I was having!