r10k 1.1.4 → 1.2.0rc1

data/lib/r10k/module/git.rb

@@ -1,6 +1,5 @@
 require 'r10k/module'
-require 'r10k/git/working_dir'
-require 'forwardable'
+require 'r10k/git'
 
 class R10K::Module::Git < R10K::Module::Base
 
@@ -12,14 +11,17 @@ class R10K::Module::Git < R10K::Module::Base
     false
   end
 
-  extend Forwardable
-  def_delegator :@working_dir, :sync
+  # @!attribute [r] working_dir
+  #   @api private
+  #   @return [R10K::Git::WorkingDir]
+  attr_reader :working_dir
 
   def initialize(name, basedir, args)
     @name, @basedir, @args = name, basedir, args
 
-    @remote = @args[:git]
-    @ref    = (@args[:ref] || 'master')
+    parse_options(args)
+
+    @full_path = Pathname.new(File.join(basedir, name))
 
     @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @basedir, @name)
   end
@@ -27,4 +29,68 @@ class R10K::Module::Git < R10K::Module::Base
   def version
     @ref
   end
+
+  def sync
+    case status
+    when :absent
+      install
+    when :mismatched
+      uninstall
+      install
+    when :outdated
+      @working_dir.sync
+    end
+  end
+
+  def status
+    if not @working_dir.exist?
+      return :absent
+    elsif not @working_dir.git?
+      return :mismatched
+    elsif not @remote == @working_dir.remote
+      return :mismatched
+    end
+
+    if @working_dir.outdated?
+      return :outdated
+    end
+
+    return :insync
+  end
+
+  private
+
+  def install
+    @working_dir.sync
+  end
+
+  def uninstall
+    @full_path.rmtree
+  end
+
+  def parse_options(options)
+    @remote = options.delete(:git)
+
+    if options[:branch]
+      @ref = R10K::Git::Head.new(options.delete(:branch))
+    end
+
+    if options[:tag]
+      @ref = R10K::Git::Tag.new(options.delete(:tag))
+    end
+
+    if options[:commit]
+      @ref = R10K::Git::Commit.new(options.delete(:commit))
+    end
+
+    if options[:ref]
+      @ref = R10K::Git::Ref.new(options.delete(:ref))
+    end
+
+    @ref ||= R10K::Git::Ref.new('master')
+
+    unless options.empty?
+      raise ArgumentError, "Unhandled options #{options.keys.inspect} specified for #{self.class}"
+    end
+  end
 end

data/lib/r10k/module/metadata.rb

@@ -0,0 +1,47 @@
+require 'r10k/module'
+require 'r10k/semver'
+require 'json'
+
+class R10K::Module::Metadata
+
+  # @!attribute [r] name
+  #   @return [String] The module name
+  attr_reader :name
+
+  # @!attribute [r] author
+  #   @return [String] The module author username
+  attr_reader :author
+
+  # @!attribute [r] version
+  #   @return [R10K::SemVer] The module version
+  attr_reader :version
+
+  # @param metadata_path [Pathname] The file path to the metadata
+  def initialize(metadata_path)
+    @metadata_path = metadata_path
+
+    @version = R10K::SemVer::MIN
+  end
+
+  # Does the metadata file itself exist?
+  def exist?
+    @metadata_path.file? and @metadata_path.readable?
+  end
+
+  # Attempt to read the metadata file
+  def read
+    if self.exist?
+      hash = JSON.parse(@metadata_path.read)
+      attributes_from_hash(hash)
+    end
+  rescue JSON::ParserError
+    false
+  end
+
+  private
+
+  def attributes_from_hash(json)
+    @author, _, @name = json['name'].partition('-')
+    @version = R10K::SemVer.new(json['version'])
+  end
+end

data/lib/r10k/module/svn.rb

