leap_cli 1.5.6 → 1.6.2

data/lib/leap_cli/core_ext/yaml.rb

@@ -0,0 +1,29 @@
+class Object
+  #
+  # ya2yaml will output hash keys in sorted order, but it outputs arrays
+  # in natural order. This new method, sorted_ya2yaml(), is the same as
+  # ya2yaml but ensures that arrays are sorted.
+  #
+  # This is important so that the .yaml files don't change each time you recompile.
+  #
+  # see https://github.com/afunai/ya2yaml/blob/master/lib/ya2yaml.rb
+  #
+  def sorted_ya2yaml(options = {})
+    # modify array
+    Array.class_eval do
+      alias_method :collect_without_sort, :collect
+      def collect(&block)
+        sorted = sort {|a,b| a.to_s <=> b.to_s}
+        sorted.collect_without_sort(&block)
+      end
+    end
+
+    # generate yaml
+    yaml_str = self.ya2yaml(options)
+
+    # restore array
+    Array.class_eval {alias_method :collect, :collect_without_sort}
+
+    return yaml_str
+  end
+end

data/lib/leap_cli/exceptions.rb

@@ -6,6 +6,30 @@ module LeapCli
       @node = node
       super(msg)
     end
+    def log
+      Util.log(0, :error, "in node `#{@node.name}`: " + self.message)
+    end
+  end
+
+  class FileMissing < StandardError
+    attr_accessor :path, :options
+    def initialize(path, options={})
+      @path = path
+      @options = options
+    end
+    def to_s
+      @path
+    end
+  end
+
+  class AssertionFailed < StandardError
+    attr_accessor :assertion
+    def initialize(assertion)
+      @assertion = assertion
+    end
+    def to_s
+      @assertion
+    end
   end
 
 end

data/lib/leap_cli/leapfile.rb

@@ -16,13 +16,28 @@ module LeapCli
     attr_accessor :leap_version
     attr_accessor :log
     attr_accessor :vagrant_network
-    attr_accessor :platform_branch
-    attr_accessor :allow_production_deploy
+    attr_accessor :environment
 
     def initialize
       @vagrant_network = '10.5.5.0/24'
     end
 
+    #
+    # The way the Leapfile handles pinning of environment (self.environment) is a little tricky.
+    # If self.environment is nil, then there is no pin. If self.environment is 'default', then
+    # there is a pin to the default environment. The problem is that an environment of nil
+    # is used to indicate the default environment in node properties.
+    #
+    # This method returns the environment tag as needed when filtering nodes.
+    #
+    def environment_filter
+      if self.environment == 'default'
+        nil
+      else
+        self.environment
+      end
+    end
+
     def load(search_directory=nil)
       directory = File.expand_path(find_in_directory_tree('Leapfile', search_directory))
       if directory == '/'
@@ -33,7 +48,7 @@ module LeapCli
         #
         @provider_directory_path = directory
         read_settings(directory + '/Leapfile')
-        read_settings(ENV['HOME'] + '/.leaprc')
+        read_settings(leaprc_path)
         @platform_directory_path = File.expand_path(@platform_directory_path || '../leap_platform', @provider_directory_path)
 
         #
@@ -51,20 +66,55 @@ module LeapCli
                      "You need platform version #{LeapCli::COMPATIBLE_PLATFORM_VERSION.first} to #{LeapCli::COMPATIBLE_PLATFORM_VERSION.last}."
         end
 
-        #
-        # set defaults
-        #
-        if @allow_production_deploy.nil?
-          # by default, only allow production deploys from 'master' or if not a git repo
-          @allow_production_deploy = !LeapCli::Util.is_git_directory?(@provider_directory_path) ||
-            LeapCli::Util.current_git_branch(@provider_directory_path) == 'master'
+        unless @allow_production_deploy.nil?
+          Util::log 0, :warning, "in Leapfile: @allow_production_deploy is no longer supported."
+        end
+        unless @platform_branch.nil?
+          Util::log 0, :warning, "in Leapfile: @platform_branch is no longer supported."
         end
         return true
       end
     end
 
