hobo-inviqa 0.0.6 → 0.0.7.pre.rc1

data/lib/hobo/helper/shell.rb

@@ -20,12 +20,27 @@ module Hobo
     end
 
     def shell *args, &block
+      def chunk_line_iterator stream
+        begin
+          until (chunk = stream.readpartial(1024)).nil? do
+            chunk.each_line do |outer_line|
+              outer_line.each_line("\r") do |line|
+                yield line
+              end
+            end
+          end
+        rescue EOFError
+          # NOP
+        end
+      end
+
       opts = (args.size > 1 && args.last.is_a?(Hash)) ? args.pop : {}
       opts = {
         :capture => false,
         :indent => 0,
         :realtime => false,
-        :env => {}
+        :env => {},
+        :ignore_errors => false
       }.merge! opts
 
       Hobo::Logging.logger.debug("helper.shell: Invoking '#{args.join(" ")}' with #{opts.to_s}")
@@ -35,16 +50,17 @@ module Hobo
         buffer = ::Tempfile.new 'hobo_run_buf'
         buffer.sync = true
         threads = [external]
+        last_buf = ""
 
         ## Create a thread to read from each stream
         { :out => out, :err => err }.each do |key, stream|
           threads.push(::Thread.new do
-            until (line = stream.gets).nil? do
-              line = ::Hobo.ui.color(line.strip, :error) if key == :err
+            chunk_line_iterator stream do |line|
+              line = ::Hobo.ui.color(line, :error) if key == :err
               buffer.write("#{line.strip}\n")
               Hobo::Logging.logger.debug("helper.shell: #{line.strip}")
               line = yield line if block
-              puts indent + line if opts[:realtime] && !line.nil?
+              print indent + line if opts[:realtime] && !line.nil?
             end
           end)
         end
@@ -56,7 +72,7 @@ module Hobo
         buffer.fsync
         buffer.rewind
 
-        raise ::Hobo::ExternalCommandError.new(args.join(" "), external.value.exitstatus, buffer) if external.value.exitstatus != 0
+        raise ::Hobo::ExternalCommandError.new(args.join(" "), external.value.exitstatus, buffer) if external.value.exitstatus != 0 && !opts[:ignore_errors]
 
         return opts[:capture] ? buffer.read.strip : nil
       end

data/lib/hobo/helper/vm_command.rb

@@ -1,39 +1,116 @@
-require 'hobo/helper/shell'
+require 'tempfile'
 
 module Hobo
   module Helper
-    def vm_shell command
-      shell VmCommand.new(command).to_s
+    def vm_shell command, opts = {}
+      shell VmCommand.new(command, opts).to_s, opts
     end
 
     def vm_mysql opts = {}
       opts = {
         :auto_echo => true,
         :db => "",
-        :user => maybe(Hobo.project_config.mysql.username) || "root",
-        :pass => maybe(Hobo.project_config.mysql.password) || "root"
+        :user => maybe(Hobo.project_config.mysql.username) || "",
+        :pass => maybe(Hobo.project_config.mysql.password) || "",
+        :mysql => 'mysql'
       }.merge(opts)
 
-      VmCommand.new "mysql -u#{opts[:user].shellescape} -p#{opts[:pass].shellescape} #{opts[:db].shellescape}", opts
+      opts[:user] = "-u#{opts[:user].shellescape}" unless opts[:user].empty?
+      opts[:pass] = "-p#{opts[:pass].shellescape}" unless opts[:pass].empty?
+      opts[:db] = opts[:db].shellescape unless opts[:db].empty?
+
+      VmCommand.new "#{opts[:mysql]} #{opts[:user]} #{opts[:pass]} #{opts[:db]}".strip, opts
     end
 
-    def vm_command command = nil
-      VmCommand.new command
+    def vm_command command = nil, opts = {}
+      VmCommand.new command, opts
     end
 
     private
 
