leap_cli 1.7.4 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fde4e852d415bcc30ed9d48a65e5b264ac999d4f
-  data.tar.gz: a3658cdc96431cf991509bbd48e0d3aa4afdadc3
+  metadata.gz: a1517e12ad3324944287a8639f98cc6783c1945c
+  data.tar.gz: d7357d37b347982b7ea5b08f0e26fd9b30c8bc80
 SHA512:
-  metadata.gz: 5ab70f0f7a3a39e09ccac39dd3fb69d7dd6a5b47366f1251b24dbfc283ada437ceed72ce1a9e5a27b96d620e7206da597e1c482c0722aca3d2116db115b5f9e5
-  data.tar.gz: 9838e7df5040c85caae31cb394edad4da7f4f809c15c3e5046707e8d4ea97195c75f49d0947df289c91bfaad3fe1549249bf1409b2bce07d49ecae0bfdb9ddd7
+  metadata.gz: c650e4c2ce659cebd34582d7873d4d553ba948ca021751642082d65e22b2367c863f5fb2e2cc95314e3e2f5f11aece4d01e325655218fbb09734f0b69a463a8b
+  data.tar.gz: 2db42b92689dea62189b5a4b801f68e3d93205bb41e5a7a333d659d117a96d4a7ec0d23400a0558b5f997769c748a140e971cf15f2e204812527712d1d61cc11

data/bin/leap

@@ -11,11 +11,11 @@ if ARGV.include?('--debug') || ARGV.include?('-d')
   rescue LoadError
   end
 else
+  $VERBOSE=nil
   DEBUG=false
 end
 
 LEAP_CLI_BASE_DIR = File.expand_path('..', File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__))
-ORIGINAL_ARGV = ARGV.dup
 
 begin
   # First, try to load the leap_cli code that is local to this `leap` command.
@@ -74,17 +74,13 @@ module LeapCli::Commands
   program_desc       LeapCli::SUMMARY
   program_long_desc  LeapCli::DESCRIPTION
 
+  LeapCli::Bootstrap::setup(ARGV)
+
   # handle --version ourselves (and not GLI)
   if ARGV.grep(/--version/).any?
-    puts "leap #{LeapCli::VERSION}, ruby #{RUBY_VERSION}"
-    begin
-      commands_from('leap_cli/commands')
-      initialize_leap_cli(false, {:verbose => 2})
-    rescue StandardError => exc
-      puts exc.to_s
-      raise exc if DEBUG
-    end
-    exit(0)
+    LeapCli::Bootstrap::handle_version(self)
+  else
+    LeapCli::Bootstrap::load_libraries(self)
   end
 
   # disable GLI error catching
@@ -92,9 +88,6 @@ module LeapCli::Commands
   def error_message(msg)
   end
 
-  # load commands
-  commands_from('leap_cli/commands')
-
   # run command
   begin
     exit_status = run(ARGV)

data/lib/leap/platform.rb

@@ -14,6 +14,7 @@ module Leap
       attr_accessor :monitor_username
       attr_accessor :reserved_usernames
 
+      attr_accessor :hiera_dir
       attr_accessor :hiera_path
       attr_accessor :files_dir
       attr_accessor :leap_dir
@@ -24,6 +25,7 @@ module Leap
       def define(&block)
         # some defaults:
         @reserved_usernames = []
+        @hiera_dir  = '/etc/leap'
         @hiera_path = '/etc/leap/hiera.yaml'
         @leap_dir   = '/srv/leap'
         @files_dir  = '/srv/leap/files'

data/lib/leap_cli.rb

@@ -36,6 +36,7 @@ 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'
@@ -45,6 +46,7 @@ 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'
@@ -54,7 +56,6 @@ require 'leap_cli/markdown_document_listener'
 #
 module LeapCli
   Util.send(:extend, LeapCli::Log)
-  Commands.send(:extend, LeapCli::Log)
   Config::Manager.send(:include, LeapCli::Log)
   extend LeapCli::Log
 end

data/lib/leap_cli/bootstrap.rb

