bcome 1.3.2 → 1.4.0

data/lib/objects/node/server/{dynamic.rb → dynamic/ec2.rb}

@@ -1,17 +1,15 @@
-module Bcome::Node::Server
-  class Dynamic < Bcome::Node::Server::Base
+# frozen_string_literal: true
+
+module Bcome::Node::Server::Dynamic
+  class Ec2 < Bcome::Node::Server::Dynamic::Base
     class << self
-      def to_s
-        'dynamic server'
+      def dynamic_server_type
+        :ec2
       end
 
       def new_from_fog_instance(fog_instance, parent)
         identifier = fog_instance.tags['Name']
-
-        if parent.override_server_identifier?
-          identifier =~ /#{parent.override_identifier}/
-          identifier = Regexp.last_match(1) if Regexp.last_match(1)
-        end
+        identifier = override_identifier(parent, identifier)
 
         params = {
           identifier: identifier,
@@ -22,17 +20,20 @@ module Bcome::Node::Server
           ec2_server: fog_instance
         }
 
-        new(parent: parent,
-            views: params)
+        new(parent: parent, views: params)
       end
     end
 
+    def host
+      'EC2'
+    end
+
     def do_generate_cloud_tags
-      raw_tags = ec2_server ? ec2_server.tags.deep_symbolize_keys : {}
+      raw_tags = cloud_server ? cloud_server.tags.deep_symbolize_keys : {}
       ::Bcome::Node::Meta::Cloud.new(raw_tags)
     end
 
-    def ec2_server
+    def cloud_server
       views[:ec2_server]
     end
   end

data/lib/objects/node/server/dynamic/gcp.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Bcome::Node::Server::Dynamic
+  class Gcp < Bcome::Node::Server::Dynamic::Base
+    class << self
+      def dynamic_server_type
+        :gcp
+      end
+
+      def new_from_gcp_instance(gcp_instance, parent)
+        identifier = gcp_instance.name
+        identifier = override_identifier(parent, identifier)
+
+        ## For now we support only the first network interface
+        first_interface = gcp_instance.network_interfaces.first
+        network_ip = first_interface.network_ip
+
+        ## And we get the first access config (terraform uses the same pattern for accessing GCP machines also)
+        first_access_config = first_interface.access_configs ? first_interface.access_configs.first : nil
+        nat_ip = first_access_config ? first_access_config.nat_ip : nil
+
+        params = {
+          identifier: identifier,
+          description: "GCP server - #{identifier}",
+          internal_ip_address: network_ip,
+          public_ip_address: nat_ip,
+          gcp_server: gcp_instance
+        }
+
+        new(parent: parent, views: params)
+      end
+    end
+
+    def host
+      'GCP'
+    end
+
+    def do_generate_cloud_tags
+      raw_labels = cloud_server.labels ? cloud_server.labels.deep_symbolize_keys : {}
+      ::Bcome::Node::Meta::Cloud.new(raw_labels)
+    end
+
+    def cloud_server
+      views[:gcp_server]
+    end
+  end
+end

data/lib/objects/node/server/static.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Bcome::Node::Server
   class Static < Bcome::Node::Server::Base
-    def self.to_s
-      'static server'
+    def host
+      'static'
     end
 
     def initialize(params)
@@ -10,12 +12,21 @@ module Bcome::Node::Server
       @public_ip_address = config[:public_ip_address]
       @internal_ip_address = config[:internal_ip_address]
       @cloud_tags = config[:cloud_tags]
+      @description = config[:description]
       verify_we_have_at_least_one_interface(config)
       super
     end
 
     attr_reader :cloud_tags
 
+    attr_reader :public_ip_address
+
+    attr_reader :internal_ip_address
+
+    attr_reader :cloud_tags
+
+    attr_reader :description
+
     def verify_we_have_at_least_one_interface(config)
       raise Bcome::Exception::MissingIpaddressOnServer, config unless has_at_least_one_interface?
     end

data/lib/objects/orchestration/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bcome::Orchestration
   class Base
     def initialize(node, arguments)
@@ -7,7 +9,15 @@ module Bcome::Orchestration
 
     def do_execute
       raise Bcome::Exception::MissingExecuteOnRegistryObject, self.class.to_s unless respond_to?(:execute)
+
       execute
     end
