configgin 0.12.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0d8a6a8b00f54998849502a456de5a17b83b265
+  data.tar.gz: 9bbe965be9848864dbff2b6e3600d83805225347
+SHA512:
+  metadata.gz: e21878032ef6a02a5647fd9e3ccee06d32e1b6f7caa39f4498b52f13fc133e7d72de1979536134e3f94af273d96f86c0ee8e4b65aa7f6e9ac4327f15a777e7ec
+  data.tar.gz: fa8e769269405ecb26fdf0338535d06c9cd88b17fdb34758b5ea6f02d5b5d6d0ccf484edbe0c9b16f88f10c5e7554b8ad2ad1eacffc7455c63a5309046539617

data/.gitignore

@@ -0,0 +1,5 @@
+/output
+/vendor/cache/
+/vendor/sentinel
+/.bundle/
+configgin.go

data/.overcommit.yml

@@ -0,0 +1,8 @@
+---
+PrePush:
+  SyncNotes:
+    enabled: true
+    command: ./vendor/github.com/hpe-cloud-garage/git-notary/hooks/pre-push/sync-notes
+  BranchHasNotes:
+    enabled: true
+    command: ./vendor/github.com/hpe-cloud-garage/git-notary/hooks/pre-push/branch-has-notes

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--backtrace
+--format progress

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  Exclude:
+    - 'output/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,48 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-10-14 10:11:25 -0700 using RuboCop version 0.31.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 20
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 108
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 28
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 3
+Style/ClassVars:
+  Enabled: false
+
+# Offense count: 1
+Style/EachWithObject:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.1.7

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    configgin (0.1.0)
+      bosh-template (~> 1.3262.24.0)
+      deep_merge (~> 1.0.1)
+      mustache (~> 1.0)
+      rainbow (~> 2.0, != 2.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    bosh-template (1.3262.24.0)
+      semi_semantic (~> 1.2.0)
+    deep_merge (1.0.1)
+    diff-lcs (1.3)
+    mustache (1.0.5)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (10.4.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    semi_semantic (1.2.0)
+    unicode-display_width (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  configgin!
+  rake (~> 10.0)
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.md

@@ -0,0 +1,7 @@
+© Copyright 2016 Hewlett Packard Enterprise Development LP
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Makefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env make
+
+GIT_ROOT:=$(shell git rev-parse --show-toplevel)
+
+.PHONY: lint test dist
+
+all: lint test dist
+
+test:
+	${GIT_ROOT}/make/test
+
+lint:
+	${GIT_ROOT}/make/lint
+
+dist:
+	gem build ${GIT_ROOT}/configgin.gemspec
+
+clean:
+	rm -rf output

data/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2016 Hewlett Packard Enterprise, Inc. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,74 @@
+# configgin
+
+A simple cli app in Ruby to generate configurations using [BOSH](https://bosh.io) ERB templates and
+a BOSH spec, but also using configurations based on environment variables,
+processed using a set of templates.
+
+## Usage
+
+```
+Usage: configgin [options]
+    -j, --jobs file                  Job configuration JSON
+    -e, --env2conf file              Environment to configuration templates YAML
+```
+
+## Examples
+
+### Example BOSH spec (bosh_spec.json)
+```json
+{
+    "job": {
+        "name": "mysql",
+        "templates": [
+            {
+                "name": "mysql"
+            },
+            {
+                "name": "consul_agent"
+            }
+        ]
+    },
+    "networks": {
+        "default": {}
+    },
+    "properties": {
+        "acceptance_tests": {
+            "include_services": false,
+            "include_sso": false,
+            "nodes": 2
+        }
+    }
+}  
+```
+
+### Example job configuration file (job_config.json)
+```json
+{
+  "job_name": {
+    "base": "/tmp/bosh_spec.json",
+    "files": {
+      "/tmp/my_template.erb": "/tmp/output_file"
+    }
+  }
+}
+```
+
+### Example environment variable template file (env2.conf.yml)
+```yaml
+---
+properties.acceptance_tests.nodes: "((TEST_NODE_COUNT))"
+properties.uaa.scim.users: "'((TEST_VAR))'"
+```
+
+### Example template (my_template.erb)
+```erb
+Hello, this is the users property: <%= p("uaa.scim.users") %>
+```
+
+### Example of using the tool
+```bash
+TEST_VAR=foo
+configgin \
+  -e ~/tmp/env2.conf.yml \
+  -j ~/tmp/job_config.json
+```

data/bin/configgin

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/configgin"
+
+options = {}
+parser = Cli.make_option_parser(options)
+
+parser.parse!(ARGV)
+
+begin
+  Cli.check_opts(options)
+rescue ArgMissingError => e
+  STDERR.puts("missing argument: #{e}")
+  exit(1)
+end
+
+jobs = JSON.load(File.read(options[:jobs]))
+templates = YAML.load_file(options[:env2conf])
+
+jobs.each do |job, job_config|
+  base_config = JSON.load(File.read(job_config['base']))
+
+  job_config['files'].each do |infile, outfile|
+    begin
+      bosh_spec = EnvironmentConfigTransmogrifier.transmogrify(base_config,
+                                                               templates,
+                                                               secrets: '/etc/secrets')
+    rescue NonHashValueOverride => e
+      STDERR.puts e.to_s
+      STDERR.puts "Error generating #{job}: #{outfile} from #{infile}"
+      exit 1
+    end
+
+    Generate.generate(bosh_spec, infile, outfile)
+  end
+end

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/configgin.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configgin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "configgin"
+  spec.version       = Configgin::VERSION
+  spec.authors       = ["hpcloud"]
+
+  spec.summary       = "A simple cli app in Ruby to generate configurations using BOSH ERB templates and a BOSH spec."
+  spec.description   = "A simple cli app in Ruby to generate configurations using BOSH ERB templates and a BOSH spec, but also using configurations based on environment variables, processed using a set of templates."
+  spec.homepage      = "https://github.com/hpcloud/configgin"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'bosh-template', '~> 1.3262.24.0'
+  spec.add_dependency 'rainbow', '~>2.0', '!=2.2.1'
+  spec.add_dependency 'deep_merge', '~> 1.0.1'
+  spec.add_dependency 'mustache', '~> 1.0'
+end

data/lib/cli.rb

@@ -0,0 +1,38 @@
+require 'optparse'
+require 'generate'
+require 'exceptions'
+
+# Cli is a helper module for dealing with command line flags
+module Cli
+  # Check options for any errors
+  #
+  # @param options [Hash] The options to check
+  def self.check_opts(options)
+    [:jobs, :env2conf].each do |key|
+      if options[key].nil? || options[key].empty?
+        raise ArgMissingError, key.to_s
+      end
+    end
+  end
+
+  # Make an option parser bound to the hash passed in.
+  #
+  # @param options [Hash]   The hash that the options will be bound to on parse!
+  # @return        [Object] The option parser that can be used.
+  def self.make_option_parser(options)
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: configgin [options]'
+
+      # Job definition file
+      opts.on('-j', '--jobs file', 'Job definitions') do |j|
+        options[:jobs] = j
+      end
+
+      # Environment to configuration templates file
+      opts.on('-e', '--env2conf file',
+              'Environment to configuration templates YAML') do |e|
+        options[:env2conf] = e
+      end
+    end
+  end
+end

data/lib/configgin.rb

@@ -0,0 +1,3 @@
+require 'cli'
+require 'generate'
+require 'environment_config_transmogrifier'

data/lib/configgin/version.rb

@@ -0,0 +1,5 @@
+module Configgin
+
+  VERSION = "0.12.0.pre"
+
+end

data/lib/environment_config_transmogrifier.rb

@@ -0,0 +1,132 @@
+require 'yaml'
+require 'mustache'
+require 'shellwords'
+
+# EnvironmentConfigTransmogrifier uses environment variables to generate config values
+# for specific keys.
+module EnvironmentConfigTransmogrifier
+  @@memoize_mustache = {}
+
+  # NoEscapeMustache does not escape these characters: & \ " < > '
+  class NoEscapeMustache < Mustache
+    # Disabling this cop because this is the function we need to override
+    # rubocop:disable MethodName
+    def escapeHTML(str)
+      str
+    end
+  end
+
+  # Processes the mustache templates and injects new keys into the configuration
+  #
+  # @return [Hash] Hash containing the updated configuration
+  def self.transmogrify(base_config, environment_templates, secrets: nil)
+    # build input hash for mustache
+    input_hash = ENV.to_hash
+
+    # load secrets
+    extendReplace(input_hash, secrets) if secrets && File.directory?(secrets)
+
+    # remove empty values
+    input_hash.reject! { |_, v| v.nil? || v.empty? }
+
+    # iterate through templates
+    environment_templates.each do |key, value|
+      # generate value from template
+
+      # we need to process the template at least once, even if it doesn't
+      # actually contain a mustache template, to get value types correctly;
+      # by default, all values are strings, because they come from the environment
+      # we need to unmarshall them using YAML.load
+      loop do
+        value = processMustacheTemplate(value, input_hash, key)
+        break unless value.respond_to?(:include?) && value.include?('((')
+      end
+
+      # inject value in huge json
+      inject_value(base_config, key.split('.'), value, key)
+    end
+
+    base_config['bootstrap'] = (base_config['index'] || 0) == 0
+
+    base_config
+  end
+
+  def self.processMustacheTemplate(value, input_hash, key)
+    val = @@memoize_mustache.fetch(value, {})[input_hash]
+    return val if val
+
+    delimiter = '{{=(( ))=}}'
+    begin
+      mustache_value = NoEscapeMustache.render("#{delimiter}#{value}", input_hash)
+      # replace new lines with double new lines for proper new-line YAML parsing
+      mustache_value = mustache_value.to_s.gsub("\n", "\n\n")
+      @@memoize_mustache[value] ||= {}
+      @@memoize_mustache[value][input_hash] = YAML.load(mustache_value)
+    rescue => e
+      msg = mustacheMessageFromError(e)
+      raise LoadYamlFromMustacheError, "Could not load config key '#{key}': #{msg}"
+    end
+  end
+
+  def self.mustacheMessageFromError(e)
+    lines = e.message.split(/\n/)
+    return 'No reason for failure given by mustache library' if lines.empty?
+    return lines.first if lines.size < 4
+
+    caret_line = lines[3]
+    caret_pos = caret_line.index('^')
+    return lines[0] + '.' unless caret_pos
+
+    delimiter = '{{=(( ))=}}'
+    actual_line = lines[2]
+    leading_junk = actual_line.lstrip.start_with?(delimiter) ? actual_line.index(delimiter) : 0
+    lines[0] + ": Error at or near position #{caret_pos - leading_junk} of template value."
+  end
+
+  def self.extendReplace(hash, path)
+    # This code assumes that 'path' points to a directory of files.
+    # The name of each file is the key into the hash, and the contents
+    # of the file are the value to enter, as-is. The order of the
+    # files in the directory does not matter.
+    Dir.glob(File.join(path, '*')).each do |file|
+      key   = File.basename(file)
+      value = File.read(file)
+
+      # Write the collected information to the hash. This will
+      # overwrite, i.e. replace an existing value for that name. This
+      # means that the values found in 'path' have priority over the
+      # values already in the 'hash'. This is what we want for
+      # '/etc/secrets'
+      hash[key.upcase.tr('-', '_')] = value
+    end
+  end
+
+  def self.inject_value(hash, key_grams, value, original_key)
+    # if we only have 1 gram, we can set the value
+    if key_grams.size == 1
+      # If the new value is nil, and the old value was a hash, it's because
+      # somebody didn't provide a full default value; ignore it.
+      unless value.nil? && hash[key_grams[0]].is_a?(Hash)
+        hash[key_grams[0]] = value
+      end
+      return
+    end
+
+    # if there's more than one gram, keep going
+
+    # Initialize a hash if we're going deeper than what's currently available;
+    # sometimes we want to override when the old value is nil (i.e. no default)
+    # but the new value is a hash.
+    hash[key_grams[0]] = {} if hash[key_grams[0]].nil?
+    # error out if we're trying to override
+    # an existing value that's not a hash
+    unless hash[key_grams[0]].is_a?(Hash)
+      raise NonHashValueOverride, \
+            "Refusing to override non-hash value #{hash[key_grams[0]].inspect} " \
+            "with #{value.inspect}: '#{key_grams.join('.')}'" \
+            " - Complete key: '#{original_key}'"
+    end
+    # keep going deeper
+    inject_value(hash[key_grams[0]], key_grams.drop(1), value, original_key)
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,4 @@
+class ArgMissingError < StandardError; end
+class NonHashValueOverride < StandardError; end
+class NoDataProvided < StandardError; end
+class LoadYamlFromMustacheError < StandardError; end

data/lib/generate.rb

@@ -0,0 +1,48 @@
+require 'bosh/template/renderer'
+require 'json'
+
+# Generate has methods for manipulating streams and generating configuration
+# files using those streams.
+module Generate
+  # Proces the given template using a provided spec and output filename
+  #
+  # @param bosh_spec          [Hash]   The input data as a hash
+  # @param input_file_path    [String] The input filepath for the template
+  # @param output_file_path   [String] The output filepath
+  def self.generate(bosh_spec, input_file_path, output_file_path, &_block)
+    # Make sure we're getting all the parameters we need
+    raise NoDataProvided if bosh_spec.nil?
+    raise NoInputFileProvided if input_file_path.nil?
+    raise NoOutputFileProvided if output_file_path.nil?
+
+    # Read the erb template
+    begin
+      perms = File.stat(input_file_path).mode
+      erb_template = ERB.new(File.read(input_file_path))
+      erb_template.filename = input_file_path
+    rescue Errno::ENOENT
+      raise "failed to read template file #{input_file_path}"
+    end
+
+    # Create a BOSH evaluation context
+    evaluation_context = Bosh::Template::EvaluationContext.new(bosh_spec)
+    # Process the Template
+    output = erb_template.result(evaluation_context.get_binding)
+
+    begin
+      # Open the output file
+      output_dir = File.dirname(output_file_path)
+      FileUtils.mkdir_p(output_dir)
+      out_file = File.open(output_file_path, 'w')
+      # Write results to the output file
+      out_file.write(output)
+      # Set the appropriate permissions on the output file
+      out_file.chmod(perms)
+    rescue Errno::ENOENT, Errno::EACCES => e
+      out_file = nil
+      raise "failed to open output file #{output_file_path}: #{e}"
+    ensure
+      out_file.close unless out_file.nil?
+    end
+  end
+end

data/make/include/darwin-support

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+set -o errexit
+
+if [ "$(uname)" == "Darwin" ]; then
+    DOCKER_RUNTIME=${DOCKER_RUNTIME:-'helioncf/hcf-pipeline-ruby-bosh'}
+
+    # We need to mount the enclosing repo in case we are just a submodule
+    # (still doesn't support being a nested submodule though)
+    ROOT=${PWD}
+    if [ -f .git ]; then cd ..; fi
+    GIT_ROOT=$(git rev-parse --show-toplevel)
+    cd ${ROOT}
+
+    WORK_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
+
+    docker run \
+       --rm \
+       --volume ${GIT_ROOT}:${GIT_ROOT} \
+       --workdir ${WORK_DIR} \
+       --entrypoint bash \
+       ${DOCKER_RUNTIME} \
+       -l -c "export RBENV_VERSION=2.1.7 && ${BASH_SOURCE[1]}"
+
+    exit
+fi

data/make/include/versioning

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+test -n "${XTRACE}" && set -o xtrace
+
+set -o errexit -o nounset
+
+GIT_ROOT=${GIT_ROOT:-$(git rev-parse --show-toplevel)}
+GIT_DESCRIBE=${GIT_DESCRIBE:-$(git describe --tags --long)}
+GIT_BRANCH=${GIT_BRANCH:-$(git name-rev --name-only HEAD)}
+
+GIT_TAG=${GIT_TAG:-$(echo ${GIT_DESCRIBE} | awk -F - '{ print $1 }' )}
+GIT_COMMITS=${GIT_COMMITS:-$(echo ${GIT_DESCRIBE} | awk -F - '{ print $2 }' )}
+GIT_SHA=${GIT_SHA:-$(echo ${GIT_DESCRIBE} | awk -F - '{ print $3 }' )}
+
+ARTIFACT_NAME=${ARTIFACT_NAME:-$(basename $(git config --get remote.origin.url) .git | sed s/^hcf-//)}
+ARTIFACT_VERSION=${GIT_TAG}+${GIT_COMMITS}.${GIT_SHA}
+
+APP_VERSION=${ARTIFACT_NAME}-${ARTIFACT_VERSION}
+
+set +o errexit +o nounset +o xtrace

data/make/lint

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -o errexit
+
+GIT_ROOT=${GIT_ROOT:-$(git rev-parse --show-toplevel)}
+. ${GIT_ROOT}/make/include/darwin-support
+
+bundle package
+bundle exec rubocop --fail-level=error

data/make/test

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -o errexit
+
+GIT_ROOT=${GIT_ROOT:-$(git rev-parse --show-toplevel)}
+. ${GIT_ROOT}/make/include/darwin-support
+
+bundle package
+bundle exec rspec "${@}"

data/vendor/github.com/hpe-cloud-garage/git-notary/.gitignore

@@ -0,0 +1,2 @@
+auto/**
+*.tex

data/vendor/github.com/hpe-cloud-garage/git-notary/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+Copyright © 2016 Chris Olstrom <chris@olstrom.com>
+
+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/vendor/github.com/hpe-cloud-garage/git-notary/README.org

@@ -0,0 +1,140 @@
+#+TITLE: git-notary
+#+SUBTITLE: a versioning experiment for git
+#+LATEX: \pagebreak
+
+* Overview
+
+~git-notary~ generates canonical version tags from versioning notes.
+
+** Why would I want this?
+
+~git-notary~ may be helpful if you want to use Semantic Versioning in a project
+with many contributors and some manner of branch-oriented workflow. Tracking
+versioning information with a ~VERSION~ file seems like a great idea, but has
+some quirks.
+
+** An Example Scenario
+
+Consider the following (simplified) scenario:
+
+#+BEGIN_EXAMPLE
+  ,*   e44e210 - (HEAD -> develop) Merge branch 'bar' into develop
+  |\
+  | * e1793f3 - (bar) PATCH
+  | * f231d3b - MAJOR 
+  | * 5c69653 - MAJOR
+  ,* |   67543e1 - Merge branch 'foo' into develop
+  |\ \
+  | |/
+  |/|
+  | * ea81623 - (foo) MAJOR
+  | * 8b773db - PATCH
+  | * 6613b79 - MINOR
+  |/
+  ,* 21c36f3 - (master) MINOR
+  ,* 64357c2 - MINOR
+  ,* 9ebfd7d - MINOR
+  ,* cc5d832 - PATCH
+  ,* ebc851f - MINOR
+  ,* a75790f - PATCH
+  ,* 572a9e8 - MAJOR
+  ,* a990127 - (tag: 0.0.0) INITIAL
+#+END_EXAMPLE
+
+In this example, two branches (~foo~ and ~bar~) were created from ~master~
+(~21c36f3~). Both branches know that ~1.4.0~ is the latest tag (at the time they
+branched). Let's assume these branches do not conflict with each other.
+
+With a ~VERSION~ file, a project generally chooses one of two places to update it:
+
+- Updates occur in the branch. In this case, once either branch is merged, the
+  other is in conflict with it.
+- Updates occur in the trunk. In this case, the trunk now contains code that did
+  not originate in a branch. Again, the first merged is safe, but the other is
+  in a conflicting state.
+
+If ~foo~ merges first, the expected version post-merge is ~2.0.0~.
+
+If ~bar~ merges first, the expected version is ~3.0.1~.
+
+At ~e44e210~ (~HEAD~ of ~develop~), the final version should be ~4.0.1~, but if
+the merge order were reversed, it should be ~4.0.0~. This gets worse as the
+number of active branches increases.
+
+* Assumptions
+
+- Versioning is important.
+- Versions should communicate scope of change.
+- Humans can signal the scope of their own changes.
+- Machines can figure out the rest.
+
+* Installation
+
+** Install via RubyGems
+
+~gem install --no-wrapper git-notary~
+
+** Manual Installation
+
+Download the latest release of ~git-notary~ and place it somewhere in your ~$PATH~.
+
+#+LATEX: \pagebreak
+
+* Usage
+
+** Add new versioning information
+
+#+BEGIN_SRC shell
+  git-notary new <version> [object] [namespace]
+#+END_SRC
+
+Where <version> is one of (major, minor, patch).
+
+** Undo a version
+
+#+BEGIN_SRC shell
+  git-notary undo [object] [namespace]
+#+END_SRC
+
+** Fetch versioning notes
+
+#+BEGIN_SRC shell
+  git-notary fetch [remote] [namespace]
+#+END_SRC
+
+** Fetch and merge versioning notes
+
+#+BEGIN_SRC shell
+  git-notary pull [remote] [namespace] [merge-strategy]
+#+END_SRC
+
+** Push versioning notes
+
+#+BEGIN_SRC shell
+  git-notary push [remote] [namespace]
+#+END_SRC
+
+** Extract Notes
+
+#+BEGIN_SRC shell
+  git-notary notes [branch] [base] [namespace]
+#+END_SRC
+
+** Compute Versions from Notes
+
+#+BEGIN_SRC shell
+  git-notary notes | git-notary versions [initial]
+#+END_SRC
+
+** Generate Tags from Versions
+
+#+BEGIN_SRC shell
+  git-notary notes | git-notary versions | git-notary tags [--apply]
+#+END_SRC
+
+* License
+
+~git-notary~ is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See ~LICENSE.txt~ for the full text.
+
+* Contributors
+- [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]

data/vendor/github.com/hpe-cloud-garage/git-notary/bin/git-notary

@@ -0,0 +1,262 @@
+#!/bin/sh
+
+GIT_NOTARY_VERSION=2.3.1
+GIT_NOTARY_NAMESPACE=${GIT_NOTARY_NAMESPACE:-'versioning'}
+
+# notes [branch] [base] [namespace]
+notes() {
+    BRANCH=${1-'develop'}
+    BASE=${2:-$(git describe --tags --abbrev=0)}
+    NAMESPACE=${3:-${GIT_NOTARY_NAMESPACE}}
+
+    git rev-list --topo-order ${BASE}..${BRANCH} --reverse | while read OBJECT; do
+        printf "${OBJECT} "
+        git notes --ref=${NAMESPACE} show ${OBJECT} 2> /dev/null || echo
+    done | grep -E '(MAJOR|MINOR|PATCH)$'
+}
+
+# squash
+squash() {
+    while read OBJECT_CHANGE; do
+        OBJECT=$(echo ${OBJECT_CHANGE} | awk '{ print $1 }')
+        CHANGE=$(echo ${OBJECT_CHANGE} | awk '{ print $2 }')
+
+        case ${CHANGE} in
+            MAJOR)
+                RESULT=MAJOR;;
+            MINOR)
+                test "${RESULT}" != MAJOR && RESULT=MINOR;;
+            PATCH)
+                test -z "${RESULT}" && RESULT=PATCH;;
+        esac
+    done
+
+    test ! -z "${RESULT}" && echo ${OBJECT} ${RESULT}
+}
+
+# squeeze <up|down>
+squeeze() {
+    case ${1} in
+        d|down|f|first|o|old*)
+            DIRECTION=DOWN;;
+        u|up|l|last|n|new*)
+            DIRECTION=UP;;
+        *)
+            echo 'git-notary squeeze requires a direction (up or down)' >&2
+            exit 23;;
+    esac
+
+    while read OBJECT_CHANGE; do
+        OBJECT=$(echo ${OBJECT_CHANGE} | awk '{ print $1 }')
+        CHANGE=$(echo ${OBJECT_CHANGE} | awk '{ print $2 }')
+
+        if test "${CHANGE}" != "${LAST_CHANGE}"; then
+            case ${DIRECTION} in
+                DOWN)
+                    echo ${OBJECT} ${CHANGE};;
+                UP)
+                    test ! -z "${LAST_OBJECT}" && echo ${LAST_OBJECT} ${LAST_CHANGE};;
+            esac
+        fi
+
+        LAST_OBJECT=${OBJECT}
+        LAST_CHANGE=${CHANGE}
+    done
+
+    test "${DIRECTION}" = UP && echo ${LAST_OBJECT} ${LAST_CHANGE}
+}
+
+# versions [initial]
+versions() {
+    set -o errexit
+    VERSION=${1:-$(git describe --tags --abbrev=0)}
+
+    MAJOR=$(echo ${VERSION} | awk -F . '{ print $1 }')
+    MINOR=$(echo ${VERSION} | awk -F . '{ print $2 }')
+    PATCH=$(echo ${VERSION} | awk -F . '{ print $3 }')
+
+    next() {
+        echo ${1} + 1 | bc
+    }
+
+    while read OBJECT_CHANGE; do
+        OBJECT=$(echo ${OBJECT_CHANGE} | awk '{ print $1 }')
+        CHANGE=$(echo ${OBJECT_CHANGE} | awk '{ print $2 }')
+
+        case ${CHANGE} in
+            MAJOR)
+                MAJOR=$(next ${MAJOR})
+                MINOR=0
+                PATCH=0
+                ;;
+            MINOR)
+                MINOR=$(next ${MINOR})
+                PATCH=0
+                ;;
+            PATCH)
+                PATCH=$(next ${PATCH})
+                ;;
+        esac
+
+        VERSION=${MAJOR}.${MINOR}.${PATCH}
+        echo ${OBJECT} ${VERSION}
+    done
+}
+
+# tags [--apply]
+tags() {
+    while read OBJECT_TAG; do
+        OBJECT=$(echo ${OBJECT_TAG} | awk '{ print $1 }')
+        TAG=$(echo ${OBJECT_TAG} | awk '{ print $2 }')
+
+        if test "${1}" = '--apply'; then
+            git tag ${TAG} ${OBJECT}
+        else
+            echo git tag ${TAG} ${OBJECT}
+        fi
+    done
+}
+
+# fetch [remote] [namespace]
+fetch() {
+    FORCE=""
+    if test "${1:-}" = "--force"; then
+        shift
+        FORCE="+"
+    fi
+    REMOTE=${1:-'origin'}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+
+    git fetch ${REMOTE} ${FORCE}refs/notes/${NAMESPACE}:refs/notes/${NAMESPACE}
+}
+
+# pull [remote] [namespace] [strategy]
+pull() {
+    REMOTE=${1:-'origin'}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+    STRATEGY=${3:-'theirs'}
+
+    git fetch ${REMOTE} refs/notes/${NAMESPACE}
+    env GIT_NOTES_REF=refs/notes/${NAMESPACE} git notes merge -s ${STRATEGY} FETCH_HEAD
+}
+
+# push [remote] [namespace]
+push() {
+    REMOTE=${1:-'origin'}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+
+    git push --no-verify ${REMOTE} refs/notes/${NAMESPACE}
+}
+
+# new <major|minor|patch> [object] [namespace]
+new() {
+    CHANGE=$(echo ${1} | tr [:lower:] [:upper:])
+    OBJECT=${2:-HEAD}
+    NAMESPACE=${3:-${GIT_NOTARY_NAMESPACE}}
+
+    if echo ${CHANGE} | grep -qE '^(MAJOR|MINOR|PATCH)$'; then
+        git notes --ref=${NAMESPACE} add --message ${CHANGE} ${OBJECT}
+    else
+        echo MAJOR MINOR and PATCH are valid. ${CHANGE} is not.
+        exit 23
+    fi
+}
+
+# delta (--squash) [object] [base] [namespace]
+delta() {
+    if test "${1}" = '--squash'; then
+       SQUASH=true
+       shift
+    fi
+
+    OBJECT=${1:-HEAD}
+    BASE=${2:-$(git describe --tags --abbrev=0)}
+    NAMESPACE=${3:-${GIT_NOTARY_NAMESPACE}}
+
+    if test "${SQUASH}" = 'true'; then
+        NEW=$(git-notary notes ${OBJECT} ${BASE} ${NAMESPACE} | git-notary squash | git-notary versions | awk '{ print $2 }')
+    else
+        NEW=$(git-notary notes ${OBJECT} ${BASE} ${NAMESPACE} | git-notary versions | tail -1 | awk '{ print $2 }')
+    fi
+
+    LATEST_TAG_ON_BASE=$(git describe --tags --abbrev=0 ${BASE})
+    OLD=${LATEST_TAG_ON_BASE:-'0.0.0'}
+    echo "${OLD} -> ${NEW}"
+}
+
+# undo [object] [namespace]
+undo() {
+    OBJECT=${1:-HEAD}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+
+    git notes --ref=${NAMESPACE} remove ${OBJECT}
+}
+
+# version
+version() {
+    echo "git-notary ${GIT_NOTARY_VERSION}"
+}
+
+# help
+help() {
+    cat <<EOF
+$(version)
+usage:
+       git-notary new <major|minor|patch> [object] [namespace]
+       git-notary undo [object] [namespace]
+       git-notary delta [--squash] [object] [base] [namespace]
+
+       git-notary fetch [remote] [namespace]
+       git-notary push [remote] [namespace]
+
+       git-notary notes [branch] [base] [namespace]
+       git-notary versions [initial]
+       git-notary tags [--apply]
+EOF
+}
+
+# notary <command> [args]
+notary() {
+    COMMAND=${1}
+    shift
+    case ${COMMAND} in
+        N|notes)
+            notes ${@};;
+        V|versions)
+            versions ${@};;
+        T|tags)
+            tags ${@};;
+        S|squash)
+            squash ${@};;
+        Z|squeeze)
+            squeeze ${@};;
+        n|new)
+            new ${@};;
+        u|undo)
+            undo ${@};;
+        d|delta)
+            delta ${@};;
+        P|push)
+            push ${@};;
+        f|fetch)
+            fetch ${@};;
+        fm|fetch-merge|pull)
+            pull ${@};;
+        M|major)
+            new MAJOR ${@};;
+        m|minor)
+            new MINOR ${@};;
+        p|patch)
+            new PATCH ${@};;
+        v|version|-v|--version)
+            version;;
+        h|help|-h|--help)
+            help;;
+        *)
+            help
+            exit 1
+            ;;
+    esac
+}
+
+notary "${@:-}"

data/vendor/github.com/hpe-cloud-garage/git-notary/git-notary.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |gem|
+  gem.name     = 'git-notary'
+  gem.version  = `git describe --tags --abbrev=0`.chomp
+  gem.license  = 'MIT'
+  gem.author   = 'Chris Olstrom'
+  gem.email    = 'chris@olstrom.com'
+  gem.homepage = 'https://github.com/colstrom/git-notary'
+  gem.summary  = 'generates canonical version tags from versioning notes'
+  gem.files    = `git ls-files`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+end

data/vendor/github.com/hpe-cloud-garage/git-notary/hooks/pre-push/branch-has-notes

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+while read LOCAL_REF LOCAL_SHA REMOTE_REF REMOTE_SHA; do
+    if git-notary notes ${LOCAL_SHA} develop > /dev/null; then
+        BRANCH_HAS_NOTES=true
+    else
+        BRANCH_HAS_NOTES=false
+        break
+    fi
+done
+
+test ${BRANCH_HAS_NOTES} = true

data/vendor/github.com/hpe-cloud-garage/git-notary/hooks/pre-push/sync-notes

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -o errexit
+
+git-notary pull
+git-notary push

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: configgin
+version: !ruby/object:Gem::Version
+  version: 0.12.0.pre
+platform: ruby
+authors:
+- hpcloud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bosh-template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3262.24.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3262.24.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A simple cli app in Ruby to generate configurations using BOSH ERB templates
+  and a BOSH spec, but also using configurations based on environment variables, processed
+  using a set of templates.
+email: 
+executables:
+- configgin
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- Makefile
+- NOTICE
+- README.md
+- bin/configgin
+- bin/setup
+- configgin.gemspec
+- lib/cli.rb
+- lib/configgin.rb
+- lib/configgin/version.rb
+- lib/environment_config_transmogrifier.rb
+- lib/exceptions.rb
+- lib/generate.rb
+- make/include/darwin-support
+- make/include/versioning
+- make/lint
+- make/test
+- vendor/github.com/hpe-cloud-garage/git-notary/.gitignore
+- vendor/github.com/hpe-cloud-garage/git-notary/LICENSE.txt
+- vendor/github.com/hpe-cloud-garage/git-notary/README.org
+- vendor/github.com/hpe-cloud-garage/git-notary/bin/git-notary
+- vendor/github.com/hpe-cloud-garage/git-notary/git-notary.gemspec
+- vendor/github.com/hpe-cloud-garage/git-notary/hooks/pre-push/branch-has-notes
+- vendor/github.com/hpe-cloud-garage/git-notary/hooks/pre-push/sync-notes
+homepage: https://github.com/hpcloud/configgin
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A simple cli app in Ruby to generate configurations using BOSH ERB templates
+  and a BOSH spec.
+test_files: []