librarian-ansible 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48ef9396b91aaa1b246bb8bbff0394c8cbdb7f6e
-  data.tar.gz: ab246ccc9577923cadd06afaaaa77956fced0365
+  metadata.gz: 72c8d1017901562889ad9a7037f3fc503cadf518
+  data.tar.gz: 640bcfe4416e2cc3ff0bab763c7da9fb72a73b05
 SHA512:
-  metadata.gz: 1e5a957983aef21392a361f12a4dacde0cfc3be09bc9e1530ae342ebfaef12d0009db8e50749361af295964605b3f2ba7247c1182ffabef7a82d3ccfc7395262
-  data.tar.gz: ca57fb28ad31e698286372e014f7ed324a7e53a8ea362af28bed868f8913c4dc447bac91a222d70169a4feec209d0bf7e5adcc1807059caa46ddc0cd6ad52eaa
+  metadata.gz: 5d799b4e7a4cae5deddd9379c70ee53c28b6e709d9c32d2f8d87816cbc5ed23e241afc013cbd8dcccbca1df842f7b9456eefc006dfcef146802aa9e6cbb73e41
+  data.tar.gz: 6970dac352e1426e85c1a516e0196486fbe6eb9a52a3742fceb6584912102c4dfb1d3c831383d8af619e3031c1feced49f20df4df37fe925fed4c04d730d14cd

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+script: rspec spec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,6 +1,9 @@
 Librarian-Ansible
 =================
 
