如何检查是否所有Perl模块都已导入？

Question

假设我有一个Perl模块：

use Foo::Bar;

sub add {
    return Foo::Bar::func() + Foo::Buzz::func();
}

此模块中存在错误，因为它忘记use Foo::Buzz 。 我的单元测试并不总能捕获此错误，例如，如果Foo::Buzz的测试运行较早并且在运行add()之前导入Foo::Buzz 。 如果我在生产代码中使用此模块，它将失败并显示未导入Foo::Buzz的错误。

如何检查代码中使用的所有模块是否也已导入？

编辑：我想在生产中部署代码之前检查代码，以避免发生任何错误。 该示例将在生产中失败，我想在此之前捕获错误，例如，当我运行单元测试时。 我想要一个工具或一些代码，我可以在部署之前运行它来捕获这个错误，比如flake8 for python。

Answer 1

简短的回答是你不能 。 由于Perl是一种动态语言，因此您无法检查是否在运行时加载所有模块，因为您无法检查代码中是否存在其他错误。

您还可以使用一些静态代码分析，试图找到This::Pattern在文件中use This::Pattern; 没有呈现，但它不保证任何东西。

Answer 2

如果Perl严格来说是一种动态语言，您可以轻松检查程序中是否安装了模块。 问题是Perl不是100％动态的。 它进行了一些编译，部分编译工作在检查模块后完成。

芦苇走在正确的轨道上。 不幸的是，您可以使用use子句来执行此操作。 在编译前检查use ，因此在执行eval之前会出现错误。

但是， 使用 perldoc页面有一个线索：

• 使用模块列表
• 使用模块
• 使用VERSION
  
  从命名模块将一些语义导入当前包，通常通过将某些子例程或变量名称别名到包中。 它完全等同于
  
  BEGIN { require Module; Module->import( LIST ); }

你去！ 您可以在BEGIN子句中使用require ，该子句甚至在解析文件的其余部分之前执行。 您可以在那里使用您的eval ，看看它是否有效。 您需要使用包变量作为标志，以查看是否因为范围问题而起作用。 当您离开BEGIN子句时，常规的词法范围变量将消失。

BEGIN {
    our $FOO_BAR_available = 0;        # Must be a package variable
    eval {
        require Foo::Bar;
        Module->import( qw(...) );     # No need if you don't import any subroutines
    };
    if (not $@ ) {
        $FOO_BAR_AVAILABLE = 0;
    }
}

然后在你的程序中，你有：

our $FOO_BAR_available;
if ( not $FOO_BAR_available ) {
    # Here be dragons...
}
else {
    # Back to your normal code...
}

our $FOO_BAR_available有点令人困惑。 您没有再次声明此变量，您只是声明要使用此变量而不使用完整包名称作为前缀。 变量在BEGIN子句中设置，这不会影响该值。

如果正确编写了此模块，则可以完全跳过包变量的使用。 模块假设设置一个名为$VERSION的包变量。 您可以将此变量用作标志：

BEGIN {
    eval {
        require Foo::Bar;
        Module->import( qw(...) );   # No need if you don't import any subroutines
    };
}

注意我不仅不必声明包变量，我甚至不必验证eval语句是否有效。

然后在你的程序中......

if ( not $FOO::BAR::VERSION )  {
    # Here be dragons...
}
else {
    # Back to your normal code...
}

如果模块设置$VERSION变量，则表示已加载。 否则，您知道模块未加载。

---

附录

我想在将代码部署到生产环境之前检查代码，以避免发生任何错误。 该示例将在生产中失败，我想在此之前捕获错误，例如，当我运行单元测试时。

这是我的建议。 它不像运行脚本那么简单，但它更好：

• 首先，定义您的生产环境：它具有哪个版本的Perl？ 使用什么模块？ 这将有助于开发人员了解预期结果。 我知道Foo::Bar很好，但是我不应该使用Far::Bu因为生产没有那个。 这是第一步。 我很惊讶那些不知道生产环境是什么的地方。
• 使用Vagrant 。 这定义了一个与您的生产环境匹配的虚拟机。 开发人员可以将其下载到他们的系统，并在他们的桌面上提供生产环境的副本。

• 使用詹金斯 。 Jenkins是一个持续构建的引擎。 是的，你不编译Perl，但你仍然可以从Jenkins中受益：

  • Jenkins可以为您运行单元测试。 自动测试代码中的每个更改。 你很早就发现了自己的错误。
  • 您的Jenkins系统可以匹配您的生产机器 - 相同的Perl版本，相同的Perl模块。 如果它没有在你的Jenkins构建机器上运行，因为某些东西没有安装，那么它很有可能无法在Production上运行。
  • 你通过詹金斯安装。 Jenkins可以打包您的版本，您可以使用它来安装已知版本。 没有从开发人员的系统中提取代码，并发现系统中的某些内容不在您的版本控制系统中。 我不知道有多少次我看到一个开发人员从他们的机器上生产一些东西用于生产（经过全面测试！相信我！），然后我们发现我们的版本控制系统中没有该代码，因为开发人员忘了检查一下。

您通常flake8在生产环境中运行flake8 。 到那时，已经有点晚了。

Perl有很多很好的工具可以执行类似的功能：

• Perlbrew ：这允许您的开发人员将具有自己的CPAN模块库的单独Perl程序安装到他们的开发系统中。 他们可以使用它来匹配Perl版本和生产环境所需的模块。 这样，他们就玩了同样的规则。
• Perlcritic ：这将检查您的模块与Damian Conway在他的Perl最佳实践中提出的编码标准。
• B :: Lint ：这就像C中的旧lint程序一样，可以捕获编码问题。

但是，在您准备在Production中运行之前，这是要做的事情。 使用Vagrant帮助开发人员设置自己的私有生产环境进行测试。 使用Jenkins确保您在类似生产的环境中进行测试，并在发生错误时立即捕获错误，而不是在UAT测试之后。