arduino_ci 0.1.9 → 0.1.10

data/lib/arduino_ci/arduino_downloader.rb.orig

@@ -0,0 +1,219 @@
+DOWNLOAD_ATTEMPTS = 3
+
+module ArduinoCI
+
+  # Manage the OS-specific download & install of Arduino
+  class ArduinoDownloader
+
+    def initialize(desired_ide_version)
+      @desired_ide_version = desired_ide_version
+    end
+
+    # Provide guidelines to the implementer of this class
+<<<<<<< HEAD
+    def must_implement(method)
+      raise NoMethodError("#{self.class.name} failed to implement ArduinoDownloader.#{method}")
+=======
+    def self.must_implement(method)
+      raise NotImplementedError, "#{self.class.name} failed to implement ArduinoDownloader.#{method}"
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # Make any preparations or run any checks prior to making changes
+    # @return [string] Error message, or nil if success
+    def prepare
+      nil
+    end
+
+    # The autolocated executable of the installation
+    #
+    # @return [string] or nil
+<<<<<<< HEAD
+    def self.autolocation
+=======
+    def self.autolocated_executable
+>>>>>>> Refactor force_install code in preparation for windows CI
+      # Arbitrarily, I'm going to pick the force installed location first
+      # if it exists.  I'm not sure why we would have both, but if we did
+      # a force install then let's make sure we actually use it.
+      locations = [self.force_installed_executable, self.existing_executable]
+      locations.each do |loc|
+        next if loc.nil?
+        next unless File.exist? loc
+        return loc
+      end
+      nil
+    end
+
+<<<<<<< HEAD
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      must_implement(__method__)
+=======
+    # The autolocated directory of the installation
+    #
+    # @return [string] or nil
+    def self.autolocated_installation
+      # Arbitrarily, I'm going to pick the force installed location first
+      # if it exists.  I'm not sure why we would have both, but if we did
+      # a force install then let's make sure we actually use it.
+      locations = [self.force_install_location, self.existing_installation]
+      locations.each do |loc|
+        next if loc.nil?
+        next unless File.exist? loc
+        return loc
+      end
+      nil
+    end
+
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      self.must_implement(__method__)
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      self.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # The technology that will be used to complete the download
+    # (for logging purposes)
+    # @return [string]
+    def downloader
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # The technology that will be used to extract the download
+    # (for logging purposes)
+    # @return [string]
+    def extracter
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # The URL of the desired IDE package (zip/tar/etc) for this platform
+    # @return [string]
+    def package_url
+      "https://downloads.arduino.cc/#{package_file}"
+    end
+
+    # The local file (dir) name of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # The local filename of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # @return [String] The location where a forced install will go
+    def self.force_install_location
+      File.join(ENV['HOME'], 'arduino_ci_ide')
+    end
+
+    # Download the package_url to package_file, and maybe print a line of dots......
+    # @return [bool] whether successful
+    def download
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def extract
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # Move the extracted package file from extracted_file to the force_install_location
+    # @return [bool] whether successful
+    def install
+<<<<<<< HEAD
+      must_implement(__method__)
+=======
+      self.class.must_implement(__method__)
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # Forcibly install Arduino on linux from the web
+    # @return [bool] Whether the command succeeded
+    def execute
+      error_preparing = prepare
+      unless error_preparing.nil?
+        puts "Arduino force-install failed preparation: #{error_preparing}"
+        return false
+      end
+
+      attempts = 0
+
+      loop do
+        if File.exist? package_file
+          puts "Arduino package seems to have been downloaded already" if attempts.zero?
+          break
+        elsif attempts >= DOWNLOAD_ATTEMPTS
+          break puts "After #{DOWNLOAD_ATTEMPTS} attempts, failed to download #{package_url}"
+        else
+          puts "Attempting to download Arduino package with #{downloader}"
+          download
+        end
+        attempts += 1
+      end
+
+      if File.exist? extracted_file
+        puts "Arduino package seems to have been extracted already"
+      elsif File.exist? package_file
+        puts "Extracting archive with #{extracter}"
+        extract
+      end
+
+      if File.exist? self.class.force_install_location
+        puts "Arduino package seems to have been installed already"
+      elsif File.exist? extracted_file
+        install
+      else
+        puts "Arduino force-install failed"
+      end
+
+      File.exist? self.class.force_install_location
+    end
+
+  end
+end

data/lib/arduino_ci/arduino_downloader_linux.rb

