第1回　ソフトウェア工学とは

Size: px

Start display at page:

Download "第1回　ソフトウェア工学とは"

がんまさかいざわ
5 years ago
Views:

1 ソフトウェア工学 1 第 8 回コーディングとレビュー 2017 年 6 月 6 日中島毅 1

2 授業内容コードを美しく書くことの意味構造化プログラミングとレビュー設計レビューとコードレビュー静的解析ツール 2

3 世の中の開発は流用ベースが多い基幹業務 ( 人事, 資材, 経理, ) のシステム FA, エレベータ, エアコン, エンジン制御, カーナビ製品ライフサイクル初期製品開発 ( 顧客 A 向け ) 市場ニーズの変化テクノロジーの進歩保守コストの増大次機種開発 YA-0 XA-0 XA-1 XA-2 XA-3 YA-1 顧客 ( 分野 )A 企画要求分析設計製造開発ライフサイクルテスト機種分岐 XB-1 XB-2 XB-3 シリーズ開発 ( 顧客ニーズ追随 ) YB-1 顧客 ( 分野 ) B 分野別開発 ( 仕向地, グレード ) 20~30 年生き長らえているプログラムがある 3

4 読めないプログラムでは開発が回らない生産量の 90% 以上が完全流用という開発プロジェクトがほとんど! 改造新規開発量 5kL 完全流用生産量 100kL 知っている人が少ない / いない新規 : 改造 : 全く新しく作る部分既存のプログラムを一部修正して作る部分完全流用 : 製品に組み込まれているが, 一切修正せず利用する部分 1 人しかアサインされない 4

5 読めないプログラムでは開発が回らない既存のコードが読めないと改造や不具合の原因追求ができない改造不具合の原因追求流用する部分を知らないで, 新規改造部分を作るのは容易でない欠陥は主にここに出現改造新規完全流用設計書がない! ソースコードが読めない! どう改造してよいか? バグの原因はどこ? 使い方のミス ( インタフェース ) にも欠陥あり既にあった欠陥の顕在化もあり品質悪化 & コスト増読めるプログラムを作ってほしい!( 切なる願い ) 5

6 授業内容コードを美しく書くことの意味構造化プログラミングとレビューコーディング規約設計レビューとコードレビュー静的解析ツール 6

7 よいプログラムを書くには良いプログラムとは欠陥がない移植性がよい性能がよいテストがしやすいシンプルである ( 無駄がない ) 自己説明的である自己証明的である ( 見て正しいことがわかる ) 基本作法構造化プログラミング 7

8 構造化プログラミングプログラムは作るほど欠陥が入る何とかならないか? Edsger W. Dijkstra 登場! オランダの数学者 ( チューリング賞受賞者 ) 構造化プログラミング提唱者プログラミングに, 数学の証明の考え方を導入すれば, プログラムに欠陥が入らなくなる. 8

9 構造化プログラミング ( 仕様の具体化 ) Structured programming とはプログラミング = 仕様を段階的に具体化していく過程順次親処理子処理 1 子処理 2 具体化子処理 3 N 階層はN+1 階層へ順次 / 分岐 / 反復の3 種類の制御構造分岐親処理具体化条件子処理 1 子処理 2 子処理 3 のいずれかを使って反復親処理 ( ルーフ ) 初期化仕様を分解条件子処理 1 具体化 9

10 例 : 生年月日と今日の日付から年齢を計算するプログラム今日が誕生日前後か判定する > 生月判定 = 後現在月 < 生月判定 = 前 = 生月日の前後で判定する >= 生日現在日判定 = 後 < 生日判定 = 前年齢を決定する判定 == 後年齢 = 現在年 - 生年年齢 = 現在年 - 生年 -1 プログラミング時 10

11 コーディング (C プログラム ) シンプルである自己説明的である自己証明的である // 年齢計算 int age(int byear, int bmonth, int bday, /* 生年月日 */ int cyear, int cmonth, int cday) /* 現在年月日 */ { enum question {yes, no afterbirthday; int result; // 今日が誕生日前後か判定する if (cmonth > bmonth) { afterbirthday = yes; else if (cmonth == bmonth) { // 日の前後で判定する if (cday >= bday) afterbirthday = yes; else afterbirthday = no; else { afterbirthday = no; プログラミング時 // 年齢を決定する if (afterbirthday == yes) result = cyear - byear; else result = cyear - byear - 1; return result; 11

12 構造化プログラミングとレビュー ( 証明過程 ) プログラムの正当性は N 階層と N+1 階層を比較して確認順次親処理子処理 1 命題 A 子処理 2 比較子処理 3 補題 1 補題 2 補題 3 補題 1 補題 2 補題 3 命題 A 数え上げ分岐親処理命題 A 比較条件子処理 1 子処理 2 子処理 3 補題 1 補題 2 補題 3 補題 1 補題 2 補題 3 命題 A 反復親処理命題 A 比較 ( ルーフ ) 初期化条件子処理 1 n=1 のとき成立 n のとき成立するとして n+1 を証明数学的帰納法 12

