puppet-library 0.9.1 → 0.10.0

data/lib/puppet_library/util/patches.rb

@@ -0,0 +1,104 @@
+# -*- encoding: utf-8 -*-
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems/package'
+
+# Early versions of Rubygems have problems with version numbers with dashes
+# (e.g. "1.0.0-rc1"). This adds the behaviour or new RG versions to all
+# versions, hopefully without breaking newer versions. In most cases we want to
+# fail silently with bad version numbers so that we don't crash the server
+# because of weird stuff from a remote forge or elsewhere.
+module Gem
+    def Version.new(version)
+        super(version.to_s.gsub("-",".pre."))
+    rescue ArgumentError
+        # If it starts with numbers, use those
+        if version =~ /^\d+(\.\d+)*/
+            super(version[/^\d+(\.\d+)*/])
+        # Somebody's really made a mess of this version number
+        else
+            super("0")
+        end
+    end
+
+    def Dependency.new(name, spec)
+        super(name, spec.to_s.gsub("-", ".pre."))
+    rescue ArgumentError
+        # If it starts with numbers, use those
+        if spec =~ /^([~><= ]+)?\d+(\.\d+)*/
+            super(name, spec[/^([~><= ]+)?\d+(\.\d+)*/])
+        # Somebody's really made a mess of this version number
+        else
+            super(name, ">= 0")
+        end
+    end
+end
+
+class Array
+    # Like 'uniq' with a block, but also works on Ruby < 1.9
+    def unique_by
+        attr_to_element = {}
+        select do |element|
+            attribute = yield(element)
+            is_duplicate = attr_to_element.include? attribute
+            unless is_duplicate
+                attr_to_element[attribute] = element
+            end
+            !is_duplicate
+        end
+    end
+
+    def version_sort
+        version_sort_by { |e| e }
+    end
+
+    def version_sort_by
+        sort_by do |element|
+            version = yield(element)
+            Gem::Version.new(version)
+        end
+    end
+
+    def deep_merge
+        inject({}) do |merged, map|
+            merged.deep_merge(map)
+        end
+    end
+end
+
+class Hash
+    def deep_merge(other)
+        merge(other) do |key, old_val, new_val|
+            if old_val.instance_of? Array
+                old_val + new_val
+            else
+                new_val
+            end
+        end
+    end
+end
+
+class Gem::Package::TarReader
+    # Old versions of RubyGems don't include Enumerable in here
+    def find
+        each do |entry|
+            if yield(entry)
+                return entry
+            end
+        end
+    end
+end

data/lib/puppet_library/util/temp_dir.rb

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fileutils'
+
+module PuppetLibrary::Util
+    class TempDir
+        attr_reader :path
+
+        def self.use(name, &block)
+            path = create(name)
+            Dir.chdir(path, &block)
+        ensure
+            FileUtils.rm_rf path
+        end
+
+        def self.create(name)
+            TempDir.new(name).path
+        end
+
+        def initialize(name)
+            file = Tempfile.new(name)
+            @path = file.path
+            file.unlink
+            FileUtils.mkdir @path
+        end
+    end
+end

data/lib/puppet_library/util.rb

@@ -15,75 +15,9 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'rubygems/package'
-
-module Gem
-    def Version.new(version)
-        begin
-            super(version.to_s.gsub("-",".pre."))
-        rescue ArgumentError => e
-            # If it starts with numbers, use those
-            if version =~ /^\d+(\.\d+)*/
-                super(version[/^\d+(\.\d+)*/])
-            # Somebody's really made a mess of this version number
-            else
-                super("0")
-            end
-        end
-    end
+module PuppetLibrary::Util
 end
 
