スキップしてメイン コンテンツに移動

Measure Code & Improve Team Based Software Development

Labels:

Introduction

In this post, I'm going to write about "Why & How to measure your code of software project. And improve it."
I am going to mainly write about this topic from the static code analysis point.

Why Measure?

There are number of reasons to measure your code.
For me especially following reasons (or intentions).

  • Daily Health Check
    • Keep code base clean
    • See impact on entire code base by your code change
    • Detect problems as soon as possible
    • Feel improvement!
  • Let every team members show what happens
    • Monitor test result status
    • Follow coding standard

Especially in team based software development, a lot of people change code for different task.
And each developer is hard to know what each developer change the code for what purpose.
If the source code measurement is public for everyone, it helps everyone to know affect of entire project which the other developers make.


What to Measure?

There are a lot of measurement is proposed but from static code analysis point, I think following covers enough for software project.
  • Lines of Code (LOC)
  • Copy and Paste
  • Code Complexity: Cyclomatic Complexity, Npath Complexity
  • Compliant of Coding Standard
  • Test Success Rate
  • Test Coverage
  • Elapsed time of Build/Test Running
  • Number of Slow Query
  • Technical Debt: Introduced by SonarQube. It calculates technical debt, whose unit is time, from code complexity or compliant rate of coding standard, etc. based on configured rules

Measurement Principles for Team Based Software Development

Before going into introduction to concrete software tools, I will show you my own principle for measuring code.

  • Automated
  • Continuously Measured
  • Public = Shared with everyone

Hope you agree with above points. Let me explain a bit about above points.
Automated - needless to say if you are a software developer having common-sense :)
Continuously Measured - Measure every small change is quite important because you can detect the change (doesn't matter bad or good) as early as possible.
In current software development world, project requires quicker and more frequent changes than before, and much more in the future.
This means measurement process should also follow with this trend.
Public = Shared with everyone - You can also use plugins on private IDE. But this is not recommended for software development based on team. Because ONLY you can run the tools and see the result.


Tools

PMD (Program Mess Detector)

This tool can calculate cyclomatic complexity or NPath complexity and aggregate by method or class or file. Then show alerts if the calculated value is higher than configured threshold.
It also show us unused variables and (private) methods.
This tool covers almost all major programming languages except PHP :P
If you would like to use it for PHP, use PHPMD.
I suggest use this with CPD (Copy & Paste Detector). Somehow CPD supports PHP.


Checkstyle

This checks written code is compliant for configured coding standard rule.
If the code violated rule, it show us an alert.


Findbugs

This tool can detect the code which is bug or may introduce bug.


SonarQube

Most powerful tool for tracking the source code or project analysis result. It introduces "Continuous Inspection"
You can analyze almost everything - LOC, Compliance of coding standard, Complexity which is a kind of PMD provides, Code Duplication, percentage of comments, test coverage rates etc.
It provides "Time machine;" functionality - you can check time change of measurement on visualized graph.
It covers all major programming languages and provides a lot of plugins.
It also calculates "Technical Debt", whose unit is time, based on your configuration.
I highly recommend SonarQube!


Build Tools

Build tools are not directly involved with source code analysis but these are so important to achieve "Automated", "Continuously Measured" process.
The major tools I can think of in 2015 are below:


Testing Tools

If you would like to analyze testing result or measure test coverage, you should use test automation tools.
This post is not aimed for introducing testing tools so I just only give you some tools.

By the way, in java, we need not only JUnit but also need external library for calculating test coverage and mocking.
By contrast to Java, for example PHP, PHPUnit provides all mock, test coverage functionalities.


Continuous Integration Server

So far I introduced a bunch of tools which analyze source code itself.
Of course you can run these tools independently but this doesn't meet my principles - "Automated", "Continuously Measured", "Public"
In order to meet the principles, we should use continuous integration server
I think Jenkins is the most popular one but there are good commercial CI servers, too. Such as TeamCity or Bamboo.
If you have a money or budget, I think you should consider these commercial CI servers.

They provides a lot of project measurement (or code inspection) features by plugins.
For example for Jenkins, there is a plugin for visualizing PMD, CPD, Checkstyle, Test coverage result more human readable format like Violation Plugin.
You can also track time changes of number of test cases and elapse of test running.

How to Evaluate?

Now you can get and see bunch of source code measurement.
But the next step, evaluation of the measurement is as important as measuring itself.

Let me show you my evaluation standards.

  • Number of Test cases: Doesn’t matter
  • Test Coverage: Higher is better. But should NOT achieve 100%! It's waste of time!
  • Duration of Test Running: Faster is much better
  • Code Duplication Percentage: Lower is better – DRY principle
  • PMD (complexity, unused variables and methods etc.): Lower is better
  • Lines of Code: Less is better

Another important evaluation point is tracking time change.
You can compare measurement between any software projects. But for me this is not so important because the background of project is so different.
Rather than comparing between projects, I think comparing measurement result between same project is much important.


Pitfall of Measurement

The trap someone usually falls into is "Measurement and improve measurement itself becomes the purpose".

For example, trying to achieving 100% test coverage is very good attitude.
But this doesn't mean test quality is good.
And also Achieving 100% test coverage costs a lot of time (=money).
In the real software development world, we work for project success in the first place.
For each project, you should carefully choose what kind of tests should be done and what kind of tests should be skipped.
I think a good (business oriented) software developer knows this kind of cost-benefit performance and can balance test granularity properly.


Final Words

Before Blaming "What a crappy code!", you should measure, improve the code and show the improved evidence!
Measurement result should be public for every team mates.
Measurement is measurement, Not itself is the purpose.
Good Luck! Hope this post help your software development ;)

