[INFRA] Add SonarCloud analysis on CI build #906

csouchet · 2020-11-25T14:40:27Z

Add configuration to run a SonarCloud analysis on master branch and pull requests

Closes #823

.github/workflows/build.yml

tbouffard · 2020-11-26T08:49:43Z

.github/workflows/build.yml

@@ -49,12 +50,12 @@ jobs:
      - name: Install dependencies
        run: npm ci
      - name: Lint check
-        run: npm run lint-check
+        run: npm run lint-check -- -f json -o build/eslint-reporter.json


❓ why is this needed? if the eslint check fails, the build fails so no other steps are triggered including sonar, so this seems useless

ℹ️ This generates the Eslint report, and we need it for Sonar.

I understand what you want to say.
If there is a error we don't analyze with Sonar, and if there is no error, sonar display anything. so it's useless.

Maybe, we should failed the job if the lint failed, only at the Sonar step end.

tbouffard · 2020-11-26T08:50:49Z

.github/workflows/build.yml

      - name: Build Application
        run: npm run build
      - name: Test Application
        id: 'test_unit'
-        run: npm run test:unit
+        run: npm run test:unit ${{ matrix.os.coverage }}


good way to configure the step according to the os! I am not this is the best name, for now, it is ok (I don't have any best proposal 😸)

.github/workflows/build.yml

tbouffard · 2020-11-26T08:54:53Z

sonar-project.properties

+
+# This is the name and version displayed in the SonarCloud UI.
+sonar.projectName=bpmn-visualization
+sonar.projectVersion=0.8.0


⚠️ we have to make the version consistent with what we have in the package.json
We should automate this on version changes: we can do it in another PR, but as soon as possible, otherwise this will become a mess and I don't want we to have to manage this manually.

I asked myself the same.
We need to change the version on the package.json, because it's corresponding to the last tag. But, here, we are on delopment on the next.
Maybe on the tag workflow, we need to change the current version, after the tag.

Ok to do that on another PR 😉

My concern was about the version sync, but yes we can also address the version that stays with the tagged version.
Some projects (I didn't remember which one, but it was a big like jest) use x.y.z-post version after release, we could do the same

We can manage it with #909

tbouffard · 2020-11-26T08:56:53Z

package.json

@@ -103,6 +103,7 @@
    "jest-html-reporter": "^3.3.0",
    "jest-image-snapshot": "^4.2.0",
    "jest-puppeteer": "^4.4.0",
+    "jest-sonar": "^0.2.11",


❓ do you know if this has perf impact on our local dev i.e if you have seen processing time increase when running tests?
I will do some checks on my side

I didn't check yet.

Ubuntu

Before jest-sonar integration

Unit test: 22s

E2e test: 2m 22s

After jest-sonar integration

Unit test: 26s

E2e test: 2m 26s

MacOS

Before jest-sonar integration

Unit test: 28s

E2e test: 3m 32s

After jest-sonar integration

Unit test: 25s

E2e test: 3m 22s

Windows

Before jest-sonar integration

Unit test: 31s

E2e test: 3m 32s

After jest-sonar integration

Unit test: 38s

E2e test: 3m 59s

Ok, thanks for the figures
It looks ok

.github/workflows/build.yml

tbouffard · 2020-11-27T09:48:02Z

README.md

@@ -14,6 +14,9 @@
        <a href="https://github.com/process-analytics/bpmn-visualization-js/actions">
        <img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-js/workflows/Build/badge.svg"> 
        </a> 
+        <a href="https://sonarcloud.io/dashboard?id=process-analytics_bpmn-visualization-js">
+        <img alt="Coverage" src="https://sonarcloud.io/api/project_badges/measure?project=process-analytics_bpmn-visualization-js&metric=coverage"> 


👍 for the badge

csouchet · 2020-11-27T10:43:06Z

I need to fix the ignored tests on test:e2e:coverage, because the performance tests run :(

tbouffard · 2020-11-27T11:06:22Z

package.json

@@ -62,11 +62,11 @@
    "lint-check": "tsc --noEmit && eslint \"*/**/*.{js,ts,tsx}\" NOTICE --max-warnings 0",
    "test": "run-s test:unit test:e2e",
    "test:unit": "jest --runInBand --config=./test/unit/jest.config.js",
-    "test:unit:coverage": "jest --runInBand --config=./test/unit/jest.config.js --coverage",
-    "test:unit:watch": "jest --runInBand --config=./test/unit/jest.config.js --coverage --watchAll",
+    "test:unit:coverage": "npm run test:unit -- --coverage",


❓ did you try run-s instead of npm (which probably fork a new process). This applies to all scripts that have been chandeg to update another script.

I didn't think to do that ^^

I don't think it's adapted to what we want to do.
Here we just want to run the same configuration as for the unit test, but with one more paramter (for the coverage).

I tried with run-s. It doesn't work. After the documentation reading of run-s, it's more to run mutliple scripts (it's not what we do).

So let's keep it

tbouffard · 2020-11-27T11:07:57Z

package.json

-    "test:unit:coverage": "jest --runInBand --config=./test/unit/jest.config.js --coverage",
-    "test:unit:watch": "jest --runInBand --config=./test/unit/jest.config.js --coverage --watchAll",
+    "test:unit:coverage": "npm run test:unit -- --coverage",
+    "test:unit:watch": "npm run test:unit:coverage -- --watchAll",


⚠️ behaviour change
I don't use this command (nor know why we created it) so I won't be impacted.
If @aibcmars is ok with this change, let's do it (check the doc if there is any mention to it)

Actually, the coverage was already run as part of the 'watch', so there is no behaviour change.

tbouffard · 2020-11-27T11:13:41Z

test/unit/jest.config.js

-  coverageThreshold: {
-    global: {
-      branches: 80,
-      functions: 80,
-      lines: 80,
-      statements: 80,
-    },
-  },


❓ I guess this disable the 'fail build' detection when we are under the threshold?

tbouffard

LGTM
@aibcmars can you check #906 (comment) and decide if this is ok to you?

…ull requests

…r-project.properties

- Configurate tslint & eslint report on Sonar

… lint check failed

Co-authored-by: Thomas Bouffard <[email protected]>

sonarqubecloud · 2020-11-30T09:44:22Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

csouchet added the infra:repo label Nov 25, 2020

csouchet force-pushed the 823-Add_code_coverage_public_reports branch from ae1c2b0 to 3cde2a9 Compare November 25, 2020 19:15

tbouffard reviewed Nov 26, 2020

View reviewed changes

csouchet force-pushed the 823-Add_code_coverage_public_reports branch 3 times, most recently from 8c0928d to 853bdf2 Compare November 26, 2020 15:58

tbouffard changed the title ~~[INFRA] Add the code coverage public reports~~ [INFRA] Add SonarCloud analysis on CI build Nov 26, 2020

csouchet force-pushed the 823-Add_code_coverage_public_reports branch from 00ea52a to ee873ba Compare November 26, 2020 18:32

tbouffard reviewed Nov 27, 2020

View reviewed changes

csouchet marked this pull request as ready for review November 27, 2020 10:11

csouchet marked this pull request as draft November 27, 2020 10:42

csouchet marked this pull request as ready for review November 27, 2020 10:53

tbouffard reviewed Nov 27, 2020

View reviewed changes

tbouffard mentioned this pull request Nov 27, 2020

[INFRA] Use specific dev version after a release #909

Closed

tbouffard approved these changes Nov 30, 2020

View reviewed changes

csouchet added 13 commits November 30, 2020 09:46

Add configuration to run a SonarCloud analysis on master branch and p…

a57bce3

…ull requests

Add the configuration file in the root directory of the project: sona…

b50b176

…r-project.properties

- Generate eslint report in json format

78ccba8

- Configurate tslint & eslint report on Sonar

Generate Jest test execution report & configure Sonar

263ac74

Execute Sonar analysis after all steps of build and only on ubuntu

410ea9f

Fix coverage generation

2be0664

Configure Sonar to get the coverage reports

62fadcf

add coverage badge in README

05d44ca

Run coverage only for ubuntu

074bdf8

Add a global property for coverage

7d79cb8

Remove Eslint configuration for Sonar, because the job failed, if the…

47e9dc0

… lint check failed

Use the 1.4 version of the Sonar Github Action

09731fc

Remove the coverage thresholds

bafe09b

csouchet and others added 15 commits November 30, 2020 09:49

add 'src/model' to ignored path for the coverage

e12e44d

remove unnecessary type of pull request on github workflow

eb3e37f

Remove source config for Sonar

246bb0e

Change path of source & test for Sonar config

201f771

Fix source encoding for Sonar

e78c05c

exclude jest config files for the Sonar analysis

6fd6757

Eclude model from Sonar analysis

f1b2e1c

Disable shallow clone for Sonar

7574e12

Disable tsconfig

168a12b

Disable src for Sonar config

1ad461d

Enable src for Sonar config & change exclusions

9b4e874

Config works in local

747b625

Exclude files from src/model, src/demo and src/static

d3cac9d

Apply suggestions from code review

0880bdc

Co-authored-by: Thomas Bouffard <[email protected]>

Fix ignore test paths on test:e2e:coverage

ec18173

csouchet force-pushed the 823-Add_code_coverage_public_reports branch from 3e80f0c to ec18173 Compare November 30, 2020 08:49

Merge branch 'master' into 823-Add_code_coverage_public_reports

ff38e70

csouchet merged commit c06ab22 into master Nov 30, 2020

csouchet deleted the 823-Add_code_coverage_public_reports branch November 30, 2020 09:59

tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Aug 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[INFRA] Add SonarCloud analysis on CI build #906

[INFRA] Add SonarCloud analysis on CI build #906

csouchet commented Nov 25, 2020 •

edited

Loading

tbouffard Nov 26, 2020 •

edited

Loading

csouchet Nov 26, 2020

csouchet Nov 26, 2020

tbouffard Nov 26, 2020 •

edited

Loading

tbouffard Nov 26, 2020

csouchet Nov 26, 2020 •

edited

Loading

tbouffard Nov 26, 2020

tbouffard Nov 27, 2020

tbouffard Nov 26, 2020

csouchet Nov 26, 2020

csouchet Nov 27, 2020 •

edited

Loading

tbouffard Nov 27, 2020

tbouffard Nov 27, 2020

csouchet commented Nov 27, 2020

tbouffard Nov 27, 2020

csouchet Nov 27, 2020

csouchet Nov 27, 2020

tbouffard Nov 30, 2020

tbouffard Nov 27, 2020

tbouffard Nov 30, 2020

tbouffard Nov 27, 2020

csouchet Nov 27, 2020

tbouffard left a comment

sonarqubecloud bot commented Nov 30, 2020

[INFRA] Add SonarCloud analysis on CI build #906

[INFRA] Add SonarCloud analysis on CI build #906

Conversation

csouchet commented Nov 25, 2020 • edited Loading

tbouffard Nov 26, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tbouffard Nov 26, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csouchet Nov 26, 2020 • edited Loading

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

csouchet Nov 27, 2020 • edited Loading

Choose a reason for hiding this comment

Ubuntu

Before jest-sonar integration

After jest-sonar integration

MacOS

Before jest-sonar integration

After jest-sonar integration

Windows

Before jest-sonar integration

After jest-sonar integration

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csouchet commented Nov 27, 2020

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

tbouffard left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 30, 2020

csouchet commented Nov 25, 2020 •

edited

Loading

tbouffard Nov 26, 2020 •

edited

Loading

tbouffard Nov 26, 2020 •

edited

Loading

csouchet Nov 26, 2020 •

edited

Loading

csouchet Nov 27, 2020 •

edited

Loading