+
+    def method_missing(method_sym, *_arguments)
+      ## A thread error deep in the bowels of IRB is not playing well with orchestration missing methods within the orchestration namespace. Until this can be resolved,
+      ## I've re-implemented it here.
+
+      raise NameError, "NameError (undefined local variable or method '#{method_sym}' for #{self.class}"
+    end
   end
 end

data/lib/objects/orchestration/interactive_terraform.rb

@@ -1,18 +1,25 @@
+# frozen_string_literal: true
+
 module Bcome::Orchestration
-  class InteractiveTerraform < Bcome::Orchestration::Base 
+  class InteractiveTerraform < Bcome::Orchestration::Base
+    ## Prototype interactive terraform shell embedded within bcome.
+
+    # * Provides access to the metadata framework, so that data may be shared between Orchestrative processes and Terraform
+    # * Transparent authorization, by passing in cloud authorisation details from the bcome session
+    # * Passes in SSH credentials directly, which can be used to bootstrap machines.
 
-    QUIT = "\\q"
-    COMMAND_PROMPT = "enter command or '#{QUIT}' to quit: " + "terraform".informational + "\s"
+    QUIT = '\\q'
+    COMMAND_PROMPT = "enter command or '#{QUIT}' to quit: " + 'terraform'.informational + "\s"
 
     def execute
       show_intro_text
       wait_for_command_input
     end
- 
+
     def show_intro_text
       puts "\n"
       puts "INTERACTIVE TERRAFORM\n".underline
-      puts "Namespace:\s" + "#{@node.namespace}".informational
+      puts "Namespace:\s" + @node.namespace.to_s.informational
       puts "Configuration Path:\s" + "#{path_to_env_config}/*".informational
       puts "\nConfigured metadata:\s" + terraform_metadata.inspect.informational
 
@@ -22,6 +29,13 @@ module Bcome::Orchestration
     # PROCESSING INTERACTIVE COMMANDS
     #
     def process_command(raw_command)
+      if raw_command =~ /destroy/
+        are_you_sure_message = "Are you SURE you want to 'destroy'? Make sure you know what will be destroyed before you continue. (y/n):".warning
+        response = wait_for_input(are_you_sure_message)
+        response = wait_for_input(are_you_sure_message) until %w[y n].include?(response)
+        return if response == 'n'
+      end
+
       full_command = command(raw_command)
       @node.execute_local(full_command)
       wait_for_command_input
@@ -31,50 +45,71 @@ module Bcome::Orchestration
     #
     def wait_for_command_input
       raw_command = wait_for_input
-      unless raw_command == QUIT
-        process_command(raw_command)
-      end
+      process_command(raw_command) unless raw_command == QUIT
     end
- 
+
     def wait_for_input(message = COMMAND_PROMPT)
       ::Readline.readline("\n#{message}", true).squeeze('').to_s
-    end 
+    end
 
     # COMMAND PROCESSING
     def terraform_metadata
-      @terraform_metadata ||= @node.metadata.fetch("terraform", @node.metadata.fetch(:terraform, {}))
-    end  
+      @terraform_metadata ||= @node.metadata.fetch('terraform', @node.metadata.fetch(:terraform, {}))
+    end
 
-    # Get the terraform variables for this stack, and merge in with our EC2 access keys
+    # Get the terraform variables for this stack, and merge in with our networking & ssh credentials
     def form_var_string
       terraform_vars = terraform_metadata
-      ec2_credentials = @node.network_driver.raw_fog_credentials
-     
-      cleaned_data = terraform_vars.select{|k,v|
-        !v.is_a?(Hash) && !v.is_a?(Array)
-      } # we can't yet handle nested terraform metadata on the command line so no arrays or hashes
-
-      all_vars = cleaned_data.merge({
-        :access_key => ec2_credentials["aws_access_key_id"],
-        :secret_key => ec2_credentials["aws_secret_access_key"]
-      })
-
-      all_vars.collect{|key, value| "-var #{key}=\"#{value}\""}.join("\s")
+
+      terraform_vars.each do |key, value|
+        # Join arrays into a string (note we cannot handle nested arrays yet)
+        terraform_vars[key] = value.join(',') if value.is_a?(Array)
+      end
+
+      cleaned_data = terraform_vars.reject do |_k, v|
+        v.is_a?(Hash)
+      end # we can't yet handle nested terraform metadata on the command line so no hashes
+
+      all_vars = cleaned_data
+
+      if @node.network_driver.has_network_credentials?
+        network_credentials = @node.network_driver.network_credentials
+        all_vars = cleaned_data.merge(network_credentials)
+      end
+
+      all_vars[:ssh_user] = @node.ssh_driver.user
+      all_vars[:ssh_key_path] = @node.ssh_driver.ssh_keys.first
+
+      all_vars.collect { |key, value| "-var #{key}=\"#{value}\"" }.join("\s")
     end
 
     def var_string
       @var_string ||= form_var_string
     end
 
