feat: add schema_version key to groups for calculated yaml definitions

Author: GrantBirki

lib/entitlements/data/groups/calculated/yaml.rb

@@ -34,6 +34,20 @@ def description
             parsed_data.fetch("description", "")
           end
 
+          # Standard interface: Get the schema version of this group.
+          #
+          # Takes no arguments.
+          #
+          # Returns a String with the schema version (semver), or "v1.0.0" if undefined.
+          Contract C::None => String
+          def schema_version
+            version = parsed_data.fetch("schema_version", "v1.0.0")
+            unless version.match?(/^\Av?\d+\.\d+\.\d+\z$/)
+              raise "Invalid schema version format: #{version} - Expected format is 'MAJOR.MINOR.PATCH' - Examples: v1.2.3 or 1.2.3"
+            end
+            version
+          end
+
           # Files can support modifiers that act independently of rules.
           # This returns the modifiers from the file as a hash.
           #

spec/unit/entitlements/data/groups/calculated/yaml_spec.rb

@@ -35,6 +35,32 @@
     end
   end
 
+  describe "#schema_version" do
+    it "returns the version string when one is set" do
+      filename = fixture("ldap-config/filters/no-filters-with-schema-version.yaml")
+      subject = described_class.new(filename: filename)
+      expect(subject.schema_version).to eq("v1.2.3")
+    end
+
+    it "returns the version string when one is set (no v prefix)" do
+      filename = fixture("ldap-config/filters/no-filters-with-schema-version-no-v.yaml")
+      subject = described_class.new(filename: filename)
+      expect(subject.schema_version).to eq("1.2.3")
+    end
+
+    it "returns the default version when schema_version is undefined" do
+      filename = fixture("ldap-config/filters/no-filters-description.yaml")
+      subject = described_class.new(filename: filename)
+      expect(subject.schema_version).to eq("v1.0.0")
+    end
+
+    it "throws an error when an invalid semver string is provided" do
+      filename = fixture("ldap-config/filters/no-filters-with-bad-schema-version.yaml")
+      subject = described_class.new(filename: filename)
+      expect { subject.schema_version }.to raise_error(RuntimeError, /Invalid schema version format/)
+    end
+  end
+
   describe "#initialize_filters" do
     it "returns the default filter hash when no filters are defined" do
       filename = fixture("ldap-config/filters/no-filters.yaml")

spec/unit/fixtures/ldap-config/filters/no-filters-with-bad-schema-version.yaml

@@ -0,0 +1,6 @@
+description: Yo kittens
+schema_version: v1.abc2.3
+rules:
+  or:
+    - username: russianblue
+    - username: BlackManx

spec/unit/fixtures/ldap-config/filters/no-filters-with-schema-version-no-v.yaml

@@ -0,0 +1,6 @@
+description: Yo kittens
+schema_version: 1.2.3
+rules:
+  or:
+    - username: russianblue
+    - username: BlackManx

spec/unit/fixtures/ldap-config/filters/no-filters-with-schema-version.yaml

@@ -0,0 +1,6 @@
+description: Yo kittens
+schema_version: v1.2.3
+rules:
+  or:
+    - username: russianblue
+    - username: BlackManx