RubyGems - bcome - Versions diffs - 1.4.0 → 2.0.0 - Mend

bcome 1.4.0 → 2.0.0

Files changed (71) hide show

checksums.yaml +4 -4
data/lib/bcome.rb +7 -0
data/lib/objects/bcome/version.rb +3 -3
data/lib/objects/bootup.rb +4 -3
data/lib/objects/driver/base.rb +16 -2
data/lib/objects/driver/ec2.rb +11 -2
data/lib/objects/driver/gcp.rb +49 -5
data/lib/objects/driver/gcp/authentication/base.rb +36 -0
data/lib/objects/driver/gcp/authentication/oauth.rb +24 -29
data/lib/objects/driver/gcp/authentication/oauth_client_config.rb +22 -0
data/lib/objects/driver/gcp/authentication/oauth_session_store.rb +22 -0
data/lib/objects/driver/gcp/authentication/service_account.rb +57 -2
data/lib/objects/driver/gcp/authentication/signet/service_account.rb +27 -0
data/lib/objects/driver/gcp/authentication/utilities.rb +42 -0
data/lib/objects/encryptor.rb +83 -0
data/lib/objects/exception/base.rb +10 -3
data/lib/objects/exception/ec2_driver_missing_authorization_keys.rb +11 -0
data/lib/objects/exception/empty_namespace_tree.rb +11 -0
data/lib/objects/exception/gcp_auth_service_account_missing_credentials.rb +11 -0
data/lib/objects/exception/invalid_metadata_encryption_key.rb +1 -1
data/lib/objects/exception/missing_gcp_service_account_credentials_filename.rb +11 -0
data/lib/objects/exception/user_orchestration_error.rb +11 -0
data/lib/objects/initialization/factory.rb +36 -0
data/lib/objects/initialization/structure.rb +18 -0
data/lib/objects/initialization/utils.rb +20 -0
data/lib/objects/loading_bar/handler.rb +1 -1
data/lib/objects/loading_bar/indicator/base.rb +1 -0
data/lib/objects/modules/draw.rb +49 -0
data/lib/objects/modules/tree.rb +157 -0
data/lib/objects/modules/workspace_commands.rb +2 -32
data/lib/objects/modules/workspace_menu.rb +113 -48
data/lib/objects/node/attributes.rb +6 -0
data/lib/objects/node/base.rb +27 -7
data/lib/objects/node/cache_handler.rb +1 -1
data/lib/objects/node/factory.rb +15 -11
data/lib/objects/node/inventory/base.rb +9 -3
data/lib/objects/node/inventory/defined.rb +18 -15
data/lib/objects/node/inventory/merge.rb +9 -1
data/lib/objects/node/inventory/subselect.rb +6 -4
data/lib/objects/node/meta_data_factory.rb +1 -1
data/lib/objects/node/meta_data_loader.rb +2 -2
data/lib/objects/node/resources/inventory.rb +19 -0
data/lib/objects/node/resources/merged.rb +23 -14
data/lib/objects/node/resources/sub_inventory.rb +6 -5
data/lib/objects/node/server/base.rb +35 -22
data/lib/objects/node/server/dynamic/ec2.rb +0 -1
data/lib/objects/node/server/dynamic/gcp.rb +0 -1
data/lib/objects/node/server/static.rb +22 -9
data/lib/objects/orchestration/base.rb +7 -1
data/lib/objects/orchestration/interactive_terraform.rb +10 -16
data/lib/objects/registry/command/external.rb +6 -2
data/lib/objects/registry/command/group.rb +5 -1
data/lib/objects/registry/loader.rb +3 -0
data/lib/objects/ssh/command.rb +4 -8
data/lib/objects/ssh/command_exec.rb +3 -1
data/lib/objects/ssh/connection_wrangler.rb +34 -17
data/lib/objects/ssh/connector.rb +17 -9
data/lib/objects/ssh/driver.rb +7 -18
data/lib/objects/ssh/driver_concerns/connection.rb +3 -11
data/lib/objects/ssh/driver_concerns/functions.rb +7 -7
data/lib/objects/ssh/proxy_chain.rb +19 -0
data/lib/objects/ssh/proxy_chain_link.rb +26 -0
data/lib/objects/ssh/proxy_hop.rb +47 -18
data/lib/objects/ssh/script_exec.rb +9 -11
data/lib/objects/startup.rb +7 -1
data/lib/objects/terraform/output.rb +5 -1
data/lib/objects/workspace.rb +10 -0
data/patches/irb.rb +35 -1
data/patches/string.rb +13 -0
metadata +71 -25
data/lib/objects/driver/static.rb +0 -6

