P5.js: GSoC 2019: Improve p5.js unit tests

[ihsavru]

I am interested in working on improving the unit tests for p5.js. (I am not quite sure if I should post this on the issue tracker or the forum?) There aren't any existing issues on GitHub which would help me get started with testing. As mentioned in the Project List, this project would start with a survey to understand which areas are in need of unit tests and which are sufficiently covered. I went through the codebase, following are the areas which are missing unit tests:

• core
  
  
  
  • shape/attributes.js
  
  
  • shape/vertex.js
  
  
  • helpers.js
  
  
  • init.js
  
  
  • legacy.js
  
  
  • p5.Graphics.js
  
  
  • p5.Renderer.js
  
  
  • p5.Renderer2D.js
  
  
  • shim.js
  
  
  • transform.js
  
  
• events
• image
  
  
  
  • filters.js
  
  
  • image.js
  
  
  • p5.image.js
  
  
• typography
  
  
  
  • attributes.js
  
  
  • p5.font.js
  
  
• utilities
  
  
  
  • conversion.js
  
  
• WebGL
  
  
  
  • 3d_primitives.js
  
  
  • interaction.js
  
  
  • light.js
  
  
  • loading.js
  
  
  • material.js
  
  
  • p5.Geometry.js
  
  
  • text.js
  
  

I would like others feedback on this! Am I missing something? Please let me know if I can pick up one of these files for creating unit tests, I would love to work on this!

[outofambit]

Hi again @ihsavru! Thanks for this list. If you're interested in working on some of these outside of Google Summer of Code, I can help get you started now! If you have questions about an idea or need guidance on forming your proposal for Google Summer of Code, please post to the Processing Forum. Thanks!

[ihsavru]

@outofambit Sure, I would like to work on this. How can I get started?

[outofambit]

@ihsavru awesome! 😄 Looking at the list above, I think a good place to start is modeAdjust(). Lets work towards having a PR with tests for that function.

Some background on our unit testing framework:

• you can run the unit tests with npm test
• we use mocha for structuring and running the unit tests
• we use chai's assert to write individual statements about how code should behave
• the color conversion unit tests are a good example to reference

Take a look at that, and let me what questions you have :)

[ihsavru]

@outofambit how do i run an individual test?

[sanketsingh24]

you can easily do it by appending .only on suite or test.

[outofambit]

you can easily do it by appending .only on suite or test.

yeah i think that's the easiest approach! we just have to be careful not to commit the .only.

for example:

suite.only('color/p5.ColorConversion', function() {

[ihsavru]

@outofambit What do I work on next? :)

[ihsavru]

Hi @outofambit, I created my first draft proposal for this project, I looking forward to some feedback from you. It would be great if you could review it 😅

[outofambit]

@ihsavru how about conversion.js or add some more tests for the keyboard events? (@Ajayneethikannan just added the first one last week!)

[chrisorban]

Hey @ihsavru and @outofambit can we get this pull request for the iPad external keyboard sorted out before we add a keyboard unit test?

https://github.com/processing/p5.js/pull/3286

This is the second oldest pull request on p5 now.