Code Inspection for DevOps

什么是代码检查

Code is pre check in before submitting to the code base inspection on code,包括静态检查、Code Review、测试、Compile a variety of ways, such as.Main purpose is to guarantee the quality of code submitted to the code base.

The current version control systems are using distributed version control system,如 Git.根据 Git 的架构设计,Can in the following figure ①②③④ To check of code.如下图所示,This a few checkpoint is：

①本地检查, Usually in local developers development space for inspection,比如 IDE Plug-in check,Check local compile time;

②本地提交, Generally when code submitted to the local warehouse check,可以使用 Git 的客户端 Hook,如 pre-commit、pre-merge 进行检查;

③远程提交, Generally when code submitted to the remote warehouse check,At this time will be submitted to the temporary branch,After the review people agree again into the code base,比如 Gerrit;

④分支合并, Generally when merge code from one branch to another branch to check,Review the people Code Review,After agreed again into another branch,Common branch merger way are MR（Merge Request）和 PR（Pull Request）两种.

Why want to do code review

Code checking their main purpose is to guarantee the quality of code submitted to the code base.In today's rapid development in the digital economy,No not through an enterprise software to support the business.**软件是业务发展的核心,**So the overall quality of the software is very important.High quality software can bring customer satisfaction、Users and income,And a better design can make the organization more easily win the market.

因此,When we face a fleeting market opportunities and time pressure for software delivery time,May temporarily decrease the standard of software quality.但是,从长远考虑,We definitely want to attach importance to software quality.The software is composed of code,The quality of the code is a decisive factor in the quality of software,因此,Attaches great importance to the software quality,One of the core is to attach importance to the quality of the code.总结一下,The importance of the quality of the code has three main reason.

• 可读性：The code is not just to the machine understanding,也是给人看的.To be able to make the team everyone can easily read and understand the code.

• 可维护性：When maintenance and test the quality of the code easier to、Safety and save time,And not easy to out of the question.

• Reduce the technical debt：High quality code design good,Technical debt less,Developers do not need to spend a lot of time to repair problems and refactoring the code,因此,Can quicken the pace of the software development.The new team members are easy to understand code,It is easier to join the project.

High quality code is the basis of high quality software,不管是什么业务,High quality software can make you the annoyance from production problems.

Code review practice

《丰田套路：Change our cognition of leadership and management》一书中介绍过“改善套路”：以循环的方式不断改进.We can also use cycle、Means to cultivate,Will improve the code quality activities into each iteration,形成一种习惯.Here are several can improve the code quality inspection tools and practice.

本地检查

Local examination refers to the check in local developers perform,比如 IDE The command line or.Local inspection there are advantages and disadvantages.

优点

• According to the principle of check the pre,The timing of the local inspection is the most appropriate,Find and fix problems cost is the lowest;

• 因为是在本地执行,Perform check the efficiency of the fastest.

缺点

• Developers need to have high consciousness.

Local inspection commonly used inspection tools and practice

• IDE 插件：SonarLint、FindBugs、CheckStyle、PMD、Ali specification etc,You can check code coding style,坏味道,漏洞等.

• 本地构建：maven 编译、gradle 编译,You can check code grammar problem,Whether can be compiled.

• 本地测试：单元测试,Can check code logic problems.

下图是 IDEA 中 SonarLint Real-time inspect the results of a single file.As developers write code,While doing inspection,Real-time enhanced feedback timely check,是一种不错的实践.

本地提交检查

Local submission examination refers to the local executivegit commitWhen to check,This way of checking also has advantages and disadvantages.

优点

• Check the timing of the moderate;

• Check the high efficiency;

• 基于 Git 的 Hook 机制,在每次提交时运行 Hook,Automatic identification code of the simple question,Code reviewers focus on logic and system structure,Avoid because of trivial problem style and a waste of time.

缺点

• Local commits to the required high speed,Only static checking to save time,Such as code style;

• 客户端的 Hook,Because it is in local developers,Did not achieve full“强制”检查;

• Also relies on the developer's consciousness.

远程提交检查

Remote submit inspection refers to the local executivegit pushWhen submitted to a remote warehouse to perform check,Remote submit inspection also has advantages and disadvantages.

优点

• Can be relatively deep dynamic check,比如漏洞、Bug,It is better to check the;

• Can do the compulsory inspection,Ensure that anyone to submit code are of high quality;

• Code submitted did not directly submitted to the code base,Add artificial review link,Check code for business logic and architecture design more complex problems, such as;

• 可以控制每次提交的代码质量.

缺点

• The timing of the check on the,反馈周期较长;

• Need to set up the code check the server;

• 维护成本较高;

• 每次提交都检查,Will slow down the team's development pace.

Branch merge check

Branch merge examination refers to the remote warehouse executive branch of the merger takes place when the check,Branch merge check the advantages and disadvantages of the following.

优点

• Each time the inspection branch and fashionable,Can control and in other branches of code quality,Does not affect the development rhythm;

• Branches usually indicates a function at the time of merger and problems developed,There can be a relatively ample time to perform more deep dynamic check,比如漏洞,Bug 等;

• You can set the mandatory inspection,Ensure us into branch code is of high quality;

• 
  

• 可以做 Code Review,Who review one-time review the function of the complete code（Don't recommend branch for a long time,大功能开发）;

• 代码托管平台支持,如 GitHub、GitLab.

缺点

• The timing of the check on the,反馈周期较长.

Common inspection tools and practice

代码检查

Need to set up the code check the server,比如 SonarQube.当代码提交后,Automatic trigger code review and decide whether to close into the code base according to the results of the inspection.In order to avoid debt repair affects the problem of history,Consider using incremental check,Only check the modified files submitted,So as not to because the problem is too much bother, submit the initiative to solve the problem.在之前的实践中,Every time we submit incremental check,Control the quality of the new code.在发版时,On the amount of code to check,Version of the quality level as the system.Increasing quality scores a month,So as to achieve the purpose of continuous improve the code quality.

人工评审

Refers to when the code is submitted,High level personnel by a team of code review.Review will check whether this change is in line with the coding standards and adopt the best technical solution,And in the review, published in the form of header comment page evaluation opinions,Submit one according to the evaluation opinions modified,Until meet the requirements of who review.At present commonly used code review tools such as Gerrit,通过与Jenkins Integration can realize machine inspection and artificial review and audit,This is also in the present enterprise with the most practical.Below is to look at the content change of Gerrit 评审页面.

自动化测试

The above two inspection has certain limitation.Code inspections can find code problem,But can't find functional issues.Manual inspection to review required higher.More effective way is to use JaCoCo Detection unit test coverage,Or perform a range of integrated test.Advised to choose a system at the core of the scene、10 Minutes to perform a complete test case.

总结

Quality is a habit

,Is to blend in the daily work of each developer,In the process of development will focus on the quality of the code.因此,对于软件从业人员来说,I'd recommend to use “本地检查” Methods the prompt anytime and anywhere、Guide our development of high quality code.