@@ -0,0 +1,99 @@
+require 'r10k/module'
+require 'r10k/execution'
+require 'r10k/logging'
+require 'r10k/svn/working_dir'
+
+class R10K::Module::SVN < R10K::Module::Base
+
+  R10K::Module.register(self)
+
+  def self.implement?(name, args)
+    args.is_a? Hash and args.has_key? :svn
+  end
+
+  # @!attribute [r] expected_revision
+  #   @return [String] The SVN revision that the repo should have checked out
+  attr_reader :expected_revision
+  alias expected_version expected_revision
+
+  # @!attribute [r] svn_path
+  #   @return [String] The path inside of the SVN repository to have checked out
+  attr_reader :svn_path
+
+  # @!attribute [r] full_path
+  #   @return [Pathname] The filesystem path to the SVN repo
+  attr_reader :full_path
+
+  def initialize(name, basedir, args)
+    @name = name
+    @basedir = basedir
+
+    parse_options(args)
+
+    @full_path = Pathname.new(File.join(@basedir, @name))
+    @working_dir = R10K::SVN::WorkingDir.new(@full_path)
+  end
+
+  def status
+    if not self.exist?
+      :absent
+    elsif not @working_dir.is_svn?
+      :mismatched
+    elsif not @url == @working_dir.url
+      :mismatched
+    elsif not @expected_revision == @working_dir.revision
+      :outdated
+    else
+      :insync
+    end
+  end
+
+  def sync
+    case status
+    when :absent
+      install
+    when :mismatched
+      reinstall
+    when :outdated
+      update
+    end
+  end
+
+  def exist?
+    @full_path.exist?
+  end
+
+  private
+
+  def install
+    FileUtils.mkdir @basedir unless File.directory? @basedir
+
+    @working_dir.checkout(@url, @expected_revision)
+  end
+
+  def uninstall
+    @full_path.rmtree
+  end
+
+  def reinstall
+    uninstall
+    install
+  end
+
+  def update
+    @working_dir.update(@expected_revision)
+  end
+
+  def parse_options(hash)
+    hash.each_pair do |key, value|
+      case key
+      when :svn
+        @url = value
+      when :rev, :revision
+        @expected_revision = value
+      when :svn_path
+        @svn_path = value
+      end
+    end
+  end
+end

data/lib/r10k/module.rb

@@ -32,4 +32,5 @@ module R10K::Module
   require 'r10k/module/base'
   require 'r10k/module/git'
   require 'r10k/module/forge'
+  require 'r10k/module/svn'
 end

data/lib/r10k/module_repository/forge.rb

@@ -0,0 +1,64 @@
+require 'r10k/module_repository'
+require 'r10k/version'
+
+require 'faraday'
+require 'faraday_middleware/multi_json'
+require 'faraday_middleware'
+
+class R10K::ModuleRepository::Forge
+
+  # @!attribute [r] forge
+  #   @return [String] The forge hostname to use for requests
+  attr_reader :forge
+
+  # @!attribute [r] :conn
+  #   @api private
+  #   @return [Faraday]
+  attr_reader :conn
+
+  def initialize(forge = 'forge.puppetlabs.com')
+    @forge = forge
+
+    @conn = Faraday.new(
+      :url => "https://#{@forge}",
+      :user_agent => "Ruby/r10k #{R10K::VERSION}"
+    ) do |builder|
+      builder.request :multi_json
+      builder.response :multi_json
+
+      # This needs to be _after_ request/response configuration for testing
+      # purposes. This comment is the result of much consternation.
+      builder.adapter Faraday.default_adapter
+    end
+  end
+
+  # Query for all published versions of a module
+  #
+  # @example
+  #   forge = R10K::ModuleRepository::Forge.new
+  #   forge.versions('adrien/boolean')
+  #   #=> ["0.9.0-rc1", "0.9.0", "1.0.0", "1.0.1"]
+  #
+  # @param module_name [String] The fully qualified module name
+  # @return [Array<String>] All published versions of the given module
+  def versions(module_name)
+    response = @conn.get("/api/v1/releases.json", {'module' => module_name})
+
+    response.body[module_name].map do |version_info|
+      version_info['version']
+    end
+  end
+
+  # Query for the newest published version of a module
+  #
+  # @example
+  #   forge = R10K::ModuleRepository::Forge.new
+  #   forge.latest_version('adrien/boolean')
+  #   #=> "1.0.1"
+  #
+  # @param module_name [String] The fully qualified module name
+  # @return [String] The latest published version of the given module
+  def latest_version(module_name)
+    versions(module_name).last
+  end
+end

