Ml5-library: Unit Testing and CI

Created on 31 Jan 2018 · 11Comments · Source: ml5js/ml5-library

As briefly discussed with @shiffman, this project should at some point have a testing framework and CI

devops feature request good first issue help wanted

Source

cvalenzuela

👍2

Most helpful comment

commits af5d848 and 5f31edc added support for Jest and a short description in the CONTRIBUTING.md guide on how to run and create tests.

There's also a new description for the website in CONTRIBUTING.md

We can now start creating unit test.

Next steps will be to implement CI and better merging and branching practices.

cvalenzuela on 5 Feb 2018

👍2

All 11 comments

I have been learning jest for a video about "continuous integration" so would be glad to participate in helping get this started!

shiffman on 31 Jan 2018

just chiming in to give encouragement for this—a test framework and CI makes it so much easier for people to contribute to an open source project.

aparrish on 31 Jan 2018

👍2

Let's discuss tomorrow! Maybe I can do a quick tutorial as practice for my video tutorial and anyone who wants to could work on it at the meeting.

shiffman on 31 Jan 2018

sounds good!

cvalenzuela on 31 Jan 2018

Making a list of tests:

[ ] for utils.js test correct image output for a given input.
[ ] test models -- squeezenet

to be continued. . . .

shiffman on 1 Feb 2018

commits af5d848 and 5f31edc added support for Jest and a short description in the CONTRIBUTING.md guide on how to run and create tests.

There's also a new description for the website in CONTRIBUTING.md

We can now start creating unit test.

Next steps will be to implement CI and better merging and branching practices.

cvalenzuela on 5 Feb 2018

👍2

Wonderful, I just did a video tutorial series about testing and CI (with jest and CircleCI). When those are published I can include that as material for getting started contributing. . .

shiffman on 5 Feb 2018

👍1

As a matter of update CircleCI is now integrated with #50. We'll certainly want more tests but we're off and running! I'll leave this open for now but we can eventually transition to individual issues for tests.

shiffman on 9 Feb 2018

🎉1

We are considering switching from Jest to Karma. (And maybe from CircleCI to TravisCI?) Jest doesn't seem particularly well suited for browser libraries (but I could be wrong!). Deeplearn.js uses Karma and Travis so mirroring their workflow makes a lot of sense. (Big thanks to @dariusk for all of the thoughts and advice about this today!)

Tagging @nsthorat and @dsmilkov for any thoughts from their experience.

shiffman on 1 Mar 2018

I don't know much about Jest, but Karma + Jasmine have worked great for us. Works great with travis + browserstack (if you want to run tests on real devices for free).