librarian-ansible 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e183c081e6dbd0eb76ad8b8b9f62ea83459429a6
+  data.tar.gz: 8bb3dd88a04994a713d843ce4b6c374987816300
+SHA512:
+  metadata.gz: e08a50aa39ba81791554532f007a5987be960dcee595343679c3d5b141a709fe3fd3801bcb136bc0370292d8bb8d304bb1b7fa31dc549c4f0ec7fdbcbab0f3f7
+  data.tar.gz: 109e4af9987d4a57bbb9315be867c1adccffba11b84d8292bcaa6a58f89550f901bbd99f2a8aef302307bd9ac4021dc494dd0a62441ef6597d17ab7326e24571

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+roles
+librarian_roles
+Ansiblefile
+Ansiblefile.lock
+npm-debug.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in librarian-ansible.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bcoe
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+Librarian::Ansible
+=================
+
+Port of librarian-chef, providing bundler functionality for Ansible roles.
+
+Installation
+------------
+
+```bash
+gem install librarian-ansible
+```
+
+Ansiblefile: Describing Your Dependencies
+---------------------------------------------
+
+To document the external Ansible roles you rely on, simply place them in an Ansiblefile:
+
+_An Example Ansiblefile:_
+
+```ruby
+#!/usr/bin/env ruby
+#^syntax detection
+
+site "https://galaxy.ansible.com/api/v1"
+
+role "kunik.deploy-upstart-scripts"
+
+role "pgolm.ansible-playbook-monit",
+  github: "pgolm/ansible-playbook-monit"
+
+role "ansible-role-nagios-nrpe-server",
+  ">=0.0.0",
+  path: "./roles/ansible-role-nagios-nrpe-server"
+```
+
+Your dependencies can be:
+
+* Ansible Galaxy IDs:
+
+```ruby
+role "kunik.deploy-upstart-scripts"
+```
+
+* paths to local files:
+
+```ruby
+role "ansible-role-nagios-nrpe-server", path: "./roles/ansible-role-nagios-nrpe-server"
+```
+
+* Github username/project pairs:
+
+```ruby
+role "pgolm.ansible-playbook-monit", github: "pgolm/ansible-playbook-monit"
+```
+
+* Git repos:
+
+```ruby
+role "pgolm.ansible-playbook-monit", git: "git@github.com:pgolm/ansible-playbook-monit.git"
+```
+
+Installing Dependencies
+-----------------------
+
+To install your dependencies, simply run:
+
+```bash
+librarian-ansible install
+```
+
+The first time you run this, an Ansible.lock file will be created which should be checked into your repo. This file ensures that other developers are pinned to the appropriate role versions.
+
+On Version #s
+-------------
+
+librarian-ansible supports version #s, simply add one to your `meta/main.yml` file:
+
+```yml
+---
+galaxy_info:
+  author: Peter Golm
+  license: MIT
+  min_ansible_version: 1.4
+  platforms:
+    - name: Ubuntu
+      versions:
+        - raring
+        - saucy
+
+  categories:
+    - monitoring
+    - system
+dependencies: []
+version: 2.0.0
+```
+
+And update your Ansiblefile accordingly:
+
+```ruby
+role "kunik.deploy-upstart-scripts", "1.0.0"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/librarian-ansible

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'librarian/ansible/cli'
+Librarian::Ansible::Cli.bin!

data/lib/ext/librarian/dsl/target.rb

@@ -0,0 +1,40 @@
+require 'librarian/spec'
+
+# Override the default librarian DSL to pass the 'name'
+# parameter to a source.
+module Librarian
+  class Dsl
+    class Target
+
+      def dependency(name, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        source = source_from_options(options, name) || @source
+        dep = dependency_type.new(name, args, source)
+        @dependencies << dep
+      end
+
+      def source_from_options(options, name = nil)
+        if options[:source]
+          source_shortcuts[options[:source]]
+        elsif source_parts = extract_source_parts(options, name)
+          source_from_params(*source_parts)
+        else
+          nil
+        end
+      end
+
+      def extract_source_parts(options, name = nil)
+        options = {:galaxy => name} if options.empty?
+
+        if name = source_type_names.find{|name| options.key?(name)}
+          options = options.dup
+          param = options.delete(name)
+          [name, param, options]
+        else
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/ext/librarian/lockfile/parser.rb

@@ -0,0 +1,51 @@
+require 'librarian/manifest'
+require 'librarian/dependency'
+require 'librarian/manifest_set'
+
+# Override the lockfile parser, to allow '.' in package names.
+module Librarian
+  class Lockfile
+    class Parser
+
+      def extract_and_parse_sources(lines)
+        sources = []
+        while source_type_names.include?(lines.first)
+          source = {}
+          source_type_name = lines.shift
+          source[:type] = source_type_names_map[source_type_name]
+          options = {}
+          while lines.first =~ /^ {2}([\w-]+):\s+(.+)$/
+            lines.shift
+            options[$1.to_sym] = $2
+          end
+          source[:options] = options
+          lines.shift # specs
+          manifests = {}
+          while lines.first =~ /^ {4}([.\w-]+) \((.*)\)$/
+            lines.shift
+            name = $1
+            manifests[name] = {:version => $2, :dependencies => {}}
+            while lines.first =~ /^ {6}([\w-]+) \((.*)\)$/
+              lines.shift
+              manifests[name][:dependencies][$1] = $2.split(/,\s*/)
+            end
+          end
+          source[:manifests] = manifests
+          sources << source
+        end
+        sources
+      end
+
+      def extract_and_parse_dependencies(lines, manifests_index)
+        dependencies = []
+        while lines.first =~ /^ {2}([.\w-]+)(?: \((.*)\))?$/
+          lines.shift
+          name, requirement = $1, $2.split(/,\s*/)
+          dependencies << Dependency.new(name, requirement, manifests_index[name].source)
+        end
+        dependencies
+      end
+
+    end
+  end
+end

data/lib/librarian-ansible.rb

@@ -0,0 +1 @@
+require "librarian/ansible"

data/lib/librarian/ansible.rb

@@ -0,0 +1 @@
+require 'librarian/ansible/extension'

data/lib/librarian/ansible/cli.rb

@@ -0,0 +1,47 @@
+require 'librarian/helpers'
+
+require 'librarian/cli'
+require 'librarian/ansible'
+
+module Librarian
+  module Ansible
+    class Cli < Librarian::Cli
+
+      module Particularity
+        def root_module
+          Ansible
+        end
+      end
+
+      extend Particularity
+
+      source_root Pathname.new(__FILE__).dirname.join("templates")
+
+      def init
+        copy_file environment.specfile_name
+      end
+
+      desc "install", "Resolves and installs all of the dependencies you specify."
+      option "quiet", :type => :boolean, :default => false
+      option "verbose", :type => :boolean, :default => false
+      option "line-numbers", :type => :boolean, :default => false
+      option "clean", :type => :boolean, :default => false
+      option "strip-dot-git", :type => :boolean
+      option "path", :type => :string
+      def install
+        ensure!
+        clean! if options["clean"]
+        if options.include?("strip-dot-git")
+          strip_dot_git_val = options["strip-dot-git"] ? "1" : nil
+          environment.config_db.local["install.strip-dot-git"] = strip_dot_git_val
+        end
+        if options.include?("path")
+          environment.config_db.local["path"] = options["path"]
+        end
+        resolve!
+        install!
+      end
+
+    end
+  end
+end

data/lib/librarian/ansible/dsl.rb

@@ -0,0 +1,18 @@
+require 'librarian/dsl'
+require 'librarian/ansible/source'
+
+module Librarian
+  module Ansible
+    class Dsl < Librarian::Dsl
+
+      dependency :role
+
+      source :git => Source::Git
+      source :github => Source::Github
+      source :path => Source::Path
+      source :galaxy => Source::Galaxy
+      source :site => Source::Site
+
+    end
+  end
+end

data/lib/librarian/ansible/environment.rb

@@ -0,0 +1,34 @@
+require "librarian/environment"
+require "librarian/ansible/dsl"
+require "librarian/ansible/source"
+require "librarian/ansible/version"
+
+require "ext/librarian/dsl/target"
+
+module Librarian
+  module Ansible
+    class Environment < Environment
+
+      def adapter_name
+        "ansible"
+      end
+
+      def adapter_version
+        VERSION
+      end
+
+      def install_path
+        part = config_db["path"] || "librarian_roles"
+        project_path.join(part)
+      end
+
+      def config_keys
+        super + %w[
+          install.strip-dot-git
+          path
+        ]
+      end
+
+    end
+  end
+end

data/lib/librarian/ansible/extension.rb

@@ -0,0 +1,10 @@
+require 'librarian/ansible/environment'
+
+module Librarian
+  module Ansible
+    extend self
+    extend Librarian
+  end
+end
+
+require "ext/librarian/lockfile/parser"

data/lib/librarian/ansible/manifest_reader.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'yaml'
+
+require 'librarian/manifest'
+
+module Librarian
+  module Ansible
+    module ManifestReader
+      extend self
+
+      def manifest_path(path)
+        path.join("meta/main.yml")
+      end
+
+      def read_manifest(name, manifest_path)
+        if [".yml", ".yaml"].include?(manifest_path.extname)
+          YAML.load(binread(manifest_path)).tap do |m|
+            m["dependencies"] ||= []
+          end
+        end
+      end
+
+      def manifest?(name, path)
+        path = Pathname.new(path)
+        !!manifest_path(path)
+      end
+
+      def check_manifest(name, manifest_path)
+        manifest = read_manifest(name, manifest_path)
+        manifest["name"] == name
+      end
+
+    private
+
+      if File.respond_to?(:binread)
+        def binread(path)
+          File.binread(path)
+        end
+      else
+        def binread(path)
+          File.read(path)
+        end
+      end
+
+    end
+  end
+end

data/lib/librarian/ansible/source.rb

@@ -0,0 +1,5 @@
+require 'librarian/ansible/source/path'
+require 'librarian/ansible/source/git'
+require 'librarian/ansible/source/github'
+require 'librarian/ansible/source/galaxy'
+require 'librarian/ansible/source/site'

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

@@ -0,0 +1,57 @@
+require "librarian/ansible/source/git"
+require "faraday"
+
+# Lookup an Ansible role in Galaxy API, using
+# github_user and package name.
+module Librarian
+  module Ansible
+    module Source
+      class Galaxy
+
+        @@galaxy_api = "https://galaxy.ansible.com/api/v1/"
+
+        class << self
+
+          def galaxy_api=(galaxy_api)
+            @@galaxy_api = galaxy_api
+          end
+
+          def lock_name
+            Git.lock_name
+          end
+
+          def from_lock_options(environment, options)
+            Git.from_lock_options(environment, options)
+          end
+
+          def from_spec_args(environment, uri, options)
+            Git.from_spec_args(environment, github_url(uri), options)
+          end
+
+          private
+
+          def github_url(uri)
+            username, name = uri.split(".")
+
+            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
+              end
+            end
+
+            "https://github.com/#{package['github_user']}/#{package['github_repo']}"
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'librarian/source/git'
+require 'librarian/ansible/source/local'
+
+# Install an ansible role based on git url.
+module Librarian
+  module Ansible
+    module Source
+      class Git < Librarian::Source::Git
+        include Local
+
+        private
+
+        def install_perform_step_copy!(found_path, install_path)
+          debug { "Copying #{relative_path_to(found_path)} to #{relative_path_to(install_path)}" }
+          FileUtils.cp_r(found_path, install_path)
+
+          if environment.config_db["install.strip-dot-git"] == "1"
+            dot_git = install_path.join(".git")
+            dot_git.rmtree if dot_git.directory?
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'librarian/ansible/source/git'
+
+# Install an ansible role based on github_user/github_repo
+# format.
+module Librarian
+  module Ansible
+    module Source
+      class Github
+
+        class << self
+
+          def lock_name
+            Git.lock_name
+          end
+
+          def from_lock_options(environment, options)
+            Git.from_lock_options(environment, options)
+          end
+
+          def from_spec_args(environment, uri, options)
+            Git.from_spec_args(environment, "https://github.com/#{uri}", options)
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+require 'librarian/ansible/manifest_reader'
+
+# Install a local role.
+module Librarian
+  module Ansible
+    module Source
+      module Local
+
+        def install!(manifest)
+          manifest.source == self or raise ArgumentError
+
+          info { "Installing #{manifest.name} (#{manifest.version})" }
+
+          debug { "Installing #{manifest}" }
+
+          name, version = manifest.name, manifest.version
+          found_path = found_path(name)
+
+          install_path = environment.install_path.join(name)
+          if install_path.exist?
+            debug { "Deleting #{relative_path_to(install_path)}" }
+            install_path.rmtree
+          end
+
+          install_perform_step_copy!(found_path, install_path)
+        end
+
+        def fetch_version(name, extra)
+          manifest_data(name)["version"] || "0.0.0"
+        end
+
+        def fetch_dependencies(name, version, extra)
+          manifest_data(name)["dependencies"]
+        end
+
+      private
+
+        def install_perform_step_copy!(found_path, install_path)
+          debug { "Copying #{relative_path_to(found_path)} to #{relative_path_to(install_path)}" }
+          FileUtils.mkdir_p(install_path)
+          FileUtils.cp_r(filter_path(found_path), install_path)
+        end
+
+        def filter_path(path)
+          Dir.glob("#{path}/*").reject { |e| e == environment.install_path.to_s }
+        end
+
+        def manifest_data(name)
+          @manifest_data ||= { }
+          @manifest_data[name] ||= fetch_manifest_data(name)
+        end
+
+        def fetch_manifest_data(name)
+          expect_manifest!(name)
+
+          found_path = found_path(name)
+          manifest_path = ManifestReader.manifest_path(found_path)
+          ManifestReader.read_manifest(name, manifest_path)
+        end
+
+        def manifest?(name, path)
+          ManifestReader.manifest?(name, path)
+        end
+
+        def expect_manifest!(name)
+          found_path = found_path(name)
+          return if found_path && ManifestReader.manifest_path(found_path)
+
+          raise Error, "No metadata file found for #{name} from #{self}! If this should be an ansible role, you might consider contributing a metadata file upstream or forking the ansible role to add your own metadata file."
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'librarian/source/path'
+require 'librarian/ansible/source/local'
+
+# Install local dependency based on
+# file path.
+module Librarian
+  module Ansible
+    module Source
+      class Path < Librarian::Source::Path
+        include Local
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'librarian/source/path'
+require 'librarian/ansible/source/git'
+require 'librarian/ansible/source/galaxy'
+
+# Set the Galaxy API url, using the
+# site directive.
+module Librarian
+  module Ansible
+    module Source
+      class Site
+
+        class << self
+
+          def lock_name
+            Git.lock_name
+          end
+
+          def from_lock_options(environment, options)
+            Git.from_lock_options(environment, options)
+          end
+
+          def from_spec_args(environment, uri, options)
+            Galaxy.galaxy_api = uri
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/librarian/ansible/version.rb

@@ -0,0 +1,5 @@
+module Librarian
+  module Ansible
+    VERSION = "1.0.0"
+  end
+end

data/librarian-ansible.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'librarian/ansible/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "librarian-ansible"
+  gem.version       = Librarian::Ansible::VERSION
+  gem.authors       = ["Jay Feldblum"]
+  gem.email         = ["y_feldblum@yahoo.com"]
+  gem.summary       = %q{A Bundler for your Ansible roles.}
+  gem.description   = %q{A Bundler for your Ansible roles.}
+  gem.homepage      = ""
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "librarian", "~> 0.1.0"
+  gem.add_dependency "faraday"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: librarian-ansible
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jay Feldblum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: librarian
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Bundler for your Ansible roles.
+email:
+- y_feldblum@yahoo.com
+executables:
+- librarian-ansible
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/librarian-ansible
+- lib/ext/librarian/dsl/target.rb
+- lib/ext/librarian/lockfile/parser.rb
+- lib/librarian-ansible.rb
+- lib/librarian/ansible.rb
+- lib/librarian/ansible/cli.rb
+- lib/librarian/ansible/dsl.rb
+- lib/librarian/ansible/environment.rb
+- lib/librarian/ansible/extension.rb
+- lib/librarian/ansible/manifest_reader.rb
+- lib/librarian/ansible/source.rb
+- lib/librarian/ansible/source/galaxy.rb
+- lib/librarian/ansible/source/git.rb
+- lib/librarian/ansible/source/github.rb
+- lib/librarian/ansible/source/local.rb
+- lib/librarian/ansible/source/path.rb
+- lib/librarian/ansible/source/site.rb
+- lib/librarian/ansible/templates/Ansiblefile
+- lib/librarian/ansible/version.rb
+- librarian-ansible.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Bundler for your Ansible roles.
+test_files: []