コメント

コメントを投稿

このブログの人気の投稿

Eclipseでコードカバレッジのハイライトを削除する方法

Eclipseには便利なコードカバレッジ表示機能が搭載されていますが、コード内に緑、赤、黄の色付けがされて煩く感じるときもあると思います。 1度カバレッジの色付けが出てしまった後に消す方法の紹介です(方法は簡単)。 下記のキャプチャの青いマーカーで示した「Remove All Sessions」のボタンを押せばすべて消えます。
コメントを投稿
Read more

「特定の文字から始まらない文字列」にマッチする正規表現

「特定の文字から始まらない文字列」 にマッチする正規表現の例です。  以下の例では、Aから始まらない文字列にマッチする正規表現を示しています。 ^(?!A).*$ 私も正規表現の組み方で四苦八苦することがあります。以下の書籍は実践的に様々な正規表現のパターンを例示してくれているので、重宝しています。
コメントを投稿
Read more

ダイソーで買った200円のドライバーセットでHDDを分解

HDDの処分 最近は個人情報の問題もあって、HDDを処分する前にちゃんとデータの消去を気にすることも多くなってきました。消去方法としては大きく分けて下記の3つがあります。 データ消去ソフトでフォーマット HDD内部のプラッタを物理破壊 データ消去を行ってくれる専門の業者や家電量販店(Sofmapやビックカメラで実施していると思います。費用発生。)に持ち込み。 データ消去ソフトでのフォーマットは簡単ですが、欠点として「フォーマットに時間がかかる」「セクタ破損などで中途半端に壊れたディスクのフォーマットができない」などがあります。 またHDD内部のプラッタの物理破壊については、HDDを分解するために、通常のプラスやマイナスドライバーではなく、星形ネジに対応したトルクスドライバーが必要とのこともあって、少し面倒です。 筆者は今回、今後もHDDの廃棄をするだろうなあと思い、思い切って自分で分解して廃棄することにチャレンジしてみました。(家電量販店に持って行くよりも安くできないかというどケチ丸出しですw) HDDの星形ネジ こんなやつです。ちなみに写真はSeagateのST2000DL003というHDDで撮影しました。 トルクスドライバー というわけで、分解のために Amazonでトルクスドライバー を探しました。 調べると T8のもだと使えそう とのことで、いろいろと物色。 セットのものとか T8一本で立派なやつとか 色々あったのですが、HDD壊すだけで800円かぁ(←どケチ)、と思って購入を躊躇。 ネット上で調べると100円ショップのダイソーでも、トルクスドライバーを販売しているとの情報をキャッチ！近所のダイソーに行って、探したところ星形のヘッド交換に対応した精密ドライバーセットがありました。 プラスが10種類、マイナスが8種類、六角が6種類、星形が6種類(今回ほしかったもの)のセットで、何とお値段税抜き200円！、税抜き200円！と安かったので、ダメもとで購入しました。 結論から言うと 買って大正解 でした。 ダイソーの精密ドライバーセット こんな商品です！ 星形対応のヘッドを装着するとこんな感じ。ドライバーのグリップもゴムで滑らない様になっていて使いやす...
コメントを投稿
Read more

SQLで特定の文字を組み合わせたランダムな文字列を生成

