Change testing framework from Mocha to Jest #719

pradeepnschrodinger · 2024-03-30T21:09:39Z

Description

I'm replacing Mocha with Jest.

Motivation and Context

Jest vs Mocha

Jest already comes packed with assertions, stubs, mocks, and snapshot testing features.
I'm planning to add some snapshot testing later, and maintaining two testing frameworks seem like a pain.

With Mocha, we also had to add Chai and Sinon to the stack.
Morever, it doesn't support snapshot testing out of the box.

Security vulnerabilities

I also had trouble fixing security issues cause of mocha-webpack and mocha-loader, cause they haven't released newer versions in a while.
We've also been using a beta version of mocha-webpack which doesn't work with newer versions of mocha...
And I don't think anyones been using these cause they appear broken since forever...

A bonus is that the following vulnerability should now be resolved since mocha will be removed.

flat vulnerable to Prototype Pollution
mocha@6.2.3 requires flat@^4.1.0 via yargs-unparser@1.6.0
The earliest fixed version is 5.0.1.

Severity: Critical (9.8 / 10)

Extra changes

I've bumped up the node versions in our CI workflow from [12, 14, 16] to [14, 16, 18, 20].
Node v12 reached EoL on 2022, and v14 reach EoL last year.

How Has This Been Tested?

Ran yarn run test and verified all tests pass.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.

wiz-inc-87ff8274df · 2024-03-30T21:10:01Z

Wiz Scan Summary


IaC Misconfigurations
Vulnerabilities
Sensitive Data
Total
Secrets

pradeepnschrodinger · 2024-03-30T21:11:37Z

.github/workflows/build-and-run-tests.yml

@@ -18,7 +18,7 @@ jobs:
    # run this job for every combination of given matrix variables
    strategy:
      matrix:
-        node-version: [12.x, 14.x, 16.x]


12 is pretty old. Kicked it out, and included 18 and 20 in its place.

pradeepnschrodinger · 2024-03-30T21:13:00Z

test/FixedDataTableRoot-test.js

@@ -1,8 +1,7 @@
 /**
 * Copyright Schrodinger, LLC
 */
-import { assert } from 'chai';


assertions are included in jest's expect

pradeepnschrodinger · 2024-03-30T21:13:33Z

test/FixedDataTableRoot-test.js

@@ -1,8 +1,7 @@
 /**
 * Copyright Schrodinger, LLC
 */
-import { assert } from 'chai';
-import sinon from 'sinon';


mocks/spies are included in jest

pradeepnschrodinger · 2024-03-30T21:29:50Z

test/FixedDataTableRoot-test.js

@@ -33,7 +46,7 @@ describe('FixedDataTableRoot', function () {
      renderer.render(table);
      let tableRender = renderer.getRenderOutput();

-      assert.isTrue(isElement(tableRender));
+      expect(isElement(tableRender)).toBe(true);


Here and elsewhere: assert() calls are replaced with expect() calls

pradeepnschrodinger · 2024-03-30T21:30:38Z

test/FixedDataTableRoot-test.js

        renderTable({ scrollLeft: undefined });
-      });
+      }).not.toThrow();


expect(...).not lets you negate the expectations

pradeepnschrodinger · 2024-03-30T21:31:28Z

webpack.config-test.js

Removed cause it doesn't work and also cause it relies on mocha-loader

pradeepnschrodinger · 2024-03-30T21:32:50Z

build_helpers/test-globals.js

This file isn't needed anymore because we have jest-environment-jsdom, which setups a DOM environment for our tests.

karry08 · 2024-04-09T10:05:48Z

what is this wiz scan summary

karry08 · 2024-04-09T09:30:47Z

test/FixedDataTableRoot-test.js

-      assert.equal(
-        table.getTableState().scrollX,
-        300,
-        'should set scrollX to 300'


no way to pass this parameter?

Ah good catch.
Unfortunately there doesn't seem to be a clean and simple enough native way in JEST to do this.

There's some workarounds in https://stackoverflow.com/a/68332874, like wrapping the individual checks inside another it like it("should set scrollX to 300"), or to use the https://github.com/mattphillips/jest-expect-message package.

But they all seem like an overkill at this point.
We can look into this in a separate PR if anyone reports they're missing the custom error messages.

karry08 · 2024-04-09T10:06:15Z

lgtm

pradeepnschrodinger · 2024-04-11T00:13:42Z

Released with v2.0.9.

pradeepnschrodinger added 5 commits March 30, 2024 17:42

Initial replacement of mocha/sinon with jest

99463c7

Migrate ReactTouchHandler-test

d8bcc52

Migrate rest of the tests to jest

fb3efee

Bump node versions

cf77f85

Update test runner scripts

37c111b

pradeepnschrodinger requested review from AmanGupta2708 and karry08 March 30, 2024 21:09

pradeepnschrodinger requested review from abhisheksingh2410, mycrobe and novakps March 30, 2024 21:10

pradeepnschrodinger assigned karry08 Mar 30, 2024

Simplify jest.setup.js

f9a3857

pradeepnschrodinger commented Mar 30, 2024

View reviewed changes

pradeepnschrodinger added the tests label Mar 30, 2024

karry08 reviewed Apr 9, 2024

View reviewed changes

pradeepnschrodinger merged commit 134b18b into master Apr 10, 2024
12 checks passed

pradeepnschrodinger deleted the jest-testing branch April 10, 2024 23:50

pradeepnschrodinger added the dependencies Pull requests that update a dependency file label Apr 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change testing framework from Mocha to Jest #719

Change testing framework from Mocha to Jest #719

pradeepnschrodinger commented Mar 30, 2024 •

edited

Loading

wiz-inc-87ff8274df bot commented Mar 30, 2024 •

edited

Loading

pradeepnschrodinger Mar 30, 2024

pradeepnschrodinger Mar 30, 2024

pradeepnschrodinger Mar 30, 2024

pradeepnschrodinger Mar 30, 2024

pradeepnschrodinger Mar 30, 2024

pradeepnschrodinger Mar 30, 2024

pradeepnschrodinger Mar 30, 2024

karry08 commented Apr 9, 2024

karry08 Apr 9, 2024

pradeepnschrodinger Apr 10, 2024 •

edited

Loading

karry08 commented Apr 9, 2024

pradeepnschrodinger commented Apr 11, 2024

Change testing framework from Mocha to Jest #719

Change testing framework from Mocha to Jest #719

Conversation

pradeepnschrodinger commented Mar 30, 2024 • edited Loading

Description

Motivation and Context

Jest vs Mocha

Security vulnerabilities

Extra changes

How Has This Been Tested?

Types of changes

Checklist:

wiz-inc-87ff8274df bot commented Mar 30, 2024 • edited Loading

Wiz Scan Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karry08 commented Apr 9, 2024

Choose a reason for hiding this comment

pradeepnschrodinger Apr 10, 2024 • edited Loading

Choose a reason for hiding this comment

karry08 commented Apr 9, 2024

pradeepnschrodinger commented Apr 11, 2024

pradeepnschrodinger commented Mar 30, 2024 •

edited

Loading

wiz-inc-87ff8274df bot commented Mar 30, 2024 •

edited

Loading

pradeepnschrodinger Apr 10, 2024 •

edited

Loading