+    def set(property, value)
+      edit_leaprc(property, value)
+    end
+
+    def unset(property)
+      edit_leaprc(property)
+    end
+
     private
 
+    #
+    # adds or removes a line to .leaprc for this particular provider directory.
+    # if value is nil, the line is removed. if not nil, it is added or replaced.
+    #
+    def edit_leaprc(property, value=nil)
+      file_path = leaprc_path
+      lines = []
+      if File.exists?(file_path)
+        regexp = /self\.#{Regexp.escape(property)} = .*? if @provider_directory_path == '#{Regexp.escape(@provider_directory_path)}'/
+        File.readlines(file_path).each do |line|
+          unless line =~ regexp
+            lines << line
+          end
+        end
+      end
+      unless value.nil?
+        lines << "self.#{property} = #{value.inspect} if @provider_directory_path == '#{@provider_directory_path}'\n"
+      end
+      File.open(file_path, 'w') do |f|
+        f.write(lines.join)
+      end
+    rescue Errno::EACCES, IOError => exc
+      Util::bail! :error, "trying to save ~/.leaprc (#{exc})."
+    end
+
+    def leaprc_path
+      File.join(ENV['HOME'], '.leaprc')
+    end
+
     def read_settings(file)
       if File.exists? file
         Util::log 2, :read, file

data/lib/leap_cli/log.rb

@@ -15,7 +15,7 @@ module LeapCli
   def log_level
     @log_level ||= 1
   end
-  def log_level=(value)
+  def set_log_level(value)
     @log_level = value
   end
 

data/lib/leap_cli/logger.rb

@@ -84,6 +84,19 @@ module LeapCli
     ## FORMATTING
     ##
 
+    #
+    # options for formatters:
+    #
+    # :match       =>  regexp for matching a log line
+    # :color       => what color the line should be
+    # :style       => what style the line should be
+    # :priority    => what order the formatters are applied in. higher numbers first.
+    # :match_level => only apply filter at the specified log level
+    # :level       => make this line visible at this log level or higher
+    # :replace     => replace the matched text
+    # :exit        => force the exit code to be this (does not interrupt program, just
+    #                 ensures a specific exit code when the program eventually exits)
+    #
     @formatters = [
       # TRACE
       { :match => /command finished/,          :color => :white,   :style => :dim, :match_level => 3, :priority => -10 },
@@ -138,8 +151,12 @@ module LeapCli
       # TESTS
       { :match => /^PASS: /,                :color => :green,   :priority => -20},
       { :match => /^(FAIL|ERROR): /,        :color => :red,     :priority => -20},
-      { :match => /^SKIP: /,                :color => :yellow,  :priority => -20}
+      { :match => /^(SKIP|WARN): /,         :color => :yellow,  :priority => -20},
+      { :match => /\d+ tests: \d+ passes, \d+ skips, 0 warnings, 0 failures, 0 errors/, :color => :blue, :priority => -20},
 
+      # LOG SUPPRESSION
+      { :match => /^warning: You cannot collect without storeconfigs being set/, :level => 2, :priority => 10},
+      { :match => /^warning: You cannot collect exported resources without storeconfigs being set/, :level => 2, :priority => 10}
     ]
 
     def self.sorted_formatters

data/lib/leap_cli/markdown_document_listener.rb

@@ -11,7 +11,7 @@ require 'gli/commands/help_modules/arg_name_formatter'
 module LeapCli
   class MarkdownDocumentListener
 
-    def initialize(global_options,options,arguments)
+    def initialize(global_options,options,arguments,app)
       @io = File.new(File.basename($0) + ".md",'w')
       @nest = ''
       @commands = [File.basename($0)]

data/lib/leap_cli/override/json.rb

@@ -0,0 +1,11 @@
+#
+# This exists solely to prevent other gems we depend on from
+# importing json/ext (e.g. require 'json').
+#
+# If json/ext is imported, json/pure cannot work, and we heavily
+# rely on the specific behavior of json/pure.
+#
+# This trick only works if this directory is early in the
+# include path.
+#
+require 'json/pure'

data/lib/leap_cli/path.rb

