code coverage with babel istanbul #4649

trusktr · 2022-01-03T19:39:45Z

Closes

Describe your changes:

replaces instanbul-intrumenter-loader with babel-plugin-istanbul. Vue <script>s are now covered, but not expressions in <template>

remove bad plugin/package and config
add new package and config
remove legacy-peer-deps option
code coverage to be correct
code coverage to work codecov.io
provide path towards coverage being usable in e2e tests
verify internal consumers still build and work fine

The previous instanbul-intrumenter-loader is outdated and abandoned with old Babel dependencies, so as our tooling progresses, it will be incompatible, and it crashes on any new syntax that all modern browsers already support without compiling or poyfilling those features.

This updates to use babel-plugin-istanbul which is maintained, so that it will stay up to date with Babel and latest syntaxes.

This also moves the converage instrumentation webpack config out of karma config into a separate webpack.coverage.js file, which can enable our other test environments besides Karma to also use it (not part of this PR).

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

Changes address original issue?
Unit tests included and/or updated with changes?
Command line build passes?
Has this been smoke tested?
Testing instructions included in associated issue?

To test: run npm run build:coverage and verify that the output in dist has coverage instrumentation (you'll see weird statements injected all over the JS code, but if you see only your plain JS code and nothing strange, then it didn't work).

Reviewer Checklist

Changes appear to address issue?
Changes appear not to be breaking changes?
Appropriate unit tests included?
Code style and in-line documentation are appropriate?
Commit messages meet standards?
Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

trusktr · 2022-01-05T01:42:25Z

hey @unlikelyzero , I see you approved. Are you okay with it not covering Vue code? Also I need to rebase this once both eslint PRs are merged. Then we can see if it'll pass.

unlikelyzero · 2022-01-05T02:02:07Z

Yea that's fine for now

akhenry · 2022-02-07T22:07:22Z

Still needed in light of using code cov?

shefalijoshi · 2022-02-14T21:55:45Z

@trusktr Please resolve conflicts. Also, @unlikelyzero , @nikhilmandlik , @trusktr Do we still need this? Discuss and close as needed.

codecov · 2022-03-16T00:17:07Z

Codecov Report

Merging #4649 (4f5e8ec) into master (b347f35) will increase coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4649      +/-   ##
==========================================
+ Coverage   50.36%   50.44%   +0.08%     
==========================================
  Files         510      511       +1     
  Lines       18657    18665       +8     
  Branches     1657     1644      -13     
==========================================
+ Hits         9396     9415      +19     
+ Misses       8847     8835      -12     
- Partials      414      415       +1

Impacted Files	Coverage Δ
src/plugins/notebook/components/Notebook.vue	`22.30% <0.00%> (-1.27%)`	⬇️
.../notebook/components/NotebookSnapshotIndicator.vue	`70.83% <0.00%> (-1.17%)`	⬇️
src/ui/inspector/details/Properties.vue	`62.50% <0.00%> (-0.66%)`	⬇️
...gins/condition/components/inspector/StylesView.vue	`47.66% <0.00%> (-0.30%)`	⬇️
src/plugins/notebook/components/NotebookEmbed.vue	`0.00% <0.00%> (ø)`
src/plugins/plot/lib/eventHelpers.js	`86.20% <0.00%> (ø)`
...plugins/displayLayout/components/DisplayLayout.vue	`2.06% <0.00%> (+<0.01%)`	⬆️
src/plugins/displayLayout/components/LineView.vue	`1.81% <0.00%> (+0.01%)`	⬆️
...pi/forms/components/controls/AutoCompleteField.vue	`1.96% <0.00%> (+0.03%)`	⬆️
src/plugins/notebook/components/PageCollection.vue	`2.85% <0.00%> (+0.07%)`	⬆️
... and 8 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 b347f35...4f5e8ec. Read the comment docs.

The base branch was changed.

package.json

karma.conf.js

…n dependencies, remove istanbul-instrumenter-loader

…e reason

trusktr · 2022-03-16T20:28:57Z

I was unable to get instrumentation into the JS expressions inside <template>s of Vue components. I asked a couple questions for ideas here:

unable to instrument Vue template code when using vue-loader istanbuljs/babel-plugin-istanbul#273
Any idea how to get this to use babel-plugin-istanbul for coverage in templates? JuniorTour/vue-template-babel-compiler#38

babel.coverage.js

webpack.coverage.js

jvigliotta · 2022-03-21T21:02:24Z

@trusktr @unlikelyzero can you guys get together on this one?

…k to issue to enable coverage in Vue <template>s

github-actions · 2022-03-22T22:58:24Z

Started e2e Run. Follow along: https://github.com/nasa/openmct/actions/runs/2025319708

github-actions · 2022-03-22T22:58:26Z

Started e2e Run. Follow along: https://github.com/nasa/openmct/actions/runs/2025319708

unlikelyzero

We did a virtual walkthrough of the changes and potential impacts downstream.

github-actions · 2022-03-22T23:03:49Z

Success ✅ ! Build artifacts are here: https://github.com/nasa/openmct/actions/runs/2025319708

