Add moduleFlag, omitDocumentedFieldsCheck and ModuleConfig to http testing framework

[sayden]

• moduleFlag: While working on the first days with the new testing framework I found a common pattern which was to re-launch tests to check a specific module. In its current state you must launch all tests and you cannot select a single one. Using go test . -module=apache you can test only that module
• module_config some modules have specific fields that are required in order them to work. http/json metricset is an example of a required field (namespace). module_config map-field in config.yml adds the map to the config params of a module. For example with this config.yml in http/json/_meta/testdata module:

type: http
url: "/hello"
suffix: json
module:
  namespace: test
  foo: bar

The following module config is produced:

- module: http
  metricsets:
    - json
  period: 10s
  hosts: ["localhost:80"]
  path: "/"
  namespace: "test"
  foo: bar

• omitDocumentedFieldsCheck: Is a new config field to omit certain fields from being checked inside the documentation. As described in the code: OmitDocumentedFieldsCheck is a list of fields that must be omitted from the function that checks if the field is contained in {metricset}/_meta/fields.yml

type: http
url: "/hello"
suffix: json
omitDocumentedFieldsCheck:
  - hello
  - world.*
  - *

[ruflin]

I wonder if we should call it just config?

[sayden]

The idea was that a reader can clearly understand that anything in this field is module related configuration and not test related configuration.

What about calling it just module then? If the reason is to short it, the file is already called config.yml so the fact that some configuration is going to be find inside is assumed.

• config only could lead to confusion as soon as we need any other config, for example metricset config (so we don't end up with config, which refers to module config and metricsetConfig for something specific of the metricset).
• An alternative is to call it config.Module so later we can also have config.Metricset but I think that as the file is called config.yml, prefixing a field with config. is redundant as well as placing it in the suffix like now.

At the same time, if we maintain the variables names like config in data_test.go code, calls to this module configuration will look like config.Module instead of config.Config.

[kaiyan-sheng]

It's great to have the ability to run go test for a specific module. I'm trying to test it locally, do I need to run go test . -module=apache under a specific directory? I tried to run it under metricbeat and it says flag provided but not defined: -module 😄

[ruflin]

I like calling the config option module.

[sayden]

It's great to have the ability to run go test for a specific module. I'm trying to test it locally, do I need to run go test . -module=apache under a specific directory? I tried to run it under metricbeat and it says flag provided but not defined: -module

Yes! You must run it from metricbeat/mb/testing/data

[sayden]

Error seems unrelated. Merging

[kaiyan-sheng]

@sayden Thanks 👍 I will try it again!!