bcome 1.3.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4e26f496e3b1756df2ee8a288a02c8ca9746f975
-  data.tar.gz: f241fbbcc02373d2071b846a1082a97eb5375a78
+SHA256:
+  metadata.gz: c27e993a1ebc7cb838f3f13927f85ef715aecf18ccebd03c54fb9d6ccb782728
+  data.tar.gz: cfc4d0618d32554c00b0d1c6bd20932cb56bd762fce87504386519db81072bf9
 SHA512:
-  metadata.gz: 0e1d58cf79db6fa814f733963ac851c4e16bce7f0f22ee6dc10139ee1164b99d84f0eae7253a01cdc8912866fd9b032f3e34fddd0d3ebf493f6d55b2c0446220
-  data.tar.gz: 6da1f5d5bda08ba8a17099a5e3f1848fd01934ed27f21bad1d7dbeed993368766ee7fd659b21ec4927993d89d975c29ee75dfdeb587b63ababef2328bb342559
+  metadata.gz: a36e1a6d0b76cb4b1a4dbfac6ce34da68eb07217a190495cea4fd5904ac1b0d6f7f30c5c7ea4b02fcbb68958d4f6472b33fb3e35f6ce5d873484e6afbcfd6434
+  data.tar.gz: b37ee3c185cf7914efb462bbb4279e92255bd711e2283a48ff4a9d40c646d9a7365afd1cdfc5b665f04127087bf7d6fd72d46e610ebad228cc3fd0e996590134

data/bin/bcome

@@ -1,15 +1,20 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bcome'
 
-begin
-  spawn_into_console = true
-  arguments = ARGV - [ARGV[0]]
-  ::Bcome::Bootup.set_and_do({ breadcrumbs: ARGV[0], arguments: arguments }, spawn_into_console)
+breadcrumbs = ARGV[0]
+arguments = ARGV - [ARGV[0]]
+handler = ::Bcome::Startup.new(breadcrumbs, arguments)
 
-  # close any trailing connections
-  Bcome::Bootup.instance.estate.close_ssh_connections
+trap('SIGINT') do
+  handler.stop_loading_bars
+end
 
-rescue ::Bcome::Exception::Base
-  puts "bcome terminated unexpectedly".warning
+trap('INT') do
+  handler.stop_loading_bars
 end
+
+Thread.report_on_exception = false
+
+handler.do

data/lib/bcome.rb

@@ -1,17 +1,14 @@
+# frozen_string_literal: true
+
 require 'irb'
-require 'irb/completion'
-require 'rainbow'
-require 'net/scp'
-require 'net/ssh/proxy/command'
-require 'fog/aws'
-require 'require_all'
-require 'pmap'
-require 'singleton'
 require 'active_support'
 require 'active_support/core_ext'
-require 'pp'
-require 'awesome_print'
-require 'io/console'
+require 'pmap'
+require 'singleton'
+require 'require_all'
+require 'tty-cursor'
+require 'strings-ansi'
+require 'pry'
 
 require_all "#{File.dirname(__FILE__)}/../patches"
 require_all "#{File.dirname(__FILE__)}/../lib/objects"
@@ -19,3 +16,9 @@ require_all "#{File.dirname(__FILE__)}/../lib/objects"
 # Load in any user defined orchestration
 path_to_bcome_orchestration_configs = "#{Dir.getwd}/bcome/orchestration"
 require_all path_to_bcome_orchestration_configs if File.directory?(path_to_bcome_orchestration_configs)
+
+# Load in any patches
+# Note: previously patches could have (and were placed) anywhere in the orchestration directory above. This just makes it more explicit, and keeps
+# things tidier.
+path_to_user_monkey_patches = "#{Dir.getwd}/bcome/patches"
+require_all path_to_user_monkey_patches if File.directory?(path_to_user_monkey_patches)

data/lib/objects/bcome/version.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
 module Bcome
-  VERSION = '1.3.4'.freeze
+  module Version
+    def self.name
+      'bcome'
+    end
+
+    def self.release
+      '2.0.1'
+    end
+
+    def self.release_name
+      'Multicloud & Hybrid'
+    end
+
+    def self.display
+      "#{name} v#{release} - #{release_name}"
+    end
+  end
 end

data/lib/objects/bootup.rb

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
+
 module Bcome
   class Bootup
     def self.set_and_do(params, spawn_into_console = true)
       instance.set(params, spawn_into_console)
       instance.do
-    rescue Bcome::Exception::Base => e
-      puts e.pretty_display
-    rescue Excon::Error::Socket => e
-      puts "\nNo network access - please check your connection and try again\n".red
     end
 
     def self.traverse(breadcrumbs = nil, _spawn_into_console = false)
