berksfiler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5fc16d987ad8571285a55ce408be5c849f1d7f8
+  data.tar.gz: 775080806b8f17f710de8ea60955eb6a3e0f6ed5
+SHA512:
+  metadata.gz: ba41c26dcd94480ee7ecbd50a129ff0305fe2d838298933e2bcb8d1150f771e7a74e771cafec8df86bf920ef91608b16a7213e52f0c41a6a03725f5179b3b30c
+  data.tar.gz: 6665555a9551a940a623d3336bfaa7964cf04ad76234f15d7d057d622022658c8a3f8fe603be9e46ada49461485049b7dc66b992cb67de4bb7ff16920ea1b38a

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
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache:
+  - bundler
+install:
+  - bundle install
+rvm:
+- 2.1.6
+- 2.2.2
+script:
+  - bundle exec rake test

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Greensmith and Cozy Services Ltd.
+
+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,118 @@
+# Berksfiler
+
+[![Build Status](https://travis-ci.org/mgreensmith/berksfiler.svg)](https://travis-ci.org/mgreensmith/berksfiler)
+
+Berksfiler programatically generates [Berkshelf](http://berkshelf.com/) Berksfiles for your [Chef](https://www.chef.io/) cookbooks.
+
+## Overview
+
+This tool is designed to help people who have monolithic cookbook repositories generate Berksfiles for their cookbooks. Keeping Berksfiles up to date can be a demanding task, especially when they reference a number of other local cookbooks.
+
+Berksfiler can iterate through a `/cookbooks` directory and generate a Berksfile for each cookbook in that directory (with configurable exclusions), or it can generate Berksfiles for individual cookbooks.
+
+It runs `knife deps` to determine the full dependency tree for a cookbook. It then generates a Berksfile that includes all local cookbook dependencies, as well as any cookbooks with manually-specified options or sources.
+
+You can configure Berksfiler to include specific cookbook dependencies in every Berksfile. This is useful for cookbook dependencies that are used for local development (eg. `chef-solo-seach`) but are not appropriate to include in the metadata of your cookbooks.
+
+## Requirements
+
+  - A working `knife` toolchain
+
+## Installation
+
+    $ gem install berksfiler
+
+## Configuration
+
+Berksfiler expects a `.berksfiler.yml` in your working directory (the root of your chef repository).
+
+Heres an example of a config file with all available options:
+
+```yaml
+---
+# A relative or absolute path to the location of your cookbooks directory.
+cookbooks_root: cookbooks
+
+# An array of cookbooks to include in every Berksfile
+# even if cookbook metadata doesn't specify them
+common_cookbooks:
+ - chef-solo-search
+
+# An array of local cookbooks for which we should not attempt
+# to overwrite the existing Berksfile. Useful for 3rd party
+# or vendored cookbooks for which we don't want to overwrite
+# an existing Berksfile.
+ excluded_cookbooks:
+ - jenkins
+
+# An array of hashes that specify options for cookbooks.
+# All array elements must have string keys 'name' and 'options'.
+# Options will be appended verbatim to the `cookbook` line
+# in the Berksfile for the named cookbook.
+cookbook_options:
+ -
+  name: artifact
+  options: "git: 'git://github.com/CozyCo/artifact-cookbook.git'"
+```
+
+## Usage
+
+```
+Usage: berksfiler [options]
+    -b, --books COOKBOOK,COOKBOOK    Cookbooks for which to generate Berksfiles
+    -c, --config-file FILE           Path to config file
+    -h, --help                       Displays Help
+```
+
+Running `berksfiler` without the `--books` option will cause Berksfiler to generate
+new Berksfiles for all cookbooks in the configured `cookbooks_root` directory,
+except for any cookbooks specified in the `excluded_cookbooks` config option.
+
+Berksfiler should be run from the root of your Chef repository.
+
+## Example
+
+Given:
+
+1. In the cookbook tree:
+```
+/cookbooks
+  /foo
+  /bar
+  /baz
+```
+
+2. if `/cookbooks/foo/metadata.rb` contains the following dependencies:
+```
+depends 'artifact'
+depends 'bar'
+depends 'baz'
+depends 'some_public_cookbook'
+depends 'some_other_public_cookbook'
+```
+
+3. And using the example config file displayed above, running
+```
+$ berksfiler -b foo
+```
+
+would create or update the file `/cookbooks/foo/Berksfile` with the following content:
+```
+# Autogenerated by Berksfiler, do not edit
+
+source 'https://supermarket.chef.io'
+metadata
+
+# Common dependencies for all Berksfiles
+cookbook 'chef-solo-search'
+
+# Dependencies of this cookbook
+cookbook 'artifact', git:  'git://github.com/CozyCo/artifact-cookbook.git'
+cookbook 'bar',      path: '../bar'
+cookbook 'baz',      path: '../baz'
+```
+
+## Copyright
+
+Copyright (c) 2014-2015 Matt Greensmith and Cozy Services Ltd. See [LICENSE.txt](LICENSE.txt) for
+further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+task default: %w(test)
+
+task :test do
+  sh 'rubocop'
+end

data/berksfiler.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'berksfiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'berksfiler'
+  spec.version       = Berksfiler::VERSION
+  spec.authors       = ['Matt Greensmith']
+  spec.email         = ['matt@mttgreensmith.net']
+  spec.summary       = 'Programatically generate Berksfiles for Chef cookbooks.'
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.name
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'configurability'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+end

data/bin/berksfiler

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'pathname'
+require 'berksfiler'
+
+options = { cookbooks: [], config_file: nil }
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: berksfiler [options]'
+  opts.on('-b', '--books COOKBOOK,COOKBOOK',
+          'Cookbooks for which to generate Berksfiles') do |cookbooks|
+    options[:cookbooks] = cookbooks.split(',').map(&:strip)
+  end
+
+  opts.on('-c', '--config-file FILE', 'Path to config file') do |cfile|
+    options[:config_file] = cfile
+  end
+
+  opts.on('-h', '--help', 'Displays Help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+Berksfiler.load_config(options[:config_file])
+
+if options[:cookbooks].empty?
+  Berksfiler.run
+else
+  options[:cookbooks].each do |cb|
+    Berksfiler.emplace_berksfile(cb)
+  end
+end

data/lib/berksfiler.rb

@@ -0,0 +1,78 @@
+require 'pathname'
+require 'configurability'
+
+require 'berksfiler/formatter'
+require 'berksfiler/generator'
+
+# Berksfiler programmatically generates Berksfiles with correct dependencies
+module Berksfiler
+  CONFIG_FILE = Pathname('.berksfiler.yml').expand_path
+
+  EXCLUDED_DIRS_REGEX = /^\./  # reject . and .. when globbing the cookbooks dir
+
+  CONFIG_DEFAULTS = {
+    cookbooks_root: 'cookbooks',
+    common_cookbooks: [],
+    excluded_cookbooks: [],
+    cookbook_options: []
+  }
+
+  def self::cookbooks_root
+    Pathname(config.cookbooks_root).expand_path
+  end
+
+  def self::cookbook_options
+    config.cookbook_options
+  end
+
+  def self::common_cookbooks
+    config.common_cookbooks
+  end
+
+  def self::excluded_cookbooks
+    config.excluded_cookbooks
+  end
+
+  ### Get the loaded config (a Configurability::Config object)
+  def self::config
+    Configurability.loaded_config
+  end
+
+  ### Load the specified +config_file+ and install the config
+  def self::load_config(config_file = nil)
+    config_file ||= CONFIG_FILE
+    config = Configurability::Config.load(config_file, CONFIG_DEFAULTS)
+    config.install
+  end
+
+  # returns an array of all local cookbooks
+  # (basically a directory listing of the cookbook_root)
+  def self::local_cookbooks
+    @local_cookbooks ||= Dir.entries(cookbooks_root).reject do |dir|
+      dir =~ EXCLUDED_DIRS_REGEX
+    end
+  end
+
+  # returns an array of all cookbooks that have non-default options
+  def self::specific_cookbooks
+    local_cookbooks + cookbook_options.map { |cb| cb['name'] }
+  end
+
+  # Generate a berksfile and place it in a +cookbook+
+  def self::emplace_berksfile(cookbook)
+    puts "Generating Berksfile for local cookbook '#{cookbook}'"
+    content = Generator.generate_berksfile(cookbook)
+    open(File.join(cookbooks_root, cookbook, 'Berksfile'), 'w') do |f|
+      f << content
+    end
+  end
+
+  # for all local cookbooks, excluding `excluded_cookbooks`, calculate all
+  # dependencies and programmatically generate a Berksfile for that cookbook
+  # which takes into account the correct sources for all dependencies.
+  def self::run
+    local_cookbooks - excluded_cookbooks.each do |cb|
+      emplace_berksfile(cb)
+    end
+  end
+end

data/lib/berksfiler/formatter.rb

@@ -0,0 +1,63 @@
+module Berksfiler
+  # Methods for formatting data to be emplaced in a Berksfile
+  class Formatter
+    # generate the correct Berksfile line for any cookbook
+    def self::cookbook_line(cookbook)
+      if special_cookbook_lines.key?(cookbook)
+        special_cookbook_lines[cookbook]
+      else
+        "cookbook '#{cookbook}'\n"
+      end
+    end
+
+    # generate a hash of 'name' => '[formatted Berksfile line]' for all local
+    # cookbooks and cookbooks that have specified options
+    def self::special_cookbook_lines
+      return @special_cookbook_lines if @special_cookbook_lines
+
+      @special_cookbook_lines = {}
+
+      # local cookbooks are discovered from coobooks_root, and are string names
+      Berksfiler.local_cookbooks.map do |cb|
+        @special_cookbook_lines[cb] = "cookbook '#{cb}', path: '../#{cb}'\n"
+      end
+
+      # cookbooks with options are provided as a hash
+      # with name: and options: keys
+      Berksfiler.cookbook_options.each do |cb|
+        @special_cookbook_lines[cb['name']] =
+          "cookbook '#{cb['name']}', #{cb['options']}\n"
+      end
+      @special_cookbook_lines
+    end
+
+    #### DISPLAY HELPERS
+
+    # given a 2-dimensional array +lists+, return an array of the maximum
+    # length of the content for each index of the inner arrays
+    def self::array_maxes(lists)
+      lists.reduce([]) do |maxes, list| # rubocop:disable Style/EachWithObject
+        list.each_with_index do |value, index|
+          maxes[index] = [(maxes[index] || 0), value.to_s.length].max
+        end
+        maxes
+      end
+    end
+
+    # given a 2-dimensional array +lists+, right-pad each array member based on
+    # the maximum length of array members at that inner array index
+    # returns an array of formatted lines
+    def self::aligned_print(lists)
+      out = []
+      maxes = array_maxes(lists)
+      lists.each do |list|
+        line = ''
+        list.each_with_index do |value, index|
+          line << "#{value.to_s.ljust(maxes[index])} "
+        end
+        out << line.strip
+      end
+      out
+    end
+  end
+end

data/lib/berksfiler/generator.rb

@@ -0,0 +1,63 @@
+module Berksfiler
+  # Methods for generating a Berksfile
+  class Generator
+    BERKSFILE_FRONTMATTER = <<-END.gsub(/^ {6}/, '')
+      # Autogenerated by Berksfiler, do not edit
+
+      source 'https://supermarket.chef.io'
+      metadata
+
+    END
+
+    # returns an array of all cookbook dependencies for a
+    # given cookbook by running `knife deps`
+    def self::get_deps(cookbook)
+      # ["cookbooks/foo", "cookbooks/bar"]
+      raw_deps = `knife deps cookbooks/#{cookbook} --remote`.split("\n")
+      # ["foo", "bar"]
+      raw_deps.map { |cb| cb.split('/')[1].strip }
+    end
+
+    # returns an array of cookbook dependencies for a given cookbook,
+    # limited to cookbooks which are are local or have specific options
+    def self::get_local_deps(cookbook)
+      all_deps = get_deps(cookbook)
+      specific_cookbooks = Berksfiler.specific_cookbooks.reject do |cb|
+        cb == cookbook
+      end # don't include self
+      all_deps.select { |cb| specific_cookbooks.include?(cb) }
+    end
+
+    # generate a full berksfile for a cookbook, including all dependencies
+    # with their correct sources. Excludes community cookbooks unless they
+    # are specified in `common_cookbooks`, because the metadata` directive
+    # handles these includes.
+    def self::generate_berksfile(cookbook)
+      content = '' << BERKSFILE_FRONTMATTER
+      content << generate_common_berksfile_section
+
+      cookbooks = get_local_deps(cookbook).map do |cb|
+        Formatter.cookbook_line(cb).split(' ')
+      end
+      unless cookbooks.empty?
+        content << "\n# Dependencies of this cookbook\n"
+        content << Formatter.aligned_print(cookbooks.sort).join("\n") << "\n"
+      end
+      content
+    end
+
+    # generate the 'common dependencies' section of a Berksfile
+    def self::generate_common_berksfile_section
+      content = ''
+      common_cookbooks = Berksfiler.common_cookbooks.map do |cb|
+        Formatter.cookbook_line(cb).split(' ')
+      end
+      unless common_cookbooks.empty?
+        content << "# Common dependencies for all Berksfiles\n"
+        content << Formatter.aligned_print(common_cookbooks.sort).join("\n")
+        content << "\n"
+      end
+      content
+    end
+  end
+end

data/lib/berksfiler/version.rb

@@ -0,0 +1,4 @@
+# Berksfiler programmatically generates Berksfiles with correct dependencies
+module Berksfiler
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: berksfiler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Greensmith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: configurability
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rubocop
+  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: Programatically generate Berksfiles for Chef cookbooks.
+email:
+- matt@mttgreensmith.net
+executables:
+- berksfiler
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- berksfiler.gemspec
+- bin/berksfiler
+- lib/berksfiler.rb
+- lib/berksfiler/formatter.rb
+- lib/berksfiler/generator.rb
+- lib/berksfiler/version.rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Programatically generate Berksfiles for Chef cookbooks.
+test_files: []