Perl 构建、单元测试、代码覆盖率 : A complete working example

Question

我发现的关于 Perl 构建过程、单元测试和代码覆盖率的大多数 Stackoverflow 答案都只是将我指向 CPAN 那里的文档。指向 CPAN 模块绝对没有任何问题，因为完整的文档应该位于此处。不过，在很多情况下，我很难找到完整的工作代码示例。

我一直在互联网上搜索实际工作的代码示例，我可以下载或粘贴到我的 IDE 中，就像典型的教程“Hello World”示例源代码一样，但是是一个演示使用单元构建过程的示例测试和代码覆盖率分析。有人有一个完整的工作项目的小例子来演示这些技术和流程吗？

(我确实有一个小的工作示例，我将用它回答我自己的问题，但可能还有其他 SO 用户拥有比我提出的更好的示例。)

Answer 1

我花了一段时间，也花了我从许多不同的来源获取小片段并将它们融合在一起，但我认为我有一个小的工作示例，足以向 Perl 新手演示 Perl 构建过程，包括单元测试以及代码覆盖率分析和报告。 (我在 Windows XP Pro PC 上使用 ActiveState ActivePerl v5.10.0、Module::Build、Test::More、Devel::Cover)

从 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_addy@goes.here>',
    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 库，除了并向我报告我编写的单个文件。我无法根据 CPAN 文档让 Cover 过滤工作! )

现在，如果刷新顶级目录，您可以看到一个名为“cover_db”的新子目录。进入该目录并双击“coverage.html”文件，在您最喜欢的网络浏览器中打开代码覆盖率报告。它为您提供了一个漂亮的彩色编码超文本报告，您可以在其中单击文件名并在报告中实际源代码旁边查看 Perl 模块的详细语句、分支、条件、子例程覆盖率统计信息。您可以在这份报告中看到，我们根本没有涵盖“bye()”例程，而且还有一行无法访问的代码没有按我们的预期涵盖。

_{(来源:leucht.com)}

为了帮助在 IDE 中自动化此过程，您还可以做的另一件事是制作更多“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');

然后，我将 IDE 设置为通过单击鼠标来执行此文件(通过“perlBuiltTest.PL”)，它会自动从 IDE 运行我的单元测试代码，而不是我从命令行手动执行。将“dispatch('test')”替换为“dispatch('testcover')”以自动执行代码覆盖率。键入“构建帮助”以获取可从 Module::Build 获得的构建目标的完整列表。