data/lib/objects/driver/gcp/authentication/signet/service_account.rb ADDED

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Bcome::Driver::Gcp::Authentication
+  class SignetServiceAccountClient < Signet::OAuth2::Client
+    def initialize(scopes, service_account_json_path)
+      @scopes = scopes
+      @service_account_json_path = service_account_json_path
+      raise ::Bcome::Exception::GcpAuthServiceAccountMissingCredentials, @service_account_json_path unless File.exist?(@service_account_json_path)
+    end
+    def fetch_access_token(_options = {})
+      token = authorizer.fetch_access_token!
+      token
+    end
+    def authorize
+      @token ||= fetch_access_token
+    end
+    def authorizer
+      authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
+        json_key_io: File.open(@service_account_json_path),
+        scope: @scopes
+      )
+    end
+  end
+end

data/lib/objects/driver/gcp/authentication/utilities.rb ADDED

@@ -0,0 +1,42 @@
+module Bcome::Driver::Gcp::Authentication::Utilities
+  def oauth_redirect_html
+    ## [GR] Style rules: Explicitly no assets to be pulled from bcome remote (no tracking). Inline styles only.
+    ## Made an exception for the google font, as the user is already oauthing against google in any case.
+    <<-HTML
+      <html>
+        <head>
+          <script>
+            function closeWindow() {
+              window.open('', '_self', '');
+              window.close();
+            }
+            setTimeout(closeWindow, 10);
+          </script>
+        </head>
+        <style>
+          @import url("https://fonts.googleapis.com/css2?family=Catamaran:wght@200;500&display=swap");
+          body {
+            font-family: 'Catamaran', sans-serif;
+            font-weight: 200;
+            color: #3E4E60;
+          }
+        </style>
+        <body>#{oauth_redirect_body}</body>
+      </html>
+    HTML
+  end
+  def oauth_redirect_body
+    <<-HTML
+     <p>
+       OAuth redirection for namespace <strong>#{@node.keyed_namespace}</strong> complete.
+     </p>
+     <p>
+       You may close this window and return to the Bcome Console.
+     </p>
+    HTML
+  end
+end

data/lib/objects/encryptor.rb CHANGED

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+require 'diffy'
 module Bcome
   class Encryptor
     UNENC_SIGNIFIER = ''
     ENC_SIGNIFIER = 'enc'
+    AFFIRMATIVE = 'yes'
     include Singleton
@@ -27,7 +30,16 @@ module Bcome
       puts "\n"
       print 'Please enter an encryption key (and if your data is already encrypted, you must provide the same key): '.informational
       @key = STDIN.noecho(&:gets).chomp
+      # puts "\n"
+    end
+    def prompt_to_overwrite
+      valid_answers = [AFFIRMATIVE, 'no']
       puts "\n"
+      print "Do you want to continue with unpacking this file? Your local changes would be overwritten [#{valid_answers.join(',')}]\s"
+      answer = STDIN.gets.chomp
+      prompt_to_overwrite unless valid_answers.include?(answer)
+      answer
     end
     def has_encrypted_files?
@@ -52,6 +64,64 @@ module Bcome
       nil
     end