@@ -26,15 +26,29 @@ module LeapCli; module Path
   end
 
   #
-  # tries to find a file somewhere
+  # Tries to find a file somewhere.
+  # Path can be a named path or a relative path.
+  #
+  # relative paths are checked against
+  # provider/<path>
+  # provider/files/<path>
+  # provider_base/<path>
+  # provider_base/files/<path>
+  #
   #
   def self.find_file(arg)
     [Path.provider, Path.provider_base].each do |base|
-      file_path = named_path(arg, base)
-      return file_path if File.exists?(file_path)
-      if arg.is_a? String
-        file_path = base + '/files/' + arg
-        return file_path if File.exists?(file_path)
+      if arg.is_a?(Symbol) || arg.is_a?(Array)
+        named_path(arg, base).tap {|path|
+          return path if File.exists?(path)
+        }
+      else
+        File.join(base, arg).tap {|path|
+          return path if File.exists?(path)
+        }
+        File.join(base, 'files', arg).tap {|path|
+          return path if File.exists?(path)
+        }
       end
     end
     return nil

data/lib/leap_cli/remote/leap_plugin.rb

@@ -26,7 +26,7 @@ module LeapCli; module Remote; module LeapPlugin
   #
   def assert_initialized
     begin
-      test_initialized_file = "test -f #{INITIALIZED_FILE}"
+      test_initialized_file = "test -f #{Leap::Platform.init_path}"
       check_required_packages = "! dpkg-query -W --showformat='${Status}\n' #{required_packages} 2>&1 | grep -q -E '(deinstall|no packages)'"
       run "#{test_initialized_file} && #{check_required_packages} && echo ok"
     rescue Capistrano::CommandError => exc
@@ -57,7 +57,7 @@ module LeapCli; module Remote; module LeapPlugin
   end
 
   def mark_initialized
-    run "touch #{INITIALIZED_FILE}"
+    run "touch #{Leap::Platform.init_path}"
   end
 
   #

data/lib/leap_cli/remote/puppet_plugin.rb

@@ -6,7 +6,7 @@
 module LeapCli; module Remote; module PuppetPlugin
 
   def apply(options)
-    run "#{PUPPET_DESTINATION}/bin/puppet_command set_hostname apply #{flagize(options)}"
+    run "#{Leap::Platform.leap_dir}/bin/puppet_command set_hostname apply #{flagize(options)}"
   end
 
   private

data/lib/leap_cli/remote/rsync_plugin.rb

@@ -3,7 +3,7 @@
 # (see RemoteCommand::new_capistrano)
 #
 
-require 'rsync_command'
+autoload :RsyncCommand, 'rsync_command'
 
 module LeapCli; module Remote; module RsyncPlugin
 

data/lib/leap_cli/remote/tasks.rb

@@ -34,7 +34,7 @@ BAD_APT_GET_UPDATE = /(BADSIG|NO_PUBKEY|KEYEXPIRED|REVKEYSIG|NODATA)/
 
 task :install_prerequisites, :max_hosts => MAX_HOSTS do
   apt_get = "DEBIAN_FRONTEND=noninteractive apt-get -q -y -o DPkg::Options::=--force-confold"
-  leap.mkdirs LeapCli::PUPPET_DESTINATION
+  leap.mkdirs Leap::Platform.leap_dir
   run "echo 'en_US.UTF-8 UTF-8' > /etc/locale.gen"
   leap.log :updating, "package list" do
     run "apt-get update" do |channel, stream, data|

data/lib/leap_cli/ssh_key.rb

@@ -1,6 +1,7 @@
 #
 # A wrapper around OpenSSL::PKey::RSA instances to provide a better api for dealing with SSH keys.
 #
+# cipher 'ssh-ed25519' not supported yet because we are waiting for support in Net::SSH
 #
 
 require 'net/ssh'
@@ -13,6 +14,10 @@ module LeapCli
     attr_accessor :filename
     attr_accessor :comment
 
