bbc-cosmos-tools 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f480d30ff3c7c874e62527ae5cc5a87e0dc33aba
-  data.tar.gz: 767d42b73f3de1212cecfff750efcfd43f1f2db7
+  metadata.gz: d312899466e33b1d4a65a7335be17846bd070f73
+  data.tar.gz: f83b250a15485d6d15ae407c4f3e2d11c89d484e
 SHA512:
-  metadata.gz: 462b70abdd71a6bdc81e3dd7658a0000cfdb9524ba131eae420279aeaf3e4dc1a6b68fd4291c06059c2f0c370d01116810f2a9e1f10023e0a37603b26444c64e
-  data.tar.gz: ea96eaaee94d9c15014caabd1a6ea4b501c1eaec6d821f4fefec8126b2b10bc0f1ae62cd4157e19bfd09d9749ba4ae0983797e83482e7329adfa64d64120de1b
+  metadata.gz: abe8c0da8cdf40c91c63df435b7e858bb304830f73a7ceac96b335b15cdb704328462a959fc35b5c7c55af53465381446211daa91be15cb27575b0fc2631ba9a
+  data.tar.gz: d1b54bb031dc796f72a6692c491da4a3906a0b926e278f335ff3a2aefeb8714771decd417645f9b627f4f3b6cc8ca6ca2e388c356cd010e1c36dffdef993e27b

data/README.md

