puppet-library 0.8.0 → 0.9.0

data/spec/archive/archive_reader_spec.rb

@@ -0,0 +1,64 @@
+# 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::Archive
+    describe ArchiveReader do
+        let :reader do
+            ArchiveReader.new(archive)
+        end
+
+        let :archive do
+            dir = Tempdir.create("zipping")
+            archive = File.join(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" }
+            end
+            archive
+        end
+
+        def write_tar_gzip!(file_name)
+            tar = StringIO.new
+
+            Gem::Package::TarWriter.new(tar) do |writer|
+                yield(writer)
+            end
+            tar.seek(0)
+
+            gz = Zlib::GzipWriter.new(File.new(file_name, 'wb'))
+            gz.write(tar.read)
+            tar.close
+            gz.close
+        end
+
+        describe "#read_entry" do
+            it "reads the first entry matched by the regex" do
+                arrival_task = reader.read_entry /arrive/
+                expect(arrival_task).to eq "say hello"
+            end
+
+            context "when the entry isn't found" do
+                it "raises an error" do
+                    expect {
+                        reader.read_entry /xxx/
+                    }.to raise_error /Couldn't find entry/
+                end
+            end
+        end
+    end
+end

data/spec/archive/archiver_spec.rb

@@ -0,0 +1,66 @@
+# 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::Archive
+    describe Archiver do
+        describe "#archive_dir" do
+            let(:dir) { Tempdir.create("tozip") }
+
+            def write_file!(filename, content)
+                path = File.join(dir, filename)
+                FileUtils.mkdir_p(File.dirname(path))
+                File.open(path, "w") do |file|
+                    file.write content
+                end
+            end
+
+            before do
+                write_file! "arrive.txt", "say hello"
+                write_file! "later/depart.txt", "say bye"
+            end
+
+            it "tars and gzips a directory and its contents" do
+                buffer = Archiver.archive_dir(dir, "todo")
+
+                expect(buffer).to be_tgz_with "todo/arrive.txt", "say hello"
+                expect(buffer).to be_tgz_with "todo/later/depart.txt", "say bye"
+            end
+
+            it "allows you to inject files from a block" do
+                buffer = Archiver.archive_dir(dir, "todo") do |archive|
+                    archive.add_file("later/return.txt", 0644) do |entry|
+                       entry.write "say hi again"
+                    end
+                end
+
+                expect(buffer).to be_tgz_with "todo/later/return.txt", "say hi again"
+            end
+
+            it "fixes leading slash for adding files" do
+                buffer = Archiver.archive_dir(dir, "todo") do |archive|
+                    archive.add_file("/later/return.txt", 0644) do |entry|
+                       entry.write "say hi again"
+                    end
+                end
+
+                expect(buffer).to be_tgz_with "todo/later/return.txt", "say hi again"
+            end
+        end
+    end
+end
+

data/spec/forge/source_spec.rb

@@ -0,0 +1,133 @@
+# 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::Forge
+    describe Source do
+        let(:module_dir) { Tempdir.create("module_dir") }
+        let(:modulefile_path) { File.join(module_dir, "Modulefile") }
+        let(:forge) { Source.new(module_dir) }
+
+        before do
+            set_module! "puppetlabs", "apache", "1.0.0"
+            add_module_dependency! "puppetlabs", "stdlib", ">= 2.4.0"
+            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
+                name '#{author}-#{name}'
+                version '#{version}'
+                author '#{author}'
+                description '#{author} #{name} module, version #{version}'
+                EOF
+            end
+        end
+
+        def add_module_dependency!(author, name, spec)
+            File.open(modulefile_path, "a") do |modulefile|
+                modulefile.puts <<-EOF
+                dependency "#{author}/#{name}", "#{spec}"
+                EOF
+            end
+        end
+
+        describe "#initialize" do
+            context "when the module directory doesn't exist" do
+                before do
+                    rm_rf module_dir
+                end
+
+                it "raises an error" do
+                    expect {
+                        Source.new(module_dir)
+                    }.to raise_error /Module directory .* doesn't exist/
+                end
+            end
+
+            context "when the module directory isn't readable" do
+                before do
+                    chmod 0400, module_dir
+                end
+
+                it "raises an error" do
+                    expect {
+                        Source.new(module_dir)
+                    }.to raise_error /Module directory .* isn't readable/
+                end
+            end
+        end
+
+        describe "#get_module" do
+            context "when the requested module doesn't match the source module" do
+                it "returns nil" do
+                    expect(forge.get_module("puppetlabs", "apache", "0.9.0")).to be_nil
+                    expect(forge.get_module("puppetlabs", "stdlib", "1.0.0")).to be_nil
+                end
+            end
+
+            context "when the source module is requested" do
+                it "returns a buffer of the packaged module" do
+                    buffer = forge.get_module("puppetlabs", "apache", "1.0.0")
+
+                    expect(buffer).to be_tgz_with(/Modulefile/, /puppetlabs-apache/)
+                end
+
+                it "generates a metadata file in the packaged application" do
+                    buffer = forge.get_module("puppetlabs", "apache", "1.0.0")
+
+                    expect(buffer).to be_tgz_with(/metadata.json/, /puppetlabs-apache/)
+                end
+            end
+        end
+
+        describe "#get_metadata" do
+            context "when the requested module doesn't match the source module" do
+                it "returns an empty list" do
+                    expect(forge.get_metadata("puppetlabs", "somethingelse")).to be_empty
+                end
+            end
+
+            context "when the requested module is the source module" do
+                it "returns an empty list" do
+                    metadata = forge.get_metadata("puppetlabs", "apache").first
+
+                    expect(metadata["name"]).to eq "puppetlabs-apache"
+                    expect(metadata["version"]).to eq "1.0.0"
+                    expect(metadata["author"]).to eq "puppetlabs"
+                    expect(metadata["description"]).to eq "puppetlabs apache module, version 1.0.0"
+                    expect(metadata["dependencies"]).to eq [
+                        { "name" => "puppetlabs/stdlib", "version_requirement" => ">= 2.4.0" },
+                        { "name" => "puppetlabs/concat", "version_requirement" => ">= 1.0.1" }
+                    ]
+                end
+            end
+        end
+
+        describe "#get_all_metadata" do
+            it "calls #get_metadata with the appropriate author and name" do
+                expect(forge).to receive(:get_metadata).with("puppetlabs", "apache").and_return("metadata")
+                expect(forge.get_all_metadata).to eq "metadata"
+            end
+        end
+    end
+end

data/spec/module_spec_helper.rb

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

data/spec/puppet_library_spec.rb

@@ -189,6 +189,20 @@ module PuppetLibrary
                 end
             end
 
+            context "when using --source-dir option" do
+                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)
+                    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)
+
+                    library.go(["--source-dir", "dir1", "--source-dir", "dir2"])
+                end
+            end
+
             context "when no proxy URLs or module directories specified" do
                 it "proxies the Puppet Forge" do
                     proxy = double("proxy")