-class Array
-    # Like 'uniq' with a block, but also works on Ruby < 1.9
-    def unique_by
-        attr_to_element = {}
-        select do |element|
-            attribute = yield(element)
-            is_duplicate = attr_to_element.include? attribute
-            unless is_duplicate
-                attr_to_element[attribute] = element
-            end
-            !is_duplicate
-        end
-    end
-
-    def version_sort
-        version_sort_by { |e| e }
-    end
-
-    def version_sort_by
-        sort_by do |element|
-            version = yield(element)
-            Gem::Version.new(version)
-        end
-    end
-
-    def deep_merge
-        inject({}) do |merged, map|
-            merged.deep_merge(map)
-        end
-    end
-end
-
-class Hash
-    def deep_merge(other)
-        merge(other) do |key, old_val, new_val|
-            if old_val.instance_of? Array
-                old_val + new_val
-            else
-                new_val
-            end
-        end
-    end
-end
-
-class Gem::Package::TarReader
-    # Old versions of RubyGems don't include Enumerable in here
-    def find
-        each do |entry|
-            if yield(entry)
-                return entry
-            end
-        end
-    end
-end
+require 'puppet_library/util/git'
+require 'puppet_library/util/patches'
+require 'puppet_library/util/temp_dir'

data/lib/puppet_library/version.rb

@@ -16,5 +16,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module PuppetLibrary
-    VERSION = "0.9.1"
+    VERSION = "0.10.0"
 end

data/spec/archive/archive_reader_spec.rb

@@ -22,9 +22,12 @@ module PuppetLibrary::Archive
             ArchiveReader.new(archive)
         end
 
+        let :source_dir do
+            Tempdir.create("zipping")
+        end
+
         let :archive do
-            dir = Tempdir.create("zipping")
-            archive = File.join(dir, "archive.tgz")
+            archive = File.join(source_dir, "archive.tgz")
             write_tar_gzip!(archive) do |zip|
                 zip.add_file("arrive.txt", 0644) { |entry| entry.write "say hello" }
                 zip.add_file("later/depart.txt", 0644) { |entry| entry.write "say bye" }
@@ -32,6 +35,10 @@ module PuppetLibrary::Archive
             archive
         end
 
+        after do
+            rm_rf source_dir
+        end
+
         def write_tar_gzip!(file_name)
             tar = StringIO.new
 

data/spec/archive/archiver_spec.rb

@@ -34,6 +34,10 @@ module PuppetLibrary::Archive
                 write_file! "later/depart.txt", "say bye"
             end
 
+            after do
+                rm_rf dir
+            end
+
             it "tars and gzips a directory and its contents" do
                 buffer = Archiver.archive_dir(dir, "todo")
 

data/spec/forge/cache_spec.rb

@@ -23,6 +23,10 @@ module PuppetLibrary::Forge
         let(:http_client) { double(PuppetLibrary::Http::HttpClient) }
         let(:forge) { Cache.new("http://forge.example.com", cache_dir, http_client) }
 
+        after do
+            rm_rf cache_dir
+        end
+
         it "is a proxy" do
             expect(forge).to be_a Proxy
         end

data/spec/forge/directory_spec.rb

@@ -45,6 +45,10 @@ module PuppetLibrary::Forge
                     chmod 0400, module_dir
                 end
 
