leap_cli 1.8.1 → 1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32bb57fcbb9e75766687cc73e04998ab9d34154f
-  data.tar.gz: 36b47fa44ec131b4ef08898c5dc79d65543eedbf
+  metadata.gz: c76581ff17beffa03bea2e6447ec048d9282cd43
+  data.tar.gz: e1b082558769fad1644c0bf78afa138aa66fcb15
 SHA512:
-  metadata.gz: 9f403ad270bc60cf3a6da1851939dc52e6da9b581cd7ee52ff0bd38f033d52827e319c7def7a173769b38114a4672190ed1ed6af537825673b9122d0caed35bd
-  data.tar.gz: 3ac1c581600222cd3251989f122e33f01b482aaca653da7dbdd8463de98528abfda6bffe5d14dfc215a3eb93ca2eccb9a9e54fa27b97d5b4a5dd65b8869f261b
+  metadata.gz: fc24e99df33af964af23fdff085bb2a87808a92138545378c70fd43e0a1c0581394c3d7c9faffa774feffb063c3da491f7a892267beb985672d736c603aff79a
+  data.tar.gz: 67c3838bc0eeaf0bd72eaf1d6c843fbfeca25414bec9ccc4120cf2e514cb2f157cad942fd4b7c67b4d9803097e11694ff0360f4eb0cf0b1e312bf0734fce1449

data/bin/leap

@@ -14,6 +14,7 @@ else
   $VERBOSE=nil
   DEBUG=false
 end
+TEST = false
 
 LEAP_CLI_BASE_DIR = File.expand_path('..', File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__))
 
@@ -27,8 +28,6 @@ rescue LoadError
 end
 
 require 'gli'
-require 'highline'
-require 'forwardable'
 require 'leap_cli/lib_ext/gli' # our custom extensions to gli
 
 #
@@ -40,16 +39,6 @@ require 'leap_cli/lib_ext/gli' # our custom extensions to gli
 #
 module LeapCli::Commands
   extend GLI::App
-  extend Forwardable
-
-  # delegate highline methods to make them available to sub-commands
-  @terminal = HighLine.new
-  def_delegator :@terminal, :ask,    'self.ask'
-  def_delegator :@terminal, :agree,  'self.agree'
-  def_delegator :@terminal, :choose, 'self.choose'
-  def_delegator :@terminal, :say,    'self.say'
-  def_delegator :@terminal, :color,  'self.color'
-  def_delegator :@terminal, :list,   'self.list'
 
   # make config manager available as 'manager'
   def self.manager
@@ -90,6 +79,9 @@ module LeapCli::Commands
 
   # run command
   begin
+    if ARGV.any?
+      LeapCli.log_raw(:log, nil, "COMMAND") { 'leap ' + ARGV.join(' ') }
+    end
     exit_status = run(ARGV)
     exit(LeapCli::Util.exit_status || exit_status)
   rescue StandardError => exc
@@ -102,6 +94,8 @@ module LeapCli::Commands
     end
     if DEBUG
       raise exc
+    else
+      exit(1)
     end
   end
 end

data/lib/leap_cli.rb

@@ -1,6 +1,6 @@
 module LeapCli
-  module Commands; end  # for commands in leap_cli/commands
-  module Macro; end     # for macros in leap_platform/provider_base/lib/macros
+  module Commands; end  # for commands in leap_platform/lib/leap_cli/commands
+  module Macro; end     # for macros in leap_platform/lib/leap_cli/macros
 end
 
 $ruby_version = RUBY_VERSION.split('.').collect{ |i| i.to_i }.extend(Comparable)
@@ -11,11 +11,8 @@ $:.unshift(File.expand_path('../leap_cli/override',__FILE__))
 # for a few gems, things will break if using earlier versions.
 # enforce the compatible versions here:
 require 'rubygems'
-gem 'net-ssh', '~> 2.7'
 gem 'gli', '~> 2.12', '>= 2.12.0'
 
