SonarQube静态代码质量检测【前端】

前言: 在公司项目快接近尾声的时候,经理要求对代码进行质量检测,并将检测结果推送到公司SonarQube服务器上,根据其图形化界面上展现的各项检测结果来对代码进行优化。前端框架为Angular。

检测通过标准

  • 总体检测通过
  • 无Bug
  • 无漏洞
  • 无异味
  • 单元测试覆盖率90%以上
  • 代码重复率为0

前端工程中的使用

基础环境准备

  1. Node
  2. Java jdk1.8

ps: sonar scanner需要依赖java环境。具体如何安装和配置环境再此不在赘述,网上资料很多。

安装依赖

npm install -D sonarqube-scanner

gulp构建

一、新建gulp-sonar.js文件,内容如下

const gulp = require('gulp);
const sonarqubeScanner = require('sonarqube-scanner');
const package = require('./package.json');

const config = {
    projectKey: 'pivs-client',
    projectName: 'pivs-client',
    projectVersion: package.version,
    host: 'http://172.16.41.100:9000',
    username: 'admin',
    password: 'admin'
};

gulp.task('sonar', () => {
   // process.env.SONAR_SCANNER_MIRROR = "可下载的地址";
   sonarqubeScanner({
    serverUrl = config.host,
    options: {
        'sonar.login': config.username,
        'sonar.password': config.password,
        'sonar.projectKey': config.projectKey,
        'sonar.projectName': config.projectName,
        'sonar.projectVersion': config.projectVersion,
        'sonar.sources': 'src/app',
        'sonar.tests': 'src/test',
        'sonar.sourceEncoding': 'UTF-8',
        'sonar.typescript.lcov.reportPath': './coverage/lcov.info'
    }
   }); 
});

ps: options中可选参数可对照sonarQube官网中的参数, 根据项目需要自行添加。

二、在gulpfile.js中引入上面的文件

require('./gulp-sonar');

三、在package.json添加脚本命令

"script": {
    "sonar": "gulp sonar"
}

四、运行npm命令进行代码检测

npm run sonar

执行上面命令后,会去找C:\Users\18627\.sonar\native-sonar-scanner\sonar-scanner-4.0.0.1744-windows\bin\sonar-scanner.bat脚本并执行。若未找到,则会自动联网下载;若下载失败,可尝试下面两种方法:

  1. 根据控制台中的提示,手动下载对应该版本的sonar-scanner-cli,下载地址
  2. 将gulp-sonar.js文件中的那段注释打开,把中文字符替换成可下载的网址链接即可。

成功下载并安装sonar-scanner-cli后,重新执行npm run sonar就会自动去做代码检查,并将检查结果上传到SonarQube服务器上面了。

单元测试结果上传

一、修改package.json中的脚本命令

"script": {
    "test": "ng test --single-run --code-coverage"
}

二、执行npm run test命令,生成单元测试结果报告

npm run test

三、 在gulp-sonar.js文件中的options中配置单元测试结果报告路径

options: {
    ...
    'sonar.typescript.lcov.reportPath': './coverage/lcov.info'
}

四、执行npm run sonar命令,上传单元测试结果

npm run sonar

另:当然你也可以直接把package.json中的sonar脚本命令修改为

"script": {
    "sonar": "ng test --single-run --code-coverage && gulp sonar"
}

这样就可以在单元测试结束后, 再进行代码质量检测,最后将结果一起上传到服务器。
当然,个人还是建议分开执行,先进行单元测试,再sonar检测。 当单元测试报错后可先对其进行修改,单元测试无报错后,再上传覆盖率结果。

评论

暂无评论