Image-sequencer: Tests for more modules; starting with QR code module jsqr

[jywarren]

We are starting to grow this library substantially and could really use more tests for specific modules. One example is that this pull request is trying to update jsqr but we don't test that module, so we don't know if that update breaks the module: #532

The test could look something like this one, and be in the same folder; we could use a data-url encoded QR code as test data, and confirm that we get the correct data out of the module!

Here's the module code itself:

https://github.com/publiclab/image-sequencer/tree/main/src/modules/DecodeQr

Once this is done, we could move on to each other module. This would be a great repeat first-timers-only issue!

---

This has been marked as a good candidate for becoming a first-timers-only issue like these, meaning that it's simple, self-contained, and with some extra formatting, could be a great entry point for a new contributor. If you're familiar enough with this code, please consider reformatting or reposting it as a first-timers-only issue, and then ping @publiclab/reviewers to get it labelled. Or, if this is not your first time, try to solve it yourself!

[gitmate[bot]]

GitMate.io thinks possibly related issues are https://github.com/publiclab/image-sequencer/issues/51 (More Testing), https://github.com/publiclab/image-sequencer/issues/71 (Implement QR-Decode Module), https://github.com/publiclab/image-sequencer/issues/141 (move module tests into separate test files), https://github.com/publiclab/image-sequencer/issues/162 (Modify the test to check number of modules), and https://github.com/publiclab/image-sequencer/issues/434 (Rotate module).

[gitmate[bot]]

GitMate.io thinks possibly related issues are https://github.com/publiclab/image-sequencer/issues/51 (More Testing), https://github.com/publiclab/image-sequencer/issues/71 (Implement QR-Decode Module), https://github.com/publiclab/image-sequencer/issues/141 (move module tests into separate test files), https://github.com/publiclab/image-sequencer/issues/162 (Modify the test to check number of modules), and https://github.com/publiclab/image-sequencer/issues/434 (Rotate module).

[VibhorCodecianGupta]

@jywarren I'm on this!
Would love to know if we already have some packages in IS to compare images or their base64 encodings, was thinking of testing the actual functioning of modules against benchmark images.

[Mridul97]

@jywarren @VibhorCodecianGupta We don't have any such package in IS already, was writing the test of brightness module #624 , so there is one issue coming while creating a way of image comparison, the module is returning the output as undefined. Please have a look!

[jywarren]

compare images or their base64 encodings

Sorry, yes we do actually, although we don't use it enough!

looks-same:

https://github.com/publiclab/image-sequencer/blob/81719a9e139e2a144219d354522f8cdf31d55dd3/test/modules/image-manip.js#L33-L37

[jywarren]

Sorry took me a few days, i'm a bit behind!

[VibhorCodecianGupta]

@jywarren looks great. I'll get on to writing some tests right away!

[Mridul97]

@VibhorCodecianGupta I was also working on adding tests, can we collaborate on this one, maybe you can create tests for some modules and I can create for others, Just a suggestion. :smiley:

[VibhorCodecianGupta]

@Mridul97 sounds nice! I think you were working on the brightness module, right? I'll pick up a couple others for the time being, and make a PR. We can proceed accordingly!

[Mridul97]

Sounds good! Yes, I am working on the brightness module!

[aashna27]

@VibhorCodecianGupta @Mridul97 can you specify the modules you are writing tests for ? I would write for the others then.

[VibhorCodecianGupta]

@jywarren added tests at #748 for brightness, invert and contrast modules. image-manip had some code which was buggy and wasn't being used. One of them was the QR code module testing, which was not functioning because the module itself is buggy in the first place. Removed those tests.