emeril 0.5.0

data/lib/emeril/releaser.rb

@@ -0,0 +1,80 @@
+# -*- encoding: utf-8 -*-
+
+require 'emeril/category'
+require 'emeril/git_tagger'
+require 'emeril/metadata_chopper'
+require 'emeril/publisher'
+
+module Emeril
+
+  # Tags a git commit with a version string and pushes the cookbook to the
+  # Community Site.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class Releaser
+
+    # Creates a new instance.
+    #
+    # @param [Hash] options configuration for a releaser
+    # @option options [Logger] an optional logger instance
+    # @option options [String] source_path the path to a git repository
+    # @option options [Hash] metadata a hash of cookbook metadata
+    # @option options [String] category a Community Site category for the
+    #   cookbook
+    # @option options [GitTagger] git_tagger a git tagger
+    # @option options [Publisher] publisher a publisher
+    # @raise [ArgumentError] if any required options are not set
+    #
+    def initialize(options = {})
+      @logger = options[:logger]
+      @tag_prefix = options[:tag_prefix]
+      @source_path = options.fetch(:source_path, Dir.pwd)
+      @metadata = options.fetch(:metadata) { default_metadata }
+      @category = options.fetch(:category) { default_category }
+      @git_tagger = options.fetch(:git_tagger) { default_git_tagger }
+      @publisher = options.fetch(:publisher) { default_publisher }
+    end
+
+    # Tags and releases a cookbook.
+    #
+    def run
+      git_tagger.run
+      publisher.run
+    end
+
+    private
+
+    DEFAULT_CATEGORY = "Other".freeze
+
+    attr_reader :logger, :tag_prefix, :source_path, :metadata,
+      :category, :git_tagger, :publisher
+
+    def default_metadata
+      metadata_file = File.expand_path(File.join(source_path, "metadata.rb"))
+      MetadataChopper.new(metadata_file)
+    end
+
+    def default_git_tagger
+      GitTagger.new(
+        :logger => logger,
+        :source_path => source_path,
+        :version => metadata[:version],
+        :tag_prefix => tag_prefix
+      )
+    end
+
+    def default_publisher
+      Publisher.new(
+        :logger => logger,
+        :source_path => source_path,
+        :name => metadata[:name],
+        :category => category
+      )
+    end
+
+    def default_category
+      Category.for_cookbook(metadata[:name]) || "Other"
+    end
+  end
+end

data/lib/emeril/thor.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+require 'emeril/thor_tasks'
+
+Emeril::ThorTasks.new

data/lib/emeril/thor_tasks.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+require 'thor'
+require 'chef/knife'
+
+require 'emeril'
+
+module Emeril
+
+  # Emeril Rake task generator.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class ThorTasks < Thor
+
+    namespace :emeril
+
+    attr_accessor :config
+
+    # Creates Emeril Thor tasks and allows the callee to configure it.
+    #
+    # @yield [self] gives itself to the block
+    #
+    def initialize(*args)
+      super
+      @config = { :logger => Chef::Log }
+      yield self if block_given?
+      define
+    end
+
+    private
+
+    def define
+      metadata = Emeril::MetadataChopper.new("metadata.rb")
+      artifact = "#{metadata[:name]}-#{metadata[:version]}"
+
+      self.class.desc "release",
+        "Create git tag for #{artifact} and push to the Community Site"
+      self.class.send(:define_method, :release) do
+        Chef::Knife.new.configure_chef
+        Emeril::Releaser.new(@config).run
+      end
+    end
+  end
+end

data/lib/emeril/version.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Emeril
+
+  VERSION = "0.5.0"
+end

data/spec/emeril/category_spec.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require_relative '../spec_helper'
+require 'vcr'
+
+require 'emeril/category'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+
+describe Emeril::Category do
+
+  describe ".for_cookbook" do
+    it "returns a category string for a known cookbook" do
+      VCR.use_cassette('known_cookbook') do
+        Emeril::Category.for_cookbook('mysql').must_equal 'Databases'
+      end
+    end
+
+    it "returns nil for a nonexistant cookbook" do
+      VCR.use_cassette('nonexistant_cookbook') do
+        Emeril::Category.for_cookbook('fooboobunnyyaya').must_be_nil
+      end
+    end
+  end
+end

data/spec/emeril/git_tagger_spec.rb

