Support mocking of response based on openapi or json schema

Author: knuthelv

import_map.json

@@ -1,3 +1,3 @@
 {
 
-}
+}

src/json-mock-from-schema.js

@@ -0,0 +1,52 @@
+import toJsonSchema from 'npm:@openapi-contrib/openapi-schema-to-json-schema@latest'
+import jsf from 'npm:json-schema-faker@latest'
+// After fix use this one: import jsf from 'npm:json-schema-faker@latest/esm'
+
+jsf.option({
+    useExamplesValue: true,
+    random: () => 0.000001
+})
+
+export const SchemaType = {
+    OPENAPI: 'openapi',
+    JSON: 'json'
+}
+
+export function toSchemaType(schema) {
+    return schema.openapi ? SchemaType.OPENAPI : SchemaType.JSON
+}
+
+export function toJsonMock(type, schema) {
+    if (!schema) {
+        return undefined
+    }
+
+    switch (type) {
+        case SchemaType.OPENAPI:
+            return toJsonMockFromOpenapi(schema)
+        case SchemaType.JSON:
+        default:
+            return toJsonMockFromJsonSchema(schema)
+    }
+}
+
+function toJsonMockFromOpenapi(schema) {
+    let jsonSchema = toJsonSchema(schema)
+
+    if (jsonSchema?.properties) {
+        jsonSchema.required = Object.entries(jsonSchema?.properties)
+            .map(([key, value]) => {
+                if (value?.type === 'array') {
+                    return key
+                }
+                return value?.required ? key : undefined
+            })
+            .filter(v => v !== undefined)
+    }
+
+    return jsf.generate(jsonSchema)
+}
+
+function toJsonMockFromJsonSchema(schema) {
+    return jsf.generate(schema)
+}

src/scenario-algorithm.js

@@ -1,5 +1,6 @@
 import utils from './utils.js'
-import * as typeGenerators from './type-generators.js'
+import {toRandomFromType} from './type-generators.js'
+import {toJsonMock, toSchemaType} from './json-mock-from-schema.js'
 
 function toTechnology(technology) {
     return technology || 'HTTP'
@@ -256,16 +257,20 @@ function toHeaders(headerFile, headers, defaultHeaders) {
             : utils.openFile(defaultHeaders)
 }
 
-function resolveInputData(data) {
-    const extracted = data?.templateFile
+function resolveTemplate(data) {
+    return data?.templateFile
         ? utils.openFile(data.templateFile)
         : data.template
+}
 
-    const final = data?.entryName && extracted
-        ? extracted[data?.entryName]
-        : extracted
+function resolveEntry(data, template) {
+    return data?.entryName
+        ? utils.resolvePathData(data.entryName, template)
+        : undefined
+}
 
-    return final || data
+function resolveInputData(data) {
+    return resolveEntry(data, resolveTemplate(data)) || data
 }
 
 function toRequest(request) {
@@ -286,7 +291,14 @@ function toResponse(response) {
 
     const {...outResponse} = response
 
-    outResponse.body = response.body ? resolveInputData(response.body) : {}
+    outResponse.body = response.body ? resolveInputData(response.body) : undefined
+
+    if (!outResponse.body) {
+        const template = resolveTemplate(response.schema)
+        const schema = resolveEntry(response.schema, template)
+
+        outResponse.body = toJsonMock(toSchemaType(template), schema)
+    }
 
     return outResponse
 }
@@ -351,7 +363,7 @@ function toGenerateConstants(generateConstants) {
         .map(constant => {
             return {
                 ...constant,
-                generated: typeGenerators.toRandomFromType(
+                generated: toRandomFromType(
                     constant.type,
                     constant.min,
                     constant.max,

src/utils.js

@@ -1,4 +1,5 @@
 import {readFileSync} from 'https://deno.land/[email protected]/node/fs.ts'
+import {parse} from "https://deno.land/[email protected]/encoding/yaml.ts";
 
 function randomIban(countryCode, technicalOrgNum) {
     return countryCode + randomInteger(20, 90) + technicalOrgNum + randomInteger(1000000, 9999999)
@@ -126,7 +127,12 @@ export default {
     setWorkingDirectory: dir => workingDirectory = dir || '.',
 
     openFile: fileName => {
-        return JSON.parse(readFileSync(toPath(fileName)).toString())
+        const text = readFileSync(toPath(fileName)).toString()
+
+        if(fileName.endsWith(".yaml") || fileName.endsWith(".yml")) {
+            return parse(text)
+        }
+        return JSON.parse(text)
     },
 
     toReplace: (generate, replace) => {
@@ -140,5 +146,10 @@ export default {
         return generateReplace(generate || [], config || {})
     },
 
-    inputReplacesToJson: csv => inputReplacesToJson(csv)
+    inputReplacesToJson: csv => inputReplacesToJson(csv),
+
+    resolvePathData: (path, obj) => {
+        return path.split('.')
+            .reduce((prev, curr) => prev ? prev[curr] : null, obj || self)
+    }
 }