r10k 0.0.9 → 1.0.0rc1

data/lib/r10k/task/environment.rb

@@ -0,0 +1,29 @@
+require 'r10k/task'
+require 'r10k/task/puppetfile'
+
+module R10K
+module Task
+module Environment
+  class Deploy < R10K::Task::Base
+
+    attr_writer :update_puppetfile
+
+    def initialize(environment)
+      @environment = environment
+
+      @update_puppetfile = false
+    end
+
+    def call
+      logger.notice "Deploying environment #{@environment.dirname}"
+      @environment.sync
+
+      if @update_puppetfile
+        task = R10K::Task::Puppetfile::Sync.new(@environment.puppetfile)
+        task_runner.insert_task_after(self, task)
+      end
+    end
+  end
+end
+end
+end

data/lib/r10k/task/module.rb

@@ -0,0 +1,18 @@
+require 'r10k/task'
+
+module R10K
+module Task
+module Module
+  class Sync < R10K::Task::Base
+    def initialize(mod)
+      @mod = mod
+    end
+
+    def call
+      logger.info "Deploying #{@mod.name} into #{@mod.basedir}"
+      @mod.sync
+    end
+  end
+end
+end
+end

data/lib/r10k/task/puppetfile.rb

@@ -0,0 +1,99 @@
+require 'r10k/task'
+require 'r10k/task/module'
+
+require 'r10k/task_runner'
+
+module R10K
+module Task
+module Puppetfile
+  class Sync < R10K::Task::Base
+    def initialize(puppetfile)
+      @puppetfile = puppetfile
+    end
+
+    def call
+      logger.info "Loading modules from Puppetfile into queue"
+
+      @puppetfile.load
+      @puppetfile.modules.each do |mod|
+        task = R10K::Task::Module::Sync.new(mod)
+        task_runner.insert_task_after(self, task)
+      end
+
+      purge_task = Purge.new(@puppetfile)
+      task_runner.append_task purge_task
+    end
+  end
+
+  class DeployModules < R10K::Task::Base
+
+    attr_accessor :module_names
+
+    def initialize(puppetfile)
+      @puppetfile = puppetfile
+    end
+
+    def call
+      logger.debug "Updating module list for Puppetfile #{@puppetfile.basedir}"
+      @puppetfile.load
+      load_modulemap!
+
+      existing = @modulemap.keys
+
+      warn_on_missing(existing, @module_names)
+
+      to_deploy = existing & @module_names
+
+      to_deploy.each do |mod_name|
+        mod = @modulemap[mod_name]
+        task = R10K::Task::Module::Sync.new(mod)
+        task_runner.insert_task_after(self, task)
+      end
+    end
+
+    private
+
+    def warn_on_missing(existing, requested)
+      missing_modules = requested - existing
+
+      unless missing_modules.empty?
+        task_runner.succeeded = false
+
+        missing_modules.each do |missing|
+          logger.warn "Unable to deploy module #{missing}: not listed in #{@puppetfile.puppetfile_path}"
+        end
+      end
+    end
+
+    def load_modulemap!
+        @modulemap = @puppetfile.modules.inject({}) do |hash, mod|
+        hash[mod.name] = mod
+        hash
+      end
+    end
+  end
+
+  class Purge < R10K::Task::Base
+    def initialize(puppetfile)
+      @puppetfile = puppetfile
+    end
+
+    def call
+      moduledir = @puppetfile.moduledir
+
+      @puppetfile.load
+
+      stale_mods = @puppetfile.stale_contents
+
+      if stale_mods.empty?
+        logger.debug "No stale modules in #{moduledir}"
+      else
+        logger.info "Purging stale modules from #{moduledir}"
+        logger.debug "Stale modules in #{moduledir}: #{stale_mods.join(', ')}"
+        @puppetfile.purge!
+      end
+    end
+  end
+end
+end
+end

data/lib/r10k/task_runner.rb