@@ -31,7 +29,7 @@ module Bcome
 
     def init_context(context)
       if @spawn_into_console
-        ::Bcome::Workspace.instance.set(context: context)
+        ::Bcome::Workspace.instance.set(context: context, show_welcome: true)
       else
         context
       end
@@ -45,17 +43,18 @@ module Bcome
         starting_context.load_nodes if starting_context.inventory? && !starting_context.nodes_loaded?
 
         # Attempt to load our next context resource
-        next_context = starting_context.resource_for_identifier(crumb)
+        next_context = starting_context.resources.active.first if crumb == 'first'
+        next_context ||= starting_context.resource_for_identifier(crumb)
 
         # Our current breadcrumb is not a node, and so we'll attempt to invoke a method call on the previous
         # e.g. given resource:foo, then invoke 'foo' on 'resource'
         unless next_context
+          puts "\n" # clean any trailing loading bars
           starting_context.invoke(crumb, @arguments)
           return
         end
         starting_context = next_context
       end
-
       # Set our workspace to our last context - we're not invoking a method call and so we're entering a console session
       init_context(starting_context)
     end
@@ -64,6 +63,16 @@ module Bcome
       @estate ||= ::Bcome::Node::Factory.instance.init_tree
     end
 
+    def estate_loaded?
+      !@estate.nil?
+    end
+
+    def close_ssh_connections
+      return unless estate_loaded?
+
+      estate.close_ssh_connections
+    end
+
     def parser
       ::Bcome::Parser::BreadCrumb.new(@breadcrumbs)
     end

data/lib/objects/command/local.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module Bcome::Command

data/lib/objects/config_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Bcome::ConfigFactory
   attr_reader :tree
 
@@ -31,6 +33,7 @@ class Bcome::ConfigFactory
 
   def hash_for_identifier_from_view(identifier, views)
     raise Bcome::Exception::InventoriesCannotHaveSubViews, 'Inventories cannot hold other inventories - invalid network config' unless views.key?(:views)
+
     views[:views].select { |v| v[:identifier].to_s == identifier.to_s }.first
   end
 end

data/lib/objects/driver/base.rb

@@ -1,30 +1,76 @@
+# frozen_string_literal: true
+
 module Bcome::Driver
   class Base
     class << self
-      def create_from_config(config)
+      def create_from_config(config, node)
         raise Bcome::Exception::InvalidNetworkDriverType, 'Your network configurtion is invalid' unless config.is_a?(Hash)
-        raise Bcome::Exception::InvalidNetworkDriverType, "Missing config parameter 'type'" unless config[:type]
+        raise Bcome::Exception::InvalidNetworkDriverType, "Missing config parameter 'type' for namespace '#{config.inspect}'" unless config[:type]
+
         config_klass_key = config[:type].to_sym
         driver_klass = klass_for_type[config_klass_key]
         raise Bcome::Exception::InvalidNetworkDriverType, config unless driver_klass
-        driver = driver_klass.new(config)
+
+        driver = driver_klass.new(config, node)
         driver
       end
 
       def klass_for_type
         {
-          static: ::Bcome::Driver::Static,
-          ec2: ::Bcome::Driver::Ec2
+          ec2: ::Bcome::Driver::Ec2,
+          gcp: ::Bcome::Driver::Gcp
         }
       end
     end
 
-    def initialize(params)
+    include ::Bcome::LoadingBar::Handler
+
+    def initialize(params, node)
       @params = params
+      @node = node
+    end
+
+    def has_network_credentials?
+      false
+    end
+
+    def loader_title
+      'Loading' + "\s#{pretty_provider_name.bc_blue.bold}\s#{pretty_resource_location.underline}".bc_green
+    end
+
+    def loader_completed_title
+      'done'
+    end
+
+    def pretty_provider_name
+      raise 'Should be overriden'
+    end
+
+    def pretty_resource_location
+      raise 'Should be overidden'
+    end
+
+    def network_credentials
+      raise 'Should be overidden'
     end
 
     def config
       @params
     end
+
+    ## Spoof-fetch. Used with the network-socket linkup POC.
+    def spoof_fetch_server_list(monkey_patched_inventory)
+      if @node.nodes_loaded?
+        monkey_patched_inventory.set_static_servers
+      else
+        wrap_indicator type: :basic, title: loader_title, completed_title: loader_completed_title do
+          fake_delay_milliseconds = rand(1..400).to_f / 1000
+          sleep fake_delay_milliseconds
+          monkey_patched_inventory.set_static_servers
+          signal_success
+        end
+        @node.nodes_loaded!
+      end
+    end
   end
 end

data/lib/objects/driver/bucket.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bcome::Driver
   class Bucket
     include Singleton
