build: enable sonarcloud checks #109

alacambre-yseop · 2019-07-10T13:42:07Z

I'm sorry because this PR is a little bit tricky and has some downsides. Let me explain.
I started to update the Jenkinsfile and add a simple configuration for sonar. This explains the picture in the first comment.
Then I tried to have code coverage too.
The thing is that in this project we were using a test framework named mocha. When I searched in the repositories I know, I found jest. jest provides code coverage very easily with just some nice dev dependencies and has a wonderful integration with VSCode. So, I started to migrate from mocha to jest.
While everything went fine for the server-side code, client-side tests don't work anymore.
This is because we try to launch tests over an instance of VSCode that will bring its dependencies at a weird moment. Jest tries the code, says something like “vscode dependency doesn't exist.”, then fails miserably.
It tried this method, but it is based on an older version of VSCode and doesn't work with modern projects.
Every new file or change in the client/ directory are for that, but I disabled the tests because they are not working (yet).
Server-side tests work fine and code coverage on this part is very nice as you can see:

While writing this comment, I discovered this tool that probably allows to use mocha. while still having code coverage.
I still prefere jest now, even for test writing.

Since our client-tests aren't quite good or very relevant, I propose to keep them disabled until I found a way to enable them later. I know that having fewer tests, even dumb ones, isn't nice, but I believe that code coverage and bug smell detection is better.

alacambre-yseop · 2019-08-30T14:35:26Z

I'm progressing!

mminot-yseop

Wow must have been tedious.

mminot-yseop · 2019-09-06T20:38:00Z

client/src/test/extension.test.ts

-                assert.notStrictEqual(languages.length, 0);
-                assert.notStrictEqual(languages.indexOf('yml'), -1);
+                expect(languages).not.toBeNull();
+                expect(languages.length).not.toBe(0);


Nothing like expect(x).toBeEmpty()? Just asking xD

It seems it doesn't exist. Maybe I can use is([]) instead?

Nonono, it’s OK.

mminot-yseop · 2019-09-06T20:38:32Z

client/src/test/index.ts

+import { runCLI } from 'jest-cli';
+import path = require('path');
+
+const jestTestRunnerForVSCodeE2E: ITestRunner = {


E2E → End to End; You can check this article for more information. It's the one from the first comment.

I don't know what are recommendations for vscode extensions' testing.
This file seems to be the main input to launch tests, but isn't it possible to directly provide the jest command as a TestRunner ?

mminot-yseop · 2019-09-06T20:39:50Z

sonar-project.properties

+##
+## Duplications
+##
+# Increase minimum lines for code duplications triggering (default = 10)


Reason for the increase? 20 seems a bit much.

No good reason for the increase. Just a copy-paste.

Try to reset (if not done already) and see if it puts us in dire straits or not. The default value – or even something lower xD – would be nice.

It was a need to allow specific patterns on AA; default values are sufficient I think.

Harukero · 2019-09-06T22:42:19Z

I will try to give a try to microsoft/vscode-test#37.

lucas-gregoire · 2019-09-10T12:38:55Z

babel.config.js

+                node: "current",
+            },
+        }],
+        +"@babel/preset-typescript",


Isn't the + weird, right ?

lucas-gregoire · 2019-09-10T12:39:25Z