data/spec/puppet_module/modulefile_spec.rb

@@ -0,0 +1,106 @@
+# 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::PuppetModule
+    describe Modulefile do
+        let(:modulefile) { Tempfile.new("Modulefile") }
+
+        def write_modulefile(content)
+            File.open(modulefile.path, "w") do |f|
+                f.write content
+            end
+        end
+
+        before do
+            write_modulefile <<-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
+
+        after do
+            modulefile.unlink
+        end
+
+        describe "#read" do
+            let(:metadata) { Modulefile.read(modulefile.path) }
+
+            it "parses the name" do
+                expect(metadata.get_name).to eq "joe-ficticious"
+            end
+
+            it "parses the version" do
+                expect(metadata.get_version).to eq "1.2.3"
+            end
+
+            it "parses the author" do
+                expect(metadata.get_author).to eq "joe"
+            end
+
+            it "parses the source URL" do
+                expect(metadata.get_source).to eq "git://example.com/joe/puppet-ficticious.git"
+            end
+
+            it "parses the summary" do
+                expect(metadata.get_summary).to eq "Example module"
+            end
+
+            it "parses the description" do
+                expect(metadata.get_description).to eq "Module for use in a test"
+            end
+
+            it "parses the project URL" do
+                expect(metadata.get_project_page).to eq "https://example.com/joe/puppet-apache"
+            end
+
+            it "parses the license name" do
+                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' },
+                    { "name" => "example/other", "version_requirement" => '>= 5.6.7' }
+                ]
+            end
+
+            context "when a bad value is configured" do
+                it "logs the bad config, but doesn't blow up" do
+                    write_modulefile <<-EOF
+                        name 'joe-ficticious'
+                        version '1.2.3'
+                        rating '10'
+                    EOF
+                    expect(Modulefile).to receive(:log).with(/rating/)
+                    Modulefile.read(modulefile.path)
+                end
+            end
+        end
+    end
+end
+

