CICD 基础

代码测试覆盖率

最近在负责相关插件的集成，今天第一次接触到“代码覆盖率”这个概念，那么，就做些简单的笔记吧。

好文

• 如何提高一个研发团队的“代码速度”？
• 代碼覆蓋率-wiki
• 如何测试代码覆盖率：coverage.py简介
• 浅谈代码覆盖率
• 代码覆盖率浅谈
• 实际软件工程中是否真的需要100%代码覆盖率（code coverage）？
• 用 Python 编写干净、可测试、高质量的代码
• 代码覆盖率工具 Istanbul 入门教程

nosetests

• nosetests-Basic usage

nosetests --with-coverage --cover-html --cover-erase --with-xunit --exe project_name\test\

代码质量好文

代码质量控制,常规三板斧：

• 静态检查
• 代码review
• 单元测试

静态检查工具

• awesome-static-analysis

sonarqube

• Jenkins+SonarQube 代码质量检查自动化
• SonarQube 的安装、配置及 Maven 项目的使用
• [Jenkins + Maven + SonarQube 构建代码质量检测平台](Jenkins + Maven + SonarQube 构建代码质量检测平台)

代码质量平台

• 代码质量检测平台架构设计
• COMPREHENSIVE GUIDE TO CODE QUALITY: BEST PRACTICES AND TOOLS
• PMD、FindBug、checkstyle、sonar这些代码检查工具的区别？各自的侧重点是什么？
• codacy-平台官网

Python代码质量

pylint

coverage

python检查好文

• python coding style guide 的快速落地实践

Java代码质量

• Checkstyle
• FindBugs
• PMD
• Jtest

Java静态分析工具	分析对象	应用技术
Checkstyle	Java 源文件	缺陷模式匹配
FindBugs	字节码	缺陷模式匹配；数据流分析
PMD	Java 源代码	缺陷模式匹配
Jtest	Java 源代码	缺陷模式匹配；数据流分析

内置编程规范

Checkstyle：

• Javadoc 注释：检查类及方法的 Javadoc 注释
• 命名约定：检查命名是否符合命名规范
• 标题：检查文件是否以某些行开头
• Import 语句：检查 Import 语句是否符合定义规范
• 代码块大小，即检查类、方法等代码块的行数
• 空白：检查空白符，如 tab，回车符等
• 修饰符：修饰符号的检查，如修饰符的定义顺序
• 块：检查是否有空块或无效块
• 代码问题：检查重复代码，条件判断，魔数等问题
• 类设计：检查类的定义是否符合规范，如构造函数的定义等问题

FindBugs

• Bad practice 坏的实践：常见代码错误，用于静态代码检查时进行缺陷模式匹配
• Correctness 可能导致错误的代码，如空指针引用等
• 国际化相关问题：如错误的字符串转换
• 可能受到的恶意攻击，如访问权限修饰符的定义等
• 多线程的正确性：如多线程编程时常见的同步，线程调度问题。
• 运行时性能问题：如由变量定义，方法调用导致的代码低效问题。

PMD：

• 可能的 Bugs：检查潜在代码错误，如空 try/catch/finally/switch 语句
• 未使用代码（Dead code）：检查未使用的变量，参数，方法
• 复杂的表达式：检查不必要的 if 语句，可被 while 替代的 for 循环
• 重复的代码：检查重复的代码
• 循环体创建新对象：检查在循环体内实例化新对象
• 资源关闭：检查 Connect，Result，Statement 等资源使用之后是否被关闭掉

Jtest

• 可能的错误：如内存破坏、内存泄露、指针错误、库错误、逻辑错误和算法错误等
• 未使用代码：检查未使用的变量，参数，方法
• 初始化错误：内存分配错误、变量初始化错误、变量定义冲突
• 命名约定：检查命名是否符合命名规范
• Javadoc 注释：检查类及方法的 Javadoc 注释
• 线程和同步：检验多线程编程时常见的同步，线程调度问题
• 国际化问题：
• 垃圾回收：检查变量及 JDBC 资源是否存在内存泄露隐患

Java静态检查参考

• IBM-常用 Java 静态代码分析工具的分析与比较

Python代码圈复杂度检查

基础知识

• 监视圈复杂度
• 详解圈复杂度

radon

• radon-2.0-文档
• radon-2.2-Command-line Usage

radon cc --total-average -s -o SCORE -j all\ > r.json

-s 显示复杂度
-a 显示平均值，受-n -m影响
-j 结果转换为json
-o --order
    - SCORE: order by cyclomatic complexity (descending):
    - LINES: order by line numbers;
-i 指定忽略文件夹

json2html

from json2html import *

import json
    with open('r.json','r') as f:
    array = json.load(f)
    print(array)

randon_html=json2html.convert(array)

with open("index.html","wr") as f:
    f.write(randon_html)

• json2html-github

业界 CI

• circleci
• travis-ci

工具链

工具链好文

• 懒羊羊大哥-常用工具集 懒羊羊大哥