web-dev-qa-db-ja.com

Perlビルド、ユニットテスト、コードカバレッジ：完全な実例

Perlのビルドプロセス、ユニットテスト、コードカバレッジに関して私が見つけたほとんどのStackoverflowの回答は、そこにあるドキュメントのCPANを指し示しているだけです。 CPANモジュールを指すことは絶対に悪いことではありません。完全なドキュメントがある場所だからです。ただし、多くの場合、完全に機能するコード例を見つけるのに苦労しました。

典型的なチュートリアル「Hello World」のソースコードの例のように、ダウンロードまたはIDEに貼り付けることができる実際の作業コードサンプルをインターネット上で検索していますが、単体テストとコードを使用したビルドプロセスを示す例カバレッジ分析。これらのテクノロジーとプロセスを実証する完全な作業プロジェクトの小さな例はありますか？

（私は小さな実例があり、それで自分の質問に答えますが、おそらく他のSO私が思いついたものよりも良い例があるユーザーがいます。 ）

perlunit-testingbuild-processbuild-automationcode-coverage
83
Kurt W. Leucht

少し時間がかかり、いくつかの異なるソースから小さなスニペットを取り、それらを一緒に溶かしましたが、ユニットテストとコードカバレッジを含むPerlビルドプロセスをPerl初心者に十分に実証する小さな作業例があると思います分析とレポート。 （Windowsで ActiveState ActivePerl v5.10.0を使用していますXP Pro PC、 Module :: Build 、 Test ::その他 、 開発::カバー ）

Perlプロジェクトのディレクトリから始めて、プロジェクトディレクトリの下に「lib」ディレクトリと「t」ディレクトリを作成します。

HelloPerlBuildWorld
        |
        |----------> lib
        |
        |----------> t

「lib」ディレクトリで、「HelloPerlBuildWorld.pm」という名前のテキストファイルを作成します。このファイルは、ビルドおよびテストするPerlモジュールです。次のコンテンツをこのファイルに貼り付けます。

use strict;
use warnings;
package HelloPerlBuildWorld;

$HelloPerlBuildWorld::VERSION = '0.1';

sub hello {
   return "Hello, Perl Build World!";
}

sub bye {
   return "Goodbye, cruel world!";
}

sub repeat {
   return 1;
}

sub argumentTest {
    my ($booleanArg) = @_;

    if (!defined($booleanArg)) {
        return "null";
    }
    elsif ($booleanArg eq "false") {
        return "false";
    }
    elsif ($booleanArg eq "true") {
        return "true";
    }
    else {
        return "unknown";
    }

   return "Unreachable code: cannot be covered";
}

1;

「t」ディレクトリで、「HelloPerlBuildWorld.t」という名前のテキストファイルを作成します。このファイルは、上記のPerlモジュールを完全にテストしようとする単体テストスクリプトです。次のコンテンツをこのファイルに貼り付けます。

use strict;
use warnings;
use Test::More qw(no_plan);

# Verify module can be included via "use" pragma
BEGIN { use_ok('HelloPerlBuildWorld') };

# Verify module can be included via "require" pragma
require_ok( 'HelloPerlBuildWorld' );

# Test hello() routine using a regular expression
my $helloCall = HelloPerlBuildWorld::hello();
like($helloCall, qr/Hello, .*World/, "hello() RE test");

# Test hello_message() routine using a got/expected routine
is($helloCall, "Hello, Perl Build World!", "hello() IS test");

# Do not test bye() routine

# Test repeat() routine using a got/expected routine
for (my $ctr=1; $ctr<=10; $ctr++) {
    my $repeatCall = HelloPerlBuildWorld::repeat();
    is($repeatCall, 1, "repeat() IS test");
}

# Test argumentTest() 
my $argumentTestCall1 = HelloPerlBuildWorld::argumentTest();
is($argumentTestCall1, "null", "argumentTest() IS null test");

# Test argumentTest("true") 
my $argumentTestCall2 = HelloPerlBuildWorld::argumentTest("true");
is($argumentTestCall2, "true", "argumentTest() IS true test");

# Test argumentTest("false") 
my $argumentTestCall3 = HelloPerlBuildWorld::argumentTest("false");
is($argumentTestCall3, "false", "argumentTest() IS false test");

# Test argumentTest(123) 
my $argumentTestCall4 = HelloPerlBuildWorld::argumentTest(123);
is($argumentTestCall4, "unknown", "argumentTest() IS unknown test");

トップレベルのプロジェクトディレクトリにバックアップし、「Build.PL」という名前のテキストファイルを作成します。このファイルは、後で使用するビルドスクリプトを作成します。次のコンテンツをこのファイルに貼り付けます。

use strict;
use warnings;
use Module::Build;

my $builder = Module::Build->new(
    module_name         => 'HelloPerlBuildWorld',
    license             => 'Perl',
    dist_abstract       => 'HelloPerlBuildWorld short description',
    dist_author         => 'Author Name <[email protected]>',
    build_requires => {
        'Test::More' => '0.10',
    },
);

$builder->create_build_script();

必要なファイルはこれだけです。次に、最上位プロジェクトディレクトリのコマンドラインから、次のコマンドを入力します。

Perl Build.PL

次のようなものが表示されます。

Checking prerequisites...
Looks good

Creating new 'Build' script for 'HelloPerlBuildWorld' version '0.1'

これで、次のコマンドを使用してユニットテストを実行できるようになります。

Build test

これに似たものを見てください：

Copying lib\HelloPerlBuildWorld.pm -> blib\lib\HelloPerlBuildWorld.pm
t\HelloPerlBuildWorld....ok
All tests successful.
Files=1, Tests=18,  0 wallclock secs ( 0.00 cusr +  0.00 csys =  0.00 CPU)