+    def decrypt_file_data(filename)
+      raw_contents = File.read(filename)
+      raw_contents.send(:decrypt, @key)
+    end
+    def enc_file_diff(filename)
+      # Get decrypted file data
+      decrypted_data_for_filename = decrypt_file_data(filename)
+      # Get unpacked file data
+      opposing_filename = opposing_file_for_filename(filename)
+      return nil unless File.exist?(opposing_filename)
+      unpacked_file_data = File.read(opposing_filename)
+      # there are no differences
+      return nil if decrypted_data_for_filename.eql?(unpacked_file_data)
+      get_diffs(unpacked_file_data, decrypted_data_for_filename)
+    end
+    def opposing_file_for_filename(filename)
+      filename =~ %r{#{path_to_metadata}/(.+)\.enc}
+      "#{path_to_metadata}/#{Regexp.last_match(1)}"
+    end
+    def get_diffs(file_one, file_two)
+      diffy = ::Diffy::SplitDiff.new(file_one, file_two)
+      left_diffs = diffy.left.split("\n").each_with_index.collect { |l, index| "#{index + 1}:\s#{l}" }
+      right_diffs = diffy.right.split("\n").each_with_index.collect { |l, index| "#{index + 1}:\s#{l}" }
+      diffed_lines = (left_diffs + right_diffs).select { |line| line =~ /^[0-9]+:\s[+-](.+)$/ }
+      return nil if diffed_lines.empty?
+      diffed_lines.collect do |line|
+        line =~ /^[0-9]+:\s\+(.+)$/ ? line.bc_green : line.bc_red
+      end.join("\n")
+    end
+    def diff
+      prompt_for_key
+      puts "\n"
+      all_encrypted_filenames.each do |filename|
+        opposing_file = opposing_file_for_filename(filename)
+        if File.exist?(opposing_file)
+          if diffs = enc_file_diff(filename)
+            puts "\n[+/-]\s".warning + filename + "\sis different to your local unpacked version\n\n"
+            puts diffs + "\n\n"
+          else
+            puts filename.to_s.informational + "\s- no differences".bc_green
+          end
+        else
+          puts filename.to_s.informational + "\s- new file".warning
+        end
+      end
+      puts "\n"
+    end
     def toggle_packed_files(filenames, packer_method)
       raise 'Missing encryption key. Please set an encryption key' unless @key
@@ -63,6 +133,18 @@ module Bcome
           filename =~ %r{#{path_to_metadata}/(.+)\.enc}
           opposing_filename = Regexp.last_match(1)
           action = 'Unpacking'
+          # Skip unpacking a file if there are local modifications that the user does not want to lose.
+          if diffs = enc_file_diff(filename)
+            puts "\n[+/-]\s".warning + filename + "\sis different to your local unpacked version\n\n"
+            puts diffs
+            if prompt_to_overwrite != AFFIRMATIVE
+              puts "\n\nskipping\s".warning + filename + "\n"
+              next
+            end
+            puts "\n"
+          end
         else
           filename =~ %r{#{path_to_metadata}/(.*)}
           opposing_filename = "#{Regexp.last_match(1)}.enc"
@@ -71,6 +153,7 @@ module Bcome
         # Write encrypted/decryption action
         enc_decrypt_result = raw_contents.send(packer_method, @key)
+        print "\n\n"
         puts "#{action}\s".informational + filename + "\sto\s".informational + "#{path_to_metadata}/" + opposing_filename
         write_file(opposing_filename, enc_decrypt_result)
       end

data/lib/objects/exception/base.rb CHANGED

@@ -8,12 +8,19 @@ module Bcome
       end
       def message
-        "#{message_prefix}#{@message_suffix ? + (!message_prefix.empty? ? ':' : '').to_s + " #{@message_suffix}" : ''}"
+        "#{message_prefix}#{if @message_suffix
+                              + (!message_prefix.empty? ? ':' : '').to_s + " #{@message_suffix}"
+                            else
+                              ''
+                            end}"
       end
-      def pretty_display
-        puts "\n\n#{message}\n".error
+      def pretty_display(show_backtrace = false)
+        puts "\n" + message.error
+        print backtrace.join("\n") if show_backtrace
+        print "\n"
       end
     end
   end
 end

data/lib/objects/exception/ec2_driver_missing_authorization_keys.rb ADDED

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Bcome
+  module Exception
+    class Ec2DriverMissingAuthorizationKeys < ::Bcome::Exception::Base
+      def message_prefix
+        'Missing authorization keys for AWS. Expected to find keys at '
+      end
+    end
+  end
+end

data/lib/objects/exception/empty_namespace_tree.rb ADDED

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Bcome
+  module Exception
+    class EmptyNamespaceTree < ::Bcome::Exception::Base
+      def message_prefix
+        'Empty namespace tree'
+      end
+    end
+  end
+end

data/lib/objects/exception/gcp_auth_service_account_missing_credentials.rb ADDED

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Bcome
+  module Exception
+    class GcpAuthServiceAccountMissingCredentials < ::Bcome::Exception::Base
+      def message_prefix
+        'Expected GCP service account credentials at'
+      end
+    end
+  end
+end

data/lib/objects/exception/invalid_metadata_encryption_key.rb CHANGED

@@ -4,7 +4,7 @@ module Bcome
   module Exception
     class InvalidMetaDataEncryptionKey < ::Bcome::Exception::Base
       def message_prefix
-        'Your metadata encryption key is invalid - your metadata files are encrypted with a different key.'
+        'Your metadata encryption key is invalid.'
       end
     end
   end

data/lib/objects/exception/missing_gcp_service_account_credentials_filename.rb ADDED

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Bcome
+  module Exception
+    class MissingGcpServiceAccountCredentialsFilename < ::Bcome::Exception::Base
+      def message_prefix
+        "Cannot authenticate with GCP - missing service account credentials file name in networks.yml.  Define this with a 'service_account_credentials' key"
+      end
+    end
+  end
+end

data/lib/objects/exception/user_orchestration_error.rb ADDED

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Bcome
+  module Exception
+    class UserOrchestrationError < ::Bcome::Exception::Base
+      def message_prefix
+        "Exception caught in orchestration script"
+      end
+    end
+  end
+end

data/lib/objects/initialization/factory.rb ADDED

@@ -0,0 +1,36 @@
+require 'fileutils'
+module Bcome::Initialization
+  class Factory
+    include ::Bcome::Initialization::Utils
+    include ::Bcome::Initialization::Structure
+    class << self
+      def do
+        new.do
+      end
+    end
+    def initialize
+      @created = []
+      @exists = []
+    end
+    def do
+      puts "\nInitialising Bcome".title.bold
+      initialization_paths.each do |conf|
+        create_file_utils(conf[:method], conf[:paths])
+      end
+      summarize(@created, "\nThe following paths were created")
+      summarize(@exists, "\nThe following paths exist already, and were untouched")
+      puts "\n"
+    end
+    def summarize(paths, caption)
+      return unless paths.any?
+      puts "#{caption}:".informational
+      paths.each { |path| puts path.resource_key }
+    end
+  end
+end

data/lib/objects/initialization/structure.rb ADDED

@@ -0,0 +1,18 @@
+module Bcome::Initialization::Structure
+  def initialization_paths
+    [
+      { # Configuration directories
+        paths: ['bcome', 'bcome/metadata', 'bcome/orchestration'],
+        method: :create_as_directory
+      },
+      { # Configuration files
+        paths: ['bcome/networks.yml', 'bcome/registry.yml'],
+        method: :initialize_empty_yaml_config
+      },
+      { # Cloud provider authorisation directories
+        paths: ['.gauth', '.aws'],
+        method: :create_as_directory
+      }
+    ]
+  end
+end

data/lib/objects/initialization/utils.rb ADDED

@@ -0,0 +1,20 @@
+module Bcome::Initialization::Utils
+  def initialize_empty_yaml_config(path)
+    File.write(path, {}.to_yaml)
+  end
+  def create_as_directory(path)
+    ::FileUtils.mkdir_p(path)
+  end
+  def create_file_utils(method, paths)
+    paths.each do |path|
+      if path.is_file_or_directory?
+        @exists << path
+      else
+        send(method, path)
+        @created << path
+      end
+    end
+  end
+end

data/lib/objects/loading_bar/handler.rb CHANGED

@@ -72,7 +72,7 @@ module Bcome
       def signal_failure
         do_signal(::Bcome::LoadingBar::Indicator::Base::SIGNAL_FAILURE)
-        # Keeo parent indicator in sync (see #signal_stop)
+        # Keep parent indicator in sync (see #signal_stop)
         @indicator.increment_failure
       end
     end

data/lib/objects/loading_bar/indicator/base.rb CHANGED

@@ -24,6 +24,7 @@ module Bcome
           print "\n"
           loop do
             increment
+            sleep 0.1
             show
           end
         end

data/lib/objects/modules/draw.rb ADDED

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module Bcome
+  module Draw
+    # see: https://en.wikipedia.org/wiki/Box-drawing_character
+    ## Tree shapes
+    BOTTOM_ANCHOR = '└───╸'
+    MID_SHIPS = '├───╸'
+    BRANCH = '│'
+    LEFT_PADDING = "\s" * 6
+    INGRESS = '│'
+    BLIP = '▐▆'
+    # # Box shapes
+    BOX_SIDE = '│'
+    BOX_TOP_LEFT = '┌'
+    BOX_TOP_RIGHT = '┐'
+    BOX_BOTTOM_LEFT = '└'
+    BOX_BOTTOM_RIGHT = '┘'
+    BOX_HORIZONTAL_LINE = '─'
+    # Takes an array of strings, each representing a line
+    # Draws a box around the lines, and returns a new array
+    # padding may be provided
+    def box_it(array_of_lines, padding = 1, _box_colour = :bc_cyan)
+      max_length = max_box_line_length(array_of_lines)
+      pad_string = "\s" * padding
+      box_lines = [
+        # Set the top box line
+        "#{BOX_TOP_LEFT}#{BOX_HORIZONTAL_LINE * (max_length + (padding + 1))}#{BOX_TOP_RIGHT}"
+      ]
+      array_of_lines.each do |line|
+        line_length = line.sanitize.length
+        box_lines << "#{BOX_SIDE}#{pad_string}" + line.to_s + "#{"\s" * (max_length - line_length)}#{pad_string}#{BOX_SIDE}"
+      end
+      # Set the bottom box line
+      box_lines << "#{BOX_BOTTOM_LEFT}#{BOX_HORIZONTAL_LINE * (max_length + (padding + 1))}#{BOX_BOTTOM_RIGHT}"
+      box_lines
+    end
+    def max_box_line_length(array_of_lines)
+      array_of_lines.max_by { |string| string.sanitize.length }.sanitize.length
+    end
+  end
+end

data/lib/objects/modules/tree.rb ADDED

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+module Bcome
+  module Tree
+    include Bcome::Draw
+    def tree
+      title_prefix = 'Namespace tree'
+      build_tree(:network_namespace_tree_data, title_prefix)
+    end
+    def routes
+      if machines.empty?
+        puts "\nNo routes are found below this namespace (empty server list)\n".warning
+      else
+        title_prefix = 'Ssh connection routes'
+        build_tree(:routing_tree_data, title_prefix)
+      end
+    end
+    def routing_tree_data
+      @tree = {}
+      # For each namespace, we have many proxy chains
+      proxy_chain_link.link.each do |proxy_chain, machines|
+        is_direct = proxy_chain.hops.any? ? false : true
+        if inventory?
+          load_nodes unless nodes_loaded?
+        end
+        ## Machine data
+        machine_data = {}
+        machines.each do |machine|
+          key = machine.routing_tree_line(is_direct)
+          machine_data[key] = nil
+        end
+        ## Construct Hop data
+        hops = proxy_chain.hops
+        hop_lines = hops.compact.enum_for(:each_with_index).collect { |hop, index| hop.pretty_proxy_details(index + 1) }
+        @tree.merge!(to_nested_hash(hop_lines, machine_data))
+      end
+      @tree
+    end
+    def to_nested_hash(array, data)
+      nested = array.reverse.inject(data) { |a, n| { n => a } }
+      nested.is_a?(String) ? { "#{nested}": nil } : nested
+    end
+    def network_namespace_tree_data
+      @tree = {}
+      resources.sort_by(&:identifier).each do |resource|
+        next if resource.hide?
+        if resource.inventory?
+          resource.load_nodes unless resource.nodes_loaded?
+        end
+        unless resource.is_a?(Bcome::Node::Inventory::Merge)
+          next if resource.parent && !resource.parent.resources.is_active_resource?(resource)
+        end
+        @tree[resource.namespace_tree_line] = resource.resources.any? ? resource.network_namespace_tree_data : nil
+      end
+      @tree
+    end
+    def namespace_tree_line
+      return "#{type.bc_green} #{identifier} (empty set)" if !server? && !resources.has_active_nodes?
+      "#{type.bc_green} #{identifier}"
+    end
+    def routing_tree_line(is_direct = true)
+      address = if is_direct && public_ip_address
+                  public_ip_address
+                else
+                  internal_ip_address
+                end
+      [
+        type.to_s.bc_cyan,
+        "namespace:\s".bc_green + keyed_namespace,
+        "ip address\s".bc_green + address.to_s,
+        "user\s".bc_green + ssh_driver.user
+      ]
+    end
+    def build_tree(data_build_method, title_prefix)
+      data = send(data_build_method)
+      @lines = []
+      title = "#{title_prefix.informational}\s#{namespace}"
+      @lines << "\n"
+      @lines << "#{BLIP}\s\s\s#{title}"
+      @lines << INGRESS.to_s
+      if data.nil?
+        parent.build_tree(data_build_method)
+        return
+      end
+      recurse_tree_lines(data)
+      @lines.each do |line|
+        print "#{LEFT_PADDING}#{line}\n"
+      end
+      print "\n\n"
+      p
+    end
+    def recurse_tree_lines(data, padding = '')
+      # @lines << padding + BRANCH
+      data.each_with_index do |config, index|
+        key = config[0]
+        values = config[1]
+        anchor, branch = deduce_tree_structure(index, data.size)
+        labels = key.is_a?(Array) ? key : [key]
+        labels.each_with_index do |label, index|
+          key_string = if index == 0 #  First line
+                         "#{anchor}\s#{label}"
+                       else # Any subsequent line
+                         "#{branch}#{"\s" * 4}\s#{label}"
+                       end
+          entry_string = "#{padding}#{key_string}"
+          @lines << entry_string
+        end # End labels group
+        @lines << "#{padding}#{branch}" if labels.size > 1
+        next unless values&.is_a?(Hash)
+        tab_padding = padding + branch + ("\s" * (anchor.length + 4))
+        recurse_tree_lines(values, tab_padding)
+        @lines << padding + branch
+      end
+      nil
+    end
+    def deduce_tree_structure(index, number_lines)
+      return BOTTOM_ANCHOR, "\s" if (index + 1) == number_lines
+      [MID_SHIPS, BRANCH]
+    end
+  end
+end