r10k 2.0.3 → 2.1.0

data/lib/shared/puppet_forge/unpacker.rb

@@ -1,68 +0,0 @@
-require 'pathname'
-require 'shared/puppet_forge/error'
-require 'shared/puppet_forge/tar'
-
-module PuppetForge
-  class Unpacker
-    # Unpack a tar file into a specified directory
-    #
-    # @param filename [String] the file to unpack
-    # @param target [String] the target directory to unpack into
-    # @return [Hash{:symbol => Array<String>}] a hash with file-category keys pointing to lists of filenames.
-    #   The categories are :valid, :invalid and :symlink
-    def self.unpack(filename, target, tmpdir)
-      inst = self.new(filename, target, tmpdir)
-      file_lists = inst.unpack
-      inst.move_into(Pathname.new(target))
-      file_lists
-    end
-
-    # Set the owner/group of the target directory to those of the source
-    # Note: don't call this function on Microsoft Windows
-    #
-    # @param source [Pathname] source of the permissions
-    # @param target [Pathname] target of the permissions change
-    def self.harmonize_ownership(source, target)
-        FileUtils.chown_R(source.stat.uid, source.stat.gid, target)
-    end
-
-    # @param filename [String] the file to unpack
-    # @param target [String] the target directory to unpack into
-    def initialize(filename, target, tmpdir)
-      @filename = filename
-      @target = target
-      @tmpdir = tmpdir
-    end
-
-    # @api private
-    def unpack
-      begin
-        PuppetForge::Tar.instance.unpack(@filename, @tmpdir)
-      rescue PuppetForge::ExecutionFailure => e
-        raise RuntimeError, "Could not extract contents of module archive: #{e.message}"
-      end
-    end
-
-    # @api private
-    def move_into(dir)
-      dir.rmtree if dir.exist?
-      FileUtils.mv(root_dir, dir)
-    ensure
-      FileUtils.rmtree(@tmpdir)
-    end
-
-    # @api private
-    def root_dir
-      return @root_dir if @root_dir
-
-      # Grab the first directory containing a metadata.json file
-      metadata_file = Dir["#{@tmpdir}/**/metadata.json"].sort_by(&:length)[0]
-
-      if metadata_file
-        @root_dir = Pathname.new(metadata_file).dirname
-      else
-        raise "No valid metadata.json found!"
-      end
-    end
-  end
-end

data/lib/shared/puppet_forge/v3.rb

@@ -1,13 +0,0 @@
-module PuppetForge
-  module V3
-    # Normalize a module name to use a hyphen as the separator between the
-    # author and module.
-    #
-    # @example
-    #   PuppetForge::V3.normalize_name('my/module') #=> 'my-module'
-    #   PuppetForge::V3.normalize_name('my-module') #=> 'my-module'
-    def self.normalize_name(name)
-      name.tr('/', '-')
-    end
-  end
-end

data/lib/shared/puppet_forge/v3/module.rb

@@ -1,69 +0,0 @@
-require 'shared/puppet_forge/v3'
-require 'shared/puppet_forge/v3/module_release'
-require 'shared/puppet_forge/connection'
-require 'shared/puppet_forge/error'
-
-module PuppetForge
-  module V3
-    # Represents metadata for a single Forge module and provides access to
-    # the releases of a module.
-    class Module
-
-      include PuppetForge::Connection
-
-      # @!attribute [r] full_name
-      #   @return [String] The hyphen separated full name of this module
-      attr_reader :full_name
-
-      # @param full_name [String] The name of this module, will be normalized to
-      #   a hyphen separated name.
-      def initialize(full_name)
-        @full_name = PuppetForge::V3.normalize_name(full_name)
-      end
-
-      # Get all released versions of this module
-      #
-      # @example
-      #   mod = PuppetForge::V3::Module.new('timmy-boolean')
-      #   mod.versions
-      #   #=> ["0.9.0-rc1", "0.9.0", "1.0.0", "1.0.1"]
-      #
-      # @return [Array<String>] All published versions of the given module
-      def versions
-        path = "/v3/modules/#{@full_name}"
-        response = conn.get(path)
-
-        releases = []
-
-        response.body['releases'].each do |release|
-          if !release['deleted_at']
-            releases << release['version']
-          end
-        end
-
-        releases.reverse
-      rescue Faraday::ResourceNotFound => e
-        raise PuppetForge::ModuleNotFound, "The module #{@full_name} does not exist on #{conn.url_prefix}.", e.backtrace
-      end
-
-      # Get all released versions of this module
-      #
-      # @example
-      #   mod = PuppetForge::V3::Module.new('timmy-boolean')
-      #   mod.latest_version
-      #   #=> "1.0.1"
-      #
-      # @return [String] The latest published version of the given module
-      def latest_version
-        versions.last
-      end
-
-      # Get a specific release of this module off of the forge.
-      #
-      # @return [ModuleRelease] a release object of the given version for this module.
-      def release(version)
-        PuppetForge::V3::ModuleRelease.new(@full_name, version).tap { |mr| mr.conn = conn }
-      end
-    end
-  end
-end