+                after do
+                    chmod 0777, module_dir
+                end
+
                 it "raises an error" do
                     expect {
                         Directory.new(module_dir)

data/spec/forge/git_repository_spec.rb

@@ -52,7 +52,10 @@ module PuppetLibrary::Forge
             rm_rf @@repo_path
         end
 
-        let(:forge) { GitRepository.new("puppetlabs", "apache", /[0-9.]+/, @@repo_path) }
+        let(:forge) { GitRepository.new(@@repo_path, /[0-9.]+/) }
+        after do
+            forge.destroy!
+        end
 
         describe "#get_module" do
             context "when the requested author is different from the configured author" do
@@ -115,7 +118,7 @@ module PuppetLibrary::Forge
 
         describe "#get_all_metadata" do
             it "generates the metadata for the each version" do
-                metadata = forge.get_metadata("puppetlabs", "apache")
+                metadata = forge.get_all_metadata
                 expect(metadata).to have(3).versions
                 expect(metadata.first["name"]).to eq "puppetlabs-apache"
                 expect(metadata.first["version"]).to eq "0.9.0"

data/spec/forge/source_spec.rb

@@ -69,6 +69,10 @@ module PuppetLibrary::Forge
                     chmod 0400, module_dir
                 end
 
+                after do
+                    chmod 0777, module_dir
+                end
+
                 it "raises an error" do
                     expect {
                         Source.new(module_dir)

data/spec/integration_test_helper.rb

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+RSpec::Matchers.define :be_cached do
+    match do |mod_file|
+        ! Dir[File.join(cache_dir, mod_file)].empty?
+    end
+end
+
+RSpec::Matchers.define :be_installed do
+    match do |mod_name|
+        File.directory?(File.join(project_dir, "modules",  mod_name))
+    end
+end
+
+def write_puppetfile(content)
+    File.open("#{project_dir}/Puppetfile", "w") do |puppetfile|
+        puppetfile.puts content
+    end
+end
+
+
+module Ports
+    def self.next!
+        @port ||= 9000
+        @port += 1
+    end
+end

data/spec/util/git_spec.rb

@@ -0,0 +1,143 @@
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+module PuppetLibrary::Util
+    describe Git do
+        @@repo_path = Tempdir.create("git-repo")
+        @@tags = [ "0.9.0", "1.0.0-rc1", "1.0.0", "xxx" ]
+
+        before :all do
+            def git(command)
+                git_command = "git --git-dir=#{@@repo_path}/.git --work-tree=#{@@repo_path} #{command}"
+                `#{git_command}`
+                unless $?.success?
+                    raise "Failed to run command: \"#{git_command}\""
+                end
+            end
+
+            git "init"
+            git "config user.name tester"
+            git "config user.email tester@example.com"
+            @@tags.each do |tag|
+                File.open(File.join(@@repo_path, "Modulefile"), "w") do |modulefile|
+                    modulefile.write <<-MODULEFILE
+                    name 'puppetlabs-apache'
+                    version '#{tag}'
+                    author 'puppetlabs'
+                    MODULEFILE
+                end
+                git "add ."
+                git "commit --message='Tagging #{tag}'"
+                git "tag #{tag}"
+            end
+        end
+
+        after :all do
+            rm_rf @@repo_path
+        end
+
+        let(:git) { Git.new(@@repo_path, cache_path) }
+        let(:cache_path) { Tempdir.create("git-cache") }
+
+        after do
+            git.clear_cache!
+        end
+
+        describe "#tags" do
+            it "lists the tags" do
+                @@tags.each { |tag| expect(git.tags).to include tag }
+            end
+        end
+
+        describe "#on_tag" do
+            it "yields to the block in a directory containing the tag" do
+                git.on_tag("1.0.0") do
+                    expect(File.read("Modulefile")).to include "version '1.0.0'"
+                end
+            end
+        end
+
+        describe "#read_file" do
+            it "returns the content of the specified file as it was at the specified tag" do
+                expect(git.read_file("Modulefile", "0.9.0")).to include "version '0.9.0'"
+            end
+        end
+
+        describe "#update_cache!" do
+            it "clones the git repository to the cache directory" do
+                git.update_cache!
+
+                expect(`git --git-dir #{cache_path}/.git remote -v`).to include @@repo_path
+            end
+
+            it "creates Git's .git/FETCH_HEAD file so that we know that the cache was recently created" do
+                git.update_cache!
+
+                expect(File.exist?(File.join(cache_path, ".git", "FETCH_HEAD"))).to be_true
+            end
+
+            it "copes with a missing .git/FETCH_HEAD file" do
+                fetch_file = File.join(cache_path, ".git", "FETCH_HEAD")
+                git.update_cache!
+                rm fetch_file
+
+                git.update_cache!
+
+                expect(File.exist? fetch_file).to be_true
+            end
+
+            it "doesn't update the cache if it was recently updated" do
+                git.update_cache!
+                new_head = Dir.chdir(@@repo_path) do
+                    touch "xxx"
+                    `git add xxx`
+                    `git commit --message='Added file'`
+                    `git rev-parse HEAD`
+                end
+
+                git.update_cache!
+
+                expect(`git --git-dir #{cache_path}/.git rev-parse HEAD`).not_to eq new_head
+            end
+
+            it "updates the cache if it's been long enough" do
+                git.update_cache!
+                git = Git.new(@@repo_path, cache_path, 0) # zero second cache TTL
+                new_head = Dir.chdir(@@repo_path) do
+                    touch "xxx"
+                    `git add xxx`
+                    `git commit --message='Added file'`
+                    `git rev-parse HEAD`
+                end
+
+                git.update_cache!
+
+                expect(`git --git-dir #{cache_path}/.git rev-parse HEAD`).to eq new_head
+            end
+        end
+
+        describe "#clear_cache!" do
+            it "deletes the cache directory" do
+                git.update_cache!
+                git.clear_cache!
+
+                expect(File.exist? cache_path).to be_false
+            end
+        end
+    end
+end

data/spec/util/patches_spec.rb

@@ -0,0 +1,86 @@
+# -*- encoding: utf-8 -*-
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe 'patches' do
+    describe Gem::Version do
+        describe "#new" do
+            context "when the version number contains a dash" do
+                it "replaces the dash with '.pre.'" do
+                    expect(Gem::Version.new("1.0.0-rc1")).to eq Gem::Version.new("1.0.0.pre.rc1")
+                end
+            end
+            context "when the version number has trailing garbage" do
+                it "uses the numbers at the beginning" do
+                    expect(Gem::Version.new("123 xyz")).to eq Gem::Version.new("123")
+                end
+            end
+            context "when the version is completely garbage" do
+                it "pretends the version number is zero" do
+                    expect(Gem::Version.new("xyz")).to eq Gem::Version.new("0")
+                end
+            end
+        end
+    end
+    describe Gem::Dependency do
+        describe "#new" do
+            context "when the version contains a dash" do
+                it "replaces the dash with '.pre.'" do
+                    expect(Gem::Dependency.new("x", "1.0.0-rc1")).to eq Gem::Dependency.new("x", "1.0.0.pre.rc1")
+                end
+            end
+            context "when the version number has trailing garbage" do
+                it "uses the numbers at the beginning" do
+                    [ "", "~>", "<", ">", ">=", "<=", "=" ].each do |operator|
+                        expect(Gem::Dependency.new("x", " #{operator} 123 xyz")).to eq Gem::Dependency.new("x", "#{operator} 123")
+                    end
+                end
+            end
+            context "when the version is completely garbage" do
+                it "pretends the version number is greater than or equal zero" do
+                    [ "", "<", ">", ">=", "<=", "=" ].each do |operator|
+                        expect(Gem::Dependency.new("x", " #{operator} xyz")).to eq Gem::Dependency.new("x", ">= 0")
+                    end
+                end
+            end
+        end
+    end
+
+    describe Array do
+        describe "#unique_by" do
+            it "behaves like #uniq with a block, but works with Ruby < 1.9" do
+                son = { "name" => "john", "age" => 10 }
+                dad = { "name" => "john", "age" => 40 }
+                mom = { "name" => "jane", "age" => 40 }
+
+                family = [son, dad, mom]
+                expect(family.unique_by {|p| p["name"]}).to eq [son, mom]
+            end
+        end
+
+        describe "#version_sort" do
+            it "sorts according to version numbers" do
+                expect(["2.0.0", "1.10.0", "1.2.0"].version_sort).to eq ["1.2.0", "1.10.0", "2.0.0"]
+            end
+
+            it "copes with odd versions" do
+                expect(["1.10.0-badprerelease", "1.3", "1.10.0", "xxx", "1.10.0.rc1", "1.2.0"].version_sort).to eq ["xxx", "1.2.0", "1.3", "1.10.0-badprerelease", "1.10.0.rc1", "1.10.0"]
+            end
+        end
+    end
+end

data/spec/util/temp_dir_spec.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+module PuppetLibrary::Util
+    describe TempDir do
+        describe "#use" do
+            it "creates a directory and changes to it for the life of the block" do
+                dir_path = nil
+                dir_existed_in_block = false
+                TempDir.use("xxx") do |path|
+                    dir_existed_in_block = File.directory? path
+                    dir_path = path
+                end
+                expect(dir_existed_in_block).to be_true
+                expect(File.exist? dir_path).to be_false
+            end
+        end
+    end
+end