@@ -0,0 +1,197 @@
+#
+# Initial bootstrap loading of all the necessary things that needed
+# for the `leap` command.
+#
+
+module LeapCli
+  module Bootstrap
+    extend LeapCli::Log
+    extend self
+
+    #
+    # the argument leapfile_path is only used for tests
+    #
+    def setup(argv, leapfile_path=nil)
+      setup_logging(argv)
+      setup_leapfile(argv, leapfile_path)
+    end
+
+    #
+    # print out the version string and exit.
+    # called from leap executable.
+    #
+    def handle_version(app)
+      puts "leap #{LeapCli::VERSION}, ruby #{RUBY_VERSION}"
+      begin
+        log_version
+      rescue StandardError => exc
+        puts exc.to_s
+        raise exc if DEBUG
+      end
+      exit(0)
+    end
+
+    #
+    # load the commands.
+    # called from leap executable.
+    #
+    def load_libraries(app)
+      if LeapCli.log_level >= 2
+        log_version
+      end
+      load_commands(app)
+      load_macros
+    end
+
+    #
+    # initialize the global options.
+    # called from pre.rb
+    #
+    def setup_global_options(app, global)
+      if global[:force]
+        global[:yes] = true
+      end
+      if Process::Sys.getuid == 0
+        Util.bail! "`leap` should not be run as root."
+      end
+    end
+
+    private
+
+    #
+    # Initial logging
+    #
+    # This is called very early by leap executable, because
+    # everything depends on the log file and log options
+    # being set correctly before any work is done.
+    #
+    # The Leapfile might later load additional logging
+    # options.
+    #
+    def setup_logging(argv)
+      options = parse_logging_options(argv)
+      verbose = (options[:verbose] || 1).to_i
+      if verbose
+        LeapCli.set_log_level(verbose)
+      end
+      if options[:log]
+        LeapCli.log_file = options[:log]
+        LeapCli::Util.log_raw(:log) { $0 + ' ' + argv.join(' ')}
+      end
+      unless options[:color].nil?
+        LeapCli.log_in_color = options[:color]
+      end
+    end
+
+    #
+    # load the leapfile and set the Path variables.
+    #
+    def setup_leapfile(argv, leapfile_path)
+      LeapCli.leapfile.load(leapfile_path)
+      if LeapCli.leapfile.valid?
+        Path.set_platform_path(LeapCli.leapfile.platform_directory_path)
+        Path.set_provider_path(LeapCli.leapfile.provider_directory_path)
+        if !Path.provider || !File.directory?(Path.provider)
+          bail! { log :missing, "provider directory '#{Path.provider}'" }
+        end
+        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
+        end
+      elsif !leapfile_optional?(argv)
+        puts
+        puts " ="
+        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
+
+    #
+    # Add a log entry for the leap command and leap platform versions.
+    #
+    def log_version(force=false)
+      str = "leap command v#{LeapCli::VERSION}"
+      if Util.is_git_directory?(LEAP_CLI_BASE_DIR)
+        str << " (%s %s)" % [Util.current_git_branch(LEAP_CLI_BASE_DIR),
+          Util.current_git_commit(LEAP_CLI_BASE_DIR)]
+      else
+        str << " (%s)" % LEAP_CLI_BASE_DIR
+      end
+      log str
+      if LeapCli.leapfile.valid?
+        str = "leap platform v#{Leap::Platform.version}"
+        if Util.is_git_directory?(Path.platform)
+          str << " (%s %s)" % [Util.current_git_branch(Path.platform), Util.current_git_commit(Path.platform)]
+        end
+        log str
+      end
+    end
+
+    def parse_logging_options(argv)
+      argv = argv.dup
+      options = {:color => true, :verbose => 1}
+      loop do
+        current = argv.shift
+        case current
+          when '--verbose'  then options[:verbose] = argv.shift;
+          when /-v[0-9]/    then options[:verbose] = current[-1];
+          when '--log'      then options[:log] = argv.shift;
+          when '--no-color' then options[:color] = false;
+          when nil          then break;
+        end
+      end
+      options
+    end
+
+    #
+    # Returns true if loading the Leapfile is optional.
+    #
+    # We could make the 'new' command skip the 'pre' command, and then load Leapfile
+    # from 'pre', but for various reasons we want the Leapfile loaded even earlier
+    # than that. So, we need a way to test to see if loading the leapfile is optional
+    # before any of the commands are loaded and the argument list is parsed by GLI.
+    # Yes, hacky.
+    #
+    def leapfile_optional?(argv)
+      if argv.include?('--version')
+        return true
+      else
+        without_flags = argv.select {|i| i !~ /^-/}
+        if without_flags.first == 'new'
+          return true
+        end
+      end
+      return false
+    end
+
+    #
+    # loads the GLI command definition files
+    #
+    def load_commands(app)
+      app.commands_from('leap_cli/commands')
+      if Path.platform
+        app.commands_from(Path.platform + '/lib/leap_cli/commands')
+      end
+    end
+
+    #
+    # loads the platform's macro definition files
+    #
+    def load_macros
+      if Path.platform
+        platform_macro_files = Dir[Path.platform + '/lib/leap_cli/macros/*.rb']
+        if platform_macro_files.any?
+          platform_macro_files.each do |macro_file|
+            require macro_file
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/leap_cli/commands/common.rb