コードカバレッジ分析を使用して単体テストを実行するには、次を試してください。

Build testcover

そして、次の順序で何かが表示されます。

t\HelloPerlBuildWorld....ok
All tests successful.
Files=1, Tests=18, 12 wallclock secs ( 0.00 cusr +  0.00 csys =  0.00 CPU)
cover
Reading database from D:/Documents and Settings/LeuchKW/workspace/HelloPerlBuildWorld/cover_db


----------------------------------- ------ ------ ------ ------ ------ ------
File                                  stmt   bran   cond    sub   time  total
----------------------------------- ------ ------ ------ ------ ------ ------
D:/Perl/lib/ActivePerl/Config.pm       0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/ActiveState/Path.pm        0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/AutoLoader.pm              0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/B.pm                      18.6   16.7   13.3   19.2   96.4   17.6
 ...
[SNIP]
 ...
D:/Perl/lib/re.pm                      0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/strict.pm                 84.6   50.0   50.0  100.0    0.0   73.1
D:/Perl/lib/vars.pm                   44.4   36.4    0.0  100.0    0.0   36.2
D:/Perl/lib/warnings.pm               15.3   12.1    0.0   11.1    0.0   12.0
D:/Perl/lib/warnings/register.pm       0.0    0.0    n/a    0.0    n/a    0.0
blib/lib/HelloPerlBuildWorld.pm       87.5  100.0    n/a   83.3    0.0   89.3
Total                                  9.9    4.6    2.8   11.3  100.0    7.6
----------------------------------- ------ ------ ------ ------ ------ ------


Writing HTML output to D:/Documents and Settings/LeuchKW/workspace/HelloPerlBuildWorld/cover_db/coverage.html ...
done.

（誰かが、Coverを除くすべてのPerlライブラリを無視するようにCoverを設定し、自分が書いた1つのファイルについて報告する方法を教えてください。 CPANドキュメント！）

これで、最上位ディレクトリを更新すると、「cover_db」という新しいサブディレクトリが表示されます。そのディレクトリに移動し、「coverage.html」ファイルをダブルクリックして、お気に入りのWebブラウザーでコードカバレッジレポートを開きます。素敵な色分けされたハイパーテキストレポートが表示され、ファイル名をクリックすると、実際のソースコードの横のレポートで、Perlモジュールの詳細なステートメント、ブランチ、条件、サブルーチンカバレッジ統計を確認できます。このレポートでは、 "bye（）"ルーチンをまったくカバーしていなかったことがわかります。また、予想どおりにカバーされなかった到達不能なコード行があります。

snapshot of code coverage report
（ソース： leucht.com ）

IDEでこのプロセスを自動化するためにできるもう1つのことは、上記で手動で行ったビルドターゲットの一部を明示的に実行する "Build.PL"タイプのファイルを作成することです。たとえば、次の内容の「BuildTest.PL」ファイルを使用します。

use strict;
use warnings;
use Module::Build;

my $build = Module::Build->resume (
  properties => {
    config_dir => '_build',
  },
);

$build->dispatch('build');
$build->dispatch('test');

次に、このファイルを（「Perl BuiltTest.PL」経由で）1回のマウスクリックで実行するようにIDEをセットアップし、IDEコマンドラインから手動で行う代わりに、自動化されたコードカバレッジ実行のために「dispatch（ 'test'）」を「dispatch（ 'testcover'）」に置き換えます。ビルドの完全なリストを表示するには「Build help」と入力します。 Module :: Buildから利用可能なターゲット。

102
Kurt W. Leucht

Kurtに応えて、私は彼のBuiltTest.PLスクリプトのこの代替案を提案します。

use strict;
use warnings;
use Module::Build;

my $build = Module::Build->resume (
  properties => {
    config_dir => '_build',
  },
);

$build->dispatch('build');
$build->dispatch('test');

Build.PLによるデータベースビルドを再利用します（したがって、すでに実行されていると想定します）。

14
Leon Timmermans

これを 中間Perl および Mastering Perl で説明します。しかし、カートはニースの要約を示しました。

Module :: Release を使用して、これらすべてをリリーススクリプトに結合します。 1つのコマンドを入力すると、すべてが発生します。

12
brian d foy

素晴らしく便利な module-starter は、モジュールのインストール、ドキュメントの作成、およびモジュールファイルの適切なレイアウトを処理する使いやすいスケルトンプロジェクトを生成し、-Ithink-コードカバレッジのサポート。これはIMOであり、Perlモジュール関連の取り組みにとって素晴らしいスタートです。

また：Module::BuildのようなCPAN関連ツールを使用する-公開される可能性の低いモジュールであっても- 非常に良いアイデアです 。

12
Gaurav

（開示：私は著者です）

上記のようにすべてをソートしたら、次のステップに進み、 Devel :: CoverX :: Covered を使用して、たとえば.

  • ソースファイルを指定して、そのソースファイルにカバレッジを提供するテストファイルを一覧表示します。これは、ファイル、サブルーチン、および行レベルで実行できます。
  • テストファイルが与えられたら、そのテストファイルの対象となるソースファイルとサブをリストします。
  • ソースファイルを指定して、行またはサブごとのカバレッジの詳細を効率的に報告します。

具体的なコマンドラインの例については、 概要 を参照してください。

Devel :: PerlySense では、Emacsがソースコードバッファーのカバレッジ情報を表示し（ スクリーンショット ）、テストファイルへ/から移動することをサポートしています。

7
jplindstrom