https://github.com/ovotech/avro-mock-generator

Generate random mock data from an Avro Schema
https://github.com/ovotech/avro-mock-generator

company-kaluza

Last synced: 12 days ago
JSON representation

Generate random mock data from an Avro Schema

• Host: GitHub
• URL: https://github.com/ovotech/avro-mock-generator
• Owner: ovotech
• License: apache-2.0
• Created: 2019-07-31T10:06:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T04:15:58.000Z (about 1 year ago)
• Last Synced: 2024-12-05T16:09:55.336Z (17 days ago)
• Topics: company-kaluza
• Language: TypeScript
• Size: 312 KB
• Stars: 8
• Watchers: 14
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Avro Mock Generator

Create mock messages from Avro schemas.

## Usage

Call the generator with the schema:

```

import generateMsg from '@ovotech/avro-mock-generator'

const schema = {

  type: 'record',

  fields: [{ name: 'nbChickens', type: 'int' }],

}

console.log(generateData(schema));

// { nbChickens: 25672672 }

```

All fields will contain randomly generated data that respects their type.

### Options

An `options` object can optionnaly be provide as the second argument.

Supported Options:

- `generators`: An `key`/`value` object of generator functions.

  - `key`: the `type` (or `logicalType`)

  - `value`: should be a generator function `(type, context) => value` where - `type`: the content of the `type` field in the schema, either a `string` for simple type, or the type configuration for complex types - `context`: an object with contextual data, including the `generators`

    It is possible to override the default generators, and add support for extra types/logicalTypes by providing

- `pickUnion`: Array of strings to drive which member of union type to choose. Can be the short name of fully namespaced names. When this option is not provided, the first element in the union will be chosen

## Reproducible generation

Use the `Seeded` factory to create a version of the generator that will use deterministic randomness.

The factory will return a function with the same signature as the default generator.

## Supported Avro features

Based on the Avro 1.9.0 [specification](https://avro.apache.org/docs/current/spec.html).

- All primitive types

- All logical types

  - including custom logicalTypes using the `options` parameter. If a `logicalType` is missing a generator, data will be generated matching the underlying `type`.

- All complex types

  - Note that for `enum` types, the first element of the array will always be chosen.

- Type Alias

**Partial support for namespaces**. Only union types are namespaced, unconditionally.

## Contributing

All contributions are welcome, just fork the repository then create a PR. Once merged we will release a new version.

## Releasing

Simply create a [new release](https://github.com/ovotech/avro-mock-generator/releases/new) on master, with the tag being the new version (eg: 1.0.0).