13 コーディング (C プログラム ) シンプルである自己説明的である自己証明的であるコードレビューがやりやすい! レビュー時 // 年齢計算 int age(int byear, int bmonth, int bday, /* 生年月日 */ int cyear, int cmonth, int cday) /* 現在年月日 */ { enum question {yes, no afterbirthday; int result; // 今日が誕生日前後か判定する if (cmonth > bmonth) { afterbirthday = yes; else if (cmonth == bmonth) { // 日の前後で判定する if (cday >= bday) afterbirthday = yes; else afterbirthday = no; else { afterbirthday = no; // 年齢を決定する if (afterbirthday == yes) result = cyear - byear; else result = cyear - byear - 1; return result; 13

14 参考 : 等価なプログラム int age(int AY, int AM, int AD, int BY, int BM, int BD) { int X, Y; X=0;Y=BY-AY; if (BM>AM)X=1; if (BM==AM&&BD>=AD)X=1; if (X==0) Y-=1; return Y; 何が悪いか読んで理解できない, 正しさを確かめられない変数名が記号になっている変数とそれを使った式の意味は? インデントや改行がない構造はどうなっている? if 文がelse 項を持たない場合分けがどこを通る? 計算の順番がまとまっていないどの計算結果がどこで使われる? 14

15 コーディング規約読みやすさの追求コーディング規約プログラム自体を説明的にしよう! 画面に収まる範囲の大きさにモジュールを作る統一的でわかりやすい関数名 / 変数名を使う統一的な制御構造を使う統一的なレイアウト ( 空行空白改ア行 ) コメントを書こう! ヘッダコメント変数コメント ( 引数 / 内部変数 ) ブロックコメントコーディング規約の例 15

16 コメント例 /******************************************* *** Designer : 中島毅 *** Date : *** Purpose : 三角形の種別を判定するプログラム *******************************************/ #include <stdio.h> enum Result {ordinaltriangle=0, isoscelestriangle=1, equilateraltriangle=2; int main() { float x, y, z; /* 三角形の 3 辺 */ enum Result myresult; /* 判定結果 */ extern enum Result checktriangle(int, int, int); // データ読み込み fprintf(stderr, "x = "); (void)scanf("%f", &x); fprintf(stderr, "y = "); (void)scanf("%f", &y); fprintf(stderr, "x = "); (void)scanf("%f", &z); ヘッダコメント ( 作成者日付内容等 ) 変数コメント ( 引数 / 内部変数 ) ブロックコメント 16

17 授業内容コードを美しく書くことの意味構造化プログラミングとレビューコーディング規約設計レビューとコードレビュー静的解析ツール 17

18 設計レビューとはソフトウェアの品質を保証するための人手による検証活動要求分析 / 企画ユーザ分析者検討確認伝達要求仕様検討確認設計設計者伝達設計仕様工程を設定するコーディングテスト検討確認プログラマテスタソースコード正しさを確かめ, 伝えるためにドキュメントを作成し, 確認する 18

19 実際設計レビューってどうやっている? 会議形式のレビューレビューしてもらう人 : 説明するレビューする人 : 質問する指摘する書面レビュー書類をまわす赤を入れる誰が? 自分 ( セルフレビュー ) 仲間内 ( ピアレビュー ) 利害関係者 ( 公式レビュー )

20 コードに含まれる欠陥の種別をあげよ今までに出会ったことのあるバグを思い浮かべよう手強かったのはどんなバグか? 20

21 コードに含まれる欠陥の種類 ( 単体レベル ) カテゴリシンボル演算配列メモリ条件式条件組合せ設計誤り種別シンボル取り違え演算子の取り違え演算順序間違い型変換誤り初期化抜け精度誤り配列領域からの逸脱参照不正領域 (Null 不定値) への書き込みメモリリーク ( 開放不正 ) 異なる型の比較演算子の順序誤り精度の異なる値の比較比較演算子の選択誤りループ終了時の処理の誤りループ脱出条件の誤りループ変数の変更誤り複合条件式の組合せ誤り複数条件ブロックの組合せ誤りアルゴリズムとデータ構造の不正条件処理抜け例外処理抜け変数の物理値域と物理値域の不整合 21

22 コードレビューソースコードの正しさを検査するために人が読んで確認する設計レビュープログラム仕様を満たすことコーディング規約コーディング規約を満たすこと視点 1: 機能仕様満足レビューのポイント 1 守るべきこと 2 確認の視点 3フィードバック ( 改善 ) プログラム仕様書ソースコード視点 2: アルゴリズムの出来視点 3: インタフェースミス視点 4: プログラムミスチェックリストレビュー結果報告書フィードバック ( また起こりそうなエラー ) 22

23 コードレビューの流れ利点 / 欠点ソースコードレビューの流れ作成者自身セルフレビュー開発チーム内ピアレビュー関係者 ( 設計者テスタ品質保証者など ) 公式レビューポカミス除去の観点実装の適切さの観点品質保証の観点利点欠点あらゆる種類の欠陥を見つけることが可能一般に欠陥を見つけるコストはテストに比べて安価人間が実施するのでレビューアの能力とやる気にパフォーマンス ( 欠陥検出率検出効率 ) が左右される 23

24 コードレビューの種類実施方法実施形態利点ウォークスルー法プログラムを机上で実行することでプログラムの動作を追いながら欠陥を見つける ( 机上実行 ) 主にピアレビューで使用複数人での実施が推奨コードの実装が仕様を満足していることを確認しやすいプログラム仕様やコードの実装の意味を伝えるのに向いている ( 技能とノウハウの伝達 ) チェックリスト法 ( インスペクション ) ルールとチェックリスト (CL) を用いて着眼点ごとに欠陥を見つける通常個別に事前レビュー実施主に公式レビューで使用参加者の役割が決っている ( 例 ) 開発者モデレータ他コードでありがちな欠陥を検出に向いている (CL の効用 ) 基準 ( ルールと CL) があるので品質保証として意味をもつ 24

25 コードレビューの体験仕様 : このプログラムは 3 つの数字を端末より読み込むこの 3 つの値はそれぞれ三角形の3 辺の長さを表すものとするプログラムは三角形が不等辺三角形二等辺三角形正三角形のうちのどれであるかを決めるメッセージを出力する三角形でないケースについてもその旨を出力するチェックリスト C-1 プログラムは仕様を満たしているか? C-2 コーディング規約にあっていないものがあるか? C-3 プログラム自体にエラーはあるか? コーディング規約 ( 抜粋 ) R-1 main 関数は引数がないとき void を記述する R-2 代入の型が違う場合には明示的にキャスト ( 強制型変換 ) する R-3 if/while/for の後は必ずブロック { にする R-4 if 文は必ず else 文を伴うこと 25

26 /************************************************* *** Designer : 中島 *** Date : *** Purpose : 三角形判定プログラム *************************************************/ #include <stdio.h> enum Result {ordinaltriangle=0, isoscelestriangle=1, equilateraltriangle=2; /************************************************ *** Function Name : checktriangle *** Designer : 中島 *** Date : *** Function: 3 辺の長さから不等辺三角形二等辺三角形正三角形のいずれかを判定する *** Return : ordinaltriangle -- 不等辺三角形 isoscelestriangle -- 二等辺三角形 equilateraltriangle -- 正三角形 ************************************************/ enum Result checktriangle(int x, int y, int z) { enum Result myresult; // 正三角形のチェック if (x == y && y == z) myresult = equilateraltriangle; // 二等辺三角形のチェック if (x == y y==z z == x) myresult = isoscelestriangle; /************************************************ *** Function Name : checktriangle *** Designer : 中島 *** Date : *** Function: 3 辺の長さから不等辺三角形二等辺三角形正三角形, 三角形不成立のいずれかを判定する ************************************************/ int main() { float x, y, z; /* 三角形の 3 辺 */ enum Result myresult; // データ読み込み fprintf(stderr, "x = "); (void)scanf("%f", &x); fprintf(stderr, "y = "); (void)scanf("%f", &y); fprintf(stderr, "x = "); (void)scanf("%f", &z); // 三角形判定 myresult = checktriangle(x, y, z); // 出力 if (myresult == ordinaltriangle) printf("result = 不等辺三角形 n"); else (myresult == isoscelestriangle) printf("result = 正三角形 n"); else { printf("result = 二等辺三角形 n"); return 0; return myresult; 26

27 授業内容コードを美しく書くことの意味構造化プログラミングとレビューコーディング規約コードレビュー静的解析ツール 27

28 コードレビューの支援ツール : 静的解析静的解析ツールプログラムを実行することなく, 危険なコード部分を見つけ警告を出すツール解析コンパイル直後ソースコード静的解析ツールレポート 1 警告 2 メトリクスプログラマ修正不具合を含むコードの重大問題を早期発見! 28

29 静的解析ツールの機能 : 警告出力危険なコードに警告を出す不具合に直結するコード保守性の悪いコード早い段階で見つけ修正できればコスト効果大! 初期化忘れの例 // ネットワークノードの接続 long NwDrawer::GNAtoINL(GNetwkArc* pgna,iltlink* pinl, double fromid,double toid) { IltObject* fromine; IltObject* toine; // 始点と終点の決定 if (fromid >= 0) { fromine = SearchNetworkElement(fromID); // 終点 IDが正常値である場合 if (toid >= 0) { toine = SearchNetworkElement(toID); // どちらかのIDが異常な場合 if ( (fromine == NULL) (toine == NULL) ) { return -1; fromid >= 0 なら fromine 初期化 toid >= 0 なら toine 初期化変数が初期化されない場合がるあので : このチェックは機能しない場合がある警告例 S: QAC PROJECT source GNWtoTGO Drawer.cpp(248) ++ WARNING ++: <=5=(4201) 変数 'fromine' は設定されていない可能性があるのにアクセスされています S: QAC PROJECT source GNWtoTGO Drawer.cpp(248) ++ WARNING ++: <=5=(4201) 変数 'toine' は設定されていない可能性があるのにアクセスされています 29

30 静的解析ツールで検出できる欠陥初期化忘れ危険な型変換型不一致の代入関数の引数戻り値の型不一致誤りがちな構文あいまいな実行評価順序危険なポインタ演算条件式内の代入メモリ操作ミスメモリ領域 ( 配列 ) の範囲オーバーメモリ解放忘れ処理系依存 ( 移植性の問題 ) 下線は OSS, 他は商用 C/C++ 言語 splint, cppcheck, QA C/QA C++, Klocwork, Coverity Java 言語 jlint, checkstyle, Klocwork Insight, Jtest 30

静的解析ツールの機能 : メトリクス出力コード品質のメトリクスを計算する保守性 : プログラム行数, McCabe ( 分岐の数 +1) 例 ) 1 モジュール 100 行 McCabe 10 以上は理解困難 / 欠陥率の増加が顕著テスト可能性 : 静的経路数 ( すべての実行パスの数 ) 例 ) 1 モジュール 200 経路以上は単体試験でのテスト網羅性を確保しにくい

