fix: Validate processing fields everywhere

Author: l0b0

json-schema/schema.json

@@ -54,21 +54,7 @@
           "properties": {
             "type": {
               "const": "Collection"
-            }
-          }
-        },
-        {
-          "$ref": "#/definitions/stac_extensions"
-        }
-      ],
-      "anyOf": [
-        {
-          "$comment": "Validate fields in Collection Providers.",
-          "type": "object",
-          "required": [
-            "providers"
-          ],
-          "properties": {
+            },
             "providers": {
               "type": "array",
               "minItems": 1,
@@ -110,16 +96,7 @@
                   }
                 ]
               }
-            }
-          }
-        },
-        {
-          "type": "object",
-          "$comment": "This validates the fields in Collection Assets, but does not require them.",
-          "required": [
-            "assets"
-          ],
-          "properties": {
+            },
             "assets": {
               "type": "object",
               "not": {
@@ -136,16 +113,7 @@
                   }
                 }
               }
-            }
-          }
-        },
-        {
-          "type": "object",
-          "$comment": "This is the schema for the fields in Item Asset Definitions. It doesn't require any fields.",
-          "required": [
-            "item_assets"
-          ],
-          "properties": {
+            },
             "item_assets": {
               "type": "object",
               "not": {
@@ -162,20 +130,14 @@
                   }
                 }
               }
-            }
-          }
-        },
-        {
-          "type": "object",
-          "$comment": "This is the schema for the fields in Summaries. By default, only checks the existance of the properties, but not the schema of the summaries.",
-          "required": [
-            "summaries"
-          ],
-          "properties": {
+            },
             "summaries": {
               "$ref": "#/definitions/require_any_field"
             }
           }
+        },
+        {
+          "$ref": "#/definitions/stac_extensions"
         }
       ]
     }

package.json

@@ -2,12 +2,16 @@
   "name": "stac-extensions",
   "version": "1.0.0",
   "scripts": {
-    "test": "npm run check-markdown && npm run check-examples",
+    "test": "npx ospec && npm run check-markdown && npm run check-examples",
     "check-markdown": "remark . -f -r .github/remark.yaml",
     "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/processing/v1.0.0/schema.json=./json-schema/schema.json",
     "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/processing/v1.0.0/schema.json=./json-schema/schema.json"
   },
+  "type": "module",
   "dependencies": {
+    "@types/ospec": "^4.0.2",
+    "ajv": "^8.8.2",
+    "ospec": "^4.1.1",
     "remark-cli": "^8.0.0",
     "remark-lint": "^7.0.0",
     "remark-lint-no-html": "^2.0.0",

tests/template_collection.test.js

@@ -0,0 +1,47 @@
+import o from 'ospec';
+import Ajv from 'ajv';
+import { join } from 'path';
+import { promises as fs } from 'fs';
+import { AjvOptions, rootDirectory, schemaPath } from './validation.js';
+
+const examplePath = join(rootDirectory, 'examples/collection.json');
+
+o.spec('Collection', () => {
+  let validate;
+  const ajv = new Ajv(AjvOptions);
+
+  o.before(async () => {
+    const data = JSON.parse(await fs.readFile(schemaPath));
+    validate = await ajv.compileAsync(data);
+  });
+
+  o('Example should pass validation', async () => {
+    // given
+    const example = JSON.parse(await fs.readFile(examplePath));
+
+    // when
+    let valid = validate(example);
+
+    // then
+    o(valid).equals(true)(JSON.stringify(validate.errors, null, 2));
+  });
+
+  o("Example with invalid providers processing:software value should fail validation", async () => {
+    // given
+    const example = JSON.parse(await fs.readFile(examplePath));
+    example['providers'][0]['processing:software'] = null;
+
+    // when
+    let valid = validate(example);
+
+    // then
+    o(valid).equals(false);
+    o(
+      validate.errors.some(
+        (error) =>
+          error.instancePath === '/providers/0/processing:software' &&
+          error.message === 'must be object',
+      ),
+    ).equals(true)(JSON.stringify(validate.errors));
+  });
+});

tests/template_item.test.js

@@ -0,0 +1,66 @@
+import o from 'ospec';
+import Ajv from 'ajv';
+import { join } from 'path';
+import { promises as fs } from 'fs';
+import { AjvOptions, rootDirectory, schemaPath } from './validation.js';
+
+const examplePath = join(rootDirectory, 'examples/item.json');
+
+o.spec('Item', () => {
+  let validate;
+  const ajv = new Ajv(AjvOptions);
+
+  o.before(async () => {
+    const data = JSON.parse(await fs.readFile(schemaPath));
+    validate = await ajv.compileAsync(data);
+  });
+
+  o('Example should pass validation', async () => {
+    // given
+    const example = JSON.parse(await fs.readFile(examplePath));
+
+    // when
+    let valid = validate(example);
+
+    // then
+    o(valid).equals(true)(JSON.stringify(validate.errors, null, 2));
+  });
+
+  o("Example with invalid properties processing:software value should fail validation", async () => {
+    // given
+    const example = JSON.parse(await fs.readFile(examplePath));
+    example['properties']['processing:software'] = null;
+
+    // when
+    let valid = validate(example);
+
+    // then
+    o(valid).equals(false);
+    o(
+      validate.errors.some(
+        (error) =>
+          error.instancePath === '/properties/processing:software' &&
+          error.message === 'must be object',
+      ),
+    ).equals(true)(JSON.stringify(validate.errors));
+  });
+
+  o("Example with invalid asset processing:software value should fail validation", async () => {
+    // given
+    const example = JSON.parse(await fs.readFile(examplePath));
+    example['assets']['manifest']['processing:software'] = null;
+
+    // when
+    let valid = validate(example);
+
+    // then
+    o(valid).equals(false);
+    o(
+      validate.errors.some(
+        (error) =>
+          error.instancePath === '/assets/manifest/processing:software' &&
+          error.message === 'must be object',
+      ),
+    ).equals(true)(JSON.stringify(validate.errors));
+  });
+});

tests/validation.js

@@ -0,0 +1,32 @@
+import axios from 'axios';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import iriFormats from 'stac-node-validator/iri.js';
+
+const directory = dirname(fileURLToPath(import.meta.url));
+
+const Schemas = new Map();
+export function loadSchema(uri) {
+  let existing = Schemas.get(uri);
+  if (existing == null) {
+    existing = loadSchemaFromUri(uri);
+    Schemas.set(uri, existing);
+  }
+  return existing;
+}
+
+/**
+ * function passed in to Ajv instance which allows us to load schemas from a url at run time.
+ */
+export async function loadSchemaFromUri(uri) {
+  try {
+    let response = await axios.get(uri);
+    return response.data;
+  } catch (error) {
+    throw new Error(`-- Schema at '${uri}' not found. Please ensure all entries in 'stac_extensions' are valid.`);
+  }
+}
+
+export const AjvOptions = { loadSchema, formats: Object.assign(iriFormats) };
+export const rootDirectory = dirname(directory);
+export const schemaPath = join(rootDirectory, 'json-schema/schema.json');