xops-pat/app/schema/spacewalkValidator.js

Procedure generator for on space operations

'use strict';

const path = require('path');
const fs = require('fs');

const YAML = require('yamljs');
const Ajv = require('ajv');

const ValidationError = require('./validationError');

const PROCEDURE_SCHEMA_FILE = './procedureSchema.json';
const TASK_SCHEMA_FILE = './taskSchema.json';

/**
 * Validates a file against a YAML schema.
 * Provides helper methods for procedure and task schemas.
 */
module.exports = class SpacewalkValidator {

	constructor() {}

	/**
     * Validates a yaml file against the procedure schema
     *
     * @param   {string} procedureYamlFilePath YAML file to validate
     * @return  {*} TBD FIXME
     */
	validateProcedureSchemaFile(procedureYamlFilePath) {

		const procedureSchema = path.join(__dirname, PROCEDURE_SCHEMA_FILE);

		return this.validateFile(procedureYamlFilePath, procedureSchema);
	}

	/**
     * Validates a yaml string against the procedure schema
     *
     * @param   {*} procedureYamlString YAML string to validate
     * @return  {*} TBD FIXME
     */
	validateProcedureSchemaString(procedureYamlString) {

		const procedureSchema = path.join(__dirname, PROCEDURE_SCHEMA_FILE);

		return this.validateString(procedureYamlString, procedureSchema);

	}

	/**
     * Validates a yaml file against the task schema.
     *
     * @param   {*} taskYamlFilePath YAML file to validate
     * @return  {*} TBD FIXME
     */
	validateTaskSchemaFile(taskYamlFilePath) {

		const taskSchema = path.join(__dirname, TASK_SCHEMA_FILE);

		return this.validateFile(taskYamlFilePath, taskSchema);

	}

	/**
     * Validates a yaml string against the task schema.
     *
     * @param   {*} taskYamlString YAML string to validate
     * @return  {*} TBD FIXME
     */
	validateTaskSchemaString(taskYamlString) {

		const taskSchema = path.join(__dirname, TASK_SCHEMA_FILE);

		return this.validateString(taskYamlString, taskSchema);

	}

	/**
     * Validates a YAML file against the provided schema.
     *
     * @param   {*} yamlFile Yaml file to validate
     * @param   {*} jsonSchemaFile Schema file to validate against
     * @return  {*} TBD FIXME
     */
	validateFile(yamlFile, jsonSchemaFile) {

		// Parse the yaml file into json
		const yaml = YAML.load(yamlFile);

		// Validate the YAML
		return this.validateYaml(yaml, jsonSchemaFile);

	}

	/**
     * Validates a YAML string against the provided schema.
     *
     * @param   {*} yamlString Yaml string to validate
     * @param   {*} jsonSchemaFile Schema file to validate against
     * @return  {*} TBD FIXME
     */
	validateString(yamlString, jsonSchemaFile) {

		// Parse the yaml string into json
		const yaml = YAML.parse(yamlString);

		return this.validateYaml(yaml, jsonSchemaFile);

	}

	/**
     * Validates a parsed YAML against the provided schema.
     *
     * @param   {*} yaml Yaml string to validate
     * @param   {*} jsonSchemaFile Schema file to validate against
     * @return  {*} TBD FIXME
     */
	validateYaml(yaml, jsonSchemaFile) {

		// Load the json-schema
		const schema = JSON.parse(fs.readFileSync(jsonSchemaFile));

		// Validate the yaml
		const ajv = new Ajv();
		const valid = ajv.validate(schema, yaml);
		if (!valid) {
			throw new ValidationError('YAML Validation Failed', ajv.errors);
		}

		return valid;
	}

};