chef-gen-flavors 0.3.0

data/spec/lib/chef_gen/flavors_spec.rb

@@ -0,0 +1,114 @@
+require 'chef_gen/flavors'
+
+# sample plugins
+require 'support/fixtures/lib/chef_gen/flavor/foo'
+require 'support/fixtures/lib/chef_gen/flavor/bar'
+require 'support/fixtures/lib/chef_gen/flavor/baz'
+
+RSpec.describe ChefGen::Flavors do
+  before do
+    ChefGen::Flavors.clear_plugins
+    ENV.delete('CHEFGEN_FLAVOR')
+    ENV.delete('CHEFDK_FLAVOR')
+    @orig_stdout = $stdout
+    $stdout = File.open(File::NULL, 'w')
+  end
+
+  after do
+    $stdout = @orig_stdout
+  end
+
+  it 'should be able to load plugins' do
+    expect(ChefGen::Flavors.plugins).to be_a(Hash)
+  end
+
+  it 'should load the expected plugins' do
+    ChefGen::Flavors.disregard_plugin :amazing, :awesome
+    expect(ChefGen::Flavors.plugins.keys).to(
+      contain_exactly(:foo, :bar, :baz)
+    )
+  end
+
+  it 'allows for the plugin list to be make explicit' do
+    ChefGen::Flavors.plugin :foo
+    expect(ChefGen::Flavors.plugins).to include(:foo)
+    expect(ChefGen::Flavors.plugins).not_to include(:bar)
+  end
+
+  it 'allows for plugins to be blacklisted' do
+    ChefGen::Flavors.disregard_plugin :foo, :baz
+    expect(ChefGen::Flavors.plugins).not_to include(:foo)
+    expect(ChefGen::Flavors.plugins).to include(:bar)
+  end
+
+  it 'should not prompt for a plugin if only one is available' do
+    ChefGen::Flavors.plugin :foo
+    expect(ChefGen::Flavors).not_to receive(:prompt_for_plugin)
+    ChefGen::Flavors.path
+  end
+
+  it 'should not prompt for a plugin if the env var matches one' do
+    ChefGen::Flavors.disregard_plugin :baz
+    ENV['CHEFGEN_FLAVOR'] = 'Foo'
+    expect(ChefGen::Flavors).not_to receive(:prompt_for_plugin)
+    ChefGen::Flavors.path
+  end
+
+  it 'should be case insensitive when selecting the plugin via env var' do
+    ChefGen::Flavors.disregard_plugin :baz
+    ENV['CHEFGEN_FLAVOR'] = 'foo'
+    expect(ChefGen::Flavors).not_to receive(:prompt_for_plugin)
+    ChefGen::Flavors.path
+    ENV.delete('CHEFGEN_FLAVOR')
+  end
+
+  it 'should prompt for a plugin if the env var does not match' do
+    ChefGen::Flavors.disregard_plugin :baz
+    ENV['CHEFGEN_FLAVOR'] = 'Gzonk'
+    expect(ChefGen::Flavors)
+      .to receive(:prompt_for_plugin)
+      .and_return(:foo)
+    ChefGen::Flavors.path
+  end
+
+  it 'should prompt for a plugin if the env var is not set' do
+    ChefGen::Flavors.disregard_plugin :baz
+    expect(ChefGen::Flavors)
+      .to receive(:prompt_for_plugin)
+      .and_return(:bar)
+    ChefGen::Flavors.path
+  end
+
+  it 'should raise an error if there are no plugins available' do
+    ChefGen::Flavors.disregard_plugin :foo, :bar, :baz,
+                                      :amazing, :awesome
+    expect { ChefGen::Flavors.path }.to raise_error
+  end
+
+  it 'should offer the builtin flavors as an option with the env var set' do
+    ENV['CHEFDK_FLAVOR'] = 'true'
+    ChefGen::Flavors.disregard_plugin :foo, :bar, :baz,
+                                      :amazing, :awesome
+    expect(ChefGen::Flavors).not_to receive(:prompt_for_plugin)
+    ChefGen::Flavors.path
+  end
+
+  it 'should raise an error if the plugin has no description' do
+    ENV['CHEFGEN_FLAVOR'] = 'Baz'
+    expect { ChefGen::Flavors.path }.to raise_error
+  end
+
+  it 'should default the code_generator path' do
+    ChefGen::Flavors.disregard_plugin :baz
+    ENV['CHEFGEN_FLAVOR'] = 'Foo'
+    expect(ChefGen::Flavors.path)
+      .to match(%r{spec/support/fixtures/code_generator$})
+  end
+
+  it 'should respect an overridden code_generator path' do
+    ChefGen::Flavors.disregard_plugin :baz
+    ENV['CHEFGEN_FLAVOR'] = 'Bar'
+    expect(ChefGen::Flavors.path)
+      .to match(%r{spec/support/fixtures/code_generator_2$})
+  end
+end

