using namespace/major.minor.patch format

Author: GrantBirki

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

@@ -37,16 +37,23 @@ def description
           # Standard interface: Get the schema version of this group.
           #
           # Takes no arguments.
+          # Examples: "entitlements/v1", "entitlements/v1.2.3", "entitlements/1.2.3"
+          # Format: namespace/major.minor.patch
           #
-          # Returns a String with the schema version (semver), or "1.0.0" if undefined.
+          # Returns a String with the schema version (k8s-style), or "entitlements/v1" if undefined.
           Contract C::None => String
           def schema_version
-            version = parsed_data.fetch("schema_version", "1.0.0").to_s
-            unless version.match?(/\A\d+\.\d+\.\d+\z/)
-              raise "Invalid schema version format: #{version} - Expected format is 'MAJOR.MINOR.PATCH' " \
-                "- Examples: 1.2.3 or 10.0.0"
+            schema_version = parsed_data.fetch("schema_version", "entitlements/v1").to_s
+
+            namespace, version = schema_version.split("/")
+
+            unless namespace.match?(/\A[a-zA-Z0-9]+\z/) && version.match?(/\A(v?\d+(\.\d+){0,2})\z/)
+              raise "Invalid schema version format: #{schema_version} - Expected format is '<namespace>/<version>' " \
+                    "- Examples: entitlements/v1, entitlements/v1.2.3, entitlements/1.2.3"
             end
-            version
+
+            # rebuild the schema version string to ensure it's in the correct format and return it
+            return "#{namespace}/#{version}"
           end
 
           # Files can support modifiers that act independently of rules.

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

@@ -39,32 +39,38 @@
     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("1.2.3")
+      expect(subject.schema_version).to eq("entitlements/1.2.3")
     end
 
-    it "returns the version string when one is set without the patch - not valid semver 2" do
+    it "returns the version string when one is set without the patch" do
       filename = fixture("ldap-config/filters/no-filters-with-schema-version-no-patch.yaml")
       subject = described_class.new(filename: filename)
-      expect { subject.schema_version }.to raise_error(RuntimeError, /Invalid schema version format/)
+      expect(subject.schema_version).to eq("entitlements/1.2")
     end
 
-    it "returns the version string when one is set (with v prefix - not valid semver 2)" do
+    it "returns the version string when one is set (with v prefix)" do
       filename = fixture("ldap-config/filters/no-filters-with-schema-version-with-v.yaml")
       subject = described_class.new(filename: filename)
-      expect { subject.schema_version }.to raise_error(RuntimeError, /Invalid schema version format/)
+      expect(subject.schema_version).to eq("entitlements/v1.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("1.0.0")
+      expect(subject.schema_version).to eq("entitlements/v1")
     end
 
-    it "throws an error when an invalid semver string is provided" do
+    it "throws an error when an invalid schema_version 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
+
+    it "throws an error when the version string is missing the namespace" do
+      filename = fixture("ldap-config/filters/no-filters-with-missing-version-namespace.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

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

@@ -1,5 +1,5 @@
 description: Yo kittens
-schema_version: 1.abc2.3
+schema_version: entitlements/1.abc2.3
 rules:
   or:
     - username: russianblue

spec/unit/fixtures/ldap-config/filters/no-filters-with-missing-version-namespace.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-no-patch.yaml

@@ -1,5 +1,5 @@
 description: Yo kittens
-schema_version: 1.2
+schema_version: entitlements/1.2
 rules:
   or:
     - username: russianblue

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

@@ -1,5 +1,5 @@
 description: Yo kittens
-schema_version: v1.2.3
+schema_version: entitlements/v1.2.3
 rules:
   or:
     - username: russianblue

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

@@ -1,5 +1,5 @@
 description: Yo kittens
-schema_version: 1.2.3
+schema_version: entitlements/1.2.3
 rules:
   or:
     - username: russianblue