-require 'leap/platform'
-
 require 'leap_cli/version'
 require 'leap_cli/exceptions'
 
@@ -32,30 +29,13 @@ require 'leap_cli/core_ext/yaml'
 require 'leap_cli/log'
 require 'leap_cli/path'
 require 'leap_cli/util'
-require 'leap_cli/util/secret'
-require 'leap_cli/util/remote_command'
-require 'leap_cli/util/x509'
-require 'leap_cli/logger'
 require 'leap_cli/bootstrap'
 
-require 'leap_cli/ssh_key'
-require 'leap_cli/config/object'
-require 'leap_cli/config/node'
-require 'leap_cli/config/tag'
-require 'leap_cli/config/provider'
-require 'leap_cli/config/secrets'
-require 'leap_cli/config/object_list'
-require 'leap_cli/config/filter'
-require 'leap_cli/config/environment'
-require 'leap_cli/config/manager'
-
 require 'leap_cli/markdown_document_listener'
 
 #
 # allow everyone easy access to log() command.
 #
 module LeapCli
-  Util.send(:extend, LeapCli::Log)
-  Config::Manager.send(:include, LeapCli::Log)
-  extend LeapCli::Log
+  extend LeapCli::LogCommand
 end

data/lib/leap_cli/bootstrap.rb

@@ -5,8 +5,8 @@
 
 module LeapCli
   module Bootstrap
-    extend LeapCli::Log
     extend self
+    extend LeapCli::LogCommand
 
     #
     # the argument leapfile_path is only used for tests
@@ -36,9 +36,11 @@ module LeapCli
     # called from leap executable.
     #
     def load_libraries(app)
-      if LeapCli.log_level >= 2
+      if LeapCli.logger.log_level >= 2
         log_version
       end
+      add_platform_lib_to_path
+      load_platform_libraries
       load_commands(app)
       load_macros
     end
@@ -72,14 +74,14 @@ module LeapCli
       options = parse_logging_options(argv)
       verbose = (options[:verbose] || 1).to_i
       if verbose
-        LeapCli.set_log_level(verbose)
+        LeapCli.logger.log_level = verbose
       end
       if options[:log]
-        LeapCli.log_file = options[:log]
-        LeapCli::Util.log_raw(:log) { $0 + ' ' + argv.join(' ')}
+        LeapCli.logger.log_file = options[:log]
+        LeapCli.logger.log_raw(:log) { $0 + ' ' + argv.join(' ')}
       end
       unless options[:color].nil?
-        LeapCli.log_in_color = options[:color]
+        LeapCli.logger.log_in_color = options[:color]
       end
     end
 
@@ -97,17 +99,16 @@ module LeapCli
         if !Path.platform || !File.directory?(Path.platform)
           bail! { log :missing, "platform directory '#{Path.platform}'" }
         end
-        if LeapCli.log_file.nil? && LeapCli.leapfile.log
-          LeapCli.log_file = LeapCli.leapfile.log
+        if LeapCli.logger.log_file.nil? && LeapCli.leapfile.log
+          LeapCli.logger.log_file = LeapCli.leapfile.log
         end
       elsif !leapfile_optional?(argv)
         puts
         puts " ="
-        log :note, "There is no `Leapfile` in this directory, or any parent directory.\n"+
-                   " =       "+
+        log :NOTE, "There is no `Leapfile` in this directory, or any parent directory.\n"+
+                   " =      "+
                    "Without this file, most commands will not be available."
         puts " ="
-        puts
       end
     end
 
@@ -158,7 +159,9 @@ module LeapCli
     # Yes, hacky.
     #
     def leapfile_optional?(argv)
-      if argv.include?('--version')
+      if TEST
+        return true
+      elsif argv.include?('--version')
         return true
       else
         without_flags = argv.select {|i| i !~ /^-/}
@@ -193,5 +196,26 @@ module LeapCli
       end
     end
 
