big refactor to enable no-x-required arduino-builder

Author: ianfixes

lib/arduino_ci/arduino_cmd.rb

@@ -22,7 +22,6 @@ def autolocate!
     end
 
     attr_accessor :installation
-    attr_reader   :prefs_cache
     attr_reader   :prefs_response_time
     attr_reader   :library_is_indexed
 
@@ -31,26 +30,47 @@ def initialize(installation)
       @display_mgr         = DisplayManager::instance
       @installation        = installation
       @prefs_response_time = nil
-      @prefs_cache         = prefs
+      @prefs_cache         = nil
       @library_is_indexed  = false
     end
 
+    def _parse_pref_string(arduino_output)
+      lines = arduino_output.split("\n").select { |l| l.include? "=" }
+      ret = lines.each_with_object({}) do |e, acc|
+        parts = e.split("=", 2)
+        acc[parts[0]] = parts[1]
+        acc
+      end
+      ret
+    end
+
     # fetch preferences to a hash
-    def prefs
+    def _prefs
       resp = nil
-      @display_mgr.with_display do
+      if @installation.requires_x
+        @display_mgr.with_display do
+          start = Time.now
+          resp = run_and_capture("--get-pref")
+          @prefs_response_time = Time.now - start
+        end
+      else
         start = Time.now
         resp = run_and_capture("--get-pref")
         @prefs_response_time = Time.now - start
       end
       return nil unless resp[:success]
-      lines = resp[:out].split("\n").select { |l| l.include? "=" }
-      ret = lines.each_with_object({}) do |e, acc|
-        parts = e.split("=", 2)
-        acc[parts[0]] = parts[1]
-        acc
-      end
-      ret
+      _parse_pref_string(resp[:out])
+    end
+
+    def prefs
+      @prefs_cache = _prefs if @prefs_cache.nil?
+      @prefs_cache.clone
+    end
+
+    # get a preference key
+    def get_pref(key)
+      data = @prefs_cache.nil? ? prefs : @prefs_cache
+      data[key]
     end
 
     # set a preference key/value pair
@@ -65,13 +85,22 @@ def set_pref(key, value)
 
     # run the arduino command
     def run(*args, **kwargs)
-      full_args = [@installation.cmd_path] + args
-      @display_mgr.run(*full_args, **kwargs)
+      full_args = @installation.base_cmd + args
+      if @installation.requires_x
+        @display_mgr.run(*full_args, **kwargs)
+      else
+        Host.run(*full_args, **kwargs)
+      end
     end
 
     def run_with_gui_guess(message, *args, **kwargs)
       # On Travis CI, we get an error message in the GUI instead of on STDERR
       # so, assume that if we don't get a rapid reply that things are not installed
+
+      # if we don't need X, we can skip this whole thing
+      return run_and_capture(*args, **kwargs)[:success] unless @installation.requires_x
+
+      prefs if @prefs_response_time.nil?
       x3 = @prefs_response_time * 3
       Timeout.timeout(x3) do
         result = run_and_capture(*args, **kwargs)

lib/arduino_ci/arduino_installation.rb

@@ -6,53 +6,96 @@ module ArduinoCI
 
   # Manage the OS-specific install location of Arduino
   class ArduinoInstallation
-    attr_accessor :cmd_path
+    attr_accessor :base_cmd
     attr_accessor :lib_dir
+    attr_accessor :requires_x
 
     class << self
       def force_install_location
         File.join(ENV['HOME'], 'arduino_ci_ide')
       end
 
+      def from_forced_install
+        ret = new
+        builder = File.join(force_install_location, "arduino-builder")
+        if File.exist? builder
+          ret.base_cmd = [builder]
+          ret.requires_x = false
+        else
+          ret.base_cmd = [File.join(force_install_location, "arduino")]
+          ret.requires_x = true
+        end
+        ret.lib_dir = File.join(force_install_location, "libraries")
+        # TODO: "libraries" is what's in the adafruit install.sh script
+        ret
+      end
+
       # attempt to find a workable Arduino executable across platforms
       def autolocate
-        ret = new
+        osx_root = "/Applications/Arduino.app"
+        old_way = false
+        if File.exist? osx_root
+          ret = new
+          osx_place = "#{osx_root}/Contents/MacOS"
 
-        osx_place = "/Applications/Arduino.app/Contents/MacOS"
-        if File.exist? osx_place
-          ret.cmd_path = File.join(osx_place, "Arduino")
+          if old_way
+            ret.base_cmd = [File.join(osx_place, "Arduino")]
+          else
+            jvm_runtime = `/usr/libexec/java_home`
+            ret.base_cmd = [
+              "java",
+              "-cp", "#{osx_root}/Contents/Java/*",
+              "-DAPP_DIR=#{osx_root}/Contents/Java",
+              "-Djava.ext.dirs=$JVM_RUNTIME/Contents/Home/lib/ext/:#{jvm_runtime}/Contents/Home/jre/lib/ext/",
+              "-Dfile.encoding=UTF-8",
+              "-Dapple.awt.UIElement=true",
+              "-Xms128M",
+              "-Xmx512M",
+              "processing.app.Base",
+            ]
+          end
           ret.lib_dir = File.join(osx_place, "Libraries")
