centralize download and unzip logic into ruby libs

Author: ianfixes

lib/arduino_ci/arduino_downloader.rb

@@ -1,3 +1,7 @@
+require "fileutils"
+require 'open-uri'
+require 'zip'
+
 DOWNLOAD_ATTEMPTS = 3
 
 module ArduinoCI
@@ -74,14 +78,14 @@ def self.force_installed_executable
     # (for logging purposes)
     # @return [string]
     def downloader
-      self.class.must_implement(__method__)
+      "open-uri"
     end
 
     # The technology that will be used to extract the download
     # (for logging purposes)
     # @return [string]
     def extracter
-      self.class.must_implement(__method__)
+      "Zip"
     end
 
     # The URL of the desired IDE package (zip/tar/etc) for this platform
@@ -107,22 +111,44 @@ 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......
+    # Download the package_url to package_file
     # @return [bool] whether successful
     def download
-      self.class.must_implement(__method__)
+      # Turned off ssl verification
+      # This should be acceptable because it won't happen on a user's machine, just CI
+
+      # define a progress-bar printer
+      chunk_size = 1024 * 1024 * 1024
+      total_size = 0
+      dots = 0
+      dot_printer = lambda do |size|
+        total_size += size
+        needed_dots = (total_size / chunk_size).to_i
+        unprinted_dots = needed_dots - dots
+        print("." * unprinted_dots) if unprinted_dots > 0
+        dots = needed_dots
+      end
+
+      open(package_url, ssl_verify_mode: 0, progress_proc: dot_printer) do |url|
+        File.open(package_file, 'wb') { |file| file.write(url.read) }
+      end
     end
 
     # Extract the package_file to extracted_file
     # @return [bool] whether successful
     def extract
-      self.class.must_implement(__method__)
+      Zip::File.open(package_file) do |zip|
+        zip.each do |file|
+          file.extract(file.name)
+        end
+      end
     end
 
     # Move the extracted package file from extracted_file to the force_install_location
     # @return [bool] whether successful
     def install
-      self.class.must_implement(__method__)
+      # Move only the content of the directory
+      FileUtils.mv extracted_file, self.class.force_install_location
     end
 
     # Forcibly install Arduino on linux from the web

lib/arduino_ci/arduino_downloader_linux.rb

@@ -1,18 +1,28 @@
-require "arduino_ci/arduino_downloader_posix"
+require "arduino_ci/arduino_downloader"
 
 USE_BUILDER = false
 
 module ArduinoCI
 
   # Manage the linux download & install of Arduino
-  class ArduinoDownloaderLinux < ArduinoDownloaderPosix
+  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]

lib/arduino_ci/arduino_downloader_osx.rb

@@ -1,29 +1,16 @@
-require "arduino_ci/arduino_downloader_posix"
+require "arduino_ci/arduino_downloader"
 
 module ArduinoCI
 
   # Manage the OSX download & install of Arduino
-  class ArduinoDownloaderOSX < ArduinoDownloaderPosix
+  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 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

lib/arduino_ci/arduino_downloader_posix.rb

@@ -2,8 +2,6 @@
 require 'shellwords' # fingers crossed this works on win32
 require 'win32/registry'
 require "arduino_ci/arduino_downloader"
-require 'open-uri'
-require 'zip'
 require "fileutils"
 
 module ArduinoCI
@@ -39,8 +37,6 @@ def download
     def install
       # Move only the content of the directory
       FileUtils.mv extracted_file, self.class.force_install_location
-      # clean up the no longer required root extracted folder
-      FileUtils.rm_rf extracted_file
     end
 
     # The local filename of the desired IDE package (zip/tar/etc)
@@ -64,8 +60,6 @@ def extract
           file.extract(file.name)
         end
       end
-      # clean up the no longer required zip
-      FileUtils.rm_rf package_file
     end
 
     # The local file (dir) name of the extracted IDE package (zip/tar/etc)

lib/arduino_ci/arduino_downloader_windows.rb

@@ -17,8 +17,6 @@
     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
@@ -42,7 +40,7 @@
     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.downloader).to eq("open-uri")
       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")
@@ -67,8 +65,8 @@
     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.downloader).to eq("open-uri")
+      expect(ad.extracter).to eq("Zip")
       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