31 静的解析ツールの機能 : メトリクス出力コード品質のメトリクスを計算する保守性 : プログラム行数, McCabe ( 分岐の数 +1) 例 ) 1 モジュール 100 行 McCabe 10 以上は理解困難 / 欠陥率の増加が顕著テスト可能性 : 静的経路数 ( すべての実行パスの数 ) 例 ) 1 モジュール 200 経路以上は単体試験でのテスト網羅性を確保しにくい品質メトリクスが悪いコード部分を指摘メトリクス基準値例モジュール別メトリクス値早めに悪いプログラム構造をチェック ( メトリクスの悪いところは品質も悪い場合が多い ) QAC 基準値経路複雑度 (1 関数あたり ) 10 GOTO 数 (1 関数あたり ) 0 コード行数 (1 関数あたり ) 100 ネストの深さ (1 関数あたり ) 7 静的経路数 (1 関数あたり ) 200 1ファイルの行数 2000

32 例題 : 人間のレビュー VS 静的解析ツールいくつプログラムの欠陥らしきものを見つけられますか? #include <stdio.h> #include <math.h> int myroot(double x) { int y; if (x > 0) { y = sqrt(x); return y; int main(void) { int i; double *x = (double*)malloc(sizeof(double)*100); while (i <= 100) { x[i] = myroot((double)i); i++; return 0; 32