+    # supported ssh key types, in order of preference
+    SUPPORTED_TYPES = ['ssh-rsa', 'ecdsa-sha2-nistp256']
+    SUPPORTED_TYPES_RE = /(#{SUPPORTED_TYPES.join('|')})/
+
     ##
     ## CLASS METHODS
     ##
@@ -33,6 +38,7 @@ module LeapCli
         end
       end
       return key
+    rescue StandardError => exc
     end
 
     def self.load_from_file(filename)
@@ -63,6 +69,61 @@ module LeapCli
       public_key || private_key
     end
 
+    #
+    # Picks one key out of an array of keys that we think is the "best",
+    # based on the order of preference in SUPPORTED_TYPES
+    #
+    # Currently, this does not take bitsize into account.
+    #
+    def self.pick_best_key(keys)
+      keys.select {|k|
+        SUPPORTED_TYPES.include?(k.type)
+      }.sort {|a,b|
+        SUPPORTED_TYPES.index(a.type) <=> SUPPORTED_TYPES.index(b.type)
+      }.first
+    end
+
+    #
+    # takes a string with one or more ssh keys, one key per line,
+    # and returns an array of SshKey objects.
+    #
+    # the lines should be in one of these formats:
+    #
+    # 1. <hostname> <key-type> <key>
+    # 2. <key-type> <key>
+    #
+    def self.parse_keys(string)
+      keys = []
+      lines = string.split("\n").grep(/^[^#]/)
+      lines.each do |line|
+        if line =~ / #{SshKey::SUPPORTED_TYPES_RE} /
+          # <hostname> <key-type> <key>
+          keys << line.split(' ')[1..2]
+        elsif line =~ /^#{SshKey::SUPPORTED_TYPES_RE} /
+          # <key-type> <key>
+          keys << line.split(' ')
+        end
+      end
+      return keys.map{|k| SshKey.load(k[1], k[0])}
+    end
+
+    #
+    # takes a string with one or more ssh keys, one key per line,
+    # and returns a string that specified the ssh key algorithms
+    # that are supported by the keys, in order of preference.
+    #
+    # eg: ecdsa-sha2-nistp256,ssh-rsa,ssh-ed25519
+    #
+    def self.supported_host_key_algorithms(string)
+      if string
+        self.parse_keys(string).map {|key|
+          key.type
+        }.join(',')
+      else
+        ""
+      end
+    end
+
     ##
     ## INSTANCE METHODS
     ##
@@ -100,7 +161,8 @@ module LeapCli
     end
 
     def summary
-      "%s %s %s (%s)" % [self.type, self.bits, self.fingerprint, self.filename || self.comment || '']
+      #"%s %s %s (%s)" % [self.type, self.bits, self.fingerprint, self.filename || self.comment || '']
+      "%s %s %s" % [self.type, self.bits, self.fingerprint]
     end
 
     def to_s

data/lib/leap_cli/util/remote_command.rb

@@ -78,10 +78,24 @@ module LeapCli; module Util; module RemoteCommand
       :keys_only => false, # Don't you dare change this.
       :global_known_hosts_file => path(:known_hosts),
       :user_known_hosts_file => '/dev/null',
-      :paranoid => true
+      :paranoid => true,
+      :verbose => net_ssh_log_level
     }
   end
 
+  def net_ssh_log_level
+    if DEBUG
+      case LeapCli.log_level
+        when 1 then 3
+        when 2 then 2
+        when 3 then 1
+        else 0
+      end
+    else
+      nil
+    end
+  end
+
   #
   # For notes on advanced ways to set server-specific options, see
   # http://railsware.com/blog/2011/11/02/advanced-server-definitions-in-capistrano/
@@ -106,7 +120,7 @@ module LeapCli; module Util; module RemoteCommand
     @capistrano_enabled ||= begin
       require 'capistrano'
       require 'capistrano/cli'
-      require 'lib_ext/capistrano_connections'
+      require 'leap_cli/lib_ext/capistrano_connections'
       require 'leap_cli/remote/leap_plugin'
       require 'leap_cli/remote/puppet_plugin'
       require 'leap_cli/remote/rsync_plugin'
@@ -135,6 +149,9 @@ module LeapCli; module Util; module RemoteCommand
         opts[:verbose] = :error # suppress all the warnings about adding host keys to known_hosts, since it is not actually doing that.
       end
     end
+    if !node.supported_ssh_host_key_algorithms.empty?
+      opts[:host_key] = node.supported_ssh_host_key_algorithms
+    end
     return opts
   end
 

data/lib/leap_cli/util/secret.rb

@@ -4,7 +4,7 @@
 #
 # Uses OpenSSL random number generator instead of Ruby's rand function
 #
-require 'openssl'
+autoload :OpenSSL, 'openssl'
 
 module LeapCli; module Util
   class Secret

data/lib/leap_cli/util/x509.rb

@@ -1,5 +1,6 @@
-require 'openssl'
-require 'certificate_authority'
+autoload :OpenSSL, 'openssl'
+autoload :CertificateAuthority, 'certificate_authority'
+
 require 'digest'
 require 'digest/md5'
 require 'digest/sha1'

data/lib/leap_cli/util.rb

@@ -8,13 +8,21 @@ module LeapCli
   module Util
     extend self
 
+    @@exit_status = nil
+
     ##
     ## QUITTING
     ##
 
     def exit_status(code=nil)
-      @exit_status = code if code
-      @exit_status
+      if !code.nil?
+        if code == 0 && @@exit_status.nil?
+          @@exit_status = 0
+        else
+          @@exit_status = code
+        end
+      end
+      @@exit_status
     end
 
     #
@@ -30,7 +38,7 @@ module LeapCli
     #
     def bail!(*message)
       if block_given?
-        LeapCli.log_level = 3
+        LeapCli.set_log_level(3)
         yield
       elsif message
         log 0, *message

data/lib/leap_cli/version.rb

@@ -1,7 +1,7 @@
 module LeapCli
   unless defined?(LeapCli::VERSION)
-    VERSION = '1.5.6'
-    COMPATIBLE_PLATFORM_VERSION = '0.5.2'..'1.99'
+    VERSION = '1.6.2'
+    COMPATIBLE_PLATFORM_VERSION = '0.6.0'..'1.99'
     SUMMARY = 'Command line interface to the LEAP platform'
     DESCRIPTION = 'The command "leap" can be used to manage a bevy of servers running the LEAP platform from the comfort of your own home.'
     LOAD_PATHS = ['lib', 'vendor/certificate_authority/lib', 'vendor/rsync_command/lib']

data/lib/leap_cli.rb

@@ -1,20 +1,31 @@
-module LeapCli; end
+module LeapCli
+  module Commands; end  # for commands in leap_cli/commands
+  module Macro; end     # for macros in leap_platform/provider_base/lib/macros
+end
 
 $ruby_version = RUBY_VERSION.split('.').collect{ |i| i.to_i }.extend(Comparable)
 
-require 'leap/platform.rb'
+# ensure lib/leap_cli/overrides has the highest priority
+$:.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.0'
+gem 'gli', '~> 2.12.0'
 
-require 'leap_cli/version.rb'
-require 'leap_cli/constants.rb'
-require 'leap_cli/requirements.rb'
-require 'leap_cli/exceptions.rb'
+require 'leap/platform'
 
-require 'leap_cli/leapfile.rb'
-require 'core_ext/hash'
-require 'core_ext/boolean'
-require 'core_ext/nil'
-require 'core_ext/string'
-require 'core_ext/json'
+require 'leap_cli/version'
+require 'leap_cli/exceptions'
+
+require 'leap_cli/leapfile'
+require 'leap_cli/core_ext/hash'
+require 'leap_cli/core_ext/boolean'
+require 'leap_cli/core_ext/nil'
+require 'leap_cli/core_ext/string'
+require 'leap_cli/core_ext/json'
+require 'leap_cli/core_ext/yaml'
 
 require 'leap_cli/log'
 require 'leap_cli/path'
@@ -31,12 +42,11 @@ 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/manager'
 
 require 'leap_cli/markdown_document_listener'
 
-module LeapCli::Commands; end
-
 #
 # allow everyone easy access to log() command.
 #