@restqa/restqa/src/config/schema.js

An all in one test automation runner

const Joi = require("joi");

function validate(config) {
  const schemaEnvironment = Joi.object({
    name: Joi.string().required(),
    default: Joi.boolean().optional(),
    secrets: Joi.object({}).unknown(),
    plugins: Joi.array()
      .items(
        Joi.object({
          name: Joi.string().required(),
          config: Joi.any()
        })
      )
      .required(),
    data: Joi.object({
      storage: Joi.string(),
      channel: Joi.string(),
      config: Joi.object({}).unknown(),
      startSymbol: Joi.string().default("{{"),
      endSymbol: Joi.string().default("}}")
    }).default(),
    outputs: Joi.array().items(
      Joi.object({
        type: Joi.string(),
        enabled: Joi.boolean(),
        config: Joi.any()
      })
    )
  });

  const schemaConfig = Joi.object({
    version: Joi.any().allow("0.0.1"),
    metadata: {
      code: Joi.string().required(),
      name: Joi.string().required(),
      description: Joi.string().required()
    },
    environment: schemaEnvironment,
    analytics: Joi.object({
      key: Joi.string(),
      ignore: Joi.array()
    }),
    restqa: Joi.object({
      timeout: Joi.number(),
      dashboard: Joi.object({
        server: Joi.object({
          testFolder: Joi.string(),
          whiteList: Joi.array(),
          report: Joi.object({
            urlPrefixPath: Joi.string(),
            outputFolder: Joi.string()
          })
        }),
        readOnly: Joi.boolean()
      }),
      tips: Joi.object({
        enabled: Joi.boolean(),
        messages: Joi.array()
      })
    })
  });

  const {value, error} = schemaConfig.validate(config);

  if (error) {
    throw error;
  }

  return value;
}

module.exports = {validate};