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,15 @@
   "name": "stac-extensions",
   "version": "1.0.0",
   "scripts": {
-    "test": "npm run check-markdown && npm run check-examples",
+    "test": "jest && 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": {
+    "ajv": "^8.8.2",
+    "jest": "^27.4.4",
     "remark-cli": "^8.0.0",
     "remark-lint": "^7.0.0",
     "remark-lint-no-html": "^2.0.0",

tests/collection.test.js

@@ -0,0 +1,75 @@
+const { join } = require('path');
+const { promises } = require('fs');
+const { AjvOptions, rootDirectory, schemaPath } = require('./validation.js');
+const ajv = new (require('ajv'))(AjvOptions);
+
+const examplePath = join(rootDirectory, 'examples/collection.json');
+
+const propertyNames = [
+	'processing:expression',
+	'processing:facility',
+	'processing:level',
+	'processing:lineage',
+	'processing:software',
+];
+
+let validate;
+beforeAll(async () => {
+	const data = JSON.parse(await promises.readFile(schemaPath));
+	validate = await ajv.compileAsync(data);
+});
+
+describe('Collection example', () => {
+	it('should pass validation', async () => {
+		// given
+		const example = JSON.parse(await promises.readFile(examplePath));
+
+		// when
+		let valid = validate(example);
+
+		// then
+		expect(valid).toBeTruthy()
+	});
+
+	it('should fail validation with invalid providers processing:software value', async () => {
+		// given
+		const example = JSON.parse(await promises.readFile(examplePath));
+		example['providers'][0]['processing:software'] = null;
+
+		// when
+		let valid = validate(example);
+
+		// then
+		expect(valid).toBeFalsy();
+		expect(
+			validate.errors.some(
+				(error) =>
+					error.instancePath === '/providers/0/processing:software' &&
+					error.message === 'must be object',
+			),
+		).toBeTruthy();
+	});
+
+	it('should fail validation without any summaries processing: properties', async () => {
+		// given
+		const example = JSON.parse(await promises.readFile(examplePath));
+		for (const propertyName of propertyNames) {
+			delete example['summaries'][propertyName];
+		}
+
+		// when
+		let valid = validate(example);
+
+		// then
+		expect(valid).toBeFalsy();
+		for (const propertyName of propertyNames) {
+			expect(
+				validate.errors.some(
+					(error) =>
+						error.instancePath === "/summaries" &&
+						error.message === `must have required property '${propertyName}'`,
+				),
+			).toBeTruthy();
+		}
+	});
+});

tests/item.test.js

@@ -0,0 +1,63 @@
+const { join } = require('path');
+const { promises } = require('fs');
+const { AjvOptions, rootDirectory, schemaPath } = require('./validation.js');
+const ajv = new (require('ajv'))(AjvOptions);
+
+const examplePath = join(rootDirectory, 'examples/item.json');
+
+let validate;
+beforeAll(async () => {
+	const data = JSON.parse(await promises.readFile(schemaPath));
+	validate = await ajv.compileAsync(data);
+});
+
+describe('Item example', () => {
+	it('should pass validation', async () => {
+		// given
+		const example = JSON.parse(await promises.readFile(examplePath));
+
+		// when
+		let valid = validate(example);
+
+		// then
+		expect(valid).toBeTruthy();
+	});
+
+	it('should fail validation with invalid properties processing:software value', async () => {
+		// given
+		const example = JSON.parse(await promises.readFile(examplePath));
+		example['properties']['processing:software'] = null;
+
+		// when
+		let valid = validate(example);
+
+		// then
+		expect(valid).toBeFalsy();
+		expect(
+			validate.errors.some(
+				(error) =>
+					error.instancePath === '/properties/processing:software' &&
+					error.message === 'must be object',
+			),
+		).toBeTruthy();
+	});
+
+	it('should fail validation with invalid asset processing:software value ', async () => {
+		// given
+		const example = JSON.parse(await promises.readFile(examplePath));
+		example['assets']['manifest']['processing:software'] = null;
+
+		// when
+		let valid = validate(example);
+
+		// then
+		expect(valid).toBeFalsy();
+		expect(
+			validate.errors.some(
+				(error) =>
+					error.instancePath === '/assets/manifest/processing:software' &&
+					error.message === 'must be object',
+			),
+		).toBeTruthy();
+	});
+});

tests/validation.js

@@ -0,0 +1,31 @@
+const axios = require('axios');
+const { dirname, join } = require('path');
+const iriFormats = require('stac-node-validator/iri.js');
+
+// const directory = dirname(fileURLToPath(import.meta.url));
+
+const Schemas = new Map();
+const loadSchema = function (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.
+ */
+module.exports.loadSchemaFromUri = async function (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.`);
+	}
+}
+
+module.exports.AjvOptions = {loadSchema, formats: Object.assign(iriFormats)};
+module.exports.rootDirectory = dirname(__dirname);
+module.exports.schemaPath = join(module.exports.rootDirectory, 'json-schema/schema.json');