Check for board manager package URLs in CI

Author: ianfixes

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 ### Added
 - Arduino command wrapper now natively supports board manager URLs
+- CI checks for proper board manager URLs for requested platforms
 
 ### Changed
 - Centralized file listing code in `arduino_ci_remote.rb`

exe/arduino_ci_remote.rb

@@ -142,6 +142,7 @@ def display_files(pathname)
 # start with the "platforms to unittest" and add the examples
 # while we're doing that, get the aux libraries as well
 all_platforms = {}
+board_platform_url = {}
 aux_libraries = Set.new(config.aux_libraries_for_unittest + config.aux_libraries_for_build)
 # while collecting the platforms, ensure they're defined
 config.platforms_to_unittest.each { |p| all_platforms[p] = assured_platform("unittest", p, config) }
@@ -151,14 +152,28 @@ def display_files(pathname)
   ovr_config.platforms_to_build.each do |p|
     # assure the platform if we haven't already
     example_platforms[p] = all_platforms[p] = assured_platform("library example", p, config) unless example_platforms.key?(p)
+    board_platform_url[p] = ovr_config.package_url(p)
   end
   aux_libraries.merge(ovr_config.aux_libraries_for_build)
 end
 
 # with all platform info, we can extract unique packages and their urls
 # do that, set the URLs, and download the packages
 all_packages = all_platforms.values.map { |v| v[:package] }.uniq.reject(&:nil?)
-all_urls = all_packages.map { |p| config.package_url(p) }.uniq.reject(&:nil?)
+
+# inform about builtin packages
+all_packages.select { |p| config.package_builtin?(p) }.each do
+  inform("Using built-in board package") { p }
+end
+
+# make sure any non-builtin package has a URL defined
+all_packages.reject { |p| config.package_builtin?(p) }.each do
+  assure("Board package #{p} has a defined URL") { board_platform_url[p] }
+end
+
+# set up all the board manager URLs.
+# we can safely reject nils now, they would be for the builtins
+all_urls = all_packages.map { |p| board_platform_url(p) }.uniq.reject(&:nil?)
 unless all_urls.empty?
   assure("Setting board manager URLs") do
     @arduino_cmd.board_manager_urls = all_urls

lib/arduino_ci/ci_config.rb

@@ -191,6 +191,13 @@ def platform_definition(platform_name)
       deep_clone(defn)
     end
 
+    # Whether a package is built-in to arduino
+    # @param package [String] the package name (e.g. "arduino:avr")
+    # @return [bool]
+    def package_builtin?(package)
+      package.start_with?("arduino:")
+    end
+
     # the URL that gives the download info for a given package (a JSON file).
     # this is NOT where the package comes from.
     # @param package [String] the package name (e.g. "arduino:avr")

misc/default.yml

@@ -3,6 +3,7 @@
 #   https://en.wikipedia.org/wiki/List_of_Arduino_boards_and_compatible_systems
 
 packages:
+  # arduino:xxx are builtin, we don't need to include them here
   esp8266:esp8266:
     url: http://arduino.esp8266.com/stable/package_esp8266com_index.json
   adafruit:avr:
@@ -16,7 +17,7 @@ platforms:
 
   uno:
     board: arduino:avr:uno
-    package: ~
+    package: arduino:avr
     gcc:
       features:
       defines:
@@ -60,7 +61,7 @@ platforms:
       flags:
   leonardo:
     board: arduino:avr:leonardo
-    package: ~
+    package: arduino:avr
     gcc:
       features:
       defines:

spec/ci_config_spec.rb

@@ -24,7 +24,12 @@
       expect(zero[:package]).to eq("arduino:samd")
       expect(zero[:gcc].class).to eq(Hash)
 
+      expect(default_config.package_builtin?("arduino:avr")).to be true
+      expect(default_config.package_builtin?("adafruit:avr")).to be false
+
       expect(default_config.package_url("adafruit:avr")).to eq("https://adafruit.github.io/arduino-board-index/package_adafruit_index.json")
+      expect(default_config.package_url("adafruit:samd")).to eq("https://adafruit.github.io/arduino-board-index/package_adafruit_index.json")
+      expect(default_config.package_url("esp32:esp32")).to eq("https://dl.espressif.com/dl/package_esp32_index.json")
       expect(default_config.platforms_to_build).to match(["uno", "due", "zero", "leonardo", "m4", "esp32", "esp8266", "mega2560"])
       expect(default_config.platforms_to_unittest).to match(["uno", "due", "zero", "leonardo"])
       expect(default_config.aux_libraries_for_build).to match([])