@@ -159,7 +159,20 @@ bbc-cosmos-tools cf create
 bbc-cosmos-tools cf update
 ```
 
-On each command you can use `--help` at the end to see the list of parameters and options that need to be passed into the command.
+### Help?
+
+You can use the built-in `help` command to see a list of parameters and options that need to be passed into the command you wish to execute. For example, if we were unsure of the options for the `stack` command then we would execute `bbc-cosmos-tools help stack` and this would display the following output:
+
+```sh
+Commands:
+  bbc-cosmos-tools stack help [COMMAND]                          # Describe subcommands or one specific subco...
+  bbc-cosmos-tools stack create [COMPONENT, MAIN_STACK = false]  # Generates and create the cloudformation te...
+  bbc-cosmos-tools stack delete [COMPONENT]                      # Deletes a stack
+  bbc-cosmos-tools stack events [COMPONENT = nil]                # Shows the stack events for a component
+  bbc-cosmos-tools stack generate [COMPONENT]                    # Generates a cloudformation template based ...
+  bbc-cosmos-tools stack list [COMPONENT = nil]                  # Lists stacks for a component
+  bbc-cosmos-tools stack update [COMPONENT = nil]                # Generates and updates the cloudformation t...
+```
 
 ## Contributing
 

data/bin/bbc-cosmos-tools

@@ -4,11 +4,11 @@ require 'pathname'
 
 root        = Pathname.new(__FILE__).dirname.parent
 lib_path    = (root + 'lib').realdirpath
-config_path = root + 'configs'
 
 $LOAD_PATH.unshift(lib_path)
 
 require 'bbc/cosmos/tools/app'
+
 include BBC::Cosmos::Tools
 
 App.start

data/lib/bbc/cosmos/tools/cloudformation/generator.rb

@@ -16,11 +16,10 @@ module BBC
           end
 
           def self.create(component, config, options, to_json = false, &block)
-
             template = CfnDsl::CloudFormationTemplate.new
             template.declare(&block)
 
-            if template.checkRefs() || CfnDsl::Errors.errors?
+            if template.checkRefs || CfnDsl::Errors.errors?
               self.raise_error template
             else
               hash = JSON.parse(template.to_json)
@@ -33,12 +32,11 @@ module BBC
 
               to_json ? JSON.pretty_generate(hash) : hash
             end
-
           end
 
           def self.parameters(data)
             if data['Parameters']
-              parameters = data['Parameters'].reduce({}) do |object, (key, value)|
+              data['Parameters'].reduce({}) do |object, (key, value)|
                 object.tap { |o| o[key] = value['Default'] }
               end
             else

data/lib/bbc/cosmos/tools/commands/base.rb

@@ -14,7 +14,7 @@ module BBC
 
           package_name "BBC Cosmos config tool"
 
-          class_option :key_path, :type => :string, :default => ENV['DEV_CERT_PATH'], :desc => "The path to your dev cert, by default the value of the env variable $DEV_CERT_PATH is used"
+          class_option :key_path, :type => :string, :default => ENV['BBC_COSMOS_TOOLS_CERT'], :desc => "The path to your dev cert, by default the value of the env variable $BBC_COSMOS_TOOLS_CERT is used"
           class_option :env, :type => :string, :default => 'int', :desc => "The environment to target"
           class_option :base, :type => :string, :desc => "The base path for the configs repo"
           class_option :project, :type => :string, :default => ENV['BBC_COSMOS_TOOLS_PROJECT'], :desc => "The name of the project, by default the value of the env variable $BBC_COSMOS_TOOLS_PROJECT is used"

data/lib/bbc/cosmos/tools/commands/stack.rb

@@ -1,6 +1,8 @@
+require "json"
 require "bbc/cosmos/tools/config"
 require 'bbc/cosmos/tools/commands/base'
 require 'bbc/cosmos/tools/cloudformation/generator'
+require "bbc/cosmos/tools/types/factory"
 
 module BBC
   module Cosmos
@@ -10,9 +12,17 @@ module BBC
           attr_accessor :api
 
           class_option :stack, :type => :string, :default => 'main', :desc => "The name of the stack to use"
+          class_option :type, :type => :string, :default => 'cfndsl', :desc => "The format of your your CloudFormation (default is cfndsl, but can also be json or yaml)", :enum => ["cfndsl", "json", "yaml"]
 
           def initialize(args = [], local_options = {}, thor_config = {})
             super(args, local_options, thor_config)
+
+            @l = -> data, component, environment do
+              if data['Parameters'] && data['Parameters']['ImageId']
+                data['Parameters']['ImageId']['Default'] = latest_ami_for(component, environment)
+              end
+            end
+
             @api = BBC::Cosmos::Tools::API.new(config.app['api'], options[:key_path])
           end
 
@@ -57,7 +67,13 @@ module BBC
           def generate(component)
 
             say "#{banner(component)}\n"
-            say cloudformation(component, options), :white
+
+            type = Tools::Types::Factory.create(component, options, config)
+            data = type.generate_data.tap do |d|
+              @l.(d, component, options[:env])
+            end
+
+            say data, :white
 
           end
 
@@ -72,7 +88,10 @@ module BBC
               components(options, component).each do |id|
                 say get_key_value("\nComponent", id)
 
-                data = cloudformation(id, options, false)
+                type = Tools::Types::Factory.create(id, options, config)
+                data = type.generate_data.tap do |d|
+                  @l.(d, id, options[:env])
+                end
 
                 post_data = {
                   'name_suffix'   => options[:stack],
@@ -106,11 +125,17 @@ module BBC
               say get_key_value("\nComponent", id)
 
               stack_name = "#{options[:env]}-#{id}-#{options[:stack]}"
-              data = cloudformation(id, options, false)
+
+              type = Tools::Types::Factory.create(id, options, config)
+              data = type.generate_data.tap do |d|
+                @l.(d, id, options[:env])
+              end
+
+              params = Tools::Cloudformation::Generator.parameters(data)
 
               post_data = {
                 'template'    => data,
-                'parameters'  => Tools::Cloudformation::Generator.parameters(data)
+                'parameters'  => params
               }
 
               response = api.post sprintf(config.app['stack_update_endpoint'], options[:env], id, stack_name), JSON.pretty_generate(post_data)
@@ -187,20 +212,6 @@ module BBC
             api_error response unless response.success?
             JSON.parse(response.body).first['image']['ami_id']
           end
-
-          def cloudformation(component, options, to_json = true)
-            config_data = config
-
-            Tools::Cloudformation::Generator.create(component, config, options, to_json) do
-              component_identifier = options[:group].nil? ? component : options[:group]
-              instance_eval config_data.cf_templates(component_identifier, options[:stack])
-            end.tap do |data|
-              if data['Parameters'] && data['Parameters']['ImageId']
-                data['Parameters']['ImageId']['Default'] = latest_ami_for(component, options[:env])
-              end
-
-            end
-          end
         end
       end
     end

data/lib/bbc/cosmos/tools/types/base_type.rb

@@ -0,0 +1,47 @@
+require "bbc/cosmos/tools/cloudformation/generator"
+
+module BBC
+  module Cosmos
+    module Tools
+      module Types
+        class BaseType
+          def initialize(id, options, config)
+            @id      = id
+            @options = options
+            @config  = config
+          end
+
+          def generate_data
+            if valid_component_and_stack
+              get_parameters.each do |key, value|
+                data['Parameters'][key]['Default'] = value if data['Parameters'][key]
+              end
+              data
+            end
+          end
+
+          protected
+
+          def data
+            raise NotImplementedError
+          end
+
+          def construct_file_path type
+            File.join(@config.base_path, 'stacks', @id, "#{@options[:stack]}.#{type}")
+          end
+
+          private
+
+          def valid_component_and_stack
+            Tools::Cloudformation::Generator.component_exists?(@id, @config) &&
+            Tools::Cloudformation::Generator.stack_exists?(@id, @config, @options[:stack])
+          end
+
+          def get_parameters
+            @config.resources['cloudformation']['components'][@id][@options[:stack]]['variants'][@options[:variant]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/types/cfndsl.rb

@@ -0,0 +1,32 @@
+require "bbc/cosmos/tools/cloudformation/generator"
+
+module BBC
+  module Cosmos
+    module Tools
+      module Types
+        class Cfndsl
+          def initialize(id, options, config)
+            @id      = id
+            @options = options
+            @config  = config
+          end
+
+          def generate_data
+            to_json = false
+
+            # Because the block is evaluated in the context of another class
+            # i.e. instance_eval &block
+            # we need to store off the values first and *then* reference them inside the block
+            component_identifier = @options[:group].nil? ? @id : @options[:group]
+            config = @config
+            stack = @options[:stack]
+
+            Tools::Cloudformation::Generator.create(@id, @config, @options, to_json) {
+              instance_eval config.cf_templates(component_identifier, stack)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/types/factory.rb

@@ -0,0 +1,17 @@
+require "bbc/cosmos/tools/types/yaml"
+require "bbc/cosmos/tools/types/json"
+require "bbc/cosmos/tools/types/cfndsl"
+
+module BBC
+  module Cosmos
+    module Tools
+      module Types
+        class Factory
+          def self.create(id, options, config)
+            BBC::Cosmos::Tools::Types.const_get(options[:type].capitalize).new(id, options, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/types/json.rb

@@ -0,0 +1,18 @@
+require "json"
+require "bbc/cosmos/tools/types/base_type"
+
+module BBC
+  module Cosmos
+    module Tools
+      module Types
+        class Json < BaseType
+          protected
+
+          def data
+            JSON.parse(IO.read(construct_file_path "json"))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/types/yaml.rb

@@ -0,0 +1,17 @@
+require "bbc/cosmos/tools/types/base_type"
+
+module BBC
+  module Cosmos
+    module Tools
+      module Types
+        class Yaml < BaseType
+          protected
+
+          def data
+            YAML.load_file(construct_file_path "yaml")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbc/cosmos/tools/version.rb

@@ -1,7 +1,7 @@
 module BBC
   module Cosmos
     module Tools
-        VERSION = "0.3.1"
+        VERSION = "0.4.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bbc-cosmos-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Steven Jack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,11 @@ files:
 - lib/bbc/cosmos/tools/commands/stack.rb
 - lib/bbc/cosmos/tools/config.rb
 - lib/bbc/cosmos/tools/cosmos_configuration.rb
+- lib/bbc/cosmos/tools/types/base_type.rb
+- lib/bbc/cosmos/tools/types/cfndsl.rb
+- lib/bbc/cosmos/tools/types/factory.rb
+- lib/bbc/cosmos/tools/types/json.rb
+- lib/bbc/cosmos/tools/types/yaml.rb
 - lib/bbc/cosmos/tools/version.rb
 homepage: ''
 licenses: