Chore/migrate mocha tests by joshuarrrr · Pull Request #1553 · opensearch-project/OpenSearch-Dashboards

joshuarrrr · 2022-05-06T00:45:28Z

Description

Moves/renames all mocha tests so they can be ran by jest instead. Also some typescript conversion and cleanup.

Issues Resolved

fixes #215

Check List

codecov-commenter · 2022-05-06T01:23:46Z

Codecov Report

Merging #1553 (baf3fcc) into main (de1a689) will decrease coverage by 0.56%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##             main    #1553      +/-   ##
==========================================
- Coverage   68.08%   67.52%   -0.57%     
==========================================
  Files        3072     3067       -5     
  Lines       59015    58971      -44     
  Branches     8924     8944      +20     
==========================================
- Hits        40183    39822     -361     
- Misses      16645    16971     +326     
+ Partials     2187     2178       -9

Impacted Files	Coverage Δ
...osd-opensearch-archiver/src/lib/docs/test_stubs.ts	`68.75% <ø> (ø)`
...-opensearch-archiver/src/lib/indices/test_stubs.ts	`80.00% <ø> (ø)`
...tional_test_runner/lib/config/fixtures/config.1.js	`100.00% <ø> (ø)`
...tional_test_runner/lib/config/fixtures/config.2.js	`100.00% <ø> (ø)`
..._test_runner/lib/config/fixtures/config.invalid.js	`100.00% <ø> (ø)`
src/legacy/utils/version.ts	`83.33% <ø> (ø)`
src/plugins/console/server/lib/proxy_config.ts	`95.23% <ø> (-0.92%)`	⬇️
src/plugins/console/server/lib/proxy_request.ts	`70.58% <0.00%> (-2.39%)`	⬇️
packages/osd-test-subj-selector/src/index.ts	`72.72% <50.00%> (ø)`
...gins/console/server/lib/proxy_config_collection.ts	`83.33% <50.00%> (-5.56%)`	⬇️
... and 84 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update de1a689...baf3fcc. Read the comment docs.

ashwin-pc

Amazing! no more Mocha! B)

ashwin-pc · 2022-05-06T01:11:10Z

