Refactor force_install code in preparation for windows CI

Author: ianfixes

lib/arduino_ci/arduino_downloader.rb

@@ -10,8 +10,8 @@ def initialize(desired_ide_version)
     end
 
     # Provide guidelines to the implementer of this class
-    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}"
     end
 
     # Make any preparations or run any checks prior to making changes
@@ -23,7 +23,7 @@ def prepare
     # The autolocated executable of the installation
     #
     # @return [string] or nil
-    def self.autolocation
+    def self.autolocated_executable
       # 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.
@@ -36,30 +36,52 @@ def self.autolocation
       nil
     end
 
+    # 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
-      must_implement(__method__)
+      self.must_implement(__method__)
     end
 
     # The executable Arduino file in a forced installation, or nil
     # @return [string]
     def self.force_installed_executable
-      must_implement(__method__)
+      self.must_implement(__method__)
     end
 
     # The technology that will be used to complete the download
     # (for logging purposes)
     # @return [string]
     def downloader
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # The technology that will be used to extract the download
     # (for logging purposes)
     # @return [string]
     def extracter
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # The URL of the desired IDE package (zip/tar/etc) for this platform
@@ -71,13 +93,13 @@ def package_url
     # The local file (dir) name of the desired IDE package (zip/tar/etc)
     # @return [string]
     def package_file
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # The local filename of the extracted IDE package (zip/tar/etc)
     # @return [string]
     def extracted_file
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # @return [String] The location where a forced install will go
@@ -88,19 +110,19 @@ def self.force_install_location
     # Download the package_url to package_file, and maybe print a line of dots......
     # @return [bool] whether successful
     def download
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # Extract the package_file to extracted_file
     # @return [bool] whether successful
     def extract
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # Move the extracted package file from extracted_file to the force_install_location
     # @return [bool] whether successful
     def install
-      must_implement(__method__)
+      self.class.must_implement(__method__)
     end
 
     # Forcibly install Arduino on linux from the web

lib/arduino_ci/arduino_downloader_linux.rb

@@ -32,6 +32,15 @@ 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

lib/arduino_ci/arduino_downloader_osx.rb

@@ -8,7 +8,7 @@ class ArduinoDownloaderOSX < ArduinoDownloaderPosix
     # The local filename of the desired IDE package (zip/tar/etc)
     # @return [string]
     def package_file
-      "#arduino-#{@desired_ide_version}-macosx.zip"
+      "arduino-#{@desired_ide_version}-macosx.zip"
     end
 
     # The technology that will be used to extract the download
@@ -30,17 +30,33 @@ def extracted_file
       "Arduino.app"
     end
 
-    # 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
     # @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, "Arduino")
+        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/Contents"])
+    end
+
     # The executable Arduino file in an existing installation, or nil
     # @return [string]
     def self.existing_executable

lib/arduino_ci/arduino_installation.rb

@@ -24,17 +24,23 @@ def autolocate
         when :osx then
           ret = autolocate_osx
         when :linux then
-          loc = ArduinoDownloaderLinux.autolocation
+          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]
         end
         ret
       end
 
       # @return [ArduinoCI::ArduinoCmdOSX] an instance of the command or nil if it can't be found
       def autolocate_osx
-        osx_root = ArduinoDownloaderOSX.autolocation
+        osx_root = ArduinoDownloaderOSX.autolocated_installation
+        return nil if osx_root.nil?
         return nil unless File.exist? osx_root
 
         launchers = [

spec/arduino_downloader_spec.rb

@@ -3,17 +3,74 @@
 DESIRED_VERSION = "rhubarb"
 RSpec.describe ArduinoCI::ArduinoDownloader do
   context "Basics" do
-    it "can instantiate" do
-      ArduinoCI::ArduinoDownloader.new(DESIRED_VERSION)
+    it "has correct class properties" do
+      ad = ArduinoCI::ArduinoDownloader
+
+      expect{ad.autolocated_executable}.to raise_error(NotImplementedError)
+      expect{ad.autolocated_installation}.to raise_error(NotImplementedError)
+      expect{ad.existing_installation}.to raise_error(NotImplementedError)
+      expect{ad.existing_executable}.to raise_error(NotImplementedError)
+      expect{ad.force_installed_executable}.to raise_error(NotImplementedError)
+      expect(ad.force_install_location).to eq(File.join(ENV['HOME'], 'arduino_ci_ide'))
     end
-  end
 
+    it "has correct instance properties" do
+      ad = ArduinoCI::ArduinoDownloader.new(DESIRED_VERSION)
+      expect(ad.prepare).to be nil
+      expect{ad.downloader}.to raise_error(NotImplementedError)
+      expect{ad.extracter}.to raise_error(NotImplementedError)
+      expect{ad.package_url}.to raise_error(NotImplementedError)
+      expect{ad.package_file}.to raise_error(NotImplementedError)
+    end
+  end
 end
+
 RSpec.describe ArduinoCI::ArduinoDownloaderLinux do
   context "Basics" do
-    it "can instantiate" do
-      ArduinoCI::ArduinoDownloaderLinux.new(DESIRED_VERSION)
+    it "has correct class properties" do
+      ad = ArduinoCI::ArduinoDownloaderLinux
+      # these will vary with CI.  Don't test them.
+      # expect(ad.autolocated_executable).to be nil
+      # expect(ad.autolocated_installation).to be nil
+      # expect(ad.existing_installation).to be nil
+      # expect(ad.existing_executable).to be nil
+      # expect(ad.force_installed_executable).to be nil
+
+      expect(ad.force_install_location).to eq(File.join(ENV['HOME'], 'arduino_ci_ide'))
+    end
+
+    it "has correct instance properties" do
+      ad = ArduinoCI::ArduinoDownloaderLinux.new(DESIRED_VERSION)
+      expect(ad.prepare).to be nil
+      expect(ad.downloader).to eq("wget")
+      expect(ad.extracter).to eq("tar")
+      expect(ad.package_url).to eq("https://downloads.arduino.cc/arduino-rhubarb-linux64.tar.xz")
+      expect(ad.package_file).to eq("arduino-rhubarb-linux64.tar.xz")
     end
   end
+end
+
+RSpec.describe ArduinoCI::ArduinoDownloaderOSX do
+  context "Basics" do
+    it "has correct class properties" do
+      ad = ArduinoCI::ArduinoDownloaderOSX
+      # these will vary with CI.  Don't test them.
+      # expect(ad.autolocated_executable).to be nil
+      # expect(ad.autolocated_installation).to be nil
+      # expect(ad.existing_installation).to be nil
+      # expect(ad.existing_executable).to be nil
+      # expect(ad.force_installed_executable).to be nil
 
+      expect(ad.force_install_location).to eq(File.join(ENV['HOME'], 'arduino_ci_ide'))
+    end
+
+    it "has correct instance properties" do
+      ad = ArduinoCI::ArduinoDownloaderOSX.new(DESIRED_VERSION)
+      expect(ad.prepare).to be nil
+      expect(ad.downloader).to eq("wget")
+      expect(ad.extracter).to eq("unzip")
+      expect(ad.package_url).to eq("https://downloads.arduino.cc/arduino-rhubarb-macosx.zip")
+      expect(ad.package_file).to eq("arduino-rhubarb-macosx.zip")
+    end
+  end
 end