bbc-cosmos-tools 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1b3b62925024f13d3a5b7faae3e72eefa93f6dc
-  data.tar.gz: ffdad2cc037fcf0f7a80e0621a5e112866caf6bc
+  metadata.gz: 682aa789050e6b06223d07a9da105df6abdc966d
+  data.tar.gz: 2256eaa0c3a4c060fb26fdaa8fa637796602723c
 SHA512:
-  metadata.gz: 70676ba07d90b32de1b3d0e780f5bc505728c9e2668719b55e9aed3a61298b3f65077a907ff46ba8eb4c72003be0bb58671a836cf5439728e823fc60473f9b2f
-  data.tar.gz: cbb8ec4259306edc4f0269acca9b06173ccfb0c16d310057d19e9c512baf26c7729bbab071d2026fb4b0712c3e681fb7c35654861bed976eee37fa90c9728291
+  metadata.gz: 8cb7f2f87c0d45e710caa0fd6f85b887410927bd37570894cfbee4eb88d7bd8df4c2976a14bd2a5e05bb505b52e95a950ec5ea7192b55e9fdf81c22643264188
+  data.tar.gz: 9b4b400d1c6cd2da4bb81c22518dfb5ee8e80217a9b7f3879bbec47cd50edbce62bf9a0478c87131e4f60b37b9318b68150f1170d101565815b45a78ffa021cc

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in bbc-cosmos-config.gemspec
 gemspec

data/bbc-cosmos-tools.gemspec

@@ -8,12 +8,12 @@ Gem::Specification.new do |spec|
   spec.version       = BBC::Cosmos::Tools::VERSION
   spec.authors       = ["Steven Jack"]
   spec.email         = ["stevenmajack@gmail.com"]
-  spec.description   = %q{Tool for interacting with BBC Cosmos platform}
-  spec.summary       = %q{Tool for pusing config to cosmos and controlling cloudformation templates}
+  spec.description   = "Tool for interacting with BBC Cosmos platform"
+  spec.summary       = "Tool for pusing config to cosmos and controlling cloudformation templates"
   spec.homepage      = ""
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   << "bbc-cosmos-tools"
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "cfndsl"
-  spec.add_runtime_dependency "aws-sdk", "~> 1"
+  spec.add_runtime_dependency "aws-sdk", "~> 1.63.0"
+  spec.add_runtime_dependency "highline"
 end

data/bin/bbc-cosmos-tools

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 
-require 'pathname'
+require "pathname"
 
 root        = Pathname.new(__FILE__).dirname.parent
-lib_path    = (root + 'lib').realdirpath
+lib_path    = (root + "lib").realdirpath
 
 $LOAD_PATH.unshift(lib_path)
 
-require 'bbc/cosmos/tools/app'
+require "bbc/cosmos/tools/app"
 
 include BBC::Cosmos::Tools
 

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

@@ -1,18 +1,17 @@
-require 'pathname'
-require 'faraday'
-require 'openssl'
+require "pathname"
+require "faraday"
+require "openssl"
 
 module BBC
   module Cosmos
     module Tools
       class API
-
         def initialize(host, key_path)
           @connection = Faraday.new host, :ssl => {
             :client_key  => client_key(key_path),
             :client_cert => client_cert(key_path),
             :verify      => false,
-            :version     => 'TLSv1'
+            :version     => "TLSv1"
           }
         end
 
@@ -28,12 +27,12 @@ module BBC
           @connection.get path
         end
 
-        def put(path, payload, content_type = 'application/json')
+        def put(path, payload, content_type = "application/json")
           content_type_from content_type
           @connection.put path, payload
         end
 
-        def post(path, payload, content_type = 'application/json')
+        def post(path, payload, content_type = "application/json")
           content_type_from content_type
           @connection.post path, payload
         end
@@ -41,7 +40,6 @@ module BBC
         def content_type_from(type)
           @connection.headers[:content_type] = type
         end
-
       end
     end
   end

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

@@ -1,8 +1,8 @@
 require "thor"
-require 'bbc/cosmos/tools/commands/config'
-require 'bbc/cosmos/tools/commands/release'
-require 'bbc/cosmos/tools/commands/stack'
-require 'bbc/cosmos/tools/commands/component'
+require "bbc/cosmos/tools/commands/config"
+require "bbc/cosmos/tools/commands/release"
+require "bbc/cosmos/tools/commands/stack"
+require "bbc/cosmos/tools/commands/component"
 
 module BBC
   module Cosmos

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

@@ -1,20 +1,19 @@
-require 'cfndsl'
-require 'json'
+require "cfndsl"
+require "json"
 
 module BBC
   module Cosmos
     module Tools
       module Cloudformation
         class Generator