packages/osd-opensearch-archiver/src/lib/archives/parse.test.ts

          throw new Error('should have failed');
        } catch (err) {
-          expect(err.message).to.contain('Unexpected number');
+          const { message } = err as Error;


I know why you did this, I just hate that there isnt a nicer way of handling this :(

Yeah, agreed. For actual error handling, I'd definitely go with a type guard, but for tests, the assertion seems a little cleaner (and preferable to a @ts-ignore, in my opinion), but I could easily be swayed to some other preference.

ashwin-pc · 2022-05-06T01:13:29Z

packages/osd-test/src/functional_test_runner/integration/basic.test.ts

@@ -38,11 +38,9 @@ const SCRIPT = resolve(REPO_ROOT, 'scripts/functional_test_runner.js');
 const BASIC_CONFIG = require.resolve('../fixtures/simple_project/config.js');

 describe('basic config file with a single app and test', function () {
-  this.timeout(60 * 1000);


Why are we removing the timeouts?

My understanding is that Jest handles timeouts as config values, not something that's specified in code for a specific suite the way mocha does. But let me know if there's an equivalent jest syntax for this that I missed.

I see functional test runner and I think this is selenium right?

This was actually a mocha test within the functional test runner - my understanding is that it's purpose is to validate that the functional test runner itself can start up correctly. So now this test will be run by jest instead.

Given that the jest suites for this package run in a couple seconds, I think it's fine.

ashwin-pc · 2022-05-06T01:13:40Z

packages/osd-test/src/functional_test_runner/integration/failure_hooks.test.js

@@ -39,11 +39,9 @@ const SCRIPT = resolve(REPO_ROOT, 'scripts/functional_test_runner.js');
 const FAILURE_HOOKS_CONFIG = require.resolve('../fixtures/failure_hooks/config.js');

 describe('failure hooks', function () {
-  this.timeout(60 * 1000);


Given that the jest suites for this package run in a couple seconds, I think it's fine.

src/plugins/console/server/lib/proxy_config_collection.ts

tmarkley

Functional test error.

test/visual_regression/services/visual_testing/visual_testing.ts

packages/osd-test-subj-selector/index.ts

joshuarrrr · 2022-05-06T19:26:19Z

Merging #1553 (253af22) into main (40a72f2) will decrease coverage by 0.57%.
The diff coverage is 66.66%.

This requires a deeper dive - my expectation here was actually for coverage to increase, as all existing mocha test cases should now be ran by the jest test runner (and I wrote one small new test suite). It may be due to coverage calculation differences between the two runners, but I'll need to investigate the specific cases where it thinks coverage has dropped.

release-notes/opensearch-dashboards.release-notes-2.0.0.md

tmarkley · 2022-05-13T18:37:02Z

decrease coverage by 0.57%.

Yes, I think this is because of the coverage runner calculation discrepancies. Once mocha is removed entirely we should re-evaluate.

joshuarrrr · 2022-05-26T19:44:12Z

Verified that 410 of previous 411 mocha test cases are correctly ran by jest.

From main:
Mocha: 411 passing tests
Jest: 10741 passing tests

From this branch/PR:
Mocha: 1 passing test (mocha report generation, which will be removed in #1572)
Jest: 11155 passing tests (11155 = 10741 previous jest tests + 4 newly added jest test + 410 migrated mocha tests)

ashwin-pc

Ship it!

kavilla · 2022-06-01T19:34:35Z

Checking it out now.

kavilla · 2022-06-01T20:09:37Z

packages/osd-test-subj-selector/index.d.ts

@@ -1,32 +0,0 @@
-/*


How come?

I would expect the declaration file if any one utilizes this package?

I converted ./index.js of this package to typescript (now at ./src/index.ts), and updated ./tsconfig.json to compile the new typescript files to js. So now the declaration file is at ./target/index.d.ts, which appears to be the preferred organization for these ts packages

(note that the default export became a named export, which is why I updated the imports; /target dirs are gitignored)

good catch. didn't catch the switch to ts yes then it should be auto compiled which preferred. thanks!

kavilla · 2022-06-01T20:10:01Z

src/legacy/utils/index.d.ts

- * under the License.
- */
-
-export function unset(object: object, rawPath: string): void;


Same as above. How come?

I converted all the js files in this directory to typescript. I didn't see any usages that require any of these modules to be compiled to js - it seemed that native ts modules were fine in his case, but are there external packages that need this set up as a js module?

tmarkley · 2022-06-01T20:35:11Z

Mocha: 1 passing test (mocha report generation, which will be removed in #1572)

Can you squash your commits and include this type of information in the commit message along with any other helpful contextual information?

joshuarrrr · 2022-06-02T00:16:55Z

Can you squash your commits

I'm happy to, and and I think that makes sense when it comes to something like compiling release notes. But I purposely updated each package/plugin/module in separately, so the individual commits are actually more compact and clean (I probably should have called that out for reviewers)

kavilla

LGTM. Ran locally. If rebasing and squashing prior functional test errors will be due to chromedriver issue. Commit message can be modified while squashing and merging.

- `src/dev` - migrate mocha tests to jest - `src/test_utils` - migrate mocha tests to jest - `src/dev/license_checker` - migrate mocha tests to jest - `src/legacy/utils` - migrate mocha tests to jest - convert to typescript - add unit test for `version.ts` - `src/plugins/console/server` - migrate mocha tests to jest - convert to typescript - fix type errors - improve test cases - update URL parsing - `packages/opensearch-datemath - migrate mocha tests to jest - convert to typescript - `packages/osd-eslint-plugin-eslint` - migrate mocha tests to jest - rename test file directory - `packages/osd-opensearch-archiver` - migrate mocha tests to jest - rename stub directory - `packages/osd-test` - migrate mocha tests to jest - remove mocha timeouts (not needed in jest) - linting fixes - `packages/osd-test-subject-selector` - migrate mocha tests to jest - convert to typescript - update tsconfig to transpile ts - switch to named exports/imports Verified that 410 of previous 411 mocha test cases are correctly ran by jest. Mocha: 1 passing test (mocha report generation, which will be removed in opensearch-project#1572) Jest: 11155 passing tests (11155 = 10741 previous jest tests + 4 newly added jest test + 410 migrated mocha tests) Signed-off-by: Josh Romero <rmerqg@amazon.com>

tmarkley

Looks great, thanks Josh!

kavilla · 2022-06-06T19:29:02Z

Approved. I see the label 2.1. Did we want to backport? Although I think this is okay to backport we should be weary to backport the removal of mocha.

tmarkley · 2022-06-06T19:37:48Z

Approved. I see the label 2.1. Did we want to backport? Although I think this is okay to backport we should be weary to backport the removal of mocha.

Agreed, I think we'll have to mark the removal of mocha (#1572) for 3.0.

- `src/dev` - migrate mocha tests to jest - `src/test_utils` - migrate mocha tests to jest - `src/dev/license_checker` - migrate mocha tests to jest - `src/legacy/utils` - migrate mocha tests to jest - convert to typescript - add unit test for `version.ts` - `src/plugins/console/server` - migrate mocha tests to jest - convert to typescript - fix type errors - improve test cases - update URL parsing - `packages/opensearch-datemath - migrate mocha tests to jest - convert to typescript - `packages/osd-eslint-plugin-eslint` - migrate mocha tests to jest - rename test file directory - `packages/osd-opensearch-archiver` - migrate mocha tests to jest - rename stub directory - `packages/osd-test` - migrate mocha tests to jest - remove mocha timeouts (not needed in jest) - linting fixes - `packages/osd-test-subject-selector` - migrate mocha tests to jest - convert to typescript - update tsconfig to transpile ts - switch to named exports/imports Verified that 410 of previous 411 mocha test cases are correctly ran by jest. Mocha: 1 passing test (mocha report generation, which will be removed in #1572) Jest: 11155 passing tests (11155 = 10741 previous jest tests + 4 newly added jest test + 410 migrated mocha tests) Resolves #215 Signed-off-by: Josh Romero <rmerqg@amazon.com> (cherry picked from commit 0e41477)

- `src/dev` - migrate mocha tests to jest - `src/test_utils` - migrate mocha tests to jest - `src/dev/license_checker` - migrate mocha tests to jest - `src/legacy/utils` - migrate mocha tests to jest - convert to typescript - add unit test for `version.ts` - `src/plugins/console/server` - migrate mocha tests to jest - convert to typescript - fix type errors - improve test cases - update URL parsing - `packages/opensearch-datemath - migrate mocha tests to jest - convert to typescript - `packages/osd-eslint-plugin-eslint` - migrate mocha tests to jest - rename test file directory - `packages/osd-opensearch-archiver` - migrate mocha tests to jest - rename stub directory - `packages/osd-test` - migrate mocha tests to jest - remove mocha timeouts (not needed in jest) - linting fixes - `packages/osd-test-subject-selector` - migrate mocha tests to jest - convert to typescript - update tsconfig to transpile ts - switch to named exports/imports Verified that 410 of previous 411 mocha test cases are correctly ran by jest. Mocha: 1 passing test (mocha report generation, which will be removed in opensearch-project#1572) Jest: 11155 passing tests (11155 = 10741 previous jest tests + 4 newly added jest test + 410 migrated mocha tests) Resolves opensearch-project#215 Signed-off-by: Josh Romero <rmerqg@amazon.com>

…arch-project#1678) - `src/dev` - migrate mocha tests to jest - `src/test_utils` - migrate mocha tests to jest - `src/dev/license_checker` - migrate mocha tests to jest - `src/legacy/utils` - migrate mocha tests to jest - convert to typescript - add unit test for `version.ts` - `src/plugins/console/server` - migrate mocha tests to jest - convert to typescript - fix type errors - improve test cases - update URL parsing - `packages/opensearch-datemath - migrate mocha tests to jest - convert to typescript - `packages/osd-eslint-plugin-eslint` - migrate mocha tests to jest - rename test file directory - `packages/osd-opensearch-archiver` - migrate mocha tests to jest - rename stub directory - `packages/osd-test` - migrate mocha tests to jest - remove mocha timeouts (not needed in jest) - linting fixes - `packages/osd-test-subject-selector` - migrate mocha tests to jest - convert to typescript - update tsconfig to transpile ts - switch to named exports/imports Verified that 410 of previous 411 mocha test cases are correctly ran by jest. Mocha: 1 passing test (mocha report generation, which will be removed in opensearch-project#1572) Jest: 11155 passing tests (11155 = 10741 previous jest tests + 4 newly added jest test + 410 migrated mocha tests) Resolves opensearch-project#215 Signed-off-by: Josh Romero <rmerqg@amazon.com> (cherry picked from commit 0e41477)

- `src/dev` - migrate mocha tests to jest - `src/test_utils` - migrate mocha tests to jest - `src/dev/license_checker` - migrate mocha tests to jest - `src/legacy/utils` - migrate mocha tests to jest - convert to typescript - add unit test for `version.ts` - `src/plugins/console/server` - migrate mocha tests to jest - convert to typescript - fix type errors - improve test cases - update URL parsing - `packages/opensearch-datemath - migrate mocha tests to jest - convert to typescript - `packages/osd-eslint-plugin-eslint` - migrate mocha tests to jest - rename test file directory - `packages/osd-opensearch-archiver` - migrate mocha tests to jest - rename stub directory - `packages/osd-test` - migrate mocha tests to jest - remove mocha timeouts (not needed in jest) - linting fixes - `packages/osd-test-subject-selector` - migrate mocha tests to jest - convert to typescript - update tsconfig to transpile ts - switch to named exports/imports Verified that 410 of previous 411 mocha test cases are correctly ran by jest. Mocha: 1 passing test (mocha report generation, which will be removed in opensearch-project#1572) Jest: 11155 passing tests (11155 = 10741 previous jest tests + 4 newly added jest test + 410 migrated mocha tests) Resolves opensearch-project#215 Signed-off-by: Josh Romero <rmerqg@amazon.com>

joshuarrrr requested a review from a team as a code owner May 6, 2022 00:45

ashwin-pc previously approved these changes May 6, 2022

View reviewed changes

tmarkley suggested changes May 6, 2022

View reviewed changes

test/visual_regression/services/visual_testing/visual_testing.ts Show resolved Hide resolved

packages/osd-test-subj-selector/index.ts Show resolved Hide resolved

joshuarrrr mentioned this pull request May 6, 2022

[Chore] Update deprecated url methods (url.parse(), url.format()) #1561

Open

joshuarrrr dismissed ashwin-pc’s stale review via 5f3a01e May 6, 2022 23:21

joshuarrrr force-pushed the chore/migrate-mocha-tests branch from 95f123e to ec05c90 Compare May 11, 2022 22:43

tmarkley reviewed May 13, 2022

View reviewed changes

release-notes/opensearch-dashboards.release-notes-2.0.0.md Show resolved Hide resolved

joshuarrrr force-pushed the chore/migrate-mocha-tests branch from ec05c90 to 111a61f Compare May 25, 2022 20:01

joshuarrrr requested a review from tmarkley May 26, 2022 19:10

joshuarrrr requested review from ashwin-pc and kavilla May 26, 2022 19:52

ashwin-pc previously approved these changes May 31, 2022

View reviewed changes

joshuarrrr requested a review from a team June 1, 2022 19:18

kavilla reviewed Jun 1, 2022

View reviewed changes

kavilla previously approved these changes Jun 2, 2022

View reviewed changes

kavilla added test:unit technical debt If not paid, jeapardizes long-term success and maintainability of the repository. labels Jun 2, 2022

joshuarrrr dismissed stale reviews from kavilla and ashwin-pc via 1714f0e June 3, 2022 19:25

joshuarrrr force-pushed the chore/migrate-mocha-tests branch from baf3fcc to 1714f0e Compare June 3, 2022 19:25

tmarkley approved these changes Jun 6, 2022

View reviewed changes

tmarkley added the v2.1.0 label Jun 6, 2022

kavilla approved these changes Jun 6, 2022

View reviewed changes

tmarkley added the backport 2.x label Jun 6, 2022

tmarkley merged commit 0e41477 into opensearch-project:main Jun 6, 2022

joshuarrrr deleted the chore/migrate-mocha-tests branch June 6, 2022 19:44

opensearch-trigger-bot bot mentioned this pull request Jun 6, 2022

[Backport 2.x] Chore/migrate mocha tests #1678

Merged

Conversation

joshuarrrr commented May 6, 2022

Description

Issues Resolved

Check List

Uh oh!

codecov-commenter commented May 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ashwin-pc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tmarkley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

joshuarrrr commented May 6, 2022

Uh oh!

Uh oh!

tmarkley commented May 13, 2022

Uh oh!

joshuarrrr commented May 26, 2022

Uh oh!

ashwin-pc left a comment

Choose a reason for hiding this comment

Uh oh!

kavilla commented Jun 1, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmarkley commented Jun 1, 2022

Uh oh!

joshuarrrr commented Jun 2, 2022

Uh oh!

kavilla left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmarkley left a comment

Choose a reason for hiding this comment

Uh oh!

kavilla commented Jun 6, 2022

Uh oh!

tmarkley commented Jun 6, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

codecov-commenter commented May 6, 2022 •

edited

Loading

kavilla left a comment •

edited

Loading