RSpec-Puppet 技术文档

1. 安装指南

安装 RSpec-Puppet

要安装 RSpec-Puppet，您可以使用以下命令：

gem install rspec-puppet

注意：如果您使用的是 Ruby 1.8，虽然 RSpec-Puppet 本身支持 Ruby 1.8，但您需要将 RSpec 的版本固定在 ~> 3.1.0，因为更高版本的 RSpec 不再支持旧版本的 Ruby。

初始化新模块

当您开始一个新模块时，首先为您的模块创建一个 metadata.json 文件，然后运行以下命令来生成必要的文件，以配置 RSpec-Puppet 用于模块测试：

rspec-puppet-init

2. 项目的使用说明

配置 Puppet 4 的清单

在 Puppet 3 中，清单设置为 $manifestdir/site.pp。然而，Puppet 4 默认值为空。为了测试清单，您需要设置适当的配置。

Puppet 配置参考可以在线找到：

• Puppet 3: Puppet 3 配置参考
• Puppet 4: Puppet 4 配置参考

配置通常在 spec/spec_helper.rb 文件中完成，每个测试文件都会引用该文件。示例代码如下：

base_dir = File.dirname(File.expand_path(__FILE__))

RSpec.configure do |c|
  c.module_path     = File.join(base_dir, 'fixtures', 'modules')
  c.manifest_dir    = File.join(base_dir, 'fixtures', 'manifests')
  c.manifest        = File.join(base_dir, 'fixtures', 'manifests', 'site.pp')
  c.environmentpath = File.join(Dir.pwd, 'spec')

  # 生成覆盖率报告
  c.after(:suite) do
    RSpec::Puppet::Coverage.report!
  end
end

3. 项目 API 使用文档

配置选项

RSpec-Puppet 可以通过修改 spec/spec_helper.rb 文件中的 RSpec.configure 块来进行配置。

RSpec.configure do |c|
  c.<config option> = <value>
end

以下是一些常用的配置选项：

manifest_dir

• 类型: 字符串
• 默认值: 必需
• Puppet 版本: 2.x, 3.x

包含基本清单（如 site.pp）的目录路径。

module_path

• 类型: 字符串
• 默认值: 必需
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

包含 Puppet 模块的目录路径。

default_facts

• 类型: 哈希
• 默认值: {}
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

用于所有测试的默认事实哈希。

hiera_config

• 类型: 字符串
• 默认值: "/dev/null"
• Puppet 版本: 3.x, 4.x, 5.x

hiera.yaml 文件的路径（如果使用）。

default_node_params

• 类型: 哈希
• 默认值: {}
• Puppet 版本: 4.x, 5.x

用于所有测试的默认节点参数哈希。

default_trusted_facts

• 类型: 哈希
• 默认值: {}
• Puppet 版本: 4.x, 5.x

用于所有测试的默认受信任事实哈希（在清单中作为 $trusted 哈希可用）。要使用此功能，必须将 trusted_node_data 设置为 true。

trusted_node_data

• 类型: 布尔值
• 默认值: false
• Puppet 版本: >=3.4, 4.x, 5.x

配置 RSpec-Puppet 在编译目录时使用 $trusted 哈希。

trusted_server_facts

• 类型: 布尔值
• 默认值: false
• Puppet 版本: >=4.3, 5.x

配置 RSpec-Puppet 在编译目录时使用 $server_facts 哈希。

confdir

• 类型: 字符串
• 默认值: "/etc/puppet"
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

Puppet 主配置目录的路径。

config

• 类型: 字符串
• 默认值: Puppet 的默认值
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

puppet.conf 的路径。

manifest

• 类型: 字符串
• 默认值: Puppet 的默认值
• Puppet 版本: 2.x, 3.x

Puppet 的入口清单，通常为 $manifest_dir/site.pp。

template_dir

• 类型: 字符串
• 默认值: nil
• Puppet 版本: 2.x, 3.x

Puppet 应搜索存储在模块外部的模板的目录路径。

environmentpath

• 类型: 字符串
• 默认值: "/etc/puppetlabs/code/environments"
• Puppet 版本: 4.x, 5.x

环境目录的搜索路径。

parser

• 类型: 字符串
• 默认值: "current"
• Puppet 版本: >= 3.2

在 3.x（current）和 4.x（future）解析器之间切换。

ordering

• 类型: 字符串
• 默认值: "title-hash"
• Puppet 版本: >= 3.3, 4.x, 5.x

在应用目录时，如何排序不相关的资源。

• manifest - 使用清单中声明的资源顺序。
• title-hash - 随机排序资源，但在运行之间保持一致（顺序仅在清单更改时更改）。
• random - 随机排序资源。

strict_variables

• 类型: 布尔值
• 默认值: false
• Puppet 版本: >= 3.5, 4.x, 5.x

当 Puppet 尝试引用未定义的变量时，使其引发错误（不包括显式设置为 undef 的变量）。

stringify_facts

• 类型: 布尔值
• 默认值: true
• Puppet 版本: >= 3.3, 4.x, 5.x

使 RSpec-Puppet 将所有事实值强制转换为字符串（匹配旧版本 Puppet 的行为）。

enable_pathname_stubbing

• 类型: 布尔值
• 默认值: false
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

配置 RSpec-Puppet 使用自己的实现来存根 Pathname#absolute?。仅在运行跨平台测试时遇到问题时才应启用此功能。

setup_fixtures

• 类型: 布尔值
• 默认值: true
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

配置 RSpec-Puppet 在测试运行开始时自动从模块根目录创建到 spec/fixtures/<module name> 的链接。

derive_node_facts_from_nodename

• 类型: 布尔值
• 默认值: true
• Puppet 版本: 2.x, 3.x, 4.x, 5.x

如果为 true，RSpec-Puppet 将从节点名称（使用 let(:node) 指定）派生出 fdqn、hostname 和 domain 事实。

在某些情况下（例如，您的节点名称/证书名称与 FQDN 不同），此行为是不希望的，可以通过将此设置更改为 false 来禁用。

4. 项目安装方式

安装 RSpec-Puppet

要安装 RSpec-Puppet，您可以使用以下命令：

gem install rspec-puppet

初始化新模块

当您开始一个新模块时，首先为您的模块创建一个 metadata.json 文件，然后运行以下命令来生成必要的文件，以配置 RSpec-Puppet 用于模块测试：

rspec-puppet-init

通过以上步骤，您可以成功安装并配置 RSpec-Puppet，开始编写和运行 Puppet 模块的测试。