-
-          RESERVED_MAIN_STACK_PARAMS = ['Environment', 'PublicSubnet1Id', 'PublicSubnet2Id', 'PublicSubnet3Id', 'ImageId', 'VpcId', 'PrivateSubnet1Id', 'PrivateSubnet2Id', 'PrivateSubnet3Id', 'BastionAccessSecurityGroup', 'DomainNameBase', 'KeyName', 'S3BucketArn']
+          RESERVED_MAIN_STACK_PARAMS = %w(Environment PublicSubnet1Id PublicSubnet2Id PublicSubnet3Id ImageId VpcId PrivateSubnet1Id PrivateSubnet2Id PrivateSubnet3Id BastionAccessSecurityGroup DomainNameBase KeyName S3BucketArn)
 
           def self.component_exists?(component, config)
-            config.resources['cloudformation']['components'][component]
+            config.resources["cloudformation"]["components"][component]
           end
 
           def self.stack_exists?(component, config, stack)
-            config.resources['cloudformation']['components'][component][stack]
+            config.resources["cloudformation"]["components"][component][stack]
           end
 
           def self.create(component, config, options, to_json = false, &block)
@@ -22,28 +21,28 @@ module BBC
             template.declare(&block)
 
             if template.checkRefs || CfnDsl::Errors.errors?
-              self.raise_error template
+              raise_error template
             else
               hash = JSON.parse(template.to_json)
-              hash['Parameters'] ||= {}
+              hash["Parameters"] ||= {}
 
               if component_exists?(component, config) && stack_exists?(component, config, options[:stack])
                 component_parameters(config.resources, options, component).each do |key, value|
-                  hash['Parameters'][key]['Default'] = value if hash['Parameters'][key]
+                  hash["Parameters"][key]["Default"] = value if hash["Parameters"][key]
                 end
               end
 
-              hash.delete_if { |k, v| k == 'Parameters' && v == {} }
+              hash.delete_if { |k, v| k == "Parameters" && v == {} }
 
               to_json ? JSON.pretty_generate(hash) : hash
             end
           end
 
           def self.parameters(data, main_stack = true)
-            if data['Parameters']
-              data['Parameters'].reduce({}) do |object, (key, value)|
+            if data["Parameters"]
+              data["Parameters"].reduce({}) do |object, (key, value)|
                 object.tap do |o|
-                  o[key] = value['Default'] unless reserved_main_stack_param_for(key, main_stack) && value['Default'].nil?
+                  o[key] = value["Default"] unless reserved_main_stack_param_for(key, main_stack) && value["Default"].nil?
                 end
               end
             else
@@ -53,27 +52,27 @@ module BBC
 
           def self.raise_error(template)
             if CfnDsl::Errors.errors?
-              raise("Errors in template: #{CfnDsl::Errors.errors.join(' # ')}")
-            elsif (invalid_references = template.checkRefs())
-              raise("Invalid Refs: #{invalid_references.join(' # ')}")
+              fail("Errors in template: #{CfnDsl::Errors.errors.join(' # ')}")
+            elsif (invalid_references = template.checkRefs)
+              fail("Invalid Refs: #{invalid_references.join(' # ')}")
             end
           end
 
           private
 
           def self.component_stack_details(resources, options, component)
-            raise("cloudformation: -> components: node is missing from the environment resource file") unless resources.has_key?("cloudformation") && resources['cloudformation'].has_key?("components")
+            fail("cloudformation: -> components: node is missing from the environment resource file") unless resources.key?("cloudformation") && resources["cloudformation"].key?("components")
 
-            components = resources['cloudformation']['components']
-            raise("'#{component}' node missing from cloudformation: -> components: nodes") unless components.has_key?(component)
+            components = resources["cloudformation"]["components"]
+            fail("'#{component}' node missing from cloudformation: -> components: nodes") unless components.key?(component)
             component = components[component]
 
-            raise("'#{options[:stack]}' stack node missing from cloudformation: -> components: -> #{component}:") unless component.has_key?(options[:stack])
+            fail("'#{options[:stack]}' stack node missing from cloudformation: -> components: -> #{component}:") unless component.key?(options[:stack])
             component[options[:stack]]
           end
 
           def self.variants(component_meta, variant = nil)
-            component_meta.has_key?('variants') ? component_meta['variants'][variant] : component_meta.fetch('parameters', {})
+            component_meta.key?("variants") ? component_meta["variants"][variant] : component_meta.fetch("parameters", {})
           end
 
           def self.component_parameters(resources, options, component)
@@ -84,10 +83,8 @@ module BBC
           def self.reserved_main_stack_param_for(key, main_stack)
             main_stack && RESERVED_MAIN_STACK_PARAMS.include?(key)
           end
-
         end
       end
     end
   end
 end
