共计 2429 个字符,预计需要花费 7 分钟才能阅读完成。
本文首发于微信公众号:大迁世界, 我的微信:qq449245884,我会第一工夫和你分享前端行业趋势,学习路径等等。
更多开源作品请看 GitHub https://github.com/qq449245884/xiaozhi,蕴含一线大厂面试残缺考点、材料以及我的系列文章。
前言
最近在自学 DevOps 的过程中,发现除了要理解根本的 CI/CD 流程外,更重要的是理解能够利用哪些工具来辅助整个 CI 的流程,明天来介绍一个好用的代码检测平台:SonarQube。
尽管在现今的开发很多时候都会藉由 code review 搭配各式的 linter 进行开发,但百密总有一疏,这时候就能够透过 SonarQube 帮忙开发者查看一些潜在的 bug,这些 bug 有可能在开发时 linter 并没有报错,而且在 code review 时可能也不小心漏看了,如果能够在 CI 的流程中加上 SonarQube 来扫描整个 codebase,这时候就能够让整个我的项目的代码有更高的品质。
什麽是 SonarQube
SonarQube 是一套基于 Java 开发的代码检测以及品质治理平台,因为这套工具是用 Java 开发的起因,所以大家要先记得去装置 Java Development Kit(JDK),这样后续能力顺利的启动 SonarQube。
SonarQube 也提供了不少的服务像是:
- 网页化操作
- 反对十分多种程序语言的剖析检测
- 提供代码重复性、潜在 bug、测试覆盖率等等相干报告
- 提供自动化剖析并且联合支流的 CI 工具
- 提供代码改善倡议
- 整合 JIRA、Mantis、LDAP、Fortify 等内部工具
- 提供历史纪录以利于后续追踪
因为 SonarQube 提供太多种服务了,这里只列出几点集体感觉最值得提出来与大家分享的内容,有趣味的读者能够再自行去官网下面进行相干的材料浏览。
启动 SonarQube
因为我是应用 mac 零碎,因而这边以 mac 的操作形式进行介绍,首先能够在终端机中进入 /bin/macosx-unversal-64
的文件夹,并下 ./sonar.sh start
这个指令启动 SonarQube 的服务。
启动服务后能够在浏览器打上 localhost:9000
即可开启 SonarQube 的网页,预设的帐号及明码都是 admin
,输出后即可在 local 端开始应用 SonarQube 提供的检测服务喽。
SonarQube 操作阐明
登入后就能够开始进行 Project 创立了,这边的 Project 次要是不便开发者能够进行我的项目品质的控管,创建好 Project 才能够开始针对想要检测的 repository 进行检测。
咱们也能够看到 SonarQube 整合了十分多用来创立我的项目的支流工具例如 GitHub
、Jira 等等,如果读者自身是有在应用这些工具进行我的项目的治理也能够间接整合现有的架构,这边为了不便介绍所以抉择手动创立 Project。
建设好 Project 后能够看到 SonarQube 也反对许多支流平台的 CI 机制,这里也是为了不便介绍所以抉择手动测试 local repository
。
想要进行剖析检测之前还须要产生一组 private token,利用这组 token 咱们在之后进行检测时能够确保检测的后果会摆在这个 project 内。
之后就能够抉择要检测的代码是属于哪种语言以及目前电脑的 OS,都抉择完后能够去官网上下载最重要的剖析工具 SonarScanner,这套 scanner 就是负责检测代码的工具。
下载完后就能够複制下方的指令进行代码的检测啦!
SonarScanner 检测后果
在下面的步骤检测完后,咱们回到 SonarQube 的平台就能够看到刚刚建设的 project 曾经有了初步的检测报告,如果代码都没有什麽潜在的问题就能够看到报告会是绿色 Passed 的状态。
但如果代码有潜在的问题,这时候报告就会呈现红色的 Failed 并且指出有几个 bug 产生。
接著点击 issues tab 就能够看到目前潜在的 bug 是从哪个档案的哪一行中产生。
再点进去后就会看到潜在的 bug 的谬误讯息,咱们能够发现 array 的长度肯定会是大于等于 0 可是我这边却写了小于 0
,所以这个 if
判断条件永远都不会通过。
但咱们回到代码后能够发现即使咱们有装置 linter 也不会查看出这种看起来就是有问题的写法,因为 linter 通常都是在查看语法上的谬误,这时候 SonarScanner 就帮忙了咱们能够进行更深刻的查看。
SonarScanner 配置
其实 SonarScanner 也能够进行一些自定义的配置,这时候就须要建设一个叫 sonar-project.properties
的文件,这份文件裡面能够设定一些 SonarScanner 提供的 analysis parameter
,因为这些配置参数切实是太多了,所以这里不会一一介绍,有趣味的读者能够参考官网,裡面有所有参数的具体介绍,整体写法会像下图这样:
总结
这次介绍了 SonarQube 这套代码检测平台,因为笔者自身是一位前端工程师,因而只会利用 ESLint 或者 TSLint 进代码但程式码还会有一些潜在的 bug 可能是这些 linter 无奈查看进去的,这时候 SonarQube 就起了一个很大的作用,帮忙咱们在开发时能够进行更深刻的解析,如果读者将来有要做一些 CI 流程的话,无妨也能够把 SonarQube 思考进去喔。
编辑中可能存在的 bug 没法实时晓得,预先为了解决这些 bug, 花了大量的工夫进行 log 调试,这边顺便给大家举荐一个好用的 BUG 监控工具 Fundebug。
作者:Andy Chen 译者:小智 起源:medium
原文:https://www.vuemastery.com/bl…
原文:https://medium.com/starbugs/%…
交换
有幻想,有干货,微信搜寻 【大迁世界】 关注这个在凌晨还在刷碗的刷碗智。
本文 GitHub https://github.com/qq449245884/xiaozhi 已收录,有一线大厂面试残缺考点、材料以及我的系列文章。