@@ -0,0 +1,86 @@
+require "arduino_ci/arduino_downloader"
+
+USE_BUILDER = false
+
+module ArduinoCI
+
+  # Manage the linux download & install of Arduino
+  class ArduinoDownloaderLinux < ArduinoDownloader
+
+    # The local filename of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+      "#{extracted_file}-linux64.tar.xz"
+    end
+
+    # Make any preparations or run any checks prior to making changes
+    # @return [string] Error message, or nil if success
+    def prepare
+      reqs = [extracter]
+      reqs.each do |req|
+        return "#{req} does not appear to be installed!" unless Host.which(req)
+      end
+      nil
+    end
+
+    # The technology that will be used to extract the download
+    # (for logging purposes)
+    # @return [string]
+    def extracter
+      "tar"
+    end
+
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def extract
+      system(extracter, "xf", package_file)
+    end
+
+    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+      "arduino-#{@desired_ide_version}"
+    end
+
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      exe = self.existing_executable
+      return nil if exe.nil?
+      File.dirname(exe) # it's not really this
+      # but for this platform it doesn't really matter
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      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
+      end
+      Host.which("arduino")
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+      if USE_BUILDER
+        # forced_builder = File.join(ArduinoCmdLinuxBuilder.force_install_location, builder_name)
+        # if File.exist?(forced_builder)
+        #   ret = ArduinoCmdLinuxBuilder.new
+        #   ret.base_cmd = [forced_builder]
+        #   return ret
+        # end
+      end
+      forced_arduino = File.join(self.force_install_location, "arduino")
+      return forced_arduino if File.exist? forced_arduino
+      nil
+    end
+
+  end
+end

data/lib/arduino_ci/arduino_downloader_linux.rb.orig

@@ -0,0 +1,79 @@
+require "arduino_ci/arduino_downloader_posix"
+
+USE_BUILDER = false
+
+module ArduinoCI
+
+  # Manage the linux download & install of Arduino
+  class ArduinoDownloaderLinux < ArduinoDownloaderPosix
+
+    # The local filename of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+      "#{extracted_file}-linux64.tar.xz"
+    end
+
+    # The technology that will be used to extract the download
+    # (for logging purposes)
+    # @return [string]
+    def extracter
+      "tar"
+    end
+
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def extract
+      system(extracter, "xf", package_file)
+    end
+
+    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+      "arduino-#{@desired_ide_version}"
+    end
+
+<<<<<<< HEAD
+=======
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      exe = self.existing_executable
+      return nil if exe.nil?
+      File.dirname(exe) # it's not really this
+      # but for this platform it doesn't really matter
+    end
+
+>>>>>>> Refactor force_install code in preparation for windows CI
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      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
+      end
+      Host.which("arduino")
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+      if USE_BUILDER
+        # forced_builder = File.join(ArduinoCmdLinuxBuilder.force_install_location, builder_name)
+        # if File.exist?(forced_builder)
+        #   ret = ArduinoCmdLinuxBuilder.new
+        #   ret.base_cmd = [forced_builder]
+        #   return ret
+        # end
+      end
+      forced_arduino = File.join(self.force_install_location, "arduino")
+      return forced_arduino if File.exist? forced_arduino
+      nil
+    end
+
+  end
+end

data/lib/arduino_ci/arduino_downloader_osx.rb

@@ -0,0 +1,66 @@
+require "arduino_ci/arduino_downloader"
+
+module ArduinoCI
+
+  # Manage the OSX download & install of Arduino
+  class ArduinoDownloaderOSX < ArduinoDownloader
+
+    # The local filename of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+      "arduino-#{@desired_ide_version}-macosx.zip"
+    end
+
+    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+      "Arduino.app"
+    end
+
+    # @return [String] The location where a forced install will go
+    def self.force_install_location
+      # include the .app extension
+      File.join(ENV['HOME'], 'Arduino.app')
+    end
+
+    # An existing Arduino directory in one of the given directories, or nil
+    # @param Array<string> a list of places to look
+    # @return [string]
+    def self.find_existing_arduino_dir(paths)
+      paths.each do |path|
+        return path if File.exist? path
+      end
+      nil
+    end
+
+    # An existing Arduino file in one of the given directories, or nil
+    # @param Array<string> a list of places to look for the executable
+    # @return [string]
+    def self.find_existing_arduino_exe(paths)
+      paths.each do |path|
+        exe = File.join(path, "MacOS", "Arduino")
+        return exe if File.exist? exe
+      end
+      nil
+    end
+
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      self.find_existing_arduino_dir(["/Applications/Arduino.app"])
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      self.find_existing_arduino_exe(["/Applications/Arduino.app"])
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+      self.find_existing_arduino_exe([self.force_install_location])
+    end
+
+  end
+end

data/lib/arduino_ci/arduino_downloader_osx.rb.orig