@@ -0,0 +1,147 @@
+# -*- encoding: utf-8 -*-
+
+require_relative '../spec_helper'
+require 'tmpdir'
+require 'logger'
+
+require 'emeril/git_tagger'
+
+describe Emeril::GitTagger do
+
+  let(:sandbox_path)  { File.join(Dir.mktmpdir, "emeril") }
+
+  let(:git_tagger) do
+    Emeril::GitTagger.new(
+      :source_path => sandbox_path,
+      :version => "4.1.1",
+      :logger => nil
+    )
+  end
+
+  describe ".initialize" do
+
+    it "raises an ArgumentError when :version is missing" do
+      proc { Emeril::GitTagger.new }.must_raise ArgumentError
+    end
+  end
+
+  describe "#run" do
+
+    before do
+      make_cookbook!
+    end
+
+    after do
+      FileUtils.remove_dir(sandbox_path)
+    end
+
+    it "tags the repo" do
+      git_tagger.run
+      run_cmd(%{git tag}).must_match /^v4.1.1$/
+    end
+
+    it "disables the tag prefix" do
+      Emeril::GitTagger.new(
+        :source_path => sandbox_path,
+        :version => "4.1.1",
+        :logger => nil,
+        :tag_prefix => false
+      ).run
+
+      run_cmd(%{git tag}).must_match /^4.1.1$/
+    end
+
+    it "uses a custom tag prefix" do
+      Emeril::GitTagger.new(
+        :source_path => sandbox_path,
+        :version => "4.1.1",
+        :logger => nil,
+        :tag_prefix => "version-"
+      ).run
+
+      run_cmd(%{git tag}).must_match /^version-4.1.1$/
+    end
+
+    it "pushes the tag to the remote" do
+      git_tagger.run
+
+      run_cmd(%{git ls-remote --tags origin}).
+        must_match %r{refs/tags/v4\.1\.1$}
+    end
+
+    describe "when git repo is not clean" do
+
+      before do
+        File.open("#{sandbox_path}/README.md", "wb") { |f| f.write "Yep." }
+      end
+
+      it "raises GitNotCleanError" do
+        proc { git_tagger.run }.must_raise Emeril::GitNotCleanError
+      end
+    end
+
+    describe "when git tag exists" do
+
+      before do
+        run_cmd %{git tag v4.1.1}
+      end
+
+      it "skips tagging" do
+        git_tagger.expects(:tag_version).never
+
+        git_tagger.run
+      end
+    end
+
+    describe "when no git remote exists" do
+
+      before do
+        run_cmd %{git remote rm origin}
+      end
+
+      it "raises GitPushError" do
+        proc { git_tagger.run }.must_raise Emeril::GitPushError
+      end
+    end
+  end
+
+  private
+
+  def make_cookbook!
+    FileUtils.mkdir_p("#{sandbox_path}/recipes")
+    remote_dir = File.join(File.dirname(sandbox_path), "remote")
+
+    File.open("#{sandbox_path}/metadata.rb", "wb") do |f|
+      f.write <<-METADATA_RB.gsub(/^ {8}/, '')
+        name             "#{name}"
+        maintainer       "Michael Bluth"
+        maintainer_email "michael@bluth.com"
+        license          "Apache 2.0"
+        description      "Doing stuff!"
+        long_description "Doing stuff!"
+        version          "4.1.1"
+      METADATA_RB
+    end
+    File.open("#{sandbox_path}/recipes/default.rb", "wb") do |f|
+      f.write <<-DEFAULT_RB.gsub(/^ {8}/, '')
+        directory "/tmp/yeah"
+
+        package "bash"
+      DEFAULT_RB
+    end
+
+    run_cmd [
+      %{git init},
+      %{git config user.email "you@example.com"},
+      %{git config user.name "Your Name"},
+      %{git add .},
+      %{git commit -m "Initial"},
+      %{git remote add origin #{remote_dir}},
+      %{git init --bare #{remote_dir}}
+    ].join(" && ")
+  end
+
+  def run_cmd(cmd, opts = {})
+    %x{cd #{opts.fetch(:in, sandbox_path)} && #{cmd}}
+  end
+end

data/spec/emeril/metadata_chopper_spec.rb

@@ -0,0 +1,70 @@
+# -*- encoding: utf-8 -*-
+
+require_relative '../spec_helper'
+
+require 'emeril/metadata_chopper'
+
+describe Emeril::MetadataChopper do
+
+  before do
+    FakeFS.activate!
+    FileUtils.mkdir_p("/tmp")
+  end
+
+  after do
+    FakeFS.deactivate!
+    FakeFS::FileSystem.clear
+  end
+
+  it "contains a :name attribute" do
+    stub_metadata!("banzai")
+    Emeril::MetadataChopper.new("/tmp/metadata.rb")[:name].must_equal "banzai"
+  end
+
+  it "contains a :version attribute" do
+    stub_metadata!("foobar", "1.2.3")
+    Emeril::MetadataChopper.new("/tmp/metadata.rb")[:version].must_equal "1.2.3"
+  end
+
+  it "raises a MetadataParseError if name attribute is missing" do
+    File.open("/tmp/metadata.rb", "wb") do |f|
+      f.write [
+        %{maintainer "Me"},
+        %{maintainer_email "me@example.com"},
+        %{version "1.2.3"}
+      ].join("\n")
+    end
+
+    proc { Emeril::MetadataChopper.new("/tmp/metadata.rb") }.
+      must_raise Emeril::MetadataParseError
+  end
+
+  it "raises a MetadataParseError if version attribute is missing" do
+    File.open("/tmp/metadata.rb", "wb") do |f|
+      f.write [
+        %{maintainer "Me"},
+        %{maintainer_email "me@example.com"},
+        %{name "pants"}
+      ].join("\n")
+    end
+
+    proc { Emeril::MetadataChopper.new("/tmp/metadata.rb") }.
+      must_raise Emeril::MetadataParseError
+  end
+
+  private
+
+  def stub_metadata!(name = "foobar", version = "5.2.1")
+    File.open("/tmp/metadata.rb", "wb") do |f|
+      f.write <<-METADATA_RB.gsub(/^ {8}/, '')
+        name             "#{name}"
+        maintainer       "Michael Bluth"
+        maintainer_email "michael@bluth.com"
+        license          "Apache 2.0"
+        description      "Doing stuff!"
+        long_description "Doing stuff!"
+        version          "#{version}"
+      METADATA_RB
+    end
+  end
+end

data/spec/emeril/publisher_spec.rb

@@ -0,0 +1,223 @@
+# -*- encoding: utf-8 -*-
+
+require_relative '../spec_helper'
+require 'chef/knife'
+require 'chef/config'
+
+require 'emeril/publisher'
+
+class DummyKnife < Emeril::Publisher::SharePlugin
+
+  def run ; end
+end
+
+describe Emeril::Publisher do
+
+  let(:cookbook_path)  { File.join(Dir.mktmpdir, "emeril") }
+  let(:category)      { "Utilities" }
+
+  let(:publisher) do
+    if ENV['DEBUG']
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::DEBUG
+    else
+      logger = nil
+    end
+
+    Emeril::Publisher.new(
+      :source_path => cookbook_path,
+      :name => "emeril",
+      :category => category,
+      :logger => logger,
+      :knife_class => DummyKnife
+    )
+  end
+
+  before do
+    @saved = Hash.new
+    %w{node_name client_key}.map(&:to_sym).each do |attr|
+      @saved[attr] = Chef::Config[attr]
+    end
+
+    Chef::Config[:node_name] = "buster"
+    Chef::Config[:client_key] = "/tmp/buster.pem"
+  end
+
+  after do
+    %w{node_name client_key}.map(&:to_sym).each do |attr|
+      Chef::Config[attr] = @saved.delete(attr)
+    end
+  end
+
+  describe ".initialize" do
+
+    it "raises an ArgumentError when :name is missing" do
+      proc { Emeril::Publisher.new }.must_raise ArgumentError
+    end
+  end
+
+  describe "#run" do
+
+    before do
+      make_cookbook!
+    end
+
+    after do
+      FileUtils.remove_dir(cookbook_path)
+    end
+
+    it "constructs an instance of :knife_class" do
+      knife_obj = DummyKnife.new
+      DummyKnife.expects(:new).returns(knife_obj)
+
+      publisher.run
+    end
+
+    it "sets a sandboxed cookbook_path on the knife object" do
+      knife_obj = DummyKnife.new
+      DummyKnife.stubs(:new).returns(knife_obj)
+      sandbox_path = Dir.mktmpdir
+      Dir.stub :mktmpdir, sandbox_path do
+        publisher.run
+      end
+
+      knife_obj.config[:cookbook_path].must_equal sandbox_path
+    end
+
+    it "sets the cookbook name and category on the knife object" do
+      knife_obj = DummyKnife.new
+      DummyKnife.stubs(:new).returns(knife_obj)
+      publisher.run
+
+      knife_obj.name_args.must_equal ["emeril", category]
+    end
+
+    it "invokes run on the knife object" do
+      knife_obj = DummyKnife.new
+      DummyKnife.stubs(:new).returns(knife_obj)
+      knife_obj.expects(:run)
+
+      publisher.run
+    end
+  end
+
+  describe "SharePlugin" do
+
+    it "overrides #exit to raise an exception" do
+      knife_obj = Emeril::Publisher::SharePlugin.new
+      knife_obj.ui = Chef::Knife::UI.new(StringIO.new, StringIO.new,
+        StringIO.new, knife_obj.ui.config)
+
+      proc { knife_obj.run }.must_raise RuntimeError
+    end
+  end
+
+  describe "LoggingUI" do
+
+    let(:stdout) { StringIO.new }
+    let(:stderr) { StringIO.new }
+    let(:stdin) { StringIO.new }
+
+    let(:logger) do
+      stub(:msg => true, :err => true, :warn => true, :fatal => true)
+    end
+
+    describe "#msg" do
+
+      it "calls #logger.info if logger is set" do
+        logger.expects(:info).with("yo")
+
+        ui_with_logger.msg("yo")
+      end
+
+      it "calls super if logger is nil" do
+        ui_without_logger.msg("yo")
+
+        stdout.string.must_match /^yo$/
+      end
+    end
+
+    describe "#err" do
+
+      it "calls #logger.error if logger is set" do
+        logger.expects(:error).with("yolo")
+
+        ui_with_logger.err("yolo")
+      end
+
+      it "calls super if logger is nil" do
+        ui_without_logger.err("yolo")
+
+        stderr.string.must_match /^yolo$/
+      end
+    end
+
+    describe "#warn" do
+
+      it "calls #logger.warn if logger is set" do
+        logger.expects(:warn).with("caution")
+
+        ui_with_logger.warn("caution")
+      end
+
+      it "calls super if logger is nil" do
+        ui_without_logger.err("caution")
+
+        stderr.string.must_match /^caution$/
+      end
+    end
+
+    describe "#fatal" do
+
+      it "calls #logger.fatal if logger is set" do
+        logger.expects(:fatal).with("die")
+
+        ui_with_logger.fatal("die")
+      end
+
+      it "calls super if logger is nil" do
+        ui_without_logger.fatal("die")
+
+        stderr.string.must_match /die$/
+      end
+    end
+
+    private
+
+    def ui_with_logger
+      Emeril::Publisher::LoggingUI.new(stdout, stderr, stdin, stub, logger)
+    end
+
+    def ui_without_logger
+      Emeril::Publisher::LoggingUI.new(stdout, stderr, stdin, stub, nil)
+    end
+  end
+
+  private
+
+  def make_cookbook!
+    FileUtils.mkdir_p("#{cookbook_path}/recipes")
+    remote_dir = File.join(File.dirname(cookbook_path), "remote")
+
+    File.open("#{cookbook_path}/metadata.rb", "wb") do |f|
+      f.write <<-METADATA_RB.gsub(/^ {8}/, '')
+        name             "#{name}"
+        maintainer       "Michael Bluth"
+        maintainer_email "michael@bluth.com"
+        license          "Apache 2.0"
+        description      "Doing stuff!"
+        long_description "Doing stuff!"
+        version          "4.1.1"
+      METADATA_RB
+    end
+    File.open("#{cookbook_path}/recipes/default.rb", "wb") do |f|
+      f.write <<-DEFAULT_RB.gsub(/^ {8}/, '')
+        directory "/tmp/yeah"
+
+        package "bash"
+      DEFAULT_RB
+    end
+    File.open("#{cookbook_path}/Berksfile", "wb") { |f| f.write "borkbork" }
+    File.open("#{cookbook_path}/.gitignore", "wb") { |f| f.write "Berksfile" }
+  end
+end