-

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

@@ -1,6 +1,6 @@
 require "thor"
 require "pathname"
-require 'json'
+require "json"
 require "bbc/cosmos/tools/config"
 
 module BBC
@@ -14,10 +14,10 @@ module BBC
 
           package_name "BBC Cosmos config tool"
 
-          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 :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"
+          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"
 
           def initialize(args = [], local_options = {}, config = {})
             super(args, local_options, config)
@@ -33,7 +33,7 @@ module BBC
           def banner(component = nil)
             output = component.nil? ? "\n" : "\n#{get_key_value('Component', component)}\n"
             options.reduce(output) do |string, (key, value)|
-              string += "#{get_key_value(key.capitalize.gsub(/_/, " "), value)}\n"
+              string += "#{get_key_value(key.capitalize.gsub(/_/, ' '), value)}\n"
             end
           end
 
@@ -42,7 +42,7 @@ module BBC
           end
 
           def api_error(response, die = true)
-            error_message = JSON.parse(response.body)['message']
+            error_message = JSON.parse(response.body)["message"]
             error(error_message, die)
           end
 
@@ -66,18 +66,16 @@ module BBC
           private
 
           def setup_config
-            config_base = !options[:base].nil? && File.directory?(options[:base]) ? Pathname.new(options[:base]) : Pathname.pwd.join('.')
-            raise("Config directory: #{config_base} doesn't exist") unless File.directory?(config_base)
+            config_base = !options[:base].nil? && File.directory?(options[:base]) ? Pathname.new(options[:base]) : Pathname.pwd.join(".")
+            fail("Config directory: #{config_base} doesn't exist") unless File.directory?(config_base)
             @config = BBC::Cosmos::Tools::Config.new(
               config_base,
               options[:project],
               options[:env]
             )
           end
-
         end
       end
     end
   end
 end
-

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

@@ -1,13 +1,13 @@
 require "bbc/cosmos/tools/api"
 require "aws-sdk"
 require "json"
+require "highline/import"
 
 module BBC
   module Cosmos
     module Tools
       module Commands
         class Component < Base
-
           desc "instances <COMPONENT>", "Show instances of the given component"
           method_option :show_tag, :type => :string, :desc => "Show tag"
           def instances(component)
@@ -18,46 +18,106 @@ module BBC
             tag = options[:show_tag]
 
             rows = instance_ids(component).map do |id|
-              [id].tap { |row|
-                 row << ec2.instances[id].tags[tag] if tag
-              }
+              [id].tap do |row|
+                row << ec2.instances[id].tags[tag] if tag
+              end
             end
 
-            headers = ['Instance ID']
+            headers = ["Instance ID"]
             headers << tag if tag
 
             print_table build_table(headers, rows)
           end
 
+          desc "SSH <COMPONENT>", "Gain SSH"
+          def ssh(component)
+            meta = make_request("env/#{options[:env]}/component/#{component}/instances")
+
+            meta.count == 1 ? single_instance(component, meta)
+                            : multiple_instance(component, meta)
+          end
+
           private
+
+          def api
+            @api ||= BBC::Cosmos::Tools::API.new(
+              "https://api.live.bbc.co.uk", options[:key_path]
+            )
+          end
+
+          def single_instance(component, meta)
+            session(component, meta[0]["id"], meta[0]["private_ip_address"])
+          end
+
+          def multiple_instance(component, meta)
+            instance_id = select_instance(meta)
+            session(component, instance_id, extract_ipaddress(meta, instance_id))
+          end
+
+          def session(component, instance_id, ip_address)
+            post_data(component, instance_id)
+            output_message(component, ip_address, instance_id)
+          end
+
+          def select_instance(meta)
+            choose do |menu|
+              say "Multiple instances detected, please select one", :green
+
+              meta.map do |i|
+                menu.choice(i["id"].to_sym)
+              end
+            end.to_s
+          end
+
+          def extract_ipaddress(meta, instance)
+            meta.detect { |hash| hash.value?(instance) }.fetch("private_ip_address")
+          end
+
+          def output_message(component, ip, id)
+            say "SSH setup for #{component} on #{options[:env]}, your IP for #{id} is #{ip}", :green
+          end
+
+          def post_data(component, id)
+            post_data = { "instance_id" => id }
+
+            endpoint = "/cosmos/env/#{options[:env]}/component/#{component}/logins/create"
+            api.post(endpoint, post_data.to_json).tap do |response|
+              fail Exception, response.body if response.status != 201
+            end
+          end
+
+          def make_request(path)
+            JSON.parse(api.get("/cosmos/#{path}").tap do |request|
+              fail Exception, request.body if request.status != 200
+            end.body)
+          end
+
           def instance_ids(component)
             response = BBC::Cosmos::Tools::API.new(
-              config.app['api'],
+              config.app["api"],
               options[:key_path]
-            )
-            .get "/cosmos/env/#{options[:env]}/component/#{component}/instances"
+            ).get "/cosmos/env/#{options[:env]}/component/#{component}/instances"
 