@@ -0,0 +1,88 @@
+require "arduino_ci/arduino_downloader_posix"
+
+module ArduinoCI
+
+  # Manage the OSX download & install of Arduino
+  class ArduinoDownloaderOSX < ArduinoDownloaderPosix
+
+    # The local filename of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+<<<<<<< HEAD
+      "#arduino-#{@desired_ide_version}-macosx.zip"
+=======
+      "arduino-#{@desired_ide_version}-macosx.zip"
+>>>>>>> Refactor force_install code in preparation for windows CI
+    end
+
+    # The technology that will be used to extract the download
+    # (for logging purposes)
+    # @return [string]
+    def extracter
+      "unzip"
+    end
+
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def extract
+      system(extracter, package_file)
+    end
+
+    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+      "Arduino.app"
+    end
+
+<<<<<<< HEAD
+    # The an existing Arduino file in one of the given directories, or nil
+=======
+    # An existing Arduino directory in one of the given directories, or nil
+    # @param Array<string> a list of places to look
+    # @return [string]
+    def self.find_existing_arduino_dir(paths)
+      paths.each do |path|
+        return path if File.exist? path
+      end
+      nil
+    end
+
+    # An existing Arduino file in one of the given directories, or nil
+>>>>>>> Refactor force_install code in preparation for windows CI
+    # @param Array<string> a list of places to look for the executable
+    # @return [string]
+    def self.find_existing_arduino_exe(paths)
+      paths.each do |path|
+<<<<<<< HEAD
+        exe = File.join(path, "Arduino")
+=======
+        exe = File.join(path, "MacOS", "Arduino")
+>>>>>>> Refactor force_install code in preparation for windows CI
+        return exe if File.exist? exe
+      end
+      nil
+    end
+
+<<<<<<< HEAD
+=======
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      self.find_existing_arduino_dir(["/Applications/Arduino.app/Contents"])
+    end
+
+>>>>>>> Refactor force_install code in preparation for windows CI
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      self.find_existing_arduino_exe(["/Applications/Arduino.app/Contents"])
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+      self.find_existing_arduino_exe([File.join(self.force_install_location, "Contents")])
+    end
+
+  end
+end

data/lib/arduino_ci/arduino_downloader_windows.rb

@@ -0,0 +1,101 @@
+require 'base64'
+require 'shellwords' # fingers crossed this works on win32
+require 'win32/registry'
+require "arduino_ci/arduino_downloader"
+require "fileutils"
+
+module ArduinoCI
+
+  # Manage the POSIX download & install of Arduino
+  class ArduinoDownloaderWindows < ArduinoDownloader
+
+    # Make any preparations or run any checks prior to making changes
+    # @return [string] Error message, or nil if success
+    def prepare
+      nil
+    end
+
+    # The technology that will be used to complete the download
+    # (for logging purposes)
+    # @return [string]
+    def downloader
+      "open-uri"
+    end
+
+    # Download the package_url to package_file
+    # @return [bool] whether successful
+    def download
+      # Turned off ssl verification
+      # This should be acceptable because it won't happen on a user's machine, just CI
+      open(URI.parse(package_url), ssl_verify_mode: 0) do |url|
+        File.open(package_file, 'wb') { |file| file.write(url.read) }
+      end
+    end
+
+    # Move the extracted package file from extracted_file to the force_install_location
+    # @return [bool] whether successful
+    def install
+      # Move only the content of the directory
+      FileUtils.mv extracted_file, self.class.force_install_location
+    end
+
+    # The local filename of the desired IDE package (zip/tar/etc)
+    # @return [string]
+    def package_file
+      "#{extracted_file}-windows.zip"
+    end
+
+    # The technology that will be used to extract the download
+    # (for logging purposes)
+    # @return [string]
+    def extracter
+      "Expand-Archive"
+    end
+
+    # Extract the package_file to extracted_file
+    # @return [bool] whether successful
+    def extract
+      Zip::File.open(package_file) do |zip|
+        zip.each do |file|
+          file.extract(file.name)
+        end
+      end
+    end
+
+    # The local file (dir) name of the extracted IDE package (zip/tar/etc)
+    # @return [string]
+    def extracted_file
+      "arduino-#{@desired_ide_version}"
+    end
+
+    # The path to the directory of an existing installation, or nil
+    # @return [string]
+    def self.existing_installation
+      exe = self.existing_executable
+      return nil if exe.nil?
+      File.dirname(exe)
+    end
+
+    # The executable Arduino file in an existing installation, or nil
+    # @return [string]
+    def self.existing_executable
+      arduino_reg = 'SOFTWARE\WOW6432Node\Arduino'
+      Win32::Registry::HKEY_LOCAL_MACHINE.open(arduino_reg) do |reg|
+        path = reg.read_s('Install_Dir')
+        exe = File.join(path, "arduino_debug.exe")
+        return exe if File.exist? exe
+      end
+    rescue
+      nil
+    end
+
+    # The executable Arduino file in a forced installation, or nil
+    # @return [string]
+    def self.force_installed_executable
+      exe = File.join(self.force_install_location, "arduino_debug.exe")
+      return nil if exe.nil?
+      exe
+    end
+
+  end
+end