+[![Code Climate](https://codeclimate.com/github/bcoe/librarian-ansible.png)](https://codeclimate.com/github/bcoe/librarian-ansible)
+[![Build Status](https://travis-ci.org/bcoe/librarian-ansible.png)](https://travis-ci.org/bcoe/librarian-ansible)
+
 Provides bundler-inspired functionality for Ansible roles:
 
 http://bundler.io/v1.3/rationale.html
@@ -104,9 +107,82 @@ And update your Ansiblefile accordingly:
 role "kunik.deploy-upstart-scripts", "1.0.0"
 ```
 
+### Configuration
+
+Configuration comes from three sources with the following highest-to-lowest
+precedence:
+
+* The local config (`./.librarian/ansible/config`)
+* The environment
+* The global config (`~/.librarian/ansible/config`)
+
+You can inspect the final configuration with:
+
+    $ librarian-ansible config
+
+You can find out where a particular key is set with:
+
+    $ librarian-ansible config KEY
+
+You can set a key at the global level with:
+
+    $ librarian-ansible config KEY VALUE --global
+
+And remove it with:
+
+    $ librarian-ansible config KEY --global --delete
+
+You can set a key at the local level with:
+
+    $ librarian-ansible config KEY VALUE --local
+
+And remove it with:
+
+    $ librarian-ansible config KEY --local --delete
+
+You cannot set or delete environment-level config keys with the CLI.
+
+Configuration set at either the global or local level will affect subsequent
+invocations of `librarian-ansible`. Configurations set at the environment level are
+not saved and will not affect subsequent invocations of `librarian-ansible`.
+
+You can pass a config at the environment level by taking the original config key
+and transforming it: replace hyphens (`-`) with underscores (`_`) and periods
+(`.`) with doubled underscores (`__`), uppercase, and finally prefix with
+`LIBRARIAN_ANSIBLE_`. For example, to pass a config in the environment for the key
+`part-one.part-two`, set the environment variable
+`LIBRARIAN_ANSIBLE_PART_ONE__PART_TWO`.
+
+Configuration affects how various commands operate.
+
+* The `path` config sets the roles directory to install to. If a relative
+  path, it is relative to the directory containing the `Ansiblefile`. The
+  equivalent environment variable is `LIBRARIAN_ANSIBLE_PATH`.
+
+* The `tmp` config sets the cache directory for librarian. If a relative
+  path, it is relative to the directory containing the `Ansiblefile`. The
+  equivalent environment variable is `LIBRARIAN_ANSIBLE_TMP`.
+
+* The `install.strip-dot-git` config causes the `.git/` directory to be stripped
+  out when installing roles from a git source. This must be set to exactly
+  "1" to cause this behavior. The equivalent environment variable is
+  `LIBRARIAN_ANSIBLE_INSTALL__STRIP_DOT_GIT`.
+
+Configuration can be set by passing specific options to other commands.
+
+* The `path` config can be set at the local level by passing the `--path` option
+  to the `install` command. It can be unset at the local level by passing the
+  `--no-path` option to the `install` command. Note that if this is set at the
+  environment or global level then, even if `--no-path` is given as an option,
+  the environment or global config will be used.
+
+* The `install.strip-dot-git` config can be set at the local level by passing
+  the `--strip-dot-git` option to the `install` command. It can be unset at the
+  local level by passing the `--no-strip-dot-git` option.
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/librarian-ansible/fork )
+1. Fork it ( http://github.com/bcoe/librarian-ansible/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/librarian/ansible/source/galaxy.rb

@@ -31,26 +31,40 @@ module Librarian
           private
 
           def github_url(uri)
-            username, name = uri.split(".")
+            package = nil
+            # because both name and username can contain dots, we have
+            # to check every combination until package will be found
+            segments = uri.split('.')
+            (0..segments.size - 2).each do |pivot|
+              username = segments[0..pivot].join('.')
+              name = segments[pivot + 1..-1].join('.')
+              package = lookup_package(username, name)
+            end
+            raise Error, "Could not find package: #{uri}" if package.nil?
+            "https://github.com/#{package['github_user']}/#{package['github_repo']}"
+          end
 
+          def lookup_package(username, name)
             conn = Faraday.new(:url => @@galaxy_api)
 
-            response = conn.get("#{@@galaxy_api}/roles/?name=#{name}&format=json")
-
-            if response.status != 200
-              raise Error, "Could not read package from galaxy API."
-            else
-              package = JSON.parse(response.body)['results'].find do |r|
-                r['summary_fields']['owner']['username'] == username &&
-                  r['name'] == name
+            url = "#{@@galaxy_api}/roles/?name=#{name}&format=json"
+            loop do
+              response = conn.get(url)
+              if response.status != 200
+                raise Error, 'Could not read package from galaxy API.'
+              else
+                json = JSON.parse(response.body)
+                package = json['results'].find do |r|
+                  r['summary_fields']['owner']['username'] == username &&
+                    r['name'] == name
+                end
+                return package if package
+                url = json['next']
+                break unless url
               end
             end
-
-            "https://github.com/#{package['github_user']}/#{package['github_repo']}"
           end
-
         end
-
       end
     end
   end

data/lib/librarian/ansible/version.rb

@@ -1,5 +1,5 @@
 module Librarian
   module Ansible
-    VERSION = "1.0.5"
+    VERSION = "1.0.6"
   end
 end

data/spec/functional/ansible/cli_spec.rb

@@ -0,0 +1,63 @@
+require_relative "../../support/spec_helper"
+require "librarian/ansible/cli"
+
+module Librarian
+  module Ansible
+    describe Cli do
+      include Librarian::RSpec::Support::CliMacro
+
+      describe "init" do
+        before do
+          cli! "init"
+        end
+
+        it "should create a file named Ansiblefile" do
+          pwd.should have_file "Ansiblefile"
+        end
+      end
+
+      describe "version" do
+        before do
+          cli! "version"
+        end
+
+        it "should print the version" do
+          stdout.should == strip_heredoc(<<-STDOUT)
+            librarian-#{Librarian::VERSION}
+            librarian-ansible-#{Librarian::Ansible::VERSION}
+          STDOUT
+        end
+      end
+
+      describe "install" do
+
+        context "a simple Ansiblefile with one role" do
+          let(:metadata) do
+            { "name" => "apt",
+              "version" => "1.0.0" }
+          end
+
+          before do
+            write_yaml_file! "role-sources/apt/meta/main.yml", metadata
+            write_file! "Ansiblefile", strip_heredoc(<<-ANSIBLEFILE)
+              role 'apt',
+                :path => 'role-sources/apt'
+            ANSIBLEFILE
+
+            cli! "install"
+          end
+
+          it "should write a lockfile" do
+            pwd.should have_file "Ansiblefile.lock"
+          end
+
+          it "should install the role" do
+            pwd.should have_yaml_file "librarian_roles/apt/meta/main.yml", metadata
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/integration/ansible/source/git_spec.rb

@@ -0,0 +1,363 @@
+require 'librarian'
+require 'librarian/helpers'
+require 'librarian/error'
+require 'librarian/action/resolve'
+require 'librarian/action/install'
+require 'librarian/action/update'
+require 'librarian/ansible'
+
+require 'support/project_path'
+
+module Librarian
+  module Ansible
+    module Source
+      describe Git do
+
+        let(:project_path) { ::Support::ProjectPath.project_path }
+        let(:tmp_path) { project_path.join("tmp/spec/integration/ansible/source/git") }
+        after { tmp_path.rmtree if tmp_path && tmp_path.exist? }
+
+        let(:roles_path) { tmp_path.join("librarian_roles") }
+
+        # depends on repo_path being defined in each context
+        let(:env) { Environment.new(:project_path => repo_path) }
+
+        context "a single dependency with a git source" do
+
+          let(:sample_path) { tmp_path.join("sample") }
+          let(:sample_metadata) do
+            { version: "0.6.5" }
+          end
+
+          let(:first_sample_path) { roles_path.join("first-sample") }
+          let(:first_sample_metadata) do
+            { version: "3.2.1" }
+          end
+
+          let(:second_sample_path) { roles_path.join("second-sample") }
+          let(:second_sample_metadata) do
+            { version: "4.3.2" }
+          end
+
+          before do
+            sample_path.rmtree if sample_path.exist?
+            sample_path.join('meta').mkpath
+            sample_path.join("meta/main.yml").open("wb") { |f| f.write(YAML.dump(sample_metadata)) }
+            Dir.chdir(sample_path) do
+              `git init`
+              `git config user.name "Simba"`
+              `git config user.email "simba@savannah-pride.gov"`
+              `git add meta/main.yml`
+              `git commit -m "Initial commit."`
+            end
+
+            roles_path.rmtree if roles_path.exist?
+            roles_path.mkpath
+            first_sample_path.join('meta').mkpath
+            first_sample_path.join("meta/main.yml").open("wb") { |f| f.write(YAML.dump(first_sample_metadata)) }
+            second_sample_path.join('meta').mkpath
+            second_sample_path.join("meta/main.yml").open("wb") { |f| f.write(YAML.dump(second_sample_metadata)) }
+            Dir.chdir(roles_path) do
+              `git init`
+              `git config user.name "Simba"`
+              `git config user.email "simba@savannah-pride.gov"`
+              `git add .`
+              `git commit -m "Initial commit."`
+            end
+          end
+
+          context "resolving" do
+            let(:repo_path) { tmp_path.join("repo/resolve") }
+            before do
+              repo_path.rmtree if repo_path.exist?
+              repo_path.mkpath
+              repo_path.join("librarian_roles").mkpath
+              ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+                #!/usr/bin/env ruby
+                role "sample", :git => #{sample_path.to_s.inspect}
+              ANSIBLEFILE
+              repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+            end
+
+            context "the resolve" do
+              it "should not raise an exception" do
+                expect { Action::Resolve.new(env).run }.to_not raise_error
+              end
+            end
+
+            context "the results" do
+              before { Action::Resolve.new(env).run }
+
+              it "should create the lockfile" do
+                repo_path.join("Ansiblefile.lock").should exist
+              end
+
+              it "should not attempt to install the sample cookbok" do
+                repo_path.join("librarian_roles/sample").should_not exist
+              end
+            end
+          end
+
+          context "installing" do
+            let(:repo_path) { tmp_path.join("repo/install") }
+            before do
+              repo_path.rmtree if repo_path.exist?
+              repo_path.mkpath
+              repo_path.join(roles_path).mkpath
+              ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+                #!/usr/bin/env ruby
+                role "sample", :git => #{sample_path.to_s.inspect}
+              ANSIBLEFILE
+              repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+
+              Action::Resolve.new(env).run
+            end
+
+            context "the install" do
+              it "should not raise an exception" do
+                expect { Action::Install.new(env).run }.to_not raise_error
+              end
+            end
+
+            context "the results" do
+              before { Action::Install.new(env).run }
+
+              it "should create the lockfile" do
+                repo_path.join("Ansiblefile.lock").should exist
+              end
+
+              it "should create the directory for the role" do
+                repo_path.join("librarian_roles/sample").should exist
+              end
+
+              it "should copy the role files into the role directory" do
+                repo_path.join("librarian_roles/sample/meta/main.yml").should exist
+              end
+            end
+          end
+
+          context "resolving and and separately installing" do
+            let(:repo_path) { tmp_path.join("repo/resolve-install") }
+            before do
+              repo_path.rmtree if repo_path.exist?
+              repo_path.mkpath
+              repo_path.join("librarian_roles").mkpath
+              ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+                #!/usr/bin/env ruby
+                role "sample", :git => #{sample_path.to_s.inspect}
+              ANSIBLEFILE
+              repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+
+              Action::Resolve.new(env).run
+              repo_path.join("tmp").rmtree if repo_path.join("tmp").exist?
+            end
+
+            context "the install" do
+              it "should not raise an exception" do
+                expect { Action::Install.new(env).run }.to_not raise_error
+              end
+            end
+
+            context "the results" do
+              before { Action::Install.new(env).run }
+
+              it "should create the directory for the role" do
+                repo_path.join("librarian_roles/sample").should exist
+              end
+
+              it "should copy the role files into the role directory" do
+                repo_path.join("librarian_roles/sample/meta/main.yml").should exist
+              end
+            end
+          end
+
+        end
+
+        context "with a path" do
+
+          let(:git_path) { tmp_path.join("big-git-repo") }
+          let(:sample_path) { git_path.join("buttercup") }
+          let(:sample_metadata) do
+            { version: "0.6.5" }
+          end
+
+          before do
+            git_path.rmtree if git_path.exist?
+            git_path.mkpath
+            sample_path.join('meta').mkpath
+            sample_path.join("meta/main.yml").open("wb") { |f| f.write(YAML.dump(sample_metadata)) }
+            Dir.chdir(git_path) do
+              `git init`
+              `git config user.name "Simba"`
+              `git config user.email "simba@savannah-pride.gov"`
+              `git add .`
+              `git commit -m "Initial commit."`
+            end
+          end
+
+          context "if no path option is given" do
+            let(:repo_path) { tmp_path.join("repo/resolve") }
+            before do
+              repo_path.rmtree if repo_path.exist?
+              repo_path.mkpath
+              repo_path.join("librarian_roles").mkpath
+              ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+                #!/usr/bin/env ruby
+                role "sample",
+                  :git => #{git_path.to_s.inspect}
+              ANSIBLEFILE
+              repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+            end
+
+            it "should not resolve" do
+              expect{ Action::Resolve.new(env).run }.to raise_error
+            end
+          end
+
+          context "if the path option is wrong" do
+            let(:repo_path) { tmp_path.join("repo/resolve") }
+            before do
+              repo_path.rmtree if repo_path.exist?
+              repo_path.mkpath
+              repo_path.join("librarian_roles").mkpath
+              ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+                #!/usr/bin/env ruby
+                role "sample",
+                  :git => #{git_path.to_s.inspect},
+                  :path => "jelly"
+              ANSIBLEFILE
+              repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+            end
+
+            it "should not resolve" do
+              expect{ Action::Resolve.new(env).run }.to raise_error
+            end
+          end
+
+          context "if the path option is right" do
+            let(:repo_path) { tmp_path.join("repo/resolve") }
+            before do
+              repo_path.rmtree if repo_path.exist?
+              repo_path.mkpath
+              repo_path.join("librarian_roles").mkpath
+              ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+                #!/usr/bin/env ruby
+                role "sample",
+                  :git => #{git_path.to_s.inspect},
+                  :path => "buttercup"
+              ANSIBLEFILE
+              repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+            end
+
+            context "the resolve" do
+              it "should not raise an exception" do
+                expect { Action::Resolve.new(env).run }.to_not raise_error
+              end
+            end
+
+            context "the results" do
+              before { Action::Resolve.new(env).run }
+
+              it "should create the lockfile" do
+                repo_path.join("Ansiblefile.lock").should exist
+              end
+            end
+          end
+
+        end
+
+        context "when upstream updates" do
+          let(:git_path) { tmp_path.join("upstream-updates-repo") }
+          let(:repo_path) { tmp_path.join("repo/resolve-with-upstream-updates") }
+
+          let(:sample_metadata) do
+            { version: "0.6.5" }
+          end
+
+          before do
+
+            # set up the git repo as normal, but let's also set up a release-stable branch
+            # from which our Ansiblefile will only pull stable releases
+            git_path.rmtree if git_path.exist?
+            git_path.join('meta').mkpath
+            git_path.join("meta/main.yml").open("wb") { |f| f.write(YAML.dump(sample_metadata)) }
+
+            Dir.chdir(git_path) do
+              `git init`
+              `git config user.name "Simba"`
+              `git config user.email "simba@savannah-pride.gov"`
+              `git add meta/main.yml`
+              `git commit -m "Initial Commit."`
+              `git checkout -b some-branch --quiet`
+              `echo 'hi' > some-file`
+              `git add some-file`
+              `git commit -m 'Some File.'`
+              `git checkout master --quiet`
+            end
+
+            # set up the ansible repo as normal, except the Ansiblefile points to the release-stable
+            # branch - we expect when the upstream copy of that branch is changed, then we can
+            # fetch & merge those changes when we update
+            repo_path.rmtree if repo_path.exist?
+            repo_path.mkpath
+            repo_path.join("librarian_roles").mkpath
+            ansiblefile = Helpers.strip_heredoc(<<-ANSIBLEFILE)
+              role "sample",
+                :git => #{git_path.to_s.inspect},
+                :ref => "some-branch"
+            ANSIBLEFILE
+            repo_path.join("Ansiblefile").open("wb") { |f| f.write(ansiblefile) }
+            Action::Resolve.new(env).run
+
+            # change the upstream copy of that branch: we expect to be able to pull the latest
+            # when we re-resolve
+            Dir.chdir(git_path) do
+              `git checkout some-branch --quiet`
+              `echo 'ho' > some-other-file`
+              `git add some-other-file`
+              `git commit -m 'Some Other File.'`
+              `git checkout master --quiet`
+            end
+          end
+
+          let(:metadata_file) { repo_path.join("librarian_roles/sample/meta/main.yml") }
+          let(:old_code_file) { repo_path.join("librarian_roles/sample/some-file") }
+          let(:new_code_file) { repo_path.join("librarian_roles/sample/some-other-file") }
+
+          context "when updating not a role from that source" do
+            before do
+              Action::Update.new(env).run
+            end
+
+            it "should pull the tip from upstream" do
+              Action::Install.new(env).run
+
+              metadata_file.should exist #sanity
+              old_code_file.should exist #sanity
+
+              new_code_file.should_not exist # the assertion
+            end
+          end
+
+          context "when updating a role from that source" do
+            before do
+              Action::Update.new(env, :names => %w(sample)).run
+            end
+
+            it "should pull the tip from upstream" do
+              pending('debug "should pull the tip from upstream"')
+
+              Action::Install.new(env).run
+
+              metadata_file.should exist #sanity
+              old_code_file.should exist #sanity
+
+              new_code_file.should exist # the assertion
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/support/project_path.rb

@@ -0,0 +1,27 @@
+module Support
+  module ProjectPath
+
+    project_path = Pathname.new(__FILE__).expand_path
+    project_path = project_path.dirname until project_path.join("Rakefile").exist?
+    project_path
+
+    PROJECT_PATH = project_path
+
+    def project_path
+      PROJECT_PATH
+    end
+
+    module ClassMethods
+      def project_path
+        PROJECT_PATH
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    extend self
+
+  end
+end

data/spec/support/spec_helper.rb

@@ -0,0 +1,28 @@
+require "librarian/rspec/support/cli_macro"
+
+class FileMatcher < Librarian::RSpec::Support::CliMacro::FileMatcher
+  def actual_content
+    @actual_content ||= begin
+      content = full_path.read
+      content = JSON.parse(content) if type == :json
+      content = YAML.load(content) if type == :yaml
+      content
+    end
+  end
+
+  def failure_message
+    if full_path.file?
+      "file content does not match"
+    else
+      "no file matches path #{rel_path}"
+    end
+  end
+end
+
+def write_yaml_file!(path, content)
+  write_file! path, YAML.dump(content)
+end
+
+def have_yaml_file(rel_path, content)
+  FileMatcher.new(rel_path, content, :type => :yaml)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librarian-ansible
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Benjamin Coe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librarian
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -99,6 +100,10 @@ files:
 - lib/librarian/ansible/templates/Ansiblefile
 - lib/librarian/ansible/version.rb
 - librarian-ansible.gemspec
+- spec/functional/ansible/cli_spec.rb
+- spec/integration/ansible/source/git_spec.rb
+- spec/support/project_path.rb
+- spec/support/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -123,4 +128,8 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Bundler for your Ansible roles.
-test_files: []
+test_files:
+- spec/functional/ansible/cli_spec.rb
+- spec/integration/ansible/source/git_spec.rb
+- spec/support/project_path.rb
+- spec/support/spec_helper.rb