【问题标题】:Feedback on Ruby / ChefSpec coding style对 Ruby / ChefSpec 编码风格的反馈
【发布时间】:2014-02-11 12:29:17
【问题描述】:

我对 Ruby 比较陌生,但在过去的两周里,我一直在对 Chef 测试进行大量研究。这个测试使用 ChefSpec 和 Fauxhai,但它看起来不是很“红宝石”,我希望社区能给我一些关于编码风格的建议。有没有更好的方法来编写这样的嵌套循环?

cookbooks/foo/recipes/default.rb

package "foo" do
  action :install
end

食谱/foo/spec/default_spec.rb

require 'chefspec'

describe 'foo::default' do
  platforms = { 
    "debian"   => ['6.0.5'],
    "ubuntu"   => ['12.04', '10.04'],
    "centos"   => ['5.8', '6.0', '6.3'],
    "redhat"   => ['5.8', '6.3'],
    "mac_os_x" => ['10.6.8', '10.7.4', '10.8.2'],
    "windows"  => ['2008R2']
  }

  platforms.each do |platform,versions|
    versions.each do |version|
      context "on #{platform} #{version}" do
        before do
          Fauxhai.mock(platform: platform, version: version)
        end

        it 'should install foo' do
          @runner = ChefSpec::ChefRunner.new.converge('foo::default')
          @runner.should install_package 'foo'
        end
      end
    end
  end
end

欢迎任何和所有的反馈。谢谢!

【问题讨论】:

  • github.com/bbatsov/ruby-style-guide 是推荐 Ruby 编码指南的一个很好的通用资源。我认为在保持可读性的同时清理这些嵌套循环没有什么可以做的。
  • 我已经阅读了该指南,但我也没有看到太多可以改进的地方。感谢您的反馈!

标签: ruby rspec chef-infra chefspec


【解决方案1】:

首先,一种常见的做法是将ChefRunner 实例化提取到let 助手。您还可以在其中包含所有 Fauxhai 配置:

let(:chef_run) do
  ChefSpec::ChefRunner.new(platform: platform, version: version) do |node|
    node.set['foo']['bar'] = 'baz'
    # ....
  end.converge('foo::default')
end

it "installs foo" do
  expect(chef_run).to install_package 'foo'
end

expect 语法似乎是 recommended 超过 should。但在本例中,我将使用单线:

subject do
  ChefSpec::ChefRunner.new(platform: platform, version: version).converge('foo::default')
end
it { should install_package 'foo' }

要稍微清理一下循环,您可以使用RSpec's shared examples。一个更扩展的例子:

require 'chefspec'

shared_examples 'foo' do |platform, version|
  context "on #{platform} #{version}" do
    let(:users) { %w[user1 user2] }
    let(:chef_run) do
      ChefSpec::ChefRunner.new(platform: platform, version: version) do |node|
        node.set['foo']['users'] = users
      end.converge('foo::default')
    end
    subject { chef_run }

    it { should install_package 'foo' }

    it "creates specified users" do
      users.each { |u| expect(chef_run).to create_user u }
    end
  end
end

describe 'foo::default' do
  platforms = {
    'debian'   => ['6.0.5'],
    'ubuntu'   => ['12.04', '10.04'],
    'centos'   => ['5.8', '6.0', '6.3'],
    'redhat'   => ['5.8', '6.3'],
    'mac_os_x' => ['10.6.8', '10.7.4', '10.8.2'],
    'windows'  => ['2008R2']
  }

  platforms.each do |platform, versions|
    versions.each do |version|
      include_examples 'foo', platform, version
    end
  end
end

【讨论】:

  • 另一种方法可能是使用 RSpec 标签 (describe 'foo', platforms: [...] do ...) 并在此基础上循环共享示例。