@@ -6,13 +8,13 @@ module Bcome::Driver
       @drivers = []
     end
 
-    def driver_for_network_data(network_data)
+    def driver_for_network_data(network_data, node)
       found_driver = @drivers.select { |driver| driver.config == network_data }.first
-      found_driver ? found_driver : create_network_driver(network_data)
+      found_driver || create_network_driver(network_data, node)
     end
 
-    def create_network_driver(network_data)
-      driver = ::Bcome::Driver::Base.create_from_config(network_data)
+    def create_network_driver(network_data, node)
+      driver = ::Bcome::Driver::Base.create_from_config(network_data, node)
       @drivers << driver
       driver
     end

data/lib/objects/driver/ec2.rb

@@ -1,20 +1,48 @@
+# frozen_string_literal: true
+
+require 'fog/aws'
+
 module Bcome::Driver
   class Ec2 < Bcome::Driver::Base
-  
-    PATH_TO_FOG_CREDENTIALS = "#{ENV['HOME']}/.fog".freeze
+    PATH_TO_FOG_CREDENTIALS = '.aws/keys'
 
     def initialize(*params)
       super
       raise Bcome::Exception::Ec2DriverMissingProvisioningRegion, params.inspect unless provisioning_region
+      raise ::Bcome::Exception::Ec2DriverMissingAuthorizationKeys, PATH_TO_FOG_CREDENTIALS unless File.exist?(PATH_TO_FOG_CREDENTIALS)
+
+      ENV['FOG_RC'] = PATH_TO_FOG_CREDENTIALS
+    end
+
+    def pretty_provider_name
+      'EC2'
+    end
+
+    def pretty_resource_location
+      @node.network_data[:provisioning_region]
     end
 
     def fog_client
       @fog_client ||= get_fog_client
     end
 
-    def fetch_server_list(filters)
-      servers = unfiltered_server_list.all(filters)
-      servers
+    def fetch_server_list(legacy_ec2_filters)
+      # Filters should be defined within a namespace's :network element. Pre 2.0 the expection for AWS was
+      # to define filters at the root level of the namespace. Here we move :filters into :network, yet retain
+      # ec2_filters at the root level for backwards compaibility with pre 2.0 versions.
+      filters = config.key?(:filters) ? config[:filters] : legacy_ec2_filters
+
+      wrap_indicator type: :basic, title: loader_title, completed_title: loader_completed_title do
+        begin
+          @servers = unfiltered_server_list.all(filters)
+          signal_success
+        rescue Exception => e
+          signal_failure
+          raise e
+        end
+      end
+
+      @servers
     end
 
     def unfiltered_server_list
@@ -25,6 +53,17 @@ module Bcome::Driver
       fog_client.servers.all({})
     end
 
+    def has_network_credentials?
+      true
+    end
+
+    def network_credentials
+      {
+        access_key: raw_fog_credentials['aws_access_key_id'],
+        secret_key: raw_fog_credentials['aws_secret_access_key']
+      }
+    end
+
     def raw_fog_credentials
       @raw_fog_credentials ||= YAML.load_file(PATH_TO_FOG_CREDENTIALS)[credentials_key]
     end
@@ -41,6 +80,7 @@ module Bcome::Driver
 
     def get_fog_client
       ::Fog.credential = credentials_key