+    def backend_config_parameter_string
+      ## Backend configs are loaded before Terraform Core which means that we cannot use variables directly in our backend config.
+      ## This is a pain as we'll have authorised with GCP via the console, and so all sesssion have an access token readily available.
+      ## This patch passes the access token directly to terraform as a parameter.
+
+      ## GCP only for now. Support for AWS may come later as needed/requested.
+      return '' unless @node.network_driver.is_a?(::Bcome::Driver::Gcp)
+
+      "\s-backend-config \"access_token=#{@node.network_driver.network_credentials[:access_token]}\"\s"
+    end
+
     # Retrieve the path to the terraform configurations for this stack
     def path_to_env_config
-      @path_to_env_config ||= "terraform/environments/#{@node.namespace.gsub(":","_")}"
+      @path_to_env_config ||= "terraform/environments/#{@node.namespace.gsub(':', '_')}"
     end
 
     # Formulate a terraform command
     def command(raw_command)
+      # if raw_command == "init"
+      #  "cd #{path_to_env_config} ; terraform #{raw_command} #{backend_config_parameter_string}"
+      # else
       "cd #{path_to_env_config} ; terraform #{raw_command} #{var_string}"
+      # end
     end
-
   end
 end

data/lib/objects/orchestrator.rb

@@ -1,10 +1,22 @@
+# frozen_string_literal: true
+
 class ::Bcome::Orchestrator
   include ::Singleton
 
   attr_reader :context
 
   def initialize
+    reset!
+  end
+
+  def reset!
     @silence = false
+    @tail_command_output = false
+    @multi_node = false
+  end
+
+  def is_multi_node?
+    @multi_node == true
   end
 
   def silence_command_output!
@@ -15,9 +27,19 @@ class ::Bcome::Orchestrator
     @silence == true
   end
 
+  def tail_all_command_output!(node)
+    @multi_node = node.machines.size > 1
+    @tail_command_output = true
+  end
+
+  def tail_all_command_output?
+    @tail_command_output == true
+  end
+
   def get(breadcrumb = nil)
     context = ::Bcome::Bootup.traverse(breadcrumb)
     raise Bcome::Exception::NoNodeFoundForBreadcrumb, breadcrumb unless context
+
     context.load_nodes if context.inventory? && !context.nodes_loaded?
     context
   end

data/lib/objects/parser/bread_crumb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bcome::Parser
   class BreadCrumb
     attr_reader :crumbs
@@ -25,7 +27,7 @@ module Bcome::Parser
     end
 
     def validate!
-      #raise Bcome::Exception::InvalidBcomeBreadcrumb.new "- letters, numbers & underscores only" unless @raw_crumbs =~ /^([a-z0-9A-Z_]+)(:\s*[a-z0-9A-Z_]+)*:?$/i
+      # raise Bcome::Exception::InvalidBcomeBreadcrumb.new "- letters, numbers & underscores only" unless @raw_crumbs =~ /^([a-z0-9A-Z_]+)(:\s*[a-z0-9A-Z_]+)*:?$/i
     end
   end
 end

data/lib/objects/registry/arguments/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bcome::Registry::Arguments
   class Base
     attr_reader :arguments, :defaults, :processed_arguments, :merged_arguments
@@ -10,7 +12,7 @@ module Bcome::Registry::Arguments
     end
 
     def initialize(_arguments, defaults)
-      @defaults = defaults ? defaults : {}
+      @defaults = defaults || {}
       validate
     end
 

data/lib/objects/registry/arguments/command_line.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Bcome::Registry::Arguments
   class CommandLine < Base
     def initialize(arguments, defaults)
-      @arguments = arguments ? arguments : []
+      @arguments = arguments || []
       @processed_arguments = {}
       super
     end
@@ -21,14 +23,17 @@ module Bcome::Registry::Arguments
       @arguments.each do |argument|
         argument =~ /^(.+)=(.+)$/
         raise Bcome::Exception::MalformedCommandLineArguments, argument unless Regexp.last_match(1) || Regexp.last_match(2)