data/spec/lib/chef_gen/snippet/attributes_spec.rb

@@ -0,0 +1,45 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::Attributes
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/RegexpLiteral
+RSpec.describe ChefGen::Snippet::Attributes do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(attributes).each do |dname|
+    it "should create the directory #{dname}" do
+      expect(@recipe).to receive(:directory).with(%r{#{dname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(attributes/default.rb).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:template).with(%r{#{fname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/chef_spec_spec.rb

@@ -0,0 +1,45 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::ChefSpec
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/RegexpLiteral
+RSpec.describe ChefGen::Snippet::ChefSpec do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(spec spec/recipes).each do |dname|
+    it "should create the directory #{dname}" do
+      expect(@recipe).to receive(:directory).with(%r{#{dname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(.rspec spec/spec_helper.rb spec/recipes/default_spec.rb).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:template).with(%r{#{fname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/cookbook_base_spec.rb

@@ -0,0 +1,37 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::CookbookBase
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+RSpec.describe ChefGen::Snippet::CookbookBase do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(Gemfile Rakefile Berksfile Guardfile README.md
+     CHANGELOG.md metadata.rb).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:template).with(/#{fname}$/)
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/example_file_spec.rb

@@ -0,0 +1,45 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::ExampleFile
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/RegexpLiteral
+RSpec.describe ChefGen::Snippet::ExampleFile do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(files files/default).each do |dname|
+    it "should create the directory #{dname}" do
+      expect(@recipe).to receive(:directory).with(%r{#{dname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(files/default/example.conf).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:cookbook_file).with(%r{#{fname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/example_template_spec.rb

@@ -0,0 +1,45 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::ExampleTemplate
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/RegexpLiteral
+RSpec.describe ChefGen::Snippet::ExampleTemplate do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(templates templates/default).each do |dname|
+    it "should create the directory #{dname}" do
+      expect(@recipe).to receive(:directory).with(%r{#{dname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(templates/default/example.conf.erb).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:cookbook_file).with(%r{#{fname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/recipes_spec.rb

@@ -0,0 +1,45 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::Recipes
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/RegexpLiteral
+RSpec.describe ChefGen::Snippet::Recipes do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(recipes).each do |dname|
+    it "should create the directory #{dname}" do
+      expect(@recipe).to receive(:directory).with(%r{#{dname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(recipes/default.rb).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:template).with(%r{#{fname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/resource_provider_spec.rb

@@ -0,0 +1,45 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::ResourceProvider
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/RegexpLiteral
+RSpec.describe ChefGen::Snippet::ResourceProvider do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  %w(resources providers).each do |dname|
+    it "should create the directory #{dname}" do
+      expect(@recipe).to receive(:directory).with(%r{#{dname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(resources/default.rb providers/default.rb).each do |fname|
+    it "should add a template for #{fname}" do
+      expect(@recipe).to receive(:template).with(%r{#{fname}$})
+      template = ChefGen::Flavor::Awesome.new(@recipe)
+      template.generate
+    end
+  end
+end

data/spec/lib/chef_gen/snippet/standard_ignore_spec.rb

@@ -0,0 +1,40 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+module ChefGen
+  module Flavor
+    class Awesome < FlavorBase
+      include ChefGen::Snippet::StandardIgnore
+
+      class << self
+        # :nocov:
+        def description
+          'my awesome template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end
+
+RSpec.describe ChefGen::Snippet::StandardIgnore do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+  end
+
+  it 'should create a chefignore file' do
+    expect(@recipe).to receive(:file).with(/chefignore$/)
+    template = ChefGen::Flavor::Awesome.new(@recipe)
+    template.generate
+  end
+
+  it 'should create a .gitignore file' do
+    expect(@recipe).to receive(:file).with(/\.gitignore$/)
+    template = ChefGen::Flavor::Awesome.new(@recipe)
+    template.generate
+  end
+end