@@ -0,0 +1,72 @@
+require 'r10k/task'
+require 'r10k/logging'
+
+module R10K
+class TaskRunner
+
+  include R10K::Logging
+
+  attr_writer :succeeded
+
+  def initialize(opts)
+    @tasks     = []
+    @succeeded = true
+    @errors    = {}
+
+    @trace = opts.delete(:trace)
+
+    raise "Unrecognized options: #{opts.keys.join(', ')}" unless opts.empty?
+  end
+
+  def run
+    catch :abort do
+      until @tasks.empty?
+        current = @tasks.first
+        current.task_runner = self
+        begin
+          current.call
+        rescue Interrupt => e
+          logger.error "Aborted!"
+          $stderr.puts e.backtrace.join("\n").red if @trace
+          @succeeded = false
+          throw :abort
+        rescue => e
+          logger.error "Task #{current} failed while running: #{e.message}"
+          $stderr.puts e.backtrace.join("\n").red if @trace
+
+          @errors[current] = e
+          @succeeded = false
+        end
+        @tasks.shift
+      end
+    end
+  end
+
+  def prepend_task(task)
+    @tasks.unshift task
+  end
+
+  def append_task(task)
+    @tasks << task
+  end
+
+  # @param [R10K::Task] task_index The task to insert the task after
+  # @param [R10K::Task] new_task The task to insert
+  def insert_task_after(task_index, new_task)
+    if (index = @tasks.index(task_index))
+      index += 1
+      @tasks.insert(index, new_task)
+    else
+      @tasks.insert(0, new_task)
+    end
+  end
+
+  def succeeded?
+    @succeeded
+  end
+
+  def exit_value
+    @succeeded ? 0 : 1
+  end
+end
+end

data/lib/r10k/util/purgeable.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+module R10K
+module Util
+module Purgeable
+  # Mixin for purging stale directory contents.
+  #
+  # @abstract Classes using this mixin need to implement {#managed_directory} and
+  #   {#desired_contents}
+
+  # @!method desired_contents
+  #   @abstract Including classes must implement this method to list the
+  #     expected filenames of managed_directory
+  #   @return [Array<String>] A list of directory contents that should be present
+
+  # @!method managed_directory
+  #   @abstract Including classes must implement this method to return the
+  #     path to the directory that can be purged
+  #   @return [String] The path to the directory to be purged
+
+  # @return [Array<String>] The present directory entries in `self.managed_directory`
+  def current_contents
+    dir = self.managed_directory
+    glob_exp = File.join(dir, '*')
+
+    Dir.glob(glob_exp).map do |fname|
+      File.basename fname
+    end
+  end
+
+  # @return [Array<String>] Directory contents that are expected but not present
+  def pending_contents
+    desired_contents - current_contents
+  end
+
+  # @return [Array<String>] Directory contents that are present but not expected
+  def stale_contents
+    current_contents - desired_contents
+  end
+
+  # Forcibly remove all unmanaged content in `self.managed_directory`
+  def purge!
+    stale_contents.each do |fname|
+      fpath = File.join(self.managed_directory, fname)
+      FileUtils.rm_rf fpath, :secure => true
+    end
+  end
+
+end
+end
+end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '0.0.9'
+  VERSION = '1.0.0rc1'
 end

data/spec/unit/deployment/environment_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'r10k/deployment/environment'
+
+describe R10K::Deployment::Environment do
+  let(:remote) { 'git://github.com/adrienthebo/r10k-fixture-repo' }
+  let(:ref)    { 'master' }
+
+  describe 'dirname' do
+    it 'uses the ref as the default dirname' do
+      subject = described_class.new(ref, remote, '/tmp')
+      subject.dirname.should == 'master'
+    end
+
+    it 'allows a specific dirname to be set' do
+      subject = described_class.new(ref, remote, '/tmp', 'sourcename_master')
+      subject.dirname.should == 'sourcename_master'
+    end
+  end
+end

data/spec/unit/git/cache_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe R10K::Git::Cache, 'memoizing objects' do
+
+  it "returns the same object when a remote is duplicated" do
+    first  = described_class.new('foo')
+    second = described_class.new('foo')
+
+    first.should be second
+  end
+
+  it "wipes the memoized objects when .clear! is called" do
+    first = described_class.new('foo')
+    described_class.clear!
+    second = described_class.new('foo')
+
+    first.should_not be second
+  end
+end
+
+describe R10K::Git::Cache do
+
+  after do
+    described_class.clear!
+  end
+
+  describe 'setting the cache root' do
+    it 'defaults to ~/.r10k/git' do
+      described_class.new('foo').cache_root.should match %r[/\.r10k/git]
+    end
+
+    it 'uses the class cache root if set' do
+      described_class.stubs(:cache_root).returns '/var/spool/r10k'
+      described_class.new('foo').cache_root.should == '/var/spool/r10k'
+    end
+  end
+end

