fix schemas

Author: ndbroadbent

examples/circleci_rails/config.yml

@@ -1,5 +1,3 @@
-$schema: ../../schemas/v1/config-schema.json
-
 # CI provider to target
 provider: circleci
 output_path: ./build

examples/circleci_rails/workflows/setup/config.yml

@@ -1,5 +1,3 @@
-$schema: ../../../schemas/v1/workflow-config-schema.json
-
 # This is a static workflow that generates the dynamic config.
 dynamic: false
 

examples/circleci_rails/workflows/test/config.yml

@@ -1,3 +1 @@
-$schema: ../../../schemas/v1/workflow-config-schema.json
-
 dynamic: true

schemas/v1/config-base-schema.json

@@ -3,6 +3,6 @@
   "title": "CIGen Configuration Base Schema",
   "description": "Base schema for cigen configuration fragments - allows any subset of properties",
   "type": "object",
-  "$ref": "https://cigen.dev/schemas/v1/definitions.json#/definitions/configProperties",
+  "$ref": "./definitions.json#/definitions/configProperties",
   "additionalProperties": false
 }

schemas/v1/workflow-config-schema.json

@@ -3,16 +3,22 @@
   "title": "CIGen Workflow Configuration Schema",
   "description": "Schema for workflow-level configuration files",
   "type": "object",
-  "allOf": [
-    {
-      "$ref": "https://cigen.dev/schemas/v1/definitions.json#/definitions/configProperties"
-    }
-  ],
   "properties": {
     "dynamic": {
       "type": "boolean",
       "description": "Whether this workflow uses dynamic job skipping based on file changes",
       "default": false
+    },
+    "output_path": {
+      "type": "string",
+      "description": "Path where generated CI config will be written",
+      "default": "./build"
+    },
+    "output_filename": {
+      "type": "string",
+      "description": "Filename for the generated CI config (useful when splitting workflows)",
+      "pattern": "^[^/\\\\]+\\.yml$"
     }
-  }
+  },
+  "additionalProperties": false
 }

src/validation/config.rs

@@ -11,20 +11,46 @@ use super::schemas::{
     SchemaRetriever, get_config_base_schema, get_config_schema, get_workflow_config_schema,
 };
 
+// Use JSON Schema draft-07 for validation (stable and well-tested)
+// TODO: Upgrade to draft 2020-12 once we update our schemas
+use jsonschema::draft7 as schema_draft;
+
 pub struct ConfigValidator;
 
 impl ConfigValidator {
     pub fn new() -> Self {
         Self
     }
 
+    /// Extract a more specific instance path for certain validation errors
+    fn refine_instance_path(error: &jsonschema::ValidationError) -> String {
+        let error_msg = error.to_string();
+
+        // For "additional properties" errors, extract the property name and append to path
+        if error_msg.contains("Additional properties are not allowed") {
+            // Extract property names from error message like "('asdf' was unexpected)"
+            if let Some(start) = error_msg.find("('") {
+                if let Some(end) = error_msg[start + 2..].find("'") {
+                    let prop_name = &error_msg[start + 2..start + 2 + end];
+                    return if error.instance_path.to_string().is_empty() {
+                        format!("/{prop_name}")
+                    } else {
+                        format!("{}/{prop_name}", error.instance_path)
+                    };
+                }
+            }
+        }
+
+        error.instance_path.to_string()
+    }
+
     pub fn validate_config(&self, config_path: &Path) -> Result<()> {
         // 1. Schema validation with beautiful miette error reporting
         let spanned_validator = SpannedValidator::new(config_path)
             .map_err(|e| anyhow::anyhow!("Failed to parse YAML from {config_path:?}: {e}"))?;
 
         let schema = get_config_schema().context("Failed to parse config schema")?;
-        let validator = jsonschema::draft7::options()
+        let validator = schema_draft::options()
             .with_retriever(SchemaRetriever)
             .build(&schema)
             .context("Failed to compile config schema")?;
@@ -36,8 +62,9 @@ impl ConfigValidator {
         if !errors.is_empty() {
             eprintln!(); // Add newline before first error
             for error in &errors {
-                let validation_error = spanned_validator
-                    .create_error(&error.instance_path.to_string(), error.to_string());
+                let instance_path = Self::refine_instance_path(error);
+                let validation_error =
+                    spanned_validator.create_error(&instance_path, error.to_string());
                 eprintln!("{:?}", Report::new(validation_error));
             }
             anyhow::bail!(
@@ -65,7 +92,7 @@ impl ConfigValidator {
             .with_context(|| format!("Failed to parse rendered YAML from: {source_path:?}"))?;
 
         let schema = get_config_schema().context("Failed to parse config schema")?;
-        let validator = jsonschema::draft7::options()
+        let validator = schema_draft::options()
             .with_retriever(SchemaRetriever)
             .build(&schema)
             .context("Failed to compile config schema")?;
@@ -94,7 +121,7 @@ impl ConfigValidator {
         // Use base schema for fragments (allows any subset of properties)
         let schema = get_config_base_schema().context("Failed to parse config base schema")?;
 
-        let validator = jsonschema::draft7::options()
+        let validator = schema_draft::options()
             .with_retriever(SchemaRetriever)
             .build(&schema)
             .context("Failed to compile config base schema")?;
@@ -122,7 +149,7 @@ impl ConfigValidator {
 
         // Use base schema for fragments (allows any subset of properties)
         let schema = get_config_base_schema().context("Failed to parse config base schema")?;
-        let validator = jsonschema::draft7::options()
+        let validator = schema_draft::options()
             .with_retriever(SchemaRetriever)
             .build(&schema)
             .context("Failed to compile config base schema")?;
@@ -148,7 +175,7 @@ impl ConfigValidator {
 
         let schema =
             get_workflow_config_schema().context("Failed to parse workflow config schema")?;
-        let validator = jsonschema::draft7::options()
+        let validator = schema_draft::options()
             .with_retriever(SchemaRetriever)
             .build(&schema)
             .context("Failed to compile workflow config schema")?;
@@ -160,8 +187,9 @@ impl ConfigValidator {
         if !errors.is_empty() {
             eprintln!(); // Add newline before first error
             for error in &errors {
-                let validation_error = spanned_validator
-                    .create_error(&error.instance_path.to_string(), error.to_string());
+                let instance_path = Self::refine_instance_path(error);
+                let validation_error =
+                    spanned_validator.create_error(&instance_path, error.to_string());
                 eprintln!("{:?}", Report::new(validation_error));
             }
             anyhow::bail!(
@@ -179,7 +207,7 @@ impl ConfigValidator {
         // Validate against the full schema
         let schema = get_config_schema().context("Failed to parse config schema")?;
 
-        let validator = jsonschema::draft7::options()
+        let validator = schema_draft::options()
             .with_retriever(SchemaRetriever)
             .build(&schema)
             .context("Failed to compile config schema")?;

src/validation/schemas.rs

@@ -38,6 +38,12 @@ impl Retrieve for SchemaRetriever {
             "https://cigen.dev/schemas/v1/definitions.json" => {
                 Ok(serde_json::from_str(DEFINITIONS_SCHEMA)?)
             }
+            // Handle the relative reference with fragment
+            "./definitions.json#/definitions/configProperties" => {
+                Ok(serde_json::from_str(DEFINITIONS_SCHEMA)?)
+            }
+            // Handle json-schema URI scheme
+            "json-schema:///definitions.json" => Ok(serde_json::from_str(DEFINITIONS_SCHEMA)?),
             "https://json-schema.org/draft-07/schema"
             | "https://json-schema.org/draft-07/schema#"
             | "http://json-schema.org/draft-07/schema"