+
       client = ::Fog::Compute.new(
         provider: 'AWS',
         region: provisioning_region

data/lib/objects/driver/gcp.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'google/apis/compute_beta'
+
+module Bcome::Driver
+  class Gcp < Bcome::Driver::Base
+    APPLICATION_NAME = 'Bcome console'
+
+    def initialize(*params)
+      super
+      validate_service_scopes
+      validate_authentication_scheme
+    end
+
+    def pretty_provider_name
+      'GCP'
+    end
+
+    def pretty_resource_location
+      "#{@params[:project]}/#{@params[:zone]}"
+    end
+
+    def fetch_server_list(_filters)
+      unless authentication_scheme.authorized?
+        get_authenticated_gcp_service
+        raise ::Bcome::Exception::Generic, 'GCP authentication process failed' unless authentication_scheme.authorized?
+      end
+
+      wrap_indicator type: :basic, title: loader_title, completed_title: loader_completed_title do
+        begin
+          @instances = do_fetch_server_list(_filters)
+          signal_success
+        rescue Exception => e
+          signal_failure
+          raise e
+        end
+      end
+      @instances.items
+    end
+
+    def do_fetch_server_list(_filters)
+      # Network filter key now called :filter. retained :list_filter for backwards compatibility.
+      # Fallback is ""
+      filters = (
+        @params[:filters] || (
+          @params[:list_filter] || ''
+        )
+      )
+
+      gcp_service.list_instances(@params[:project], @params[:zone], filter: filters)
+    rescue Google::Apis::AuthorizationError => e
+      raise ::Bcome::Exception::CannotAuthenticateToGcp
+    rescue Google::Apis::ClientError => e
+      raise ::Bcome::Exception::Generic, "Namespace #{@node.namespace} / #{e.message}"
+    rescue Google::Apis::TransmissionError => e
+      raise ::Bcome::Exception::Generic, 'Cannot reach GCP - do you have an internet connection?'
+    end
+
+    def has_network_credentials?
+      true
+    end
+
+    def network_credentials
+      {
+        access_token: access_token,
+        project_name: @params[:project]
+      }
+    end
+
+    protected
+
+    def validate_authentication_scheme
+      raise ::Bcome::Exception::MissingGcpAuthenticationScheme, "node #{@node.namespace}" if @params[:authentication_scheme].nil? || @params[:authentication_scheme].empty?
+      raise ::Bcome::Exception::InvalidGcpAuthenticationScheme, "Invalid GCP authentication scheme '#{@params[:authentication_scheme]}' for node #{@node.namespace}" unless auth_scheme
+    end
+
+    def invalid_auth_scheme?
+      !auth_schemes.keys.include?(@params[:authentication_scheme].to_sym)
+    end
+
+    def auth_scheme
+      auth_schemes[@params[:authentication_scheme].to_sym]
+    end
+
+    def auth_schemes
+      {
+        oauth: ::Bcome::Driver::Gcp::Authentication::Oauth,
+        service_account: ::Bcome::Driver::Gcp::Authentication::ServiceAccount
+        # api_key: ::Bcome::Driver::Gcp::Authentication::ApiKey
+      }
+    end
+
+    def compute_service
+      @compute_service ||= ::Google::Apis::ComputeBeta::ComputeService.new
+    end
+
+    def get_authenticated_gcp_service
+      authentication_scheme.do!
+      compute_service
+    end
+
+    def authentication_scheme
+      # Service scopes are specified directly from the network config
+      # A minumum scope of https://www.googleapis.com/auth/compute.readonly is required in order to list resources.
+
+      auth_scheme_key = @params[:authentication_scheme].to_sym
+      auth_scheme = auth_schemes[auth_scheme_key]
+      raise ::Bcome::Exception::InvalidGcpAuthenticationScheme, "Invalid GCP authentication scheme '#{auth_scheme_key}' for node #{@node.namespace}" unless auth_scheme
+
+      case auth_scheme_key
+      when :oauth
+
+        client_config = ::Bcome::Driver::Gcp::Authentication::OauthClientConfig.new(service_scopes, oauth_filename)
+
+        # Prevent second oauth flow during same session with same credentials, different inventory.
+        # If we already have an outh authentication scheme for the same scopes & oauth credentials, then we'll return that one
+
+        # If the scheme is set, return it
+        return @authentication_scheme if @authentication_scheme
+
+        # Look to see if we have an existing oauth scheme setup for the same scopes & credentials file
+        if @authentication_scheme = ::Bcome::Driver::Gcp::Authentication::OauthSessionStore.instance.in_memory_session_for(client_config)
+          @compute_service = @authentication_scheme.service
+
+          return @authentication_scheme
+        end
+
+        # Otherwise, we'll create a new outh scheme and register it with the session store
+        @authentication_scheme = auth_scheme.new(self, compute_service, client_config, @node)
+        ::Bcome::Driver::Gcp::Authentication::OauthSessionStore.instance << @authentication_scheme
+        @authentication_scheme
+
+      when :service_account
+        @authentication_scheme ||= auth_scheme.new(compute_service, service_scopes, @node, @params[:service_account_credentials], self)
+      else
+        raise ::Bcome::Exception::InvalidGcpAuthenticationScheme, "Invalid GCP authentication scheme '#{auth_scheme_key}' for node #{@node.namespace}"
+      end
+    end
+
+    def oauth_filename
+      @params[:secrets_path] || @params[:secrets_filename]
+    end
+
+    def gcp_service
+      @gcp_service ||= get_authenticated_gcp_service
+    end
+
+    def access_token
+      gcp_service.authorization.access_token
+    end
+
+    def authorization
+      gcp_service.authorization
+    end
+
+    def service_scopes
+      @params[:service_scopes]
+    end
+
+    def validate_service_scopes
+      raise ::Bcome::Exception::MissingGcpServiceScopes, 'Please define as minimum https://www.googleapis.com/auth/compute.readonly' unless has_service_scopes_defined?
+    end
+
+    def has_service_scopes_defined?
+      service_scopes&.any?
+    end
+  end
+end