+    #
+    # makes all the ruby libraries in the leap_platform/lib directory
+    # available for inclusion.
+    #
+    def add_platform_lib_to_path
+      if Path.platform
+        path = File.join(Path.platform, 'lib')
+        $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+      end
+    end
+
+    #
+    # loads libraries that live in the platform and should
+    # always be available.
+    #
+    def load_platform_libraries
+      if Path.platform
+        require 'leap_cli/load_libraries'
+      end
+    end
+
   end
 end

data/lib/leap_cli/commands/common.rb

@@ -1,61 +1,103 @@
-#
-# Some common helpers available to all LeapCli::Commands
-#
-# This also includes utility methods, and makes all instance
-# methods available as class methods.
-#
+require 'readline'
 
-module LeapCli
-  module Commands
+module LeapCli; module Commands
 
-    extend self
-    extend LeapCli::Log
-    extend LeapCli::Util
-    extend LeapCli::Util::RemoteCommand
+  extend LeapCli::LogCommand
+  extend LeapCli::Util
 
-    protected
-
-    def path(name)
-      Path.named_path(name)
-    end
+  def path(name)
+    Path.named_path(name)
+  end
 
-    #
-    # keeps prompting the user for a numbered choice, until they pick a good one or bail out.
-    #
-    # block is yielded and is responsible for rendering the choices.
-    #
-    def numbered_choice_menu(msg, items, &block)
-      while true
-        say("\n" + msg + ':')
-        items.each_with_index &block
-        say("q. quit")
-        index = ask("number 1-#{items.length}> ")
-        if index.empty?
-          next
-        elsif index =~ /q/
+  #
+  # keeps prompting the user for a numbered choice, until they pick a good one or bail out.
+  #
+  # block is yielded and is responsible for rendering the choices.
+  #
+  def numbered_choice_menu(msg, items, &block)
+    while true
+      say("\n" + msg + ':')
+      items.each_with_index(&block)
+      say("q. quit")
+      index = ask("number 1-#{items.length}> ")
+      if index.nil? || index.empty?
+        next
+      elsif index =~ /q/
+        bail!
+      else
+        i = index.to_i - 1
+        if i < 0 || i >= items.length
           bail!
         else
-          i = index.to_i - 1
-          if i < 0 || i >= items.length
-            bail!
-          else
-            return i
-          end
+          return i
         end
       end
     end
+  end
+
+  def parse_node_list(nodes)
+    if nodes.is_a? Config::Object
+      Config::ObjectList.new(nodes)
+    elsif nodes.is_a? Config::ObjectList
+      nodes
+    elsif nodes.is_a? String
+      manager.filter!(nodes)
+    else
+      bail! "argument error"
+    end
+  end
+
+  def say(statement)
+    if ends_in_whitespace?(statement)
+      $stdout.print(statement)
+      $stdout.flush
+    else
+      $stdout.puts(statement)
+    end
+  end
+
+  def ask(question, options={})
+    default = options[:default]
+    if default
+      if ends_in_whitespace?(question)
+        question = question + "|" + default + "| "
+      else
+        question = question + "|" + default + "|"
+      end
+    end
+    response = Readline.readline(question, true) # set to false if ever reading passwords.
+    if response
+      response = response.strip
+      if response.empty?
+        return default
+      else
+        return response
+      end
+    else
+      return default
+    end
+  end
 
-    def parse_node_list(nodes)
-      if nodes.is_a? Config::Object
-        Config::ObjectList.new(nodes)
-      elsif nodes.is_a? Config::ObjectList
-        nodes
-      elsif nodes.is_a? String
-        manager.filter!(nodes)
+  def agree(question, options={})
+    while true
+      response = ask(question, options)
+      if response.nil?
+        say('Please enter "yes" or "no".')
+      elsif ["y","yes", "ye"].include?(response.downcase)
+        return true
+      elsif ["n", "no"].include?(response.downcase)
+        return false
       else
-        bail! "argument error"
+        say('Please enter "yes" or "no".')
       end
     end
+  end
 