data/lib/shared/puppet_forge/v3/module_release.rb

@@ -1,85 +0,0 @@
-require 'shared/puppet_forge/v3'
-require 'shared/puppet_forge/connection'
-require 'shared/puppet_forge/error'
-require 'json'
-
-module PuppetForge
-  module V3
-    # Access metadata and downloads for a specific module release.
-    class ModuleRelease
-
-      include PuppetForge::Connection
-
-      # @!attribute [r] full_name
-      #   @return [String] The hyphen delimited name of this module
-      attr_reader :full_name
-
-      # @!attribute [r] version
-      #   @return [String] The version of this module
-      attr_reader :version
-
-      # @param full_name [String] The name of the module, will be normalized
-      #   to a hyphen delimited name.
-      # @param version [String]
-      def initialize(full_name, version)
-        @full_name = PuppetForge::V3.normalize_name(full_name)
-        @version   = version
-      end
-
-      # @return [Hash] The complete Forge response for this release.
-      def data
-        @data ||= conn.get(resource_url).body
-      rescue Faraday::ResourceNotFound => e
-        raise PuppetForge::ModuleReleaseNotFound, "The module release #{slug} does not exist on #{conn.url_prefix}.", e.backtrace
-      end
-
-      # @return [String] The unique identifier for this module release.
-      def slug
-        "#{full_name}-#{version}"
-      end
-
-      # Download this module release to the specified path.
-      #
-      # @param path [Pathname]
-      # @return [void]
-      def download(path)
-        resp = conn.get(file_url)
-        path.open('wb') { |fh| fh.write(resp.body) }
-      rescue Faraday::ResourceNotFound => e
-        raise PuppetForge::ModuleReleaseNotFound, "The module release #{slug} does not exist on #{conn.url_prefix}.", e.backtrace
-      rescue Faraday::ClientError => e
-        if e.response[:status] == 403
-          raise PuppetForge::ModuleReleaseForbidden.from_response(e.response)
-        else
-          raise e
-        end
-      end
-
-      # Verify that a downloaded module matches the checksum in the metadata for this release.
-      #
-      # @param path [Pathname]
-      # @return [void]
-      def verify(path)
-        expected_md5 = data['file_md5']
-        file_md5     = Digest::MD5.file(path).hexdigest
-        if expected_md5 != file_md5
-          raise ChecksumMismatch.new("Expected #{path} checksum to be #{expected_md5}, got #{file_md5}")
-        end
-      end
-
-      private
-
-      def file_url
-        "/v3/files/#{slug}.tar.gz"
-      end
-
-      def resource_url
-        "/v3/releases/#{slug}"
-      end
-
-      class ChecksumMismatch < StandardError
-
-      end
-    end
-  end
-end

data/lib/shared/puppet_forge/version.rb

@@ -1,3 +0,0 @@
-module PuppetForge
-  VERSION = '2.0.0.alpha'
-end

data/spec/unit/puppet/module_tool/metadata_spec.rb