+          ret.requires_x = false
           return ret
         end
 
+        # # AAARRRRGGGGHHH
+        # # Even though arduino-builder is an awesome CLI for Arduino,
+        # # ALL THE OPTIONS ARE DIFFERENT (single vs double dash for flags)
+        # #  USELESS FOR THE TIME BEING
+        #
+        # posix_place = Host.which("arduino-builder")
+        # unless posix_place.nil?
+        #   ret = new
+        #   ret.base_cmd = [posix_place]
+        #   ret.lib_dir = File.join(ENV['HOME'], "Sketchbook") # assume linux
+        #   ret.requires_x = false
+        #   # https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use/how-to-install-a-library
+        #   return ret
+        # end
+
         posix_place = Host.which("arduino")
         unless posix_place.nil?
-          ret.cmd_path = posix_place
+          ret = new
+          ret.base_cmd = [posix_place]
           ret.lib_dir = File.join(ENV['HOME'], "Sketchbook") # assume linux
+          ret.requires_x = true
           # https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use/how-to-install-a-library
           return ret
         end
 
-        if File.exist? force_install_location
-          ret.cmd_path = File.join(force_install_location, "arduino")
-          ret.lib_dir = File.join(force_install_location, "libraries")
-          # TODO: "libraries" is what's in the adafruit install.sh script
-          return ret
-        end
+        return from_forced_install if File.exist? force_install_location
 
-        ret
+        new
       end
 
       # Attempt to find a workable Arduino executable across platforms, and install it if we don't
       def autolocate!
         candidate = autolocate
-        return candidate unless candidate.cmd_path.nil?
-        # force the install
+        return candidate unless candidate.base_cmd.nil?
 
-        if force_install
-          candidate.cmd_path = File.join(force_install_location, "arduino")
-          candidate.lib_dir = File.join(force_install_location, "libraries")
-        end
+        # force the install
+        candidate = from_forced_install if force_install
         candidate
       end
 

lib/arduino_ci/display_manager.rb

@@ -148,11 +148,7 @@ def run(*args, **kwargs)
         env_vars.merge!(args[0]) if has_env
         actual_args = has_env ? args[1..-1] : args  # need to shift over if we extracted args
         full_cmd = env_vars.empty? ? actual_args : [env_vars] + actual_args
-        shell_vars = env_vars.map { |k, v| "#{k}=#{v}" }.join(" ")
-        puts " $ #{shell_vars} #{actual_args.join(' ')}"
-        ret = system(*full_cmd, **kwargs)
-        status = ret ? "succeeded" : "failed"
-        puts "#{actual_args[0]} has #{status}"
+        ret = Host.run(*full_cmd, **kwargs)
       end
       ret
     end

lib/arduino_ci/host.rb

@@ -15,5 +15,21 @@ def self.which(cmd)
       end
       nil
     end
+
+    # run a command in a display
+    def self.run(*args, **kwargs)
+      # do some work to extract & merge environment variables if they exist
+      has_env = !args.empty? && args[0].class == Hash
+      env_vars = has_env ? args[0] : {}
+      actual_args = has_env ? args[1..-1] : args  # need to shift over if we extracted args
+      full_cmd = env_vars.empty? ? actual_args : [env_vars] + actual_args
+      shell_vars = env_vars.map { |k, v| "#{k}=#{v}" }.join(" ")
+      puts " $ #{shell_vars} #{actual_args.join(' ')}"
+      ret = system(*full_cmd, **kwargs)
+      status = ret ? "succeeded" : "failed"
+      puts "#{actual_args[0]} has #{status}"
+      ret
+    end
+
   end
 end

spec/arduino_cmd_spec.rb

@@ -15,8 +15,8 @@ def get_sketch(dir, file)
   context "autolocate!" do
     it "Finds the Arduino executable" do
       arduino_cmd = ArduinoCI::ArduinoCmd.autolocate!
-      expect(arduino_cmd.installation.cmd_path).not_to be nil
-      expect(arduino_cmd.prefs_cache.class).to be Hash
+      expect(arduino_cmd.installation.base_cmd).not_to be nil
+      expect(arduino_cmd.prefs.class).to be Hash
       expect(arduino_cmd.prefs_response_time).not_to be nil
     end
   end
@@ -42,7 +42,7 @@ def get_sketch(dir, file)
     ArduinoCI::DisplayManager::instance.enable
 
     it "Sets key to what it was before" do
-      upload_verify = arduino_cmd.prefs_cache["upload.verify"]
+      upload_verify = arduino_cmd.get_pref("upload.verify")
       result = arduino_cmd.set_pref("upload.verify", upload_verify)
       expect(result).to be true
     end

spec/arduino_installation_spec.rb

@@ -16,7 +16,7 @@
   context "autolocate!" do
     it "doesn't fail" do
       installation = ArduinoCI::ArduinoInstallation.autolocate!
-      expect(installation.cmd_path).not_to be nil
+      expect(installation.base_cmd).not_to be nil
       expect(installation.lib_dir).not_to be nil
     end
   end