+  private
+
+  # true if str ends in whitespace before a color escape code.
+  def ends_in_whitespace?(str)
+    /[ \t](\e\[\d+(;\d+)*m)?\Z/ =~ str
   end
-end
+
+end; end

data/lib/leap_cli/commands/new.rb

@@ -4,7 +4,6 @@ module LeapCli; module Commands
 
   desc 'Creates a new provider instance in the specified directory, creating it if necessary.'
   arg_name 'DIRECTORY'
-  #skips_pre
   command :new do |c|
     c.flag 'name', :desc => "The name of the provider." #, :default_value => 'Example'
     c.flag 'domain', :desc => "The primary domain of the provider." #, :default_value => 'example.org'
@@ -12,19 +11,7 @@ module LeapCli; module Commands
     c.flag 'contacts', :desc => "Default email address contacts." #, :default_value => 'root'
 
     c.action do |global, options, args|
-      unless args.first
-        # this should not be needed, but GLI is not making it required.
-        bail! "Argument DIRECTORY is required."
-      end
-      directory = File.expand_path(args.first)
-      create_provider_directory(global, directory)
-      options[:domain]   ||= ask_string("The primary domain of the provider: ") {|q| q.default = 'example.org'}
-      options[:name]     ||= ask_string("The name of the provider: ") {|q| q.default = 'Example'}
-      options[:platform] ||= ask_string("File path of the leap_platform directory: ") {|q| q.default = File.expand_path('../leap_platform', directory)}
-      options[:platform] = "./" + options[:platform] unless options[:platform] =~ /^\//
-      options[:contacts] ||= ask_string("Default email address contacts: ") {|q| q.default = 'root@' + options[:domain]}
-      options[:platform] = relative_path(options[:platform])
-      create_initial_provider_files(directory, global, options)
+      new_provider_action(global, options, args)
     end
   end
 
@@ -32,13 +19,33 @@ module LeapCli; module Commands
 
   DEFAULT_REPO = 'https://leap.se/git/leap_platform.git'
 
+  def new_provider_action(global, options, args)
+    unless args.first
+      # this should not be needed, but GLI is not making it required.
+      bail! "Argument DIRECTORY is required."
+    end
+    directory = File.expand_path(args.first)
+    create_provider_directory(global, directory)
+    options[:domain]   ||= ask_string("The primary domain of the provider: ",
+                                      default: 'example.org')
+    options[:name]     ||= ask_string("The name of the provider: ",
+                                      default: 'Example')
+    options[:platform] ||= ask_string("File path of the leap_platform directory: ",
+                                      default: File.expand_path('../leap_platform', directory))
+    options[:platform] = "./" + options[:platform] unless options[:platform] =~ /^\//
+    options[:contacts] ||= ask_string("Default email address contacts: ",
+                                       default: 'root@' + options[:domain])
+    options[:platform] = relative_path(options[:platform])
+    create_initial_provider_files(directory, global, options)
+  end
+
   #
   # don't let the user specify any of the following: y, yes, n, no
   # they must actually input a real string
   #
-  def ask_string(str, &block)
+  def ask_string(str, options={})
     while true
-      value = ask(str, &block)
+      value = ask(str, options)
       if value =~ /^(y|yes|n|no)$/i
         say "`#{value}` is not a valid value. Try again"
       else
@@ -54,7 +61,7 @@ module LeapCli; module Commands
     unless directory && directory.any?
       help! "Directory name is required."
     end
-    unless File.exists?(directory)
+    unless File.exist?(directory)
       if global[:yes] || agree("Create directory #{directory}? ")
         ensure_dir directory
       else

data/lib/leap_cli/commands/pre.rb

@@ -1,9 +1,11 @@
-
 #
 # check to make sure we can find the root directory of the platform
 #
 module LeapCli; module Commands
 
+  extend self # this is a trick to make all instance methods
+              # available as class methods.
+
   desc 'Verbosity level 0..5'
   arg_name 'LEVEL'
   default_value '1'