33 コードに含まれる欠陥と検出手段コードに含まれる誤り検出手段カテゴリ種別コンパイラテストレビュー静的解析シンボルシンボル取り違え演算演算子の取り違え演算順序間違い型変換誤り初期化抜け精度誤り配列配列領域からの逸脱参照メモリ不正領域 (Null 不定値) への書き込みメモリーリーク ( 開放不正 ) 条件式異なる型の比較演算子の順序誤り精度の異なる値の比較比較演算子の選択誤りループ終了時の処理の誤りループ脱出条件の誤りループ変数の変更誤り条件組合せ複合条件式の組合せ誤り複数条件ブロックの組合せ誤り設計誤りアルゴリズムとデータ構造の不正条件処理抜け例外処理抜け変数の物理値域と物理値域の不整合検出可能場合により検出可能 33

34 まとめコードは資産人に読んでもらうことを意識する良いコードを書くには : 構造化プログラミングコーディング規約コードレビューはソフト開発における重要な活動守るべきこと確認の視点フィードバックウォークスルー法とチェックリスト法静的解析ツールを使う SE はコードを書かなくても良いコードの意味レビューを大切さを知っておく必要がある 34

040402．ユニットテスト

040402．ユニットテスト 2. ユニットテストユニットテスト ( 単体テスト ) ユニットテストとはユニットテストはプログラムの最小単位であるモジュールの品質をテストすることでありその目的は結合テスト前にモジュール内のエラーを発見することであるテストは機能テストと構造テストの2つの観点から行うモジュールはプログラムを構成する要素であるから単体では動作しないドライバとスタブというテスト支援ツールを使用してテストを行う

第1回 ソフトウェア工学とは

第1回　ソフトウェア工学とは