puppet-library 0.10.0 → 0.11.0

data/spec/forge/git_repository_spec.rb

@@ -18,16 +18,17 @@ require 'spec_helper'
 
 module PuppetLibrary::Forge
     describe GitRepository do
-        @@repo_path = Tempdir.create("git-repo")
-        @@versions = [ "0.9.0", "1.0.0-rc1", "1.0.0" ]
-        @@tags = @@versions + [ "xxx" ]
+        @@repo_dir = Tempdir.new("git-repo")
+        @@versions = [ "0.1.0", "0.9.0", "1.0.0-rc1", "1.0.0" ]
+        @@tags = @@versions.map {|version| "v#{version}"} + [ "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}\""
+                git_command = "git --git-dir=#{@@repo_dir.path}/.git --work-tree=#{@@repo_dir.path} #{command}"
+                pid, stdin, stdout, stderr = Open4.popen4(git_command)
+                ignored, status = Process::waitpid2 pid
+                unless status.success?
+                    raise "Error running Git command: #{git_command}\n#{stdout.read}\n#{stderr.read}"
                 end
             end
 
@@ -35,26 +36,66 @@ module PuppetLibrary::Forge
             git "config user.name tester"
             git "config user.email tester@example.com"
             @@versions.zip(@@tags).each do |(version, tag)|
-                File.open(File.join(@@repo_path, "Modulefile"), "w") do |modulefile|
+                # Add some changes for the version
+                change_file_path = File.join(@@repo_dir.path, "changes.txt")
+                File.open(change_file_path, "a") do |change_file|
+                    change_file.puts "Version #{version}"
+                end
+
+                # Update the module file
+                modulefile_path = File.join(@@repo_dir.path, "Modulefile")
+                File.open(modulefile_path, "w") do |modulefile|
                     modulefile.write <<-MODULEFILE
                     name 'puppetlabs-apache'
                     version '#{version}'
                     author 'puppetlabs'
                     MODULEFILE
                 end
+
+                # A dodgy early version with no modulefile
+                File.delete modulefile_path if version == "0.1.0"
                 git "add ."
                 git "commit --message='Version #{version}'"
                 git "tag #{tag}"
             end
         end
 
-        after :all do
-            rm_rf @@repo_path
+        let :forge do
+            cache_dir = Tempdir.new("git-repo-cache")
+            git = PuppetLibrary::Util::Git.new(@@repo_dir.path, cache_dir)
+            GitRepository.new(git, /[0-9.]+/)
+        end
+
+        describe "#configure" do
+            it "exposes a configuration API" do
+                forge = GitRepository.configure do
+                    source @@repo_dir.path
+                    include_tags /v123/
+                end
+                expect(forge.instance_eval "@version_tag_regex").to eq /v123/
+            end
+        end
+
+        describe "#prime" do
+            it "creates the repo cache" do
+                git = double('git')
+                forge = GitRepository.new(git, //)
+
+                expect(git).to receive(:update_cache!)
+
+                forge.prime
+            end
         end
 
-        let(:forge) { GitRepository.new(@@repo_path, /[0-9.]+/) }
-        after do
-            forge.destroy!
+        describe "#clear_cache" do
+            it "deletes the repo cache" do
+                git = double('git')
+                forge = GitRepository.new(git, //)
+
+                expect(git).to receive(:clear_cache!)
+
+                forge.clear_cache
+            end
         end
 
         describe "#get_module" do
@@ -123,6 +164,12 @@ module PuppetLibrary::Forge
                 expect(metadata.first["name"]).to eq "puppetlabs-apache"
                 expect(metadata.first["version"]).to eq "0.9.0"
             end
+
+            it "doesn't include versions with no Modulefile" do
+                metadata = forge.get_all_metadata
+                dodgy_version = metadata.find {|m| m["version"] == "0.1.0" }
+                expect(dodgy_version).to be_nil
+            end
         end
     end
 end

data/spec/forge/multi_spec.rb

@@ -38,6 +38,22 @@ module PuppetLibrary::Forge
             return forge
         end
 
+        describe "#prime" do
+            it "primes the subforges" do
+                expect(subforge_one).to receive(:prime)
+                expect(subforge_two).to receive(:prime)
+                multi_forge.prime
+            end
+        end
+
+        describe "#clear_cache" do
+            it "clears the subforges' caches" do
+                expect(subforge_one).to receive(:clear_cache)
+                expect(subforge_two).to receive(:clear_cache)
+                multi_forge.clear_cache
+            end
+        end
+
         describe "#search_modules" do
             context "when no modules match in any subforge" do
                 it "returns an empty array" do

data/spec/forge/proxy_spec.rb

@@ -24,6 +24,24 @@ module PuppetLibrary::Forge
         let(:download_cache) { PuppetLibrary::Http::Cache::InMemory.new }
         let(:forge) { Proxy.new("http://puppetforge.example.com", query_cache, download_cache, http_client) }
 
+        describe "#configure" do
+            it "exposes a configuration API" do
+                forge = Proxy.configure do
+                    url "http://example.com"
+                end
+                expect(forge.instance_eval "@url").to eq "http://example.com"
+            end
+        end
+
+        describe "#clear_cache" do
+            it "clears the caches" do
+                expect(query_cache).to receive(:clear)
+                expect(download_cache).to receive(:clear)
+
+                forge.clear_cache
+            end
+        end
+
         describe "#search_modules" do
             it "forwards the request directly" do
                 search_results = '["a","b","c"]'

data/spec/forge/source_spec.rb

@@ -18,8 +18,8 @@ require 'spec_helper'
 
 module PuppetLibrary::Forge
     describe Source do
-        let(:module_dir) { Tempdir.create("module_dir") }
-        let(:modulefile_path) { File.join(module_dir, "Modulefile") }
+        let(:module_dir) { Tempdir.new("module_dir") }
+        let(:modulefile_path) { File.join(module_dir.path, "Modulefile") }
         let(:forge) { Source.new(module_dir) }
 
         before do
@@ -28,10 +28,6 @@ module PuppetLibrary::Forge
             add_module_dependency! "puppetlabs", "concat", ">= 1.0.1"
         end
 
-        after do
-            rm_rf module_dir
-        end
-
         def set_module!(author, name, version)
             File.open(modulefile_path, "w") do |modulefile|
                 modulefile.puts <<-EOF
@@ -51,10 +47,19 @@ module PuppetLibrary::Forge
             end
         end
 
+        describe "#configure" do
+            it "exposes a configuration API" do
+                forge = Source.configure do
+                    path module_dir.path
+                end
+                expect(forge.instance_eval "@module_dir.path").to eq module_dir.path
+            end
+        end
+
         describe "#initialize" do
             context "when the module directory doesn't exist" do
                 before do
-                    rm_rf module_dir
+                    rm_rf module_dir.path
                 end
 
                 it "raises an error" do
@@ -66,11 +71,11 @@ module PuppetLibrary::Forge
 
             context "when the module directory isn't readable" do
                 before do
-                    chmod 0400, module_dir
+                    chmod 0400, module_dir.path
                 end
 
                 after do
-                    chmod 0777, module_dir
+                    chmod 0777, module_dir.path
                 end
 
                 it "raises an error" do

data/spec/http/cache/disk_spec.rb

@@ -19,13 +19,9 @@ require 'spec_helper'
 
 module PuppetLibrary::Http::Cache
     describe Disk do
-        let(:cache_dir) { Tempdir.new("modulecache").path }
+        let(:cache_dir) { Tempdir.new("modulecache") }
         let(:cache) { Disk.new(cache_dir) }
 
-        after do
-            rm_rf cache_dir
-        end
-
         describe "#get" do
             context "the first time it's called" do
                 it "returns the value from the block" do
@@ -41,7 +37,7 @@ module PuppetLibrary::Http::Cache
 
                     result = cache.get("dir/my-file") { buffer }
 
-                    path = File.join(cache_dir, "dir", "my-file")
+                    path = File.join(cache_dir.path, "dir", "my-file")
                     expect(File.read(path)).to eq "hello"
                 end
             end
@@ -53,5 +49,14 @@ module PuppetLibrary::Http::Cache
                 end
             end
         end
+
+        describe "#clear" do
+            it "clears the cache" do
+                cache.get("dir/my-file") { StringIO.new "1" }
+                cache.clear
+                result = cache.get("dir/my-file") { StringIO.new "2" }
+                expect(result.read).to eq "2"
+            end
+        end
     end
 end

data/spec/http/cache/in_memory_spec.rb

@@ -59,5 +59,17 @@ module PuppetLibrary::Http::Cache
                 end
             end
         end
+
+        describe "#clear" do
+            it "clears the cache" do
+                cache.get { 1 }
+                result = cache.get { 2 }
+                expect(result).to eq 1
+
+                cache.clear
+                result = cache.get { 3 }
+                expect(result).to eq 3
+            end
+        end
     end
 end

data/spec/http/cache/noop_spec.rb

@@ -28,5 +28,11 @@ module PuppetLibrary::Http::Cache
                 expect(name).to eq "james"
             end
         end
+
+        describe "#clear" do
+            it "does nothing" do
+                cache.clear
+            end
+        end
     end
 end

data/spec/integration_test_helper.rb

@@ -17,18 +17,18 @@
 
 RSpec::Matchers.define :be_cached do
     match do |mod_file|
-        ! Dir[File.join(cache_dir, mod_file)].empty?
+        ! Dir[File.join(cache_dir.path, mod_file)].empty?
     end
 end
 
 RSpec::Matchers.define :be_installed do
     match do |mod_name|
-        File.directory?(File.join(project_dir, "modules",  mod_name))
+        File.directory?(File.join(project_dir.path, "modules",  mod_name))
     end
 end
 
 def write_puppetfile(content)
-    File.open("#{project_dir}/Puppetfile", "w") do |puppetfile|
+    File.open("#{project_dir.path}/Puppetfile", "w") do |puppetfile|
         puppetfile.puts content
     end
 end

data/spec/module_spec_helper.rb

@@ -59,12 +59,12 @@ module ModuleSpecHelper
     end
 
     def add_module(author, name, version, &block)
-        writer = ModuleWriter.new(module_dir)
+        writer = ModuleWriter.new(module_dir.path)
         writer.write_module(author, name, version, &block)
     end
 
     def add_file(file, content)
-        File.open(File.join(module_dir, file), "w") do |f|
+        File.open(File.join(module_dir.path, file), "w") do |f|
             f.write content
         end
     end

data/spec/puppet_library_spec.rb

@@ -19,12 +19,12 @@ require 'spec_helper'
 
 module PuppetLibrary
     describe PuppetLibrary do
-        let(:forge) do
+        let :forge do
             forge = double(Forge::Multi).as_null_object
             allow(Forge::Multi).to receive(:new).and_return(forge)
             return forge
         end
-        let(:server) do
+        let :server do
             server = double(Server)
             allow(Server).to receive(:new).with(forge).and_return(server)
             return server
@@ -108,18 +108,19 @@ module PuppetLibrary
 
             context "when using --config-file option" do
                 it "uses config values from config file as config defaults" do
+                    forge_dir = Tempdir.new("forge")
                     config = {
                         "port" => 4567,
                         "daemonize" => true,
                         "server" => "thin",
                         "pidfile" => "/var/run/puppet-library.pid",
                         "forges" => [
-                            { "Directory" => "/var/lib/modules" },
+                            { "Directory" => forge_dir.path },
                             { "Proxy" => "http://forge.puppetlabs.com" }
                         ]
                     }
                     File.open(config_file.path, "w") { |f| f << config.to_yaml }
-                    expect(Forge::Directory).to receive(:new).with("/var/lib/modules")
+                    expect(Forge::Directory).to receive(:new)
                     expect(Forge::Proxy).to receive(:new).with("http://forge.puppetlabs.com")
                     expect(forge).to receive(:add_forge).twice
                     expect(Rack::Server).to receive(:start).with(default_options_with(:Port => 4567, :daemonize => true, :pid => "/var/run/puppet-library.pid", :server => "thin"))
@@ -129,6 +130,8 @@ module PuppetLibrary
             end
 
             context "when using --proxy option" do
+                let(:proxy) { double('proxy').as_null_object }
+
                 it "adds a proxy module forge for each option specified" do
                     proxy1 = double('proxy1')
                     proxy2 = double('proxy2')
@@ -143,7 +146,7 @@ module PuppetLibrary
 
                 context "when no protocol is specified" do
                     it "defaults to HTTP" do
-                        expect(Forge::Proxy).to receive(:new).with("http://forge.example.com")
+                        expect(Forge::Proxy).to receive(:new).with("http://forge.example.com").and_return proxy
 
                         library.go(["--proxy", "forge.example.com"])
                     end
@@ -151,7 +154,7 @@ module PuppetLibrary
 
                 context "when the URL contains a trailing slash" do
                     it "removes the slash" do
-                        expect(Forge::Proxy).to receive(:new).with("http://forge.example.com")
+                        expect(Forge::Proxy).to receive(:new).with("http://forge.example.com").and_return proxy
 
                         library.go(["--proxy", "http://forge.example.com/"])
                     end
@@ -159,28 +162,42 @@ module PuppetLibrary
             end
 
             context "when using --cache-basedir option" do
+                let(:proxy) { double('proxy').as_null_object }
+                let(:cache_basedir) { Tempdir.new("cache") }
+                let(:cache_dir) { double(Dir) }
+
+                before do
+                    expect(Dir).to receive(:new).with("#{cache_basedir.path}/forge1.example.com").and_return(cache_dir)
+                end
+
                 it "uses the specified directory to hold cache directories for all proxies" do
-                    proxy1 = double('proxy')
-                    expect(Forge::Cache).to receive(:new).with("http://forge1.example.com", "/var/modules/forge1.example.com").and_return(proxy1)
-                    expect(forge).to receive(:add_forge).with(proxy1)
+                    expect(Forge::Cache).to receive(:new).with("http://forge1.example.com", cache_dir).and_return(proxy)
+                    expect(forge).to receive(:add_forge).with(proxy)
                     expect(Rack::Server).to receive(:start).with(default_options)
 
-                    library.go(["--proxy", "http://forge1.example.com", "--cache-basedir", "/var/modules"])
+                    library.go(["--proxy", "http://forge1.example.com", "--cache-basedir", cache_basedir.path])
                 end
 
                 it "expands the path specified" do
-                    expect(Forge::Cache).to receive(:new).with("http://forge1.example.com", "/var/modules/forge1.example.com")
+                    expect(Forge::Cache).to receive(:new).with("http://forge1.example.com", cache_dir).and_return(proxy)
 
-                    library.go(["--proxy", "http://forge1.example.com", "--cache-basedir", "/var/../var/modules"])
+                    library.go(["--proxy", "http://forge1.example.com", "--cache-basedir", "#{cache_basedir.path}/xxx/.."])
                 end
             end
 
+            def dir(path)
+                dir = double(Dir)
+                allow(Dir).to receive(:new).with(/.*#{path}$/).and_return dir
+                dir
+            end
+
             context "when using --module-dir option" do
                 it "adds a directory forge to the server for each module directory" do
                     directory_forge_1 = double("directory_forge_1")
                     directory_forge_2 = double("directory_forge_2")
-                    expect(Forge::Directory).to receive(:new).with("dir1").and_return(directory_forge_1)
-                    expect(Forge::Directory).to receive(:new).with("dir2").and_return(directory_forge_2)
+                    dir1, dir2 = dir("dir1"), dir("dir2")
+                    expect(Forge::Directory).to receive(:new).with(dir1).and_return(directory_forge_1)
+                    expect(Forge::Directory).to receive(:new).with(dir2).and_return(directory_forge_2)
                     expect(forge).to receive(:add_forge).with(directory_forge_1)
                     expect(forge).to receive(:add_forge).with(directory_forge_2)
                     expect(Rack::Server).to receive(:start).with(default_options)
@@ -193,8 +210,9 @@ module PuppetLibrary
                 it "adds a source forge to the server for each source directory" do
                     source_forge_1 = double("source_forge_1")
                     source_forge_2 = double("source_forge_2")
-                    expect(Forge::Source).to receive(:new).with("dir1").and_return(source_forge_1)
-                    expect(Forge::Source).to receive(:new).with("dir2").and_return(source_forge_2)
+                    dir1, dir2 = dir("dir1"), dir("dir2")
+                    expect(Forge::Source).to receive(:new).with(dir1).and_return(source_forge_1)
+                    expect(Forge::Source).to receive(:new).with(dir2).and_return(source_forge_2)
                     expect(forge).to receive(:add_forge).with(source_forge_1)
                     expect(forge).to receive(:add_forge).with(source_forge_2)
                     expect(Rack::Server).to receive(:start).with(default_options)

data/spec/puppet_module/modulefile_spec.rb

@@ -18,10 +18,10 @@ require 'spec_helper'
 
 module PuppetLibrary::PuppetModule
     describe Modulefile do
-        let(:modulefile) { Tempfile.new("Modulefile") }
+        let(:module_file) { Tempfile.new("Modulefile") }
 
         def write_modulefile(content)
-            File.open(modulefile.path, "w") do |f|
+            File.open(module_file.path, "w") do |f|
                 f.write content
             end
         end
@@ -42,12 +42,8 @@ module PuppetLibrary::PuppetModule
             EOF
         end
 
-        after do
-            modulefile.unlink
-        end
-
         describe "#read" do
-            let(:metadata) { Modulefile.read(modulefile.path) }
+            let(:metadata) { Modulefile.read(module_file.path) }
 
             it "parses the name" do
                 expect(metadata.get_name).to eq "joe-ficticious"
@@ -81,7 +77,6 @@ module PuppetLibrary::PuppetModule
                 expect(metadata.get_license).to eq "Apache 2.0"
             end
 
-
             it "parses the dependencies" do
                 expect(metadata.get_dependencies).to eq [
                     { "name" => "example/standard", "version_requirement" => '>= 2.3.4' },
@@ -97,7 +92,7 @@ module PuppetLibrary::PuppetModule
                         rating '10'
                     EOF
                     expect(Modulefile).to receive(:log).with(/rating/)
-                    Modulefile.read(modulefile.path)
+                    Modulefile.read(module_file.path)
                 end
             end
         end
@@ -107,6 +102,50 @@ module PuppetLibrary::PuppetModule
                 metadata = Modulefile.parse("version '1.0.0'")
                 expect(metadata.get_version).to eq "1.0.0"
             end
+
+            context "when a a value is missing" do
+                it "defaults to an empty string" do
+                    modulefile = Modulefile.parse <<-EOF
+                        name 'joe-ficticious'
+                        version '1.2.3'
+                    EOF
+                    expect(modulefile.get_description).to eq ""
+                end
+            end
+        end
+
+        describe "#to_metadata" do
+            let :modulefile do
+                Modulefile.parse <<-EOF
+                    name 'joe-ficticious'
+                    version '1.2.3'
+                    source 'git://example.com/joe/puppet-ficticious.git'
+                    author 'joe'
+                    license 'Apache 2.0'
+                    summary 'Example module'
+                    description 'Module for use in a test'
+                    project_page 'https://example.com/joe/puppet-apache'
+
+                    dependency 'example/standard', '>= 2.3.4'
+                    dependency 'example/other', '>= 5.6.7'
+                EOF
+            end
+
+            it "converts the modulefile into a metadata hash" do
+                metadata = modulefile.to_metadata
+                expect(metadata["name"]).to eq "joe-ficticious"
+                expect(metadata["version"]).to eq "1.2.3"
+                expect(metadata["source"]).to eq "git://example.com/joe/puppet-ficticious.git"
+                expect(metadata["author"]).to eq "joe"
+                expect(metadata["license"]).to eq "Apache 2.0"
+                expect(metadata["summary"]).to eq "Example module"
+                expect(metadata["description"]).to eq "Module for use in a test"
+                expect(metadata["project_page"]).to eq "https://example.com/joe/puppet-apache"
+                expect(metadata["dependencies"]).to eq [
+                    { "name" => 'example/standard', "version_requirement" => ">= 2.3.4" },
+                    { "name" => 'example/other', "version_requirement" => ">= 5.6.7" }
+                ]
+            end
         end
     end
 end