簡易的な方法として「指定した文字列からランダムに1文字選ぶ」を必要な文字の長さ分concat関数でつなげれば実現できます。 1文字ずつ文字を選ぶので、あまり性能もよくない上、セキュリティ的な観点からのランダム性も担保されていないので、あくまで開発中に必要になった時に使う程度が無難だと思います。 下記に英数字大文字小文字を含んだランダムな3文字の文字列を生成するクエリを示します。 # RAND関数で指定した文字列からランダムに1文字選択。 # 下記の例の62の部分はa~z、A~Z、1~9の文字数の合計値を入れた結果 SELECT CONCAT( SUBSTRING('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789', FLOOR(RAND() * 62 + 1), 1), SUBSTRING('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789', FLOOR(RAND() * 62 + 1), 1), SUBSTRING('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789', FLOOR(RAND() * 62 + 1), 1) ) AS random_string;
コメントを投稿
Read more

PHPの配列(array)のメモリ使用量の考察

はじめに 最近PHP上に大量のデータをメモリ上に展開していたのですが、配列(array)の形式(連想配列 or 単純な配列)や配列の要素のデータ構造(数字、配列、文字列など)で大きくメモリ使用量に差が出てくることに気づき、簡単なプログラムを組んで調べてみました。 あくまで筆者の環境での結果なので、細かい数値は参考程度に見てください。 測定環境と方法 OS: Windows 10 PHP 7.4.5 (php-7.4.5-nts-Win32-vc15-x64) 配列に要素を追加するプログラムを書いて、PHPのmemory_get_usage(true)関数を使って実メモリ使用量を計測しました。 計測結果 No. 方式 1MB当たり作成できる 要素数 プログラム 補足 1 キーも値も整数の配列 (整数IDを想定) 28571 // 2,000,000 / 70MB $row = []; for($i = 0; $i < 2000000; $i++) { $row[] = $i; } No.2~6でテストしたプログラム中の要素数は200,000。これだけ一桁多い！ 2 キーが文字列、値が整数の連想配列 8333 // 200,000 / 24MB $row = []; for($i = 0; $i < 200000; $i++) { $row[$i.'_key_string'] = $i; } キーの文字列が長い方がメモリ使用量多くなる。 3 キーが整数、値が連想配列の配列 DBから取得してきたデータを想定 2325 // 200,000 / 86MB $row = []; for($i = 0; $i < 200000; $i++) { row[] = ['id' => $i]; } 4 キーが整数、値が連想配列の配列(配列に複数の値を保持) DBから取得してきたデータを想定 2127 // 200,000 /...
コメントを投稿
Read more

ADODB.streamオブジェクトを使って文字列とByte配列を相互変換(Excel VBA)

ADODB.streamオブジェクトを使って文字列をByte配列に変換するコードのサンプルです。 ExcelVBAでADODB.streamを使う際には、 1. ExcelのMicrosoft Visual Basic エディタのメニューバーから「ツール->参照設定」とたどる。 2. 表示されたダイアログからMicrosoft ActiveX Data Objectsにチェックを入れる。 という手順が必要です。 文字列からByte配列へ Private Function ADOS_EncodeStringToByte(ByVal cset As String, ByRef strUni As String) As Byte() On Error GoTo e Dim objStm As ADODB.stream: Set objStm = New ADODB.stream objStm.Mode = adModeReadWrite objStm.Open objStm.Type = adTypeText objStm.Charset = cset objStm.WriteText strUni objStm.Position = 0 objStm.Type = adTypeBinary Select Case UCase(cset) Case "UNICODE", "UTF-16" objStm.Position = 2 Case "UTF-8" objStm.Position = 3 End Select ADOS_EncodeStringToByte = objStm.Read() objStm.Close Set objStm = Nothing Exit Function e: Debug.Print "Error occurred while encoding characters" & Err.Description If objStm Is No...
コメントを投稿
Read more

MySQL: SELECTの結果をUNIONして ORDER BYする際の最適化方法