client/package.json

    },
    "dependencies": {
+        "@types/jest": "^24.0.18",


You can move it to devDependencies

lucas-gregoire · 2019-09-10T12:44:59Z

client/package.json

        "glob": "^7.1.4",
-        "mocha": "^5.2.0",
+        "jest-cli": "^24.9.0",


You can directly use the jest dep which simply wraps the jest-cli

client/package.json

client/src/test/extension.test.ts

lucas-gregoire · 2019-09-10T12:48:49Z

client/src/test/extension.test.ts

        const ymlExtension = vscode.extensions.all.find((extension) => {
            return extension.id === YML_EXTENSION_ID;
        });
-        assert.notStrictEqual(ymlExtension, null);
-        assert.strictEqual(ymlExtension.isActive, false);
+        expect(ymlExtension).not.toBeNull();


you can do something like expect(ymlExtension).toBeDefined(); to also check undefined values

lucas-gregoire · 2019-09-10T12:50:56Z

client/src/test/extension.test.ts

        ymlExtension
            .activate()
            .then(() => {
-                assert.strictEqual(ymlExtension.isActive, true);
+                expect(ymlExtension.isActive).toBeTruthy();


you can do the done() just after this expect()

myPromise.then(() => { expect(ymlExtension.isActive).toBeTruthy(); done(); })

and jest also supports promises as returned type.
It allows to avoid using the done mechanism.

return myPromise.then(() => { expect(ymlExtension.isActive).toBeTruthy(); })

Jenkinsfile

client/src/test/extension.test.ts

lucas-gregoire · 2019-09-10T13:02:49Z

sonar-project.properties

+# sonar.typescript.tslint.reportPaths=target/lint/tslint-report.json
+
+# Stylelint report
+# sonar.css.stylelint.reportPaths=target/lint/stylelint-report.json


I don't think stylelint will be used one day in this project.

lucas-gregoire · 2019-09-10T13:04:20Z

Jenkinsfile

@@ -23,7 +25,7 @@ pipeline {
                ansiColor('xterm') {
                    sh "npm install --unsafe-perm"


You could use npm ci to install packages without updating them.

Jenkinsfile

lucas-gregoire · 2019-09-10T13:08:26Z

client/src/test/index.ts

+import { runCLI } from 'jest-cli';
+import path = require('path');
+
+const jestTestRunnerForVSCodeE2E: ITestRunner = {


I don't know what are recommendations for vscode extensions' testing.
This file seems to be the main input to launch tests, but isn't it possible to directly provide the jest command as a TestRunner ?

lucas-gregoire · 2019-09-10T13:10:04Z

package.json

        "rimraf": "^2.6.3",
+        "sonar-scanner": "^3.1.0",


If you use the Sonar CLI provided by Jenkins, this dep is not used.

mminot-yseop

I had quite a lot of “Changed since last view” but could not make out much from them. 😅

jest.config.js

sonarqubecloud · 2020-04-24T08:41:00Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
0.0% Duplication

mminot-yseop

Did you fix your issue regarding the config file that seemed to be ignored? (cf. what you said on Slack while asking for help)

alacambre-yseop · 2020-04-24T08:59:23Z

Did you fix your issue regarding the config file that seemed to be ignored? (cf. what you said on Slack while asking for help)

It seems so (I hope).

alacambre-yseop force-pushed the feature/sonarqube branch from 756738a to 29a0c22 Compare July 12, 2019 23:44

alacambre-yseop force-pushed the feature/sonarqube branch from 29a0c22 to 3add9a1 Compare August 30, 2019 13:13

alacambre-yseop force-pushed the feature/sonarqube branch 5 times, most recently from 954cc8b to 1ca3c7a Compare September 6, 2019 19:55

alacambre-yseop changed the title ~~chore: try to use sonarqube~~ build: enable sonarcloud checks Sep 6, 2019

alacambre-yseop self-assigned this Sep 6, 2019

alacambre-yseop requested review from cchahbazian-yseop, eborel-yseop, lucas-gregoire and mminot-yseop September 6, 2019 20:20

alacambre-yseop marked this pull request as ready for review September 6, 2019 20:20

mminot-yseop reviewed Sep 6, 2019

View reviewed changes

lucas-gregoire reviewed Sep 10, 2019

View reviewed changes

babel.config.js Outdated

node: "current",

},

}],

+"@babel/preset-typescript",

Copy link

lucas-gregoire Sep 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the + weird, right ?

lucas-gregoire reviewed Sep 10, 2019

View reviewed changes

client/package.json Outdated

},

"dependencies": {

"@types/jest": "^24.0.18",

Copy link

lucas-gregoire Sep 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can move it to devDependencies

lucas-gregoire reviewed Sep 10, 2019

View reviewed changes

client/package.json Show resolved Hide resolved

lucas-gregoire reviewed Sep 10, 2019

View reviewed changes

cchahbazian-yseop removed their request for review February 17, 2020 13:12

alacambre-yseop force-pushed the feature/sonarqube branch from 38b43ca to c403321 Compare March 20, 2020 15:28

alacambre-yseop force-pushed the feature/sonarqube branch from 4594148 to 48c1a47 Compare April 10, 2020 09:58

alacambre-yseop requested review from mminot-yseop and lucas-gregoire April 10, 2020 10:55

mminot-yseop reviewed Apr 10, 2020

View reviewed changes

jest.config.js Show resolved Hide resolved

alacambre-yseop force-pushed the feature/sonarqube branch from 9ecfc52 to ae69cdc Compare April 21, 2020 15:27

alacambre-yseop removed the request for review from eborel-yseop April 24, 2020 07:51

alacambre-yseop force-pushed the feature/sonarqube branch 2 times, most recently from ce8a97c to ebba558 Compare April 24, 2020 08:33

build: use jest for tests; add sonarqube build step

b4ae898

alacambre-yseop force-pushed the feature/sonarqube branch from ebba558 to b4ae898 Compare April 24, 2020 08:39

alacambre-yseop requested a review from mminot-yseop April 24, 2020 08:43

mminot-yseop approved these changes Apr 24, 2020

View reviewed changes

alacambre-yseop merged commit 969ba93 into develop Apr 24, 2020

alacambre-yseop deleted the feature/sonarqube branch April 24, 2020 08:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: enable sonarcloud checks #109

build: enable sonarcloud checks #109

alacambre-yseop commented Jul 10, 2019 •

edited

Loading

alacambre-yseop commented Aug 30, 2019

mminot-yseop left a comment

mminot-yseop Sep 6, 2019

Harukero Sep 6, 2019

mminot-yseop Sep 7, 2019

mminot-yseop Sep 6, 2019

Harukero Sep 6, 2019

lucas-gregoire Sep 10, 2019

mminot-yseop Sep 6, 2019

Harukero Sep 6, 2019

mminot-yseop Sep 7, 2019

lucas-gregoire Sep 10, 2019

Harukero commented Sep 6, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

lucas-gregoire Sep 10, 2019

mminot-yseop left a comment

sonarqubecloud bot commented Apr 24, 2020

mminot-yseop left a comment

alacambre-yseop commented Apr 24, 2020

		@@ -23,7 +25,7 @@ pipeline {
		ansiColor('xterm') {
		sh "npm install --unsafe-perm"

build: enable sonarcloud checks #109

build: enable sonarcloud checks #109

Conversation

alacambre-yseop commented Jul 10, 2019 • edited Loading

alacambre-yseop commented Aug 30, 2019

mminot-yseop left a 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

Harukero commented Sep 6, 2019

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

mminot-yseop left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 24, 2020

mminot-yseop left a comment

Choose a reason for hiding this comment

alacambre-yseop commented Apr 24, 2020

alacambre-yseop commented Jul 10, 2019 •

edited

Loading