+    class VmInspector
+      attr_accessor :ssh_config, :project_mount_path
+
+      def project_mount_path
+        configured_path = maybe(Hobo.project_config.vm.project_mount_path)
+        return configured_path if configured_path
+        return @project_mount_path if @project_mount_path
+
+        tmp = Tempfile.new('vm_command_locator', Hobo.project_path)
+        tmp.write(Hobo.project_path)
+
+        locator_file = File.basename(tmp.path)
+
+        pattern = OS.windows? ? 'vboxsf' : Hobo.project_path.shellescape
+
+        # TODO genericise the command escaping from lib/hobo/patches/slop.rb to avoid nested shell escaping hell
+        sed = 's/.* on \(.*\) type.*/\\\1\\\/%%/g'.gsub('%%', locator_file)
+        locator_results = vm_shell(
+          "mount | grep #{pattern} | sed -e\"#{sed}\" | xargs md5sum",
+          :capture => true,
+          :pwd => '/',
+          :psuedo_tty => false,
+          :ignore_errors => true
+        )
+
+        tmp.close
+
+        match = locator_results.match(/^([a-z0-9]{32})\s+(.*)$/)
+
+        raise Exception.new("Unable to locate project mount point in VM") if !match
+
+        @project_mount_path = File.dirname(match[2])
+
+        # Stash it in config
+        Hobo.project_config[:vm] ||= {}
+        Hobo.project_config[:vm][:project_mount_path] = @vm_project_mount_path
+        Hobo::Config::File.save(Hobo.project_config_file, Hobo.project_config)
+
+        return @vm_project_mount_path
+      end
+
+      def ssh_config
+        return @ssh_config if @ssh_config
+        config = nil
+        locate "*Vagrantfile" do
+          config = bundle_shell "vagrant ssh-config", :capture => true
+        end
+
+        raise Exception.new "Could not retrieve VM ssh configuration" unless config
+
+        patterns = {
+          :ssh_user => /^\s*User (.*)$/,
+          :ssh_identity => /^\s*IdentityFile (.*)$/,
+          :ssh_host => /^\s*HostName (.*)$/,
+          :ssh_port => /^\s*Port (\d+)/
+        }
+
+        output = {}
+
+        patterns.each do |k, pattern|
+          match = config.match(pattern)
+          output[k] = match[1] if match
+        end
+
+        return @ssh_config = output
+      end
+    end
+
     class VmCommand
+      class << self
+        attr_accessor :vm_inspector
+        @@vm_inspector = VmInspector.new
+      end
+
       attr_accessor :opts, :command
 
       def initialize command, opts = {}
         @command = command
         @opts = {
           :auto_echo => false,
-          :psuedo_tty => true,
-          :ssh_identity => "#{ENV['HOME'].shellescape}/.vagrant.d/insecure_private_key",
-          :ssh_user => "vagrant",
-          :ssh_host => maybe(Hobo.project_config.hostname) || ""
+          :psuedo_tty => false,
+          :pwd => opts[:pwd] || @@vm_inspector.project_mount_path,
+          :append => ''
         }.merge(opts)
       end
 
@@ -44,12 +121,45 @@ module Hobo
         return self
       end
 
+      def < pipe
+        pipe = "echo '#{pipe.shellescape}'" if opts[:auto_echo]
+        @pipe_in_vm = pipe
+        @opts[:psuedo_tty] = false
+        return self
+      end
+
+      # TODO Speed up Vagrant SSH connections
+      # May need to be disabled for windows (mm_send_fd: UsePrivilegeSeparation=yes not supported)
+      # https://gist.github.com/jedi4ever/5657094
+
       def to_s
