More flexible config overriding

Author: ianfixes

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Provide an `itoa` function. It is present in Arduino's runtime environment but not on most (all?) host systems because itoa is not a portable standard function.
 - `to_h` and `to_s` functions for `ci_config.rb`
+- `CIConfig::clone`
+- Ability to override `CIConfig` from a hash instead of just a file
 
 ### Changed
 - Simplified the use of `Array.each` with a return statement; it's now simply `Array.find`

lib/arduino_ci/ci_config.rb

@@ -127,6 +127,13 @@ def load_yaml(path)
       yml = YAML.load_file(path)
       raise ConfigurationError, "The YAML file at #{path} failed to load" unless yml
 
+      apply_configuration(yml)
+    end
+
+    # Load configuration from a hash
+    # @param yml [Hash] the source data
+    # @return [ArduinoCI::CIConfig] a reference to self
+    def apply_configuration(yml)
       if yml.include?("packages")
         yml["packages"].each do |k, v|
           valid_data = validate_data("packages", v, PACKAGE_SCHEMA)
@@ -154,19 +161,35 @@ def load_yaml(path)
       self
     end
 
+    # Create a clone of this configuration and return it
+    # @return [ArduinoCI::CIConfig] the new settings object
+    def clone
+      cloned_config = self.class.new
+      cloned_config.package_info  = deep_clone(@package_info)
+      cloned_config.platform_info = deep_clone(@platform_info)
+      cloned_config.compile_info  = deep_clone(@compile_info)
+      cloned_config.unittest_info = deep_clone(@unittest_info)
+      cloned_config
+    end
+
     # Override these settings with settings from another file
     # @param path [String] the path to the settings yaml file
     # @return [ArduinoCI::CIConfig] the new settings object
     def with_override(path)
-      overridden_config = self.class.new
-      overridden_config.package_info  = deep_clone(@package_info)
-      overridden_config.platform_info = deep_clone(@platform_info)
-      overridden_config.compile_info  = deep_clone(@compile_info)
-      overridden_config.unittest_info = deep_clone(@unittest_info)
+      overridden_config = clone
       overridden_config.load_yaml(path)
       overridden_config
     end
 
+    # Override these settings with settings from a hash
+    # @param config_hash [Hash] A configuration hash
+    # @return [ArduinoCI::CIConfig] the new settings object
+    def with_override_config(config_hash)
+      overridden_config = clone
+      overridden_config.apply_configuration(config_hash)
+      overridden_config
+    end
+
     # Get the config file at a given path, if it exists, and pass that to a block.
     # Many config files may exist, but only the first match is used
     # @param base_dir [String] The directory in which to search for a config file

spec/ci_config_spec.rb

@@ -39,6 +39,46 @@
     end
   end
 
+  context "clone" do
+    it "creates a copy" do
+      base = ArduinoCI::CIConfig.new
+      base.load_yaml(File.join(File.dirname(__FILE__), "yaml", "o2.yaml"))
+
+      expect(base.to_h).to eq(
+        packages: {},
+        platforms: {
+          "bogo"=> {
+            board: "fakeduino:beep:bogo"
+          },
+        },
+        compile: {
+          libraries: ["zip"],
+          platforms: ["bogo"]
+        },
+        unittest: {
+          testfiles: {
+            select: ["*-*.*"],
+            reject: ["sam-squamsh.*"]
+          },
+          libraries: ["def456"],
+          platforms: ["bogo"]
+        }
+      )
+    end
+  end
+
+  context "clone" do
+    it "creates a copy" do
+      base = ArduinoCI::CIConfig.default
+      orig = base.to_h
+      clone1 = orig.clone.to_h
+      clone2 = orig.clone.to_h
+
+      expect(orig).to eq(clone1)
+      expect(clone1).to eq(clone2)
+    end
+  end
+
   context "with_override" do
     it "loads from yaml" do
       override_file = File.join(File.dirname(__FILE__), "yaml", "o1.yaml")

spec/yaml/o2.yaml

@@ -0,0 +1,20 @@
+platforms:
+  bogo:
+    board: fakeduino:beep:bogo
+
+compile:
+  libraries:
+    - "zip"
+  platforms:
+    - bogo
+
+unittest:
+  testfiles:
+    select:
+      - "*-*.*"
+    reject:
+      - "sam-squamsh.*"
+  libraries:
+    - "def456"
+  platforms:
+    - bogo