data/lib/r10k/module_repository.rb

@@ -0,0 +1,8 @@
+module R10K
+
+  # Locations that can be queried for remote module metadata
+  module ModuleRepository
+
+    require 'r10k/module_repository/forge'
+  end
+end

data/lib/r10k/semver.rb

@@ -112,7 +112,7 @@ class SemVer < Numeric
   end
 
   def inspect
-    @vstring || "v#{@major}.#{@minor}.#{@tiny}#{@special}"
+    @vstring || "#{@major}.#{@minor}.#{@tiny}#{@special}"
   end
   alias :to_s :inspect
 

data/lib/r10k/svn/working_dir.rb

@@ -0,0 +1,76 @@
+require 'r10k/logging'
+require 'r10k/util/subprocess'
+
+module R10K
+  module SVN
+    class WorkingDir
+
+      # @param full_path [Pathname]
+      def initialize(full_path)
+        @full_path = full_path
+      end
+
+      def is_svn?
+        dot_svn = @full_path + '.svn'
+        dot_svn.exist?
+      end
+
+      def revision
+        info.slice(/^Revision: (\d+)$/, 1)
+      end
+
+      def url
+        info.slice(/^URL: (.*)$/, 1)
+      end
+
+      def root
+        info.slice(/^Repository Root: (.*)$/, 1)
+      end
+
+      def update(revision = nil)
+        argv = %w[update]
+        argv << '-r' << revision if revision
+
+        svn argv, :cwd => @full_path
+      end
+
+      def checkout(url, revision = nil)
+        argv = ['checkout', url]
+        argv << '-r' << revision if revision
+        argv << @full_path.basename.to_s
+
+        svn argv, :cwd => @full_path.parent
+      end
+
+      private
+
+      def info
+        svn ["info"], :cwd => @full_path
+      end
+
+      include R10K::Execution
+      include R10K::Logging
+
+      # Wrap SVN commands
+      #
+      # @param argv [Array<String>]
+      # @param opts [Hash]
+      #
+      # @option opts [Pathname] :cwd The directory to run the command in
+      #
+      # @return [String] The stdout from the given command
+      def svn(argv, opts = {})
+        argv.unshift('svn')
+
+        subproc = R10K::Util::Subprocess.new(argv)
+        subproc.raise_on_fail = true
+        subproc.logger = self.logger
+
+        subproc.cwd = opts[:cwd]
+        result = subproc.execute
+
+        result.stdout
+      end
+    end
+  end
+end

data/lib/r10k/task/deployment.rb

@@ -11,39 +11,32 @@ module Deployment
 
     private
 
-    def active_environments(names)
-
-      active = []
-
-      all_environments = @deployment.environments
-      if names.empty?
-        active = all_environments
-      else
-        # This has average case O(N^2) but N should remain relatively small, so
-        # while this should be optimized that optimization can wait a while.
-        names.each do |env_name|
-
-          matching = all_environments.select do |env|
-            env.dirname == env_name
-          end
-
-          if matching.empty?
-            logger.warn "Environment #{env_name} not found in any source"
-            task_runner.succeeded = false
-          else
-            active.concat(matching)
-          end
-        end
+    def load_environments!
+      @environments = @deployment.environments.inject({}) do |hash, env|
+        hash[env.dirname] = env
+        hash
       end
-
-      active
     end
 
     # @param [Array<String>] names The list of environments to deploy.
     #
-    def with_environments(names = [])
-      active_environments(names).each do |env|
-        yield env
+    def with_environments(names = [], &block)
+      load_environments!
+
+      # If an explicit list of environments were not given, deploy everything
+      if names.size > 0
+        to_deploy = names
+      else
+        to_deploy = @environments.keys
+      end
+
+      to_deploy.reverse.each do |env_name|
+        if (env = @environments[env_name])
+          yield env
+        else
+          logger.warn "Environment #{env_name} not found in any source"
+          task_runner.succeeded = false
+        end
       end
     end
   end