SELECTの結果をUNIONして ORDER BY する際には下記の点に注意する必要があります。 無駄なメモリ消費 ソートにINDEXが利かない (≒CPU負荷増大) 対応策 可能であればPush-down Condition (各サブクエリ内でORDER BY, LIMIT, OFFSETを適用してからUNION, ORDER BYを実行する)を利用することで、 パフォーマンスを改善できる場合があります。 下記に例を示します。 もともとのクエリ SELECT tmp.* FROM ( SELECT tableA.column1, tableA.column2 FROM tableA WHERE (条件) UNION ALL SELECT tableB.column1, tableB.column2 FROM tableB WHERE (条件) ) AS tmp ORDER BY tmp.column1, tmp.column2 LIMIT 100, 20 Push-down Conditionを用いて書き直したクエリ SELECT tmp.* FROM ( SELECT tableA.column1, tableA.column2 FROM tableA WHERE (条件) ORDER BY tableA.column1, tableA.column2 LIMIT 30 # ただしこのPush-down Conditionの手法も下記の場合は、効果が半減しますので注意が必要です。 OFFSETの値が大きい場合は、結局全結果セットUNIONと変わらない サブクエリ内のソートで、INDEXが効かない場合
コメントを投稿
Read more

Visual Studio 2010 SP1のアンインストール

Visual Studio 2013に乗り換えるためにVisual Studio 2010をアンインストールしようとしたところで問題発生。。。 先にVisual Studio 2010本体をアンインストールした後、Visual Studio 2010 SP1をアンインストールできなくて困っていました。 Google先生で調べたところ、以下の情報が見つかり、書かれていた通り実施したところ無事Visual Studio 2010 SP1のアンインストールに成功しました。 How to uninstall/remove Visual Studio SP1 アンインストール手順は以下の通りです。 http://www.microsoft.com/en-gb/download/details.aspx?id=23691 からMicrosoft Visual Studio 2010 Service Pack 1 (Installer)をダウンロード VS10sp1-KB983509.exeというファイル名でダウンロードされる(はず)。 コマンドプロンプトから以下のコマンドを実行 (以下の例は、c:\tempにVS10sp1-KB983509.exeがある場合) c:\temp\VS10sp1-KB983509.exe /uninstall /force ダイアログが立ち上がるので、アンインストールを選択して次へ進めばOK!
コメントを投稿
Read more

PHPでファイルを指定した行数ごとに分割

ファイルを指定した行数ごとに分割するためには、Linuxのsplitコマンドを使えば簡単に実現できます。 PHPではexec関数にsplitコマンドを渡して実行すればよいですが、下記の弱点があります。 Linuxのコマンドに依存 (PHPの場合はほとんどLinux環境で動作させることが普通なのでそこまで問題にならないかも知れません)。 exec関数は慎重に引数を渡さないと、OSコマンドインジェクション脆弱性を引き起こす可能性がある。 そこで、今回はPHPでファイルを指定した行数ごとに分割するプログラムを書いてみました。 <?php class FileSplitter { private $lines; private $fileCount; public function split($filePath, $linesPerFile, $outputDir) { $this->fileCount = 0; $this->lines = null; $file = new \SplFileObject($filePath); $lineCount = 0; try{ while (!$file->eof()) { if($lineCount % $linesPerFile === 0) { $this->writeToFile($this->generateOutputFilePath($outputDir, $file)); } $this->lines[] = $file->fgets(); $lineCount++; } $this->writeToFile($this->generateOutpu...
コメントを投稿
Read more

MySQLのSQL_CALC_FOUND_ROWS使用上の注意

MySQLのSQL_CALC_FOUND_ROWSを使用する際の無駄なメモリ消費に注意 ページング機能の実装などのために、ヒットした全件数を取得する必要のある場合があるかと思います。 その場合、下記のようにSQL_CALC_FOUND_ROWSを使うと、検索結果に加えて、そのクエリの全ヒット件数が取得できます。 SELECT SQL_CALC_FOUND_ROWS table.column1, table.column2 ...(途中省略)... FROM table WHERE (条件) しかし、SQL_CALC_FOUND_ROWSを使うと、「絞り込んだ結果にヒットする全べての行の結果のセットを作成する」という大きな欠点があります。 これは、LIMIT, OFFSETを指定していても実行されてしまうので、 SELECTで指定するカラム数やデータ量が多い SELECTの結果返ってくる行数が多い 場合、無駄に領域(≒メモリ)を消費してしまうので注意が必要です。 例えば、100万行検索対象としてヒットするクエリの場合、仮にLIMIT 20と指定して最初の20行を取得するようにクエリを書いても、その100万行分の結果セットが作成されてしまうということになります。 対応策 根本的な対応策としては、SQL_CALC_FOUND_ROWSを使わない(結果行数の取得はCOUNTを用いた別クエリで取得する、結果行数をあらかじめサマリーテーブルに保持しておく)ことですが、 SQL_CALC_FOUND_ROWSをどうしても使う必要がある場合は、 SELECT SQL_CALC_FOUND_ROWS primary_id のように最低限のカラムを指定して結果行セットを取得 (LIMIT OFFSET指定前提) 取得したprimary_idを使って必要なデータを取得 して、SQL_CALC_FOUND_ROWSで使用する領域をできるだけ減らすことで、対応するしかないと思います。 世の中ではLIMIT, OFFSETは使わない方がよいとよく書かれていますが、 SQL_CALC_FOUND_ROWSは、書いてしまえばどんなときも検索にヒットする全結果行セットを作成するので、同じくらい使用する際には注意が必要です。
コメントを投稿
Read more