@@ -1,301 +0,0 @@
-require 'spec_helper'
-require 'shared/puppet/module_tool/metadata'
-
-describe Puppet::ModuleTool::Metadata do
-  let(:data) { {} }
-  let(:metadata) { Puppet::ModuleTool::Metadata.new }
-
-  describe 'property lookups' do
-    subject { metadata }
-
-    %w[ name version author summary license source project_page issues_url
-    dependencies dashed_name release_name description ].each do |prop|
-      describe "##{prop}" do
-        it "responds to the property" do
-          subject.send(prop)
-        end
-      end
-    end
-  end
-
-  describe "#update" do
-    subject { metadata.update(data) }
-
-    context "with a valid name" do
-      let(:data) { { 'name' => 'billgates-mymodule' } }
-
-      it "extracts the author name from the name field" do
-        expect(subject.to_hash['author']).to eq('billgates')
-      end
-
-      it "extracts a module name from the name field" do
-        expect(subject.module_name).to eq('mymodule')
-      end
-
-      context "and existing author" do
-        before { metadata.update('author' => 'foo') }
-
-        it "avoids overwriting the existing author" do
-          expect(subject.to_hash['author']).to eq('foo')
-        end
-      end
-    end
-
-    context "with a valid name and author" do
-      let(:data) { { 'name' => 'billgates-mymodule', 'author' => 'foo' } }
-
-      it "use the author name from the author field" do
-        expect(subject.to_hash['author']).to eq('foo')
-      end
-
-      context "and preexisting author" do
-        before { metadata.update('author' => 'bar') }
-
-        it "avoids overwriting the existing author" do
-          expect(subject.to_hash['author']).to eq('foo')
-        end
-      end
-    end
-
-    context "with an invalid name" do
-      context "(short module name)" do
-        let(:data) { { 'name' => 'mymodule' } }
-
-        it "raises an exception" do
-          expect { subject }.to raise_error(ArgumentError, "Invalid 'name' field in metadata.json: the field must be a namespaced module name")
-        end
-      end
-
-      context "(missing namespace)" do
-        let(:data) { { 'name' => '/mymodule' } }
-
-        it "raises an exception" do
-          expect { subject }.to raise_error(ArgumentError, "Invalid 'name' field in metadata.json: the field must be a namespaced module name")
-        end
-      end
-
-      context "(missing module name)" do
-        let(:data) { { 'name' => 'namespace/' } }
-
-        it "raises an exception" do
-          expect { subject }.to raise_error(ArgumentError, "Invalid 'name' field in metadata.json: the field must be a namespaced module name")
-        end
-      end
-
-      context "(invalid namespace)" do
-        let(:data) { { 'name' => "dolla'bill$-mymodule" } }
-
-        it "raises an exception" do
-          expect { subject }.to raise_error(ArgumentError, "Invalid 'name' field in metadata.json: the namespace contains non-alphanumeric characters")
-        end
-      end
-
-      context "(non-alphanumeric module name)" do
-        let(:data) { { 'name' => "dollabils-fivedolla'" } }
-
-        it "raises an exception" do
-          expect { subject }.to raise_error(ArgumentError, "Invalid 'name' field in metadata.json: the module name contains non-alphanumeric (or underscore) characters")
-        end
-      end
-
-      context "(module name starts with a number)" do
-        let(:data) { { 'name' => "dollabills-5dollars" } }
-
-        it "raises an exception" do
-          expect { subject }.to raise_error(ArgumentError, "Invalid 'name' field in metadata.json: the module name must begin with a letter")
-        end
-      end
-    end
-
-
-    context "with an invalid version" do
-      let(:data) { { 'version' => '3.0' } }
-
-      it "raises an exception" do
-        expect { subject }.to raise_error(ArgumentError, "Invalid 'version' field in metadata.json: version string cannot be parsed as a valid Semantic Version")
-      end
-    end
-
-    context "with a valid source" do
-      context "which is a GitHub URL" do
-        context "with a scheme" do
-          before { metadata.update('source' => 'https://github.com/billgates/amazingness') }
-
-          it "predicts a default project_page" do
-            expect(subject.to_hash['project_page']).to eq('https://github.com/billgates/amazingness')
-          end
-
-          it "predicts a default issues_url" do
-            expect(subject.to_hash['issues_url']).to eq('https://github.com/billgates/amazingness/issues')
-          end
-        end
-
-        context "without a scheme" do
-          before { metadata.update('source' => 'github.com/billgates/amazingness') }
-
-          it "predicts a default project_page" do
-            expect(subject.to_hash['project_page']).to eq('https://github.com/billgates/amazingness')
-          end
-
-          it "predicts a default issues_url" do
-            expect(subject.to_hash['issues_url']).to eq('https://github.com/billgates/amazingness/issues')
-          end
-        end
-      end
-
-      context "which is not a GitHub URL" do
-        before { metadata.update('source' => 'https://notgithub.com/billgates/amazingness') }
-
-        it "does not predict a default project_page" do
-          expect(subject.to_hash['project_page']).to be nil
-        end
-
-        it "does not predict a default issues_url" do
-          expect(subject.to_hash['issues_url']).to be nil
-        end
-      end
-
-      context "which is not a URL" do
-        before { metadata.update('source' => 'my brain') }
-
-        it "does not predict a default project_page" do
-          expect(subject.to_hash['project_page']).to be nil
-        end
-
-        it "does not predict a default issues_url" do
-          expect(subject.to_hash['issues_url']).to be nil
-        end
-      end
-
-    end
-
-    context "with a valid dependency", :pending => "dependency resolution is not yet in scope" do
-      let(:data) { {'dependencies' => [{'name' => 'puppetlabs-goodmodule'}] }}
-
-      it "adds the dependency" do
-        expect(subject.dependencies.size).to eq(1)
-      end
-    end
-
-    context "with a invalid dependency name" do
-      let(:data) { {'dependencies' => [{'name' => 'puppetlabsbadmodule'}] }}
-
-      it "raises an exception" do
-        expect { subject }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "with a valid dependency version range", :pending => "dependency resolution is not yet in scope" do
-      let(:data) { {'dependencies' => [{'name' => 'puppetlabs-badmodule', 'version_requirement' => '>= 2.0.0'}] }}
-
-      it "adds the dependency" do
-        expect(subject.dependencies.size).to eq(1)
-      end
-    end
-
-    context "with a invalid version range" do
-      let(:data) { {'dependencies' => [{'name' => 'puppetlabsbadmodule', 'version_requirement' => '>= banana'}] }}
-
-      it "raises an exception" do
-        expect { subject }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "with duplicate dependencies", :pending => "dependency resolution is not yet in scope" do
-      let(:data) { {'dependencies' => [{'name' => 'puppetlabs-dupmodule', 'version_requirement' => '1.0.0'},
-        {'name' => 'puppetlabs-dupmodule', 'version_requirement' => '0.0.1'}] }
-      }
-
-      it "raises an exception" do
-        expect { subject }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "adding a duplicate dependency", :pending => "dependency resolution is not yet in scope" do
-      let(:data) { {'dependencies' => [{'name' => 'puppetlabs-origmodule', 'version_requirement' => '1.0.0'}] }}
-
-      it "with a different version raises an exception" do
-        metadata.add_dependency('puppetlabs-origmodule', '>= 0.0.1')
-        expect { subject }.to raise_error(ArgumentError)
-      end
-
-      it "with the same version does not add another dependency" do
-        metadata.add_dependency('puppetlabs-origmodule', '1.0.0')
-        expect(subject.dependencies.size).to eq(1)
-      end
-    end
-  end
-
-  describe '#dashed_name' do
-    it 'returns nil in the absence of a module name' do
-      expect(metadata.update('version' => '1.0.0').release_name).to be_nil
-    end
-
-    it 'returns a hyphenated string containing namespace and module name' do
-      data = metadata.update('name' => 'foo-bar')
-      expect(data.dashed_name).to eq('foo-bar')
-    end
-
-    it 'properly handles slash-separated names' do
-      data = metadata.update('name' => 'foo/bar')
-      expect(data.dashed_name).to eq('foo-bar')
-    end
-
-    it 'is unaffected by author name' do
-      data = metadata.update('name' => 'foo/bar', 'author' => 'me')
-      expect(data.dashed_name).to eq('foo-bar')
-    end
-  end
-
-  describe '#release_name' do
-    it 'returns nil in the absence of a module name' do
-      expect(metadata.update('version' => '1.0.0').release_name).to be_nil
-    end
-
-    it 'returns nil in the absence of a version' do
-      expect(metadata.update('name' => 'foo/bar').release_name).to be_nil
-    end
-
-    it 'returns a hyphenated string containing module name and version' do
-      data = metadata.update('name' => 'foo/bar', 'version' => '1.0.0')
-      expect(data.release_name).to eq('foo-bar-1.0.0')
-    end
-
-    it 'is unaffected by author name' do
-      data = metadata.update('name' => 'foo/bar', 'version' => '1.0.0', 'author' => 'me')
-      expect(data.release_name).to eq('foo-bar-1.0.0')
-    end
-  end
-
-  describe "#to_hash" do
-    subject { metadata.to_hash }
-
-    it "contains the default set of keys" do
-      expect(subject.keys.sort).to eq(%w[ name version author summary license source issues_url project_page dependencies ].sort)
-    end
-
-    describe "['license']" do
-      it "defaults to Apache 2" do
-        expect(subject['license']).to eq("Apache-2.0")
-      end
-    end
-
-    describe "['dependencies']" do
-      it "defaults to an empty set" do
-        expect(subject['dependencies']).to eq(Set.new)
-      end
-    end
-
-    context "when updated with non-default data" do
-      subject { metadata.update('license' => 'MIT', 'non-standard' => 'yup').to_hash }
-
-      it "overrides the defaults" do
-        expect(subject['license']).to eq('MIT')
-      end
-
-      it 'contains unanticipated values' do
-        expect(subject['non-standard']).to eq('yup')
-      end
-    end
-  end
-end