data/spec/unit/git/working_dir_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe R10K::Git::WorkingDir do
+
+  before do
+    R10K::Git::Cache.stubs(:cache_root).returns '/tmp'
+  end
+
+  describe "initializing" do
+    it "generates a new cache for the remote" do
+      wd = described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/tmp')
+      wd.cache.should be_kind_of R10K::Git::Cache
+    end
+  end
+end

data/spec/unit/module/forge_spec.rb

@@ -0,0 +1,95 @@
+require 'r10k/module/forge'
+require 'semver'
+require 'spec_helper'
+
+describe R10K::Module::Forge do
+  before :each do
+    Object.expects(:systemu).never
+  end
+
+  before :each do
+    s = stub(:debug2 => nil, :debug1 => nil, :debug => nil, :info => nil)
+    described_class.any_instance.stubs(:logger).returns s
+  end
+
+  describe "implementing the Puppetfile spec" do
+    it "should implement 'branan/eight_hundred', '8.0.0'" do
+      described_class.should be_implement('branan/eight_hundred', '8.0.0')
+    end
+
+    it "should fail with an invalid full name" do
+      described_class.should_not be_implement('branan-eight_hundred', '8.0.0')
+    end
+
+    it "should fail with an invalid version" do
+      described_class.should_not be_implement('branan-eight_hundred', 'not a semantic version')
+    end
+  end
+
+  describe "setting attributes" do
+    subject { described_class.new('branan/eight_hundred', '/moduledir', '8.0.0') }
+
+    its(:name) { should eq 'eight_hundred' }
+    its(:owner) { should eq 'branan' }
+    its(:full_name) { should eq 'branan/eight_hundred' }
+    its(:basedir) { should eq '/moduledir' }
+    its(:full_path) { should eq '/moduledir/eight_hundred' }
+  end
+
+  describe "when syncing" do
+    let(:fixture_modulepath) { File.expand_path('spec/fixtures/module/forge', PROJECT_ROOT) }
+    let(:empty_modulepath) { File.expand_path('spec/fixtures/empty', PROJECT_ROOT) }
+
+    describe "and the module is in sync" do
+      subject { described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0') }
+
+      it { should be_insync }
+      its(:version) { should eq '8.0.0' }
+      its(:current_version) { should eq '8.0.0' }
+    end
+
+    describe "and the desired version is newer than the installed version" do
+      subject { described_class.new('branan/eight_hundred', fixture_modulepath, '80.0.0') }
+
+      it { should_not be_insync }
+      its(:version) { should eq '80.0.0' }
+      its(:current_version) { should eq '8.0.0' }
+
+      it "should try to upgrade the module" do
+        # "v80.0.0" ? Seriously? Where did the "v" come from?
+        expected = %w{upgrade --version=v80.0.0 --ignore-dependencies branan/eight_hundred}
+        subject.expects(:pmt).with(expected)
+        subject.sync!
+      end
+    end
+
+    describe "and the desired version is older than the installed version" do
+      subject { described_class.new('branan/eight_hundred', fixture_modulepath, '7.0.0') }
+
+      it { should_not be_insync }
+      its(:version) { should eq '7.0.0' }
+      its(:current_version) { should eq '8.0.0' }
+
+      it "should try to downgrade the module" do
+        # Again with the magical "v" prefix to the version.
+        expected = %w{upgrade --version=v7.0.0 --ignore-dependencies branan/eight_hundred}
+        subject.expects(:pmt).with(expected)
+        subject.sync!
+      end
+    end
+
+    describe "and the module is not installed" do
+      subject { described_class.new('branan/eight_hundred', empty_modulepath, '8.0.0') }
+
+      it { should_not be_insync }
+      its(:version) { should eq '8.0.0' }
+      its(:current_version) { should eq SemVer::MIN }
+
+      it "should try to install the module" do
+        expected = %w{install --version=v8.0.0 --ignore-dependencies branan/eight_hundred}
+        subject.expects(:pmt).with(expected)
+        subject.sync!
+      end
+    end
+  end
+end