arduino_ci 0.1.9 → 0.1.10

data/lib/arduino_ci/arduino_installation.rb

@@ -1,10 +1,14 @@
 require "arduino_ci/host"
 require "arduino_ci/arduino_cmd_osx"
 require "arduino_ci/arduino_cmd_linux"
+require "arduino_ci/arduino_cmd_windows"
 require "arduino_ci/arduino_cmd_linux_builder"
+require "arduino_ci/arduino_downloader_osx"
+require "arduino_ci/arduino_downloader_linux"
+
+require "arduino_ci/arduino_downloader_windows" if ArduinoCI::Host.os == :windows
 
 DESIRED_ARDUINO_IDE_VERSION = "1.8.5".freeze
-USE_BUILDER = false
 
 module ArduinoCI
 
@@ -12,75 +16,67 @@ module ArduinoCI
   class ArduinoInstallation
 
     class << self
-      # @return [String] The location where a forced install will go
-      def force_install_location
-        File.join(ENV['HOME'], 'arduino_ci_ide')
-      end
 
       # attempt to find a workable Arduino executable across platforms
-      # @return [ArduinoCI::ArduinoCmd] an instance of the command
+      #
+      # Autolocation assumed to be an expensive operation
+      # @return [ArduinoCI::ArduinoCmd] an instance of the command or nil if it can't be found
       def autolocate
+        ret = nil
         case Host.os
-        when :osx then autolocate_osx
-        when :linux then autolocate_linux
+        when :osx then
+          ret = autolocate_osx
+        when :linux then
+          loc = ArduinoDownloaderLinux.autolocated_executable
+          return nil if loc.nil?
+          ret = ArduinoCmdLinux.new
+          ret.base_cmd = [loc]
+        when :windows then
+          loc = ArduinoDownloaderWindows.autolocated_executable
+          return nil if loc.nil?
+          ret = ArduinoCmdWindows.new
+          ret.base_cmd = [loc]
         end
+        ret
       end
 
-      # @return [ArduinoCI::ArduinoCmdOSX] an instance of a command
+      # @return [ArduinoCI::ArduinoCmdOSX] an instance of the command or nil if it can't be found
       def autolocate_osx
-        osx_root = "/Applications/Arduino.app/Contents"
+        osx_root = ArduinoDownloaderOSX.autolocated_installation
+        return nil if osx_root.nil?
         return nil unless File.exist? osx_root
 