+
         key = Regexp.last_match(1).to_sym; value = Regexp.last_match(2)
         raise Bcome::Exception::DuplicateCommandLineArgumentKey, "'#{key}'" if @processed_arguments.key?(key)
+
         @processed_arguments[key] = value
       end
     end
 
     def validate
       raise Bcome::Exception::InvalidRegistryArgumentType, 'invalid argument format' unless @arguments.is_a?(Array)
+
       super
     end
   end

data/lib/objects/registry/arguments/console.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Bcome::Registry::Arguments
   class Console < Base
     def initialize(arguments, defaults)
-      @arguments = arguments ? arguments : {}
+      @arguments = arguments || {}
       super
     end
 
@@ -9,6 +11,7 @@ module Bcome::Registry::Arguments
 
     def validate
       raise Bcome::Exception::InvalidRegistryArgumentType, 'invalid argument format' unless @arguments.is_a?(Hash)
+
       super
     end
   end

data/lib/objects/registry/command/base.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Bcome::Registry::Command
   class Base
     class << self
       def new_from_raw_command(data)
         raise Bcome::Exception::InvalidContextCommand, "#{data.inspect} is missing key type" unless data[:type]
         raise Bcome::Exception::InvalidContextCommand, "#{data.inspect} has invalid type '#{data[:type]}'" unless is_valid_type?(data[:type])
+
         valid_types[data[:type].to_sym].new(data)
       end
 

data/lib/objects/registry/command/external.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bcome::Registry::Command
   class External < Base
     # In which the bcome context is passed to an external call
@@ -28,8 +30,8 @@ module Bcome::Registry::Command
           error_message_suffix = "- missing '#{substitution}' from command '#{local_command}'"
           raise Bcome::Exception::MissingArgumentForRegistryCommand, error_message_suffix
         end
-  
-        substitute_with = [TrueClass, FalseClass].include?(substitute_with.class) ? (substitute_with ? "true" : "false") : substitute_with
+
+        substitute_with = [TrueClass, FalseClass].include?(substitute_with.class) ? (substitute_with ? 'true' : 'false') : substitute_with
         substituted_command.gsub!("%#{substitution}%", substitute_with)
       end
       substituted_command

data/lib/objects/registry/command/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bcome::Registry::Command
   class Group
     def initialize(node)
@@ -32,7 +34,8 @@ module Bcome::Registry::Command
     end
 
     def item_spacing(item)
-      raise ::Bcome::Exception::InvalidRegistryCommandNameLength.new "command '#{item}' exceeds length limit of #{menu_item_spacing_length}" if item.length > menu_item_spacing_length
+      raise ::Bcome::Exception::InvalidRegistryCommandNameLength, "command '#{item}' exceeds length limit of #{menu_item_spacing_length}" if item.length > menu_item_spacing_length
+
       "\s" * (menu_item_spacing_length - item.length)
     end
 
@@ -48,7 +51,7 @@ module Bcome::Registry::Command
       ::Bcome::System::Local.instance.in_console_session?
     end
 
-    def pretty_print ## TODO - revisit. This is a mess
+    def pretty_print
       puts "\nRegistry commands".title + "\sfor #{@node.class} #{@node.keyed_namespace}".resource_value + "\n\n"
       all_commands.sort.each do |group_name, commands|
         puts tab_spacing + group_name.title + "\n\n"
@@ -63,7 +66,7 @@ module Bcome::Registry::Command
           puts tab_spacing + ("\s" * menu_item_spacing_length) + 'usage: '.instructional + usage_string
 
           if defaults.keys.any?
-            defaults_usage = in_console_session? ? "\s\"#{defaults.collect { |key, _value| "#{key}=your-value" }.join(',')}\"" : "\s" + defaults.collect { |key, _value| "#{key}=your-value" }.join("\s")
+            defaults_usage = in_console_session? ? "\s#{defaults.collect { |key, _value| "\"#{key}=your-value\"" }.join(",\s")}" : "\s" + defaults.collect { |key, _value| "#{key}=your-value" }.join("\s")
             puts tab_spacing + ("\s" * menu_item_spacing_length) + "defaults:\s".instructional + defaults.collect { |k, v| "#{k}=#{v}" }.join(', ')
             puts tab_spacing + ("\s" * menu_item_spacing_length) + "override:\s".instructional + usage_string + defaults_usage
           end