github-actions · 2022-03-22T23:07:51Z

Success ✅ ! Build artifacts are here: https://github.com/nasa/openmct/actions/runs/2025319708

trusktr changed the base branch from master to update-eslint January 3, 2022 19:39

trusktr marked this pull request as draft January 3, 2022 19:40

trusktr requested a review from unlikelyzero January 3, 2022 21:26

trusktr changed the title ~~Add vue code coverage~~ code coverage with babel istanbul Jan 4, 2022

unlikelyzero previously approved these changes Jan 4, 2022

View reviewed changes

trusktr force-pushed the update-eslint branch 2 times, most recently from c83c331 to c68223c Compare January 5, 2022 00:33

trusktr force-pushed the add-vue-code-coverage branch from 8be8493 to 1c6e69f Compare March 16, 2022 00:14

WIP add instanbul code coverage to vue files

4a4bc10

trusktr force-pushed the add-vue-code-coverage branch from 1c6e69f to 4a4bc10 Compare March 16, 2022 01:47

trusktr changed the base branch from update-eslint to master March 16, 2022 01:47

unlikelyzero self-requested a review March 16, 2022 15:37

unlikelyzero reviewed Mar 16, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

unlikelyzero reviewed Mar 16, 2022

View reviewed changes

karma.conf.js Show resolved Hide resolved

trusktr added 2 commits March 16, 2022 13:06

move webpack coverage config to a separate file for test:coverage, pi…

15ca977

…n dependencies, remove istanbul-instrumenter-loader

dont include node_modules in babel config, it breaks istanbul for som…

52c7716

…e reason

trusktr marked this pull request as ready for review March 16, 2022 20:17

trusktr requested a review from unlikelyzero March 16, 2022 20:20

ignore spec files from coverage

a69e220

unlikelyzero reviewed Mar 16, 2022

View reviewed changes

babel.coverage.js Outdated Show resolved Hide resolved

unlikelyzero reviewed Mar 16, 2022

View reviewed changes

webpack.coverage.js Show resolved Hide resolved

Merge branch 'master' into add-vue-code-coverage

b5fce91

trusktr added 3 commits March 22, 2022 14:13

Merge branch 'master' into add-vue-code-coverage

f392df9

Merge branch 'master' into add-vue-code-coverage

65de717

document coverage files, remove unused karma config

eab57e6

trusktr mentioned this pull request Mar 22, 2022

[Blocked] Update code coverage to include JS expressions in <template>s of Vue components #4973

Open

use test instead of test:coverage in config.yml, disable code and lin…

4f5e8ec

…k to issue to enable coverage in Vue <template>s

unlikelyzero added pr:e2e Automatically triggers e2e tests to run pr:visual labels Mar 22, 2022

unlikelyzero self-requested a review March 22, 2022 22:58

unlikelyzero approved these changes Mar 22, 2022

View reviewed changes

unlikelyzero added the pr:platform Runs tests against all supported platforms label Mar 22, 2022

trusktr merged commit ca7fbe5 into master Mar 22, 2022

trusktr deleted the add-vue-code-coverage branch March 28, 2022 18:09

unlikelyzero mentioned this pull request Mar 28, 2022

[e2e] Add code coverage support for our e2e tests #4995

Closed

7 tasks

scottbell mentioned this pull request May 17, 2022

Tests aren't using source maps #5211

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

code coverage with babel istanbul #4649

code coverage with babel istanbul #4649

trusktr commented Jan 3, 2022 •

edited

Loading

trusktr commented Jan 5, 2022 •

edited

Loading

unlikelyzero commented Jan 5, 2022

akhenry commented Feb 7, 2022

shefalijoshi commented Feb 14, 2022

codecov bot commented Mar 16, 2022 •

edited

Loading

trusktr commented Mar 16, 2022 •

edited

Loading

jvigliotta commented Mar 21, 2022

github-actions bot commented Mar 22, 2022

github-actions bot commented Mar 22, 2022

unlikelyzero left a comment

github-actions bot commented Mar 22, 2022

github-actions bot commented Mar 22, 2022

code coverage with babel istanbul #4649

code coverage with babel istanbul #4649

Conversation

trusktr commented Jan 3, 2022 • edited Loading

Describe your changes:

All Submissions:

Author Checklist

Reviewer Checklist

trusktr commented Jan 5, 2022 • edited Loading

unlikelyzero commented Jan 5, 2022

akhenry commented Feb 7, 2022

shefalijoshi commented Feb 14, 2022

codecov bot commented Mar 16, 2022 • edited Loading

Codecov Report

trusktr commented Mar 16, 2022 • edited Loading

jvigliotta commented Mar 21, 2022

github-actions bot commented Mar 22, 2022

github-actions bot commented Mar 22, 2022

unlikelyzero left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 22, 2022

github-actions bot commented Mar 22, 2022

trusktr commented Jan 3, 2022 •

edited

Loading

trusktr commented Jan 5, 2022 •

edited

Loading

codecov bot commented Mar 16, 2022 •

edited

Loading

trusktr commented Mar 16, 2022 •

edited

Loading