-        ret = ArduinoCmdOSX.new
-
-        # old_way
-        # ret.base_cmd = [File.join("#{osx_root}/MacOS", "Arduino")]
-        ret.base_cmd = [
-          "java",
-          "-cp", "#{osx_root}/Java/*",
-          "-DAPP_DIR=#{osx_root}/Java",
-          "-Dfile.encoding=UTF-8",
-          "-Dapple.awt.UIElement=true",
-          "-Xms128M",
-          "-Xmx512M",
-          "processing.app.Base",
+        launchers = [
+          # try a hack that skips splash screen
+          # from https://github.com/arduino/Arduino/issues/1970#issuecomment-321975809
+          [
+            "java",
+            "-cp", "#{osx_root}/Java/*",
+            "-DAPP_DIR=#{osx_root}/Java",
+            "-Dfile.encoding=UTF-8",
+            "-Dapple.awt.UIElement=true",
+            "-Xms128M",
+            "-Xmx512M",
+            "processing.app.Base",
+          ],
+          # failsafe way
+          [File.join(osx_root, "Contents", "MacOS", "Arduino")]
         ]
-        ret
-      end
-
-      # @return [ArduinoCI::ArduinoCmdLinux] an instance of a command
-      def autolocate_linux
-        if USE_BUILDER
-          builder_name = "arduino-builder"
-          cli_place = Host.which(builder_name)
-          unless cli_place.nil?
-            ret = ArduinoCmdLinuxBuilder.new
-            ret.base_cmd = [cli_place]
-            return ret
-          end
 
-          forced_builder = File.join(force_install_location, builder_name)
-          if File.exist?(forced_builder)
-            ret = ArduinoCmdLinuxBuilder.new
-            ret.base_cmd = [forced_builder]
+        # create return and find a command launcher that works
+        ret = ArduinoCmdOSX.new
+        launchers.each do |launcher|
+          # test whether this method successfully launches the IDE
+          # note that "successful launch" involves a command that will fail,
+          # because that's faster than any command which succeeds.  what we
+          # don't want to see is a java error.
+          args = launcher + ["--bogus-option"]
+          result = Host.run_and_capture(*args)
+          if result[:err].include? "Error: unknown option: --bogus-option"
+            ret.base_cmd = launcher
             return ret
           end
         end
-
-        gui_name = "arduino"
-        gui_place = Host.which(gui_name)
-        unless gui_place.nil?
-          ret = ArduinoCmdLinux.new
-          ret.base_cmd = [gui_place]
-          return ret
-        end
-
-        forced_arduino = File.join(force_install_location, gui_name)
-        if File.exist?(forced_arduino)
-          ret = ArduinoCmdLinux.new
-          ret.base_cmd = [forced_arduino]
-          return ret
-        end
         nil
       end
 
@@ -98,30 +94,13 @@ module ArduinoCI
       # Forcibly install Arduino from the web
       # @return [bool] Whether the command succeeded
       def force_install
-        case Host.os
-        when :linux
-          pkgname = "arduino-#{DESIRED_ARDUINO_IDE_VERSION}"
-          tarfile = "#{pkgname}-linux64.tar.xz"
-          if File.exist? tarfile
-            puts "Arduino tarfile seems to have been downloaded already"
-          else
-            puts "Downloading Arduino binary with wget"
-            system("wget", "--quiet", "--progress=dot:giga", "https://downloads.arduino.cc/#{tarfile}")
-          end
-
-          if File.exist? pkgname
-            puts "Tarfile seems to have been extracted already"
-          else
-            puts "Extracting archive with tar"
-            system("tar", "xf", tarfile)
-          end
-
-          if File.exist? force_install_location
-            puts "Arduino binary seems to have already been force-installed"
-          else
-            system("mv", pkgname, force_install_location)
-          end
-        end
+        worker_class =  case Host.os
+                        when :osx then ArduinoDownloaderOSX
+                        when :windows then ArduinoDownloaderWindows
+                        when :linux then ArduinoDownloaderLinux
+                        end
+        worker = worker_class.new(DESIRED_ARDUINO_IDE_VERSION)
+        worker.execute
       end
 
     end

data/lib/arduino_ci/arduino_installation.rb.orig

@@ -0,0 +1,116 @@
+require "arduino_ci/host"
+require "arduino_ci/arduino_cmd_osx"
+require "arduino_ci/arduino_cmd_linux"
+require "arduino_ci/arduino_cmd_linux_builder"
+require "arduino_ci/arduino_downloader_linux"
+require "arduino_ci/arduino_downloader_osx"
+
+DESIRED_ARDUINO_IDE_VERSION = "1.8.5".freeze
+
+module ArduinoCI
+
+  # Manage the OS-specific install location of Arduino
+  class ArduinoInstallation
+
+    class << self
+
+      # attempt to find a workable Arduino executable across platforms
+      #
+      # Autolocation assumed to be an expensive operation
+      # @return [ArduinoCI::ArduinoCmd] an instance of the command or nil if it can't be found
+      def autolocate
+        ret = nil
+        case Host.os
+        when :osx then
+          ret = autolocate_osx
+        when :linux then
+<<<<<<< HEAD
+          loc = ArduinoDownloaderLinux.autolocation
+          return nil if loc.nil?
+          ret = ArduinoCmdLinux.new
+          ret.base_cmd = [loc]
+=======
+          loc = ArduinoDownloaderLinux.autolocated_executable
+          return nil if loc.nil?
+          ret = ArduinoCmdLinux.new
+          ret.base_cmd = [loc]
+          # when :windows then
+          #   ArduinoDownloaderWindows.autolocation
+          #   return nil if loc.nil?
+          #   ret = ArduinoCmdWindows.new
+          #   ret.base_cmd = [loc]
+>>>>>>> Refactor force_install code in preparation for windows CI
+        end
+        ret
+      end
+
+      # @return [ArduinoCI::ArduinoCmdOSX] an instance of the command or nil if it can't be found
+      def autolocate_osx
+<<<<<<< HEAD
+        osx_root = ArduinoDownloaderOSX.autolocation
+=======
+        osx_root = ArduinoDownloaderOSX.autolocated_installation
+        return nil if osx_root.nil?
+>>>>>>> Refactor force_install code in preparation for windows CI
+        return nil unless File.exist? osx_root
+
+        launchers = [
+          # try a hack that skips splash screen
+          # from https://github.com/arduino/Arduino/issues/1970#issuecomment-321975809
+          [
+            "java",
+            "-cp", "#{osx_root}/Java/*",
+            "-DAPP_DIR=#{osx_root}/Java",
+            "-Dfile.encoding=UTF-8",
+            "-Dapple.awt.UIElement=true",
+            "-Xms128M",
+            "-Xmx512M",
+            "processing.app.Base",
+          ],
+          # failsafe way
+          [File.join(osx_root, "MacOS", "Arduino")]
+        ]
+
+        # create return and find a command launcher that works
+        ret = ArduinoCmdOSX.new
+        launchers.each do |launcher|
+          # test whether this method successfully launches the IDE
+          # note that "successful launch" involves a command that will fail,
+          # because that's faster than any command which succeeds.  what we
+          # don't want to see is a java error.
+          args = launcher + ["--bogus-option"]
+          result = Host.run_and_capture(*args)
+          if result[:err].include? "Error: unknown option: --bogus-option"
+            ret.base_cmd = launcher
+            return ret
+          end
+        end
+        nil
+      end
+
+      # Attempt to find a workable Arduino executable across platforms, and install it if we don't
+      # @return [ArduinoCI::ArduinoCmd] an instance of a command
+      def autolocate!
+        candidate = autolocate
+        return candidate unless candidate.nil?
+
+        # force the install
+        force_install
+        autolocate
+      end
+
+      # Forcibly install Arduino from the web
+      # @return [bool] Whether the command succeeded
+      def force_install
+        worker_class =  case Host.os
+                        when :osx then ArduinoDownloaderOSX
+                        # when :windows then force_install_windows
+                        when :linux then ArduinoDownloaderLinux
+                        end
+        worker = worker_class.new(DESIRED_ARDUINO_IDE_VERSION)
+        worker.execute
+      end
+
+    end
+  end
+end

data/lib/arduino_ci/display_manager.rb

@@ -34,6 +34,7 @@ module ArduinoCI
     # @return [bool] whether there is already a GUI that can accept windows
     def existing_display?
       return true  if RUBY_PLATFORM.include? "darwin"
+      return true  if Host.os == :windows
       return false if ENV["DISPLAY"].nil?
       return true  if ENV["DISPLAY"].include? ":"
       false

data/lib/arduino_ci/host.rb

@@ -37,5 +37,16 @@ module ArduinoCI
       return :windows if OS.windows?
     end
 
+    # if on windows, call mklink, else self.symlink
+    # https://stackoverflow.com/a/22716582/2063546
+    def self.symlink(old_path, new_path)
+      return FileUtils.ln_s(old_path, new_path) unless RUBY_PLATFORM =~ /mswin32|cygwin|mingw|bccwin/
+
+      # windows mklink syntax is reverse of unix ln -s
+      # windows mklink is built into cmd.exe
+      # vulnerable to command injection, but okay because this is a hack to make a cli tool work.
+      _stdin, _stdout, _stderr, wait_thr = Open3.popen3('cmd.exe', "/c mklink #{new_path} #{old_path}")
+      wait_thr.value.exitstatus
+    end
   end
 end

data/lib/arduino_ci/version.rb

@@ -1,3 +1,3 @@
 module ArduinoCI
-  VERSION = "0.1.9".freeze
+  VERSION = "0.1.10".freeze
 end

data/lib/arduino_ci.rb

@@ -4,7 +4,7 @@ require "arduino_ci/cpp_library"
 require "arduino_ci/ci_config"
 
 # ArduinoCI contains classes for automated testing of Arduino code on the command line
-# @author Ian Katz <ifreecarve@gmail.com>
+# @author Ian Katz <ianfixes@gmail.com>
 module ArduinoCI
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,7 @@ dependencies:
         version: 0.9.11
 description: ''
 email:
-- ifreecarve@gmail.com
+- ianfixes@gmail.com
 executables:
 - arduino_ci_remote.rb
 extensions: []
@@ -394,14 +408,23 @@ files:
 - lib/arduino_ci/arduino_cmd_linux.rb
 - lib/arduino_ci/arduino_cmd_linux_builder.rb
 - lib/arduino_ci/arduino_cmd_osx.rb
+- lib/arduino_ci/arduino_cmd_windows.rb
+- lib/arduino_ci/arduino_downloader.rb
+- lib/arduino_ci/arduino_downloader.rb.orig
+- lib/arduino_ci/arduino_downloader_linux.rb
+- lib/arduino_ci/arduino_downloader_linux.rb.orig
+- lib/arduino_ci/arduino_downloader_osx.rb
+- lib/arduino_ci/arduino_downloader_osx.rb.orig
+- lib/arduino_ci/arduino_downloader_windows.rb
 - lib/arduino_ci/arduino_installation.rb
+- lib/arduino_ci/arduino_installation.rb.orig
 - lib/arduino_ci/ci_config.rb
 - lib/arduino_ci/cpp_library.rb
 - lib/arduino_ci/display_manager.rb
 - lib/arduino_ci/host.rb
 - lib/arduino_ci/version.rb
 - misc/default.yml
-homepage: http://github.com/ifreecarve/arduino_ci
+homepage: http://github.com/ianfixes/arduino_ci
 licenses:
 - Apache-2.0
 metadata: {}