Implementation and Evaluation of a Continuous Code Inspection Platform
Total Page:16
File Type:pdf, Size:1020Kb
Linköping University | IDA Master Thesis | Computer Science Spring 2016 | LIU-IDA/LITH-EX-A--16/047—SE IMPLEMENTATION AND EVALUATION OF A CONTINUOUS CODE INSPECTION PLATFORM Tomas Melin Handledare/Tutor, Cyrille Berger, Wang Tiantian, Christian Svedin, Magnus Grimsell Examinator, Kristian Sandahl 硕士学位论文 Dissertation for Master’s Degree (工程硕士) (Master of Engineering) 持续的代码审查平台的实现与评价 IMPLEMENTATION AND EVALUATION OF A CONTINUOUS CODE INSPECTION PLATFORM 王维 Linköping University UnUniversity 2016 年 9 月 国内图书分类号:TP311 学校代码:10213 国际图书分类号:681 密级:公开 工程硕士学位论文 Dissertation for the Master’s Degree in Engineering (工程硕士) (Master of Engineering) 持续的代码审查平台的实现与评价 IMPLEMENTATION AND EVALUATION OF A CONTINUOUS CODE INSPECTION PLATFORM 硕 士 研 究 生 : 你的姓名 导 师 : HIT 王甜甜 副教授 副导师 : LiU 导师姓名、职称 实习单位导师 : 实习单位导师姓名、职称 申 请 学 位 : 工程硕士 学科 : 软件工程 所 在 单 位 : 软件学院 答 辩 日 期 : 2016 年 9 月 授予学位单位 : 哈尔滨工业大学 Classified Index: TP311 U.D.C: 681 Dissertation for the Master’s Degree in Engineering IMPLEMENTATION AND EVALUATION OF A CONTINUOUS INSPECTION PLATFORM Candidate: Tomas Melin Supervisor: Prof. Wang Tiantian Associate Supervisors: Prof. Kristian Sandahl, Cyrille Berger Industrial Supervisors: Christian Svedin, Magnus Grimsell Academic Degree Applied for: Master of Science Speciality: Software Engineering Affiliation: School of Software Date of Defense: September, 2016 Degree-Conferring-Institution: Harbin Institute of Technology Upphovsrätt Detta dokument hålls tillgängligt på Internet – eller dess framtida ersättare – under 25 år från publiceringsdatum under förutsättning att inga extraordinära omständigheter uppstår. Tillgång till dokumentet innebär tillstånd för var och en att läsa, ladda ner, skriva ut enstaka kopior för enskilt bruk och att använda det oförändrat för ickekommersiell forskning och för undervisning. Överföring av upphovsrätten vid en senare tidpunkt kan inte upphäva detta tillstånd. All annan användning av dokumentet kräver upphovsmannens medgivande. För att garantera äktheten, säkerheten och tillgängligheten finns lösningar av teknisk och administrativ art. Upphovsmannens ideella rätt innefattar rätt att bli nämnd som upphovsman i den omfattning som god sed kräver vid användning av dokumentet på ovan beskrivna sätt samt skydd mot att dokumentet ändras eller presenteras i sådan form eller i sådant sammanhang som är kränkande för upphovsmannens litterära eller konstnärliga anseende eller egenart. För ytterligare information om Linköping University Electronic Press se förlagets hemsida http://www.ep.liu.se/. Copyright The publishers will keep this document online on the Internet – or its possible replacement – for a period of 25 years starting from the date of publication barring exceptional circumstances. The online availability of the document implies permanent permission for anyone to read, to download, or to print out single copies for his/hers own use and to use it unchanged for non-commercial research and educational purpose. Subsequent transfers of copyright cannot revoke this permission. All other uses of the document are conditional upon the consent of the copyright owner. The publisher has taken technical and administrative measures to assure authenticity, security and accessibility. According to intellectual property law the author has the right to be mentioned when his/her work is accessed as described above and to be protected against infringement. For additional information about the Linköping University Electronic Press and its procedures for publication and for assurance of document integrity, please refer to its www home page: http://www.ep.liu.se/. © Tomas Melin 摘 要 建立和保持高水平的软件质量可以带来经济利益等诸多好处,然而这是一项 很困难的任务。其中一种防止软件项目质量下降的方法是通过跟踪项目的度量值 和某些属性,来查看项目的属性的变化情况。通过引入持续的代码审查和应用静 态代码分析方法可以实现这种方法。然而,在人们的印象中,这类工具往往具有 较高的误检,因此需要进一步调查实际情况、研究其可行性,这是本文的初始研 究目标。本文在瑞典林雪平的 Ida Infront AB 公司开展了案例研究,调研了该公 司开发人员的意见,并通过访问开发人员,确定持续的代码审查平台 SonarQ ube 的性能。作者对持续的代码审查环境进行了配置,分析了公司的部分产品,进而 确定哪些规则适用于该公司。调查结果表明该工具是高质量并且准确的,还提供 了持续监测代码来观察度量值的趋势和进展等先进功能,例如通过监测环路复杂 度和重复代码等度量值,来防止复杂度和重复代码的增加。通过组合误检压缩、 对 pull requests 的瞬间分析反馈、以及分解和建立给定的条件等特征,使得所实 现的环境成为一种可以降低软件质量保障难度的方式。 关键词:静态代码分析,持续代码审查,SonarQube,软件质量 I Abstract Establishing and preserving a high level of software quality is a not a trivial task, although the benefits of succeeding with this task has been proven profitable and advantageous. An approach to mitigate the decreasing quality of a project is to track metrics and certain properties of the project, in order to view the progression of the project’s properties. This approach may be carried out by introducing continuous code inspection with the application of static code analysis. However, as the initial common opinion is that these type of tools produce a too high number of false positives, there is a need to investigate what the actual case is. This is the origin for the investigation and case study performed in this paper. The case study is performed at Ida Infront AB in Linköping, Sweden and involves interviews with developers to determine the performance of the continuous inspection platform SonarQube, in addition to examine the general opinion among developers at the company. The author executes the implementation and configuration of a continuous inspection environment to analyze a partition of the company’s product and determine what rules that are appropriate to apply in the company’s context. The results from the investigation indicate the high quality and accuracy of the tool, in addition to the advantageous functionality of continuously monitoring the code to observe trends and the progression of metrics such as cyclomatic complexity and duplicated code, with the goal of preventing the constant increase of complex and duplicated code. Combining this with features such as false positive suppression, instant analysis feedback in pull requests and the possibility to break the build given specified conditions, suggests that the implemented environment is a way to mitigate software quality difficulties. Keywords: Static Code Analysis, Continuous Code Inspection, SonarQube, Software Quality II Thesis for Master’s Degree at HIT and LiU Acknowledgment For a start, the author would like to thank his supervisors; Kristian Sandahl, Cyrille Berger and Wang Tiantian for their guidance during the author’s work, it has been invaluable. Equally important, the author would like to acknowledge Christian Svedin and Magnus Grimsell at Ida Infront AB for the grateful opportunity of performing the master thesis project at their company. It has been an incredible eye opening experience in being a part of the company during this project. In addition, the author would like to communicate his appreciation to the interviewees at Ida Infront AB who were willing to contribute to this paper by being interviewed and observed as they performed code reviews in rather spartan conditions. In order for these interviewees to remain anonymous, their names will not be listed. The author would also like to express his gratitude towards his companions , Daniel Andersson and Robert Krogh, who have guided the author during the progression of this project in regards to brainstorming and solving problems related to both the theoretical work and the practical assignment executed at Ida Infront AB. III Thesis for Master’s Degree at HIT and LiU Table of Contents 摘 要......................................................................................................................... I ABSTRACT............................................................................................................... II CHAPTER 1 INTRODUCTION .............................................................................. 1 1.1 BACKGROUND .................................................................................................. 2 1.1.1 About the Company ................................................................................. 2 1.1.2 Context ..................................................................................................... 3 1.2 MOTIVATION .................................................................................................... 3 1.3 PURPOSE AND AIM ........................................................................................... 4 1.4 RESEARCH QUESTIONS..................................................................................... 4 1.5 DELIMITATIONS ................................................................................................ 5 1.6 APPROACH ........................................................................................................ 5 1.6.1 Literature Study ....................................................................................... 5 1.6.2 Setup ......................................................................................................... 6 1.6.3 Rule Configuration .................................................................................. 6 1.7 MAIN CONTENT AND ORGANIZATION OF THE THESIS ..................................... 8 CHAPTER 2 THEORETICAL FRAMEWORK ................................................... 10 2.1 METRICS ......................................................................................................... 10 2.1.1 Complexity ............................................................................................. 10 2.1.2 Size ......................................................................................................... 13 2.1.3 Technical Debt ....................................................................................... 13 2.2 STATIC