Code coverage for cypress testing #2031

PRINCESANCHEZ · 2024-06-20T18:38:55Z

Developer's Certificate of Origin 1.1

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

Signed-off-by: Prince Sanchez <[email protected]>

canvas_modules/harness/cypress/support/e2e.js

canvas_modules/harness/package.json

canvas_modules/harness/webpack.config.dev.js

canvas_modules/harness/webpack.config.prod.js

matthoward366 · 2024-06-21T12:12:04Z

canvas_modules/harness/.nycrc

@@ -0,0 +1,24 @@
+{


Can you explain why this is needed?

.nycrc file is needed to configure NYC which generates code coverage reports.

Can you give more details on this? For example how does webpack get used and is there any documentation on this?

I removed this file and it doesn't seem to make a different in the result.

Signed-off-by: Prince Sanchez <[email protected]>

canvas_modules/harness/.babelrc

canvas_modules/harness/package.json

matthoward366 · 2024-06-25T16:15:57Z

canvas_modules/harness/webpack.config.dev.js

@@ -141,4 +141,4 @@ module.exports = {
 		rules: rules
 	},
 	plugins: plugins
-};
+};


Why are these files changed? Looks like an addition line?

For the webpack.config.dev.js and webpack.config.prod.js, I reverted them to their original state because I believe I added a comma in the previous commit last Thursday.

These are still showing up as changed though.

Signed-off-by: Prince Sanchez <[email protected]>

… into cypress-fvt-testing

matthoward366 · 2024-07-01T13:04:44Z

canvas_modules/harness/.nycrc

