sfn-parameters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60f94bc12df681811d673ed12d335b649d8afe34
+  data.tar.gz: ab2b0af5c83b21878b6414f3d94321cc56811932
+SHA512:
+  metadata.gz: e742bb6759120d042aaf41b15beb3d834bd47a602480efcdad6e72731339fcb8559ed6c9acd81094343532436d01c3af22b983985efcea515e58b1b5bbee1737
+  data.tar.gz: 38afc7bef28db6ab7a29e7ca7a81a8af5a81d2d7dd9e7c74d9daaedf4fa79d481f3c11db935209328ac060b58d8e767ebd1e3189b43c8b6f424bad80a54b8c2e

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial release

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2015 Heavy Water Operations LLC.
+
+   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,107 @@
+# SparkleFormation Parameters Callback
+
+Provides automatic assignment of stack parameter information.
+Currently supported workflows:
+
+* Infrastructure Mode
+
+## Usage
+
+### Infrastructure Mode
+
+Infrastructure mode assumes a single template which describes
+an entire infrastructure (generally via nested templates). A
+configuration file can provide all information required for the
+root stack, as well as all descendant stacks.
+
+#### Enable
+
+The `sfn-parameters` callback is configured via the `.sfn`
+configuration file. First the callback must be enabled:
+
+~~~ruby
+Configuration.new do
+  callbacks do
+    require ['sfn-parameters']
+    default ['parameters_infrastructure']
+  end
+end
+~~~
+
+#### Configure
+
+Some optional configuration is available via the `.sfn` file
+to control the behavior of the callback:
+
+~~~ruby
+Configuration.new do
+  sfn_parameters do
+    directory 'infrastructure'
+    destination 'default'
+  end
+end
+~~~
+
+* `directory` - Relative path from repository root to directory containing configuration files
+* `destination` - Name of file holding configuration minus the extension
+
+#### Functionality
+
+One file will contain the configuration information required
+for the stack operation (create/update). The location of this
+file is generated using the configuration values provided
+above. Using the default values used in the example above, the
+file will be expected at:
+
+~~~
+REPO_ROOT/infrastructure/default.{rb,xml,json,yaml,yml}
+~~~
+
+The contents of the file will be processed using the bogo-config
+library. This allows defining the file in a serialization format
+(JSON, YAML, XML) or as a Ruby file.
+
+#### File format
+
+The basic structure of the file in JSON:
+
+~~~json
+{
+  "parameters": {},
+  "compile_parameters": {},
+  "apply_stacks": [],
+  "stacks": {}
+}
+~~~
+
+Break down of the keys:
+
+* `parameters` - Run time parameters sent to the orchestration API
+* `compile_parameters` - Compile time parameters used to generate the template
+* `apply_stacks` - List of stacks whose outputs should be applied
+* `stacks`- Nested stack information
+
+##### Example
+
+~~~json
+{
+  "parameters": {
+    "stack_creator": "chris"
+  },
+  "apply_stacks": [
+    "networking"
+  ],
+  "stacks": {
+    "compute_stack": {
+      "parameters": {
+        "ssh_key": "default"
+      }
+    }
+  }
+}
+~~~
+
+# Info
+
+* Repository: https://github.com/sparkleformation/sfn-parameters
+* IRC: Freenode @ #sparkleformation

data/lib/sfn-parameters/infrastructure.rb

@@ -0,0 +1,70 @@
+require 'sfn-parameters'
+
+module Sfn
+  class Callback
+    # Auto load stack parameters for infrastructure pattern
+    class ParametersInfrastructure < Callback
+
+      # Valid file extensions for configuration file
+      VALID_EXTENSIONS = ['.rb', '.xml', '.json', '.yaml', '.yml']
+
+      # Update configuration after configuration is loaded
+      #
+      # @return [NilClass]
+      def after_config_update(*_)
+        config[:parameters] ||= Smash.new
+        config[:compile_parameters] ||= Smash.new
+        config[:apply_stack] ||= []
+        stack_name = arguments.first
+        content = load_file_for(stack_name)
+        process_information_hash(content, [])
+        nil
+      end
+      alias_method :after_config_create, :after_config_update
+
+      protected
+
+      # Load the configuration file
+      #
+      # @param stack_name [String]
+      # @return [Smash]
+      def load_file_for(stack_name)
+        root_path = config.fetch(:sfn_parameters, :directory, 'infrastructure')
+        isolation_name = config.fetch(:sfn_parameters, :destination,
+          ENV.fetch('SFN_PARAMETERS_DESTINATION', 'default')
+        )
+        paths = Dir.glob(File.join(root_path, "#{isolation_name}{#{VALID_EXTENSIONS.join(',')}}")).map(&:to_s)
+        if(paths.size > 1)
+          raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(', ')})"
+        elsif(paths.empty?)
+          raise ArgumentError.new 'No parameter file matches found!'
+        end
+        Bogo::Config.new(paths.first).data
+      end
+
+      # Process the given hash and set configuration values
+      #
+      # @param hash [Hash]
+      # @param path [Array<String>] stack name hierarchy
+      # @return [TrueClass]
+      def process_information_hash(hash, path=[])
+        hash.fetch(:parameters, {}).each do |key, value|
+          key = [*path, Bogo::Utility.camel(key)].compact.map(&:to_s).join('_')
+          config[:parameters][key] = value
+        end
+        hash.fetch(:compile_parameters, {}).each do |key, value|
+          key = [*path, Bogo::Utility.camel(key)].compact.map(&:to_s).join('_')
+          config[:compile_parameters][key] = value
+        end
+        hash.fetch(:stacks, {}).each do |key, value|
+          process_information_hash(value, [*path, Bogo::Utility.camel(key)].compact)
+        end
+        hash.fetch(:apply_stacks, []).each do |s_name|
+          config[:apply_stack] << s_name
+        end
+        true
+      end
+
+    end
+  end
+end

data/lib/sfn-parameters/version.rb

@@ -0,0 +1,3 @@
+module SfnParameters
+  VERSION = Gem::Version.new('0.1.0')
+end

data/lib/sfn-parameters.rb

@@ -0,0 +1,3 @@
+require 'sfn-parameters/version'
+require 'sfn-parameters/infrastructure'
+#require 'sfn-parameters/single-stack'

data/sfn-parameters.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'sfn-parameters/version'
+Gem::Specification.new do |s|
+  s.name = 'sfn-parameters'
+  s.version = SfnParameters::VERSION.version
+  s.summary = 'SparkleFormation Parameters Callback'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'http://github.com/sparkleformation/sfn-parameters'
+  s.description = 'SparkleFormation Parameters Callback'
+  s.license = 'Apache-2.0'
+  s.require_path = 'lib'
+  s.add_dependency 'sfn', '>= 1.0.0', '< 2.0'
+  s.files = Dir['{lib,bin,docs}/**/*'] + %w(sfn-parameters.gemspec README.md CHANGELOG.md LICENSE)
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: sfn-parameters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sfn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: SparkleFormation Parameters Callback
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sfn-parameters.rb
+- lib/sfn-parameters/infrastructure.rb
+- lib/sfn-parameters/version.rb
+- sfn-parameters.gemspec
+homepage: http://github.com/sparkleformation/sfn-parameters
+licenses:
+- Apache-2.0
+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.8
+signing_key: 
+specification_version: 4
+summary: SparkleFormation Parameters Callback
+test_files: []
+has_rdoc: