random_data_creation.md

General

Goal is the generate random data from a given JSON schema.

The general approach is to annotate a given model with configurations for random data generation and let then in a second step the script createRandomData.py process the configuration

Configuration

JSON schemas can be extended with specific configurations see here. The extension can be put on types and attributes after an attribute processing

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Info Section",
    "description": "Info section for API definition specs as openapi and ayncapi",
    "version": "0.1.0",
    "x-domain": "yacg.model.shared.info",
    "type": "object",
    "properties": {
        "title": {
            "type": "string"
        },
        "version": {
            "type": "string"
        },
        "description": {
            "type": "string",
            "processing": {
                "randValueConf": {
                    "stringTypeConf": {
                        "strType": "TEXT",
                        "maxLength": 200
                    }
                }
            }
        },
        "license": {
            "type": "string",
            "processing": {
                "randIgnore": true
            }
        }
    },
    "processing": {
        "$comment": "includes this element in the random data creation, one element will be generated",
        "randElemCount": 1
    }

}

Examples to use the jq command to annotate JSON schemas

Include specific types in the random data generation

cat resources/models/json/shared/info.json | jq \
     '. + {
            "processing": {
                comment: "includes this element in the random data creation", 
                randElemCount: 1
            }
        }'

Include random data gen config to a specific attribute

cat resources/models/json/shared/info.json | jq \
     '.properties.description += {
            "processing": {
                "randValueConf": {
                    "stringTypeConf": {
                        "strType": "TEXT",
                        "maxLength": 200
                    }
                }
            }
        } | .properties.license += {
            "processing": {
                "randIgnore": true
            }
        }'

Include all random data gen configs to a schema

# example with a monster configuration ...
cat resources/models/json/shared/info.json | jq \
     '.properties.description += {
            "processing": {
                "randValueConf": {
                    "stringTypeConf": {
                        "strType": "TEXT",
                        "maxLength": 200
                    }
                }
            }
        } | .properties.license += {
            "processing": {
                "randIgnore": true
            }
        } | . += {
            "processing": {
                comment: "includes this element in the random data creation", 
                randElemCount: 1
            }
        }'

# example splitted the monster configuration into multiple pipeline steps
cat resources/models/json/shared/info.json | \
    # includes the configuration for the description property \
    jq '.properties.description += {
            "processing": {
                "randValueConf": {
                    "stringTypeConf": {
                        "strType": "TEXT",
                        "maxLength": 200
                    }
                }
            }
        }' | \
    # includes the configuration for the license property \
    jq '.properties.license += {
            "processing": {
                "randIgnore": true
            }
        }' | \
    # enables the main type for the random data generation \
    jq '. += {
            "processing": {
                comment: "includes this element in the random data creation", 
                randElemCount: 1
            }
        }'