@@ -0,0 +1,24 @@
+{


Can you give more details on this? For example how does webpack get used and is there any documentation on this?

matthoward366 · 2024-07-01T13:05:14Z

canvas_modules/harness/package.json

    "build": "npx stylelint 'src/**/*.scss' 'assets/**/*.scss' && grunt",
-    "test": "npx cypress open",
+    "test": "npx cypress open && npx cypress run",


Why was this changed?

I initially added the script to see if Cypress would open and run in the terminal simultaneously, but unfortunately, it didn't work as expected. I intended to revert the changes but it seems I have forgot to.

I was not able to comment on your question above, but I did some more research and the .nycrc file configures NYC (Istanbul's CLI) for code coverage, specifying which files to include, exclude, and the reporting format. Webpack is used with Babel to instrument the code via babel-plugin-istanbul before bundling it. Here was the documentation for NYC https://github.com/istanbuljs/nyc, it can also be found on the cypress docs.

matthoward366 · 2024-07-01T13:06:05Z

canvas_modules/harness/package.json

    "@pmmmwh/react-refresh-webpack-plugin": "0.5.11",
    "ajv": "8.12.0",
    "autoprefixer": "10.4.19",
+    "babel-core": "6.26.3",


Is this needed?

Did some research on both babel-core and @babel/register and found that they primarily ensure the code runs correctly in environments that don't natively support the latest JavaScript features. Since I was still able to generate code coverage without them, I went ahead and removed these dependencies from the project.

matthoward366 · 2024-07-01T13:06:21Z

canvas_modules/harness/package.json

@@ -34,14 +36,19 @@
    "@babel/polyfill": "7.12.1",
    "@babel/preset-env": "7.24.3",
    "@babel/preset-react": "7.24.1",
+    "@babel/register": "7.24.6",


Is this needed?

Signed-off-by: Prince Sanchez <[email protected]>

matthoward366 · 2024-07-01T20:03:20Z

canvas_modules/harness/package.json

@@ -5,8 +5,10 @@
  "license": "Apache-2.0",
  "scripts": {
    "start": "NODE_ENV=development node index.js",
+    "cypress:run": "cypress open",


Why did we add this? We already run a similar cmd under test.

I believe this was an extra script, so I went ahead and removed it to eliminate redundancy.

matthoward366 · 2024-07-01T20:06:38Z

canvas_modules/harness/package.json

@@ -62,7 +67,10 @@
    "grunt-yamllint": "0.3.0",
    "html-webpack-plugin": "5.6.0",
    "ibm-design-icons": "2.1.4",
+    "istanbul": "0.4.5",
+    "istanbul-instrumenter-loader": "3.0.1",


Is that actually used?

I was still able to generate a coverage report without these, so I removed them

matthoward366 · 2024-07-01T20:09:53Z

canvas_modules/harness/package.json

@@ -62,7 +67,10 @@
    "grunt-yamllint": "0.3.0",
    "html-webpack-plugin": "5.6.0",
    "ibm-design-icons": "2.1.4",
+    "istanbul": "0.4.5",


Do we need this module. It says it's no longer maintained and shouldn't be used.

Regarding your comment on generating a coverage report, I updated the 'coverage' script to: "coverage": "npx cypress run && npx nyc --reporter=html --reporter=text-summary". This way, when you run npm run coverage, it will execute all the tests. Once all 43 tests are finished, you can open coverage/index.html to view the report in the browser.

matthoward366

How does this work? I tried running npm run coverage but that errors out.

If I want to see coverage reports what steps are needed?

Signed-off-by: Prince Sanchez <[email protected]>

… into cypress-fvt-testing

matthoward366 · 2024-07-02T19:43:39Z

canvas_modules/harness/cypress.config.js

@@ -12,13 +12,17 @@ module.exports = defineConfig({
 	e2e: {


can you add this file to be checked in linting. It should have flagged the new code since we don't use single quotes.

matthoward366

I don't think this is working as expected. This is giving code coverage for the test harness but what we really want is code coverage for common-canvas.

matthoward366 · 2024-07-02T19:54:37Z

canvas_modules/harness/cypress/support/e2e.js

@@ -31,6 +31,7 @@ import "./canvas/utils-cmds";
 import "./canvas/verification-cmds";


also add the entire cypress directory. It should have flagged this well in the build.

matthoward366 · 2024-07-02T19:55:04Z

canvas_modules/harness/.nycrc

@@ -0,0 +1,24 @@
+{


I removed this file and it doesn't seem to make a different in the result.

Signed-off-by: Prince Sanchez <[email protected]>

… into cypress-fvt-testing

Signed-off-by: Prince Sanchez <[email protected]>

sonarqubecloud · 2024-07-31T23:32:54Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Prince Sanchez added 2 commits June 20, 2024 11:26

Code coverage for cypress testing

bd1287d

Signed-off-by: Prince Sanchez <[email protected]>

babelrc and nycrc files for code coverage

ccaa79b

Signed-off-by: Prince Sanchez <[email protected]>

PRINCESANCHEZ requested a review from matthoward366 June 20, 2024 23:02

matthoward366 reviewed Jun 21, 2024

View reviewed changes

Minor changes (pinned versions, removed console.log)

7488842

Signed-off-by: Prince Sanchez <[email protected]>

PRINCESANCHEZ requested a review from matthoward366 June 25, 2024 15:45

Merge branch 'main' into cypress-fvt-testing

5d864c3

matthoward366 reviewed Jun 25, 2024

View reviewed changes

Prince Sanchez added 2 commits June 25, 2024 10:24

Removed .babelrc and removed extra dependency)

cbd1181

Signed-off-by: Prince Sanchez <[email protected]>

Merge branch 'cypress-fvt-testing' of github.com:PRINCESANCHEZ/canvas…

c3dd4c8

… into cypress-fvt-testing

PRINCESANCHEZ requested a review from matthoward366 June 26, 2024 04:23

matthoward366 reviewed Jul 1, 2024

View reviewed changes

Removed @babel/register & babelcore from dependencies

888746b

Signed-off-by: Prince Sanchez <[email protected]>

PRINCESANCHEZ requested a review from matthoward366 July 1, 2024 18:29

matthoward366 reviewed Jul 1, 2024

View reviewed changes

Merge branch 'main' into cypress-fvt-testing

627c528

matthoward366 reviewed Jul 1, 2024

View reviewed changes

Prince Sanchez added 2 commits July 2, 2024 10:08

Removed some modules and scripts to eliminate redundancy

cdf0ca7

Signed-off-by: Prince Sanchez <[email protected]>

Merge branch 'cypress-fvt-testing' of github.com:PRINCESANCHEZ/canvas…

ebd8a90

… into cypress-fvt-testing

PRINCESANCHEZ requested a review from matthoward366 July 2, 2024 17:16

Merge branch 'main' into cypress-fvt-testing

41b803c

matthoward366 reviewed Jul 2, 2024

View reviewed changes

matthoward366 requested changes Jul 2, 2024

View reviewed changes

Prince Sanchez added 3 commits July 3, 2024 10:58

Minor change to coverage script

9332db0

Signed-off-by: Prince Sanchez <[email protected]>

Merge branch 'cypress-fvt-testing' of github.com:PRINCESANCHEZ/canvas…

66b72de

… into cypress-fvt-testing

Minor changes

0ca3cb8

Signed-off-by: Prince Sanchez <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code coverage for cypress testing #2031

Code coverage for cypress testing #2031

PRINCESANCHEZ commented Jun 20, 2024

matthoward366 Jun 21, 2024

PRINCESANCHEZ Jun 24, 2024

matthoward366 Jul 1, 2024

matthoward366 Jul 2, 2024

matthoward366 Jun 25, 2024

PRINCESANCHEZ Jun 25, 2024

matthoward366 Jun 25, 2024

matthoward366 Jul 1, 2024

matthoward366 Jul 1, 2024

PRINCESANCHEZ Jul 1, 2024

PRINCESANCHEZ Jul 1, 2024

matthoward366 Jul 1, 2024

PRINCESANCHEZ Jul 1, 2024

matthoward366 Jul 1, 2024

matthoward366 Jul 1, 2024

PRINCESANCHEZ Jul 2, 2024

matthoward366 Jul 1, 2024

PRINCESANCHEZ Jul 2, 2024

matthoward366 Jul 1, 2024

PRINCESANCHEZ Jul 2, 2024

matthoward366 left a comment

matthoward366 Jul 2, 2024

matthoward366 left a comment

matthoward366 Jul 2, 2024

matthoward366 Jul 2, 2024

sonarqubecloud bot commented Jul 31, 2024

		@@ -31,6 +31,7 @@ import "./canvas/utils-cmds";
		import "./canvas/verification-cmds";

Code coverage for cypress testing #2031

Are you sure you want to change the base?

Code coverage for cypress testing #2031

Conversation

PRINCESANCHEZ commented Jun 20, 2024

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

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

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

matthoward366 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthoward366 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 31, 2024

Quality Gate passed