-        psuedo_tty = @opts[:psuedo_tty] ? "-t" : ""
-        command = [
-          "ssh -i #{opts[:ssh_identity]} #{psuedo_tty} #{opts[:ssh_user].shellescape}@#{opts[:ssh_host].shellescape}",
+        opts = @@vm_inspector.ssh_config.merge(@opts)
+
+        psuedo_tty = opts[:psuedo_tty] ? "-t" : ""
+
+        ssh_command = [
+          "ssh",
+          "-o 'UserKnownHostsFile /dev/null'",
+          "-o 'StrictHostKeyChecking no'",
+          "-o 'ForwardAgent yes'",
+          "-o 'LogLevel FATAL'",
+          "-p #{opts[:ssh_port]}",
+          "-i #{opts[:ssh_identity].shellescape}",
+          psuedo_tty,
+          "#{opts[:ssh_user].shellescape}@#{opts[:ssh_host].shellescape}"
+        ].join(" ")
+
+        pwd_set_command = " -- \"cd #{@opts[:pwd].shellescape}; exec /bin/bash"
+
+        vm_command = [
+          @pipe_in_vm,
           @command
-        ].compact.join(" -- ")
+        ].compact.join(" | ")
+
+        command = [
+          ssh_command + pwd_set_command,
+          vm_command.empty? ? nil : vm_command.shellescape
+        ].compact.join(" -c ") + "#{opts[:append].shellescape}\""
 
         [
           @pipe,
@@ -64,4 +174,4 @@ module Hobo
   end
 end
 
-include Hobo::Helper
+include Hobo::Helper

data/lib/hobo/lib/host_check.rb

@@ -4,20 +4,34 @@ module Hobo
       class << self
         include Hobo::Lib::HostCheck
 
-        def check silent = true
+        def check opts = {}
+          opts = {
+            :filter => nil,
+            :raise => false
+          }.merge(opts)
+
+          results = {}
           methods = Hobo::Lib::HostCheck.public_instance_methods(false)
           methods.each do |method|
+            next if opts[:filter] && !method.match(opts[:filter])
+
             name = method.to_s.gsub('_', ' ')
             name[0] = name[0].upcase
-            begin
+            if opts[:raise]
               self.send method
-              Hobo.ui.success "#{name}: OK" unless silent
-            rescue
-              Hobo.ui.error "#{name}: FAILED" unless silent
+            else
+              begin
+                self.send method
+                results[name] = :ok
+              rescue Hobo::Error => error
+                results[name] = error
+              end
             end
           end
+
+          return results
         end
       end
     end
   end
-end
+end

data/lib/hobo/lib/host_check/deps.rb

@@ -2,20 +2,38 @@ module Hobo
   module Lib
     module HostCheck
       def ssh_present
+        advice = "The SSH command could not be located on your system.\n\n"
+
+        if OS.windows?
+          advice += "To make SSH available you must re-install git using the installer from http://git-scm.com/downloads ensuring you select the 'Use git and unix tools everywhere' option."
+        else
+          advice += "Please install openssh using your package manager."
+        end
+
         begin
           shell "ssh -V"
         rescue Errno::ENOENT
-          raise Hobo::MissingDependency.new("ssh")
+          raise Hobo::HostCheckError.new("SSH is missing", advice)
         end
       end
 
       def php_present
+        advice = <<-EOF
+The PHP command could not be located on your system.
+
+This is an optional command that can speed up composer dependency installs.
+
+Please install it from your package manager ensuring that the following command does not produce any errors:
+
+  php -r "readfile('https://getcomposer.org/installer');" | php
+EOF
+
         begin
-          shell "php -v"
+          shell "php --version"
         rescue Errno::ENOENT
-          raise Hobo::MissingDependency.new("php")
+          raise Hobo::HostCheckError.new("PHP is missing", advice)
         end
       end
     end
   end
-end
+end

data/lib/hobo/lib/host_check/git.rb

@@ -2,46 +2,70 @@ module Hobo
   module Lib
     module HostCheck
       def git_present
+        advice = "The Git command could not be detected on your system.\n\n"
+        if OS.windows?
+          advice += "Please install it from http://git-scm.com/downloads ensuring you select the 'Use git and unix tools everywhere' option."
+        else
+          advice += "Please install it using your package manager."
+        end
+
         begin
           shell "git --version"
         rescue Errno::ENOENT
-          raise Hobo::MissingDependency.new("ssh")
+          raise Hobo::HostCheckError.new("Git is missing", advice)
         end
       end
 
       def git_config_name_set
+        advice = <<-EOF
+You have not set your name in git config!
+
+Please do so with the following command:
+  git config --global user.name <your name here>
+EOF
         begin
           shell "git config user.name"
         rescue Hobo::ExternalCommandError
-          Hobo.ui.error "You must provide git with your full name"
-          name = Hobo.ui.ask "Full name"
-          shell "git config --global user.name #{name.shellescape}"
+          raise Hobo::HostCheckError.new("Git config is incomplete (Full name)", advice)
         end
       end
 
       def git_config_email_set
+        advice = <<-EOF
+You have not set your email in git config!
+
+Please do so with the following command:
+  git config --global user.email <your email here>
+EOF
+
         begin
           shell "git config user.email"
         rescue Hobo::ExternalCommandError
-          email = Hobo.ui.ask "Email address"
-          shell "git config --global user.email #{email.shellescape}"
+          raise Hobo::HostCheckError.new("Git config is incomplete (Email)", advice)
         end
       end
 
       def git_autocrlf_disabled
-        return true
+        return unless OS.windows?
+
+        advice = <<-EOF
+You're using git with the core.autocrlf option enabled.
+
+This setting can often cause problems when you clone a repository on windows but need to execute the contents of that repository within a linux VM.
+
+You can disable autocrlf globally with the following command:
+  git config --global core.autocrlf false
+
+Disabling this setting will cause git to see all line endings as changed in a repository that was cloned with it enabled.
+As such, you must either enable it just for those repositories or delete and re-clone them with the setting disabled.
+
+You can enable the setting on a per-clone basis by ensuring that you are in the project directory and executing the following command:
+  git config core-autocrlf true
+EOF
         begin
           value = shell "git config core.autocrlf", :capture => true
           if value != "false"
-            Hobo.ui.error "You're using git with autocrlf!"
-            Hobo.ui.error "This setting can cause problems executing scripts within VMs."
-            Hobo.ui.error "If you've had it enabled for a while, you'll need to check out all of your repositories again if you change it."
-            disable = Hobo.ui.ask "Would you like to disable this setting?", :default => true
-            if disable
-              shell "git config --global core.autocrlf false"
-              Hobo.ui.success "Disabled autocrlf\nYou can re-enable it by executing `git config --global core.autocrlf true"
-            end
-
+            raise Hobo::HostCheckError.new("Git config has autocrlf enabled", advice)
           end
         rescue Hobo::ExternalCommandError
           # NOP
@@ -49,4 +73,4 @@ module Hobo
       end
     end
   end
-end
+end

data/lib/hobo/lib/host_check/ruby.rb

@@ -2,41 +2,51 @@ module Hobo
   module Lib
     module HostCheck
       def not_using_system_ruby
-        return if Gem.win_platform?
+        return if OS.windows?
+        advice = <<-EOF
+You're using a system ruby install which can cause issues with installing Gems and running some older projects.
+
+rbenv is HIGHLY recommended.
+
+You can install it with the following command:
+  curl https://raw.github.com/fesplugas/rbenv-installer/master/bin/rbenv-installer | bash
+
+Once installed, run the following to set it as the default ruby and re-install hobo-inviqa:
+  rbenv install 1.9.3-p448 && rbenv global 1.9.3-448 && gem install hobo-inviqa
+EOF
         which = shell "which ruby", :capture => true
-        unless which =~ /\.rbenc|\.rvm/
-          Hobo.ui.error "You're using a system ruby install! rbenv is HIGHLY recommended"
-          Hobo.ui.error "You can install it with the following command:\n"
-          Hobo.ui.error "  curl https://raw.github.com/fesplugas/rbenv-installer/master/bin/rbenv-installer | bash\n"
-          Hobo.ui.error "Once installed, run the following:\n"
-          Hobo.ui.error "  rbenv install 1.9.3-p448 && rbenv global 1.9.3-448 && gem install hobo-inviqa"
-          raise "System ruby in use"
+        unless which =~ /\.rbenv|\.rvm/
+          raise Hobo::HostCheckError.new("Hobo is running under a system ruby", advice)
         end
       end
 
       def system_paths_for_ruby
-        return if Gem.win_platform?
+        return if OS.windows?
+
+        advice = <<-EOF
+The ordering of your system paths may cause a problem with Gems.
+
+Unfortunately we can't automatically fix this for you at this time.
+
+Please seek assistance.
+
+Your paths were detected as:
+
+#{ENV['PATH'].split(':').join("\n")}
+EOF
+
         paths = ENV['PATH'].split(':')
         system_path_found = false
         ruby_path_found = false
         paths.each do |path|
           system_before_ruby = system_path_found && !ruby_path_found
           ruby_after_system = path =~ /\.rbenv|\.rvm/ && system_path_found
-          raise "Bad system paths" if system_before_ruby or ruby_after_system
+          raise Hobo::HostCheckError.new("System paths appear to be mis-ordered", advice) if system_before_ruby or ruby_after_system
 
           ruby_path_found = true if path =~ /\.rbenv|\.rvm/
           system_path_found = true if path =~ /\/usr\/bin|\/usr\/local\/bin/
         end
       end
-
-      def ruby_include_paths
-        paths = $:
-        bad_paths = paths.reject do |path|
-          path.match /\.rbenv|\.rvm/
-        end.compact.length > 0
-
-        raise "Bad gem paths" if bad_paths
-      end
     end
   end
-end
+end