-            raise Exception, response.body if response.status != 200
+            fail Exception, response.body if response.status != 200
 
-            JSON.parse(response.body).map { |instance|
+            JSON.parse(response.body).map do |instance|
               instance.fetch "id"
-            }
+            end
           end
 
           def aws_credentials
-           response = BBC::Cosmos::Tools::API.new(
-             "https://wormhole.cloud.bbc.co.uk",
-             options[:key_path]
-           )
-           .get "/login/credentials"
+            response = BBC::Cosmos::Tools::API.new(
+              "https://wormhole.cloud.bbc.co.uk",
+              options[:key_path]
+            ).get "/login/credentials"
 
-            raise Exception, response.body if response.status != 200
+            fail Exception, response.body if response.status != 200
 
             credentials = JSON.parse response.body
 
             { :access_key_id     => credentials["accessKeyId"],
-              :secret_access_key => credentials['secretAccessKey'],
-              :session_token     => credentials['sessionToken'],
+              :secret_access_key => credentials["secretAccessKey"],
+              :session_token     => credentials["sessionToken"],
               :region            => "eu-west-1" }
           end
         end

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

@@ -1,8 +1,8 @@
-require 'json'
-require 'pathname'
-require 'bbc/cosmos/tools/commands/base'
-require 'bbc/cosmos/tools/cosmos_configuration'
-require 'bbc/cosmos/tools/api'
+require "json"
+require "pathname"
+require "bbc/cosmos/tools/commands/base"
+require "bbc/cosmos/tools/cosmos_configuration"
+require "bbc/cosmos/tools/api"
 
 module BBC
   module Cosmos
@@ -22,12 +22,11 @@ module BBC
           method_option :cosmos_format, :type => :boolean, :desc => "Toogles if the output should be in the cosmos format"
           def generate(component)
             if options[:write]
-              File.open("#{component}.json", 'w') do |f|
+              File.open("#{component}.json", "w") do |f|
                 f.write(JSON.pretty_generate(cosmos_config.component(component)))
               end
             end
 
-
             if options[:output] == "machine"
               say JSON.pretty_generate(cosmos_config.cosmos_component(component)), :white
 
@@ -46,7 +45,6 @@ module BBC
             rescue Exception => e
               error e.message
             end
-
           end
 
           desc "config list", "Lists all components for a given project"
@@ -71,48 +69,41 @@ module BBC
             rescue Exception => e
               error e.message
             end
-
           end
 
           desc "config push [COMPONENT_ID = nil]", "Push config for a component to the cosmos API"
           method_option :force, :type => :boolean, :desc => "This skips asking of you want to push the changes"
           def push(component_id = nil)
-            begin
+            components = component_id.nil? ? cosmos_config.component_keys : [component_id]
+            say "#{banner}\n"
 
-              components = component_id.nil? ? cosmos_config.component_keys : [component_id]
-              say "#{banner}\n"
+            reply = yes?("Are you sure you want to push changes for #{components.length} components(s) to #{options[:env]}?", :yellow) unless options[:force]
+            if reply || reply.nil?
 
-              reply = yes?("Are you sure you want to push changes for #{components.length} components(s) to #{options[:env]}?", :yellow) unless options[:force]
-              if reply || reply.nil?
+              components.each do |id|
+                say "\n#{get_key_value('Component', id)}\n"
 
-                components.each do |id|
+                component_config = JSON.generate(cosmos_config.cosmos_component id)
 
-                  say "\n#{get_key_value('Component', id)}\n"
+                @api = BBC::Cosmos::Tools::API.new(config.app["api"], options[:key_path])
+                response = @api.put sprintf(config.app["config_endpoint"], options[:env], id), component_config
 
-                  component_config = JSON.generate(cosmos_config.cosmos_component id)
-
-                  @api = BBC::Cosmos::Tools::API.new(config.app['api'], options[:key_path])
-                  response = @api.put sprintf(config.app['config_endpoint'], options[:env], id), component_config
-
-                  if response.success?
-                    say 'Successfully saved', :green
-                  else
-                    api_error response
-                  end
+                if response.success?
+                  say "Successfully saved", :green
+                else
+                  api_error response
                 end
-
-              else
-                error 'Action cancelled'
               end
 
-            rescue Exception => e
-              error e.message
+            else
+              error "Action cancelled"
             end
-          end
 
+          rescue Exception => e
+            error e.message
+          end
         end
       end
     end
   end
 end
-