@@ -0,0 +1,61 @@
+#
+# Some common helpers available to all LeapCli::Commands
+#
+# This also includes utility methods, and makes all instance
+# methods available as class methods.
+#
+
+module LeapCli
+  module Commands
+
+    extend self
+    extend LeapCli::Log
+    extend LeapCli::Util
+    extend LeapCli::Util::RemoteCommand
+
+    protected
+
+    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/
+          bail!
+        else
+          i = index.to_i - 1
+          if i < 0 || i >= items.length
+            bail!
+          else
+            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
+
+  end
+end

data/lib/leap_cli/commands/new.rb

@@ -4,7 +4,7 @@ module LeapCli; module Commands
 
   desc 'Creates a new provider instance in the specified directory, creating it if necessary.'
   arg_name 'DIRECTORY'
-  skips_pre
+  #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,6 +12,10 @@ 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'}

data/lib/leap_cli/commands/pre.rb

@@ -31,73 +31,8 @@ module LeapCli; module Commands
   switch 'color', :negatable => true
 
   pre do |global,command,options,args|
-    if global[:force]
-      global[:yes] = true
-    end
-    initialize_leap_cli(true, global)
+    Bootstrap.setup_global_options(self, global)
     true
   end
 
-  protected
-
-  #
-  # available options:
-  #  :verbose -- integer log verbosity level
-  #  :log     -- log file path
-  #  :color   -- true or false, to log in color or not.
-  #
-  def initialize_leap_cli(require_provider, options={})
-    if Process::Sys.getuid == 0
-      bail! "`leap` should not be run as root."
-    end
-
-    # set verbosity
-    options[:verbose] ||= 1
-    LeapCli.set_log_level(options[:verbose].to_i)
-
-    # load Leapfile
-    LeapCli.leapfile.load
-    if LeapCli.leapfile.valid?
-      Path.set_platform_path(LeapCli.leapfile.platform_directory_path)
-      Path.set_provider_path(LeapCli.leapfile.provider_directory_path)
-      if !Path.provider || !File.directory?(Path.provider)
-        bail! { log :missing, "provider directory '#{Path.provider}'" }
-      end
-      if !Path.platform || !File.directory?(Path.platform)
-        bail! { log :missing, "platform directory '#{Path.platform}'" }
-      end
-    elsif require_provider
-      bail! { log :missing, 'Leapfile in directory tree' }
-    end
-
-    # set log file
-    LeapCli.log_file = options[:log] || LeapCli.leapfile.log
-    LeapCli::Util.log_raw(:log) { $0 + ' ' + ORIGINAL_ARGV.join(' ')}
-    log_version
-    LeapCli.log_in_color = options[:color]
-  end
-
-  #
-  # add a log entry for the leap command and leap platform versions
-  #
-  def log_version
-    if LeapCli.log_level >= 2
-      str = "leap command v#{LeapCli::VERSION}"
-      if Util.is_git_directory?(LEAP_CLI_BASE_DIR)
-        str << " (%s %s)" % [Util.current_git_branch(LEAP_CLI_BASE_DIR),
-          Util.current_git_commit(LEAP_CLI_BASE_DIR)]
-      else
-        str << " (%s)" % LEAP_CLI_BASE_DIR
-      end
-      log 2, str
-      if LeapCli.leapfile.valid?
-        str = "leap platform v#{Leap::Platform.version}"
-        if Util.is_git_directory?(Path.platform)
-          str << " (%s %s)" % [Util.current_git_branch(Path.platform), Util.current_git_commit(Path.platform)]
-        end
-        log 2, str
-      end
-    end
-  end
-
 end; end