data/spec/spec_helper.rb

@@ -39,3 +39,35 @@ class Tempdir
         FileUtils.mkdir @path
     end
 end
+
+class Tgz
+    def initialize(buffer)
+        @buffer = buffer
+    end
+
+    def read(entry_name)
+        @buffer.rewind
+        tar = Gem::Package::TarReader.new(Zlib::GzipReader.wrap(@buffer))
+        tar.rewind
+        entry = tar.find do |e|
+            if Regexp === entry_name
+                e.full_name =~ entry_name
+            else
+                e.full_name == entry_name
+            end
+        end
+        raise "No entry matching #{entry_name} found" if entry.nil?
+        entry.read
+    end
+end
+
+RSpec::Matchers.define :be_tgz_with do |expected_file_name, expected_content|
+    match do |buffer|
+        file_content = Tgz.new(buffer).read expected_file_name
+        if Regexp === expected_content
+            file_content =~ expected_content
+        else
+            file_content == expected_content
+        end
+    end
+end

data/test/librarian_puppet_integration_test.rb

@@ -93,13 +93,13 @@ module PuppetLibrary
                 mod 'puppetlabs/apache'
             EOF
 
-            # Install modules through the proxy
+            # Install modules
             system "librarian-puppet install" or fail "call to puppet-library failed"
             expect("apache").to be_installed
             expect("concat").to be_installed
             expect("stdlib").to be_installed
 
-            # Search through the proxy
+            # Search
             search_results = JSON.parse(open("http://localhost:9004/modules.json").read)
             found_modules = Hash[search_results.map do |result|
                 [ result["full_name"], result["version"] ]
@@ -110,6 +110,79 @@ module PuppetLibrary
         end
     end
 
+    describe "source forge" do
+        include ModuleSpecHelper
+
+        let(:module_dir) { Tempdir.create("module_dir") }
+        let(:project_dir) { Tempdir.create("project_dir") }
+        let(:start_dir) { pwd }
+        let(:source_forge) { Forge::Source.new(module_dir) }
+        let(:source_server) do
+            Server.set_up do |server|
+                server.forge source_forge
+            end
+        end
+        let(:source_rack_server) do
+            Rack::Server.new(
+                :app => source_server,
+                :Host => "localhost",
+                :Port => 9005,
+                :server => "webrick"
+            )
+        end
+        let(:source_server_runner) do
+            Thread.new do
+                source_rack_server.start
+            end
+        end
+
+        before do
+            # Initialize to catch wiring errors
+            source_rack_server
+
+            # Start the servers
+            source_server_runner
+            start_dir
+            cd project_dir
+        end
+
+        after do
+            rm_rf module_dir
+            rm_rf project_dir
+            cd start_dir
+        end
+
+        it "queries, downloads and searches from a directory" do
+            add_file "Modulefile", <<-EOF
+            name 'puppetlabs-ficticious'
+            version '0.2.0'
+            author 'puppetlabs'
+            description 'Fake module'
+            EOF
+
+            write_puppetfile <<-EOF
+                forge 'http://localhost:9005'
+                mod 'puppetlabs/ficticious'
+            EOF
+
+            # Install modules
+            system "librarian-puppet install" or fail "call to puppet-library failed"
+            expect("ficticious").to be_installed
+
+            # Search
+            search_results = JSON.parse(open("http://localhost:9005/modules.json").read)
+            found_modules = Hash[search_results.map do |result|
+                [ result["full_name"], result["version"] ]
+            end]
+            expect(found_modules["puppetlabs/ficticious"]).to eq "0.2.0"
+
+            # Download
+            archive = open("http://localhost:9005/modules/puppetlabs-ficticious-0.2.0.tar.gz")
+            expect(archive).to be_tgz_with /Modulefile/, /puppetlabs-ficticious/
+            expect(archive).to be_tgz_with /metadata.json/, /puppetlabs-ficticious/
+        end
+    end
+
     describe "offline proxy", :no_1_8 => true do
         include ModuleSpecHelper