s2i build . quay.io/quarkus/ubi-quarkus-native-s2i:19.3.2-java11 backpackcloud/fakeomatic

Some configuration values can be externalized by different ways additionally to the normal String value:

env

Fetches the value from an Environment Variable.

property

Fetches the value from a System Property.

file

Reads the value from a file.

resource

Reads the value using a class.getResourceAsStream.

url

Reads the value from the given URL by using GET url.

value

Supplies a raw value.

It is also possible to combine different approaches for getting the value by passing all the desired options. The first one that holds a value will be used (see the priority bellow):

The priority for getting the value is:

1. env

2. property

3. file

4. resource

5. url

6. value

It’s also possible to supply a raw value without specifying the type value if it’s the only value:

Some samples take other samples as configuration. In most cases, there are two ways of passing a sample as configuration:

1. Referring through a ref property.

2. Directly through a sample property.

An endpoint is primarily used to send generated payloads but can also be used as a source of data for the samples.

Configuration

Built In

endpoints:
  default:
    url:
      env: ENDPOINT_URL
      property: endpoint.url
      value: http://localhost:8080
    payload:
      content-type:
        env: ENDPOINT_CONTENT_TYPE
        property: endpoint.content_type
        value: application/json
      template:
        env: ENDPOINT_TEMPLATE
        property: endpoint.template
        resource: /META-INF/resources/config/payload.json
    method:
      env: ENDPOINT_METHOD
      property: endpoint.method
      value: POST
    concurrency:
      env: ENDPOINT_CONCURRENCY
      property: endpoint.concurrency
      value: 10
    buffer:
      env: ENDPOINT_BUFFER
      property: endpoint.buffer
      value: 10
    insecure:
      env: ENDPOINT_INSECURE
      property: endpoint.insecure
      value: false

The rules for generating data can contain sample and placeholders. Samples are a set of data that Fake-O-Matic can randomly pick and placeholders are characters that can be associated with the samples for to allow the use of expressions for generating data.

Samples

samples:
  letter:
    type: chars
    value: "abcdefghijklmnopqrstuvwxyz"
  digit:
    type: chars
    value: "0123456789"

samples:
  cause:
    type: list
    values:
      - "clock speed"
      - "solar flares"
      - "electromagnetic radiation from satellite debris"
      - "static from nylon underwear"
      - "static from plastic slide rules"
      - "global warming"
      - "poor power conditioning"
      - "static buildup"
      - "doppler effect"
  first_name:
    type: list
    samples:
      - man_name
      - woman_name
  story:
    type: list
    source:
      env: STORIES
      property: stories
      default: stories.txt

samples:
  chuck_norris:
    type: api
    endpoint:
      url: https://api.chucknorris.io/jokes/random
  example:
    type: api
    endpoint:
      url: https://api.example.com/{version}/some/path
      headers:
        token:
          env: EXAMPLE_API_TOKEN
          property: example.api.token
      params:
        version:
          env: EXAMPLE_API_VERSION
          property: example.api.version
          value: v1

samples:
  chuck_norris:
    type: json
    source:
      sample:
        type: api
        endpoint:
          url: https://api.chucknorris.io/jokes/random
    path: /value

samples:
  uuid:
    type: uuid

samples:
  full_name:
    type: join
    separator: " "
    samples:
      - first_name
      - last_name

samples:
  color:
    type: weight
    values:
      - weight: 30
        value: blue
      - weight: 45
        value: yellow
      - weight: 10
        value: red
      - weight: 20
        value: brown
      - weight: 25
        value: cyan

samples:
  grade:
    type: range
    min: 0
    max: 10
  temperature:
    type: range
    min: -10
    max: 20

samples:
  address_expression:
    type: list
    values:
      - "Some Street ##"
      - "Another Street ###"
      - "Galaxy ###"
  address:
    type: expression
    sample: address_expression
  credit_card:
    type: expression
    expression: "################"

samples:
  day_in_2020:
    type: date
    from: 2020-01-01
    to: 2021-01-01
  day_in_quarter:
    type: date
    from: 2020-01-01
    period: P3M
  yesterday_to_tomorrow:
    type: date
    from: yesterday
    to: tomorrow
    inclusive: true

samples:
  new_person:
    type: api
    url: http://api.example.com/persons
    method: POST
    payload:
      template: person.json
    return: /id
  person:
    type: cache
    source:
      ref: new_person

Placeholders

placeholders:
  "#": digit   (1)
  "%": letter  (2)

samples:
  letter:
    type: chars
    value: "abcdefghijklmnopqrstuvwxyz"
  digit:
    type: chars
    value: "0123456789"

Fake-O-Matic uses Qute templates to produce the payloads. A couple of methods can be used to get a fake data, the main one are:

some(sampleName)

Gets a random sample from the given sample name.

expression(placeholders)

Gets a random data produced by replacing each placeholder by a random sample associated with it.

The following properties can be configured as a JVM argument (prefix -D), environment variable (with upper cases and underscores), or a command line parameter:

endpoint.name|ENDPOINT_NAME|--endpoint-name

Which endpoint in the configuration to use. Defaults to default.

endpoint.url|ENDPOINT_URL|--endpoint-url

The endpoint url to use for the default endpoint. Defaults to http://localhost:8080.

endpoint.method|ENDPOINT_METHOD|--method

Which HTTP method to use for calling the endpoint. Defaults to POST.

endpoint.concurrency|ENDPOINT_CONCURRENCY|--concurrency

The maximum number of concurrent requests to the endpoint. Defaults to 10.

endpoint.buffer|ENDPOINT_BUFFER|--buffer

How many payloads should be buffered while we have ongoing requests. Defaults to 10.

endpoint.insecure|ENDPOINT_INSECURE|--insecure

Marks the endpoint as insecure or not. An insecure endpoint will not have its certificate check. Defaults to false.

endpoint.template|ENDPOINT_TEMPLATE|--template

Where to locate the template for generating the payloads. Defaults to ./payload.json.

endpoint.content_type|ENDPOINT_CONTENT_TYPE|--content-type

Which Content-Type to pass to the endpoint. Defaults to application/json.

generator.total|GENERATOR_TOTAL|--total

The number of generated payloads. Defaults to 10.

generator.config|GENERATOR_CONFIG|--config

Which configuration files should be used. Fake-O-Matic allows you to define parent configurations, so you can reuse them in the way it suits you better. The configurations should be comma separated from the most specific to the least specific (so the last configuration file becomes the parent one). The built-in configuration can be included with a simple fakeomatic name. The built-in configuration can be found at src/main/resources/META-INF/config/fakeomatic.yaml.

generator.seed|GENERATOR_SEED|--seed

The seed to use for the random functions. Fake-O-Matic will generate one if empty.

fakeomatic.events.log.level|FAKEOMATIC_EVENTS_LOG_LEVEL|--events-log-level

Sets the log level for the events. To see all the payloads and responses, set the log level to DEBUG.