Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Metricbeat] Testing: Allow use of different directory to test data instead of the expected one #34467

Merged
merged 25 commits into from
Feb 20, 2023
Merged

[Metricbeat] Testing: Allow use of different directory to test data instead of the expected one #34467

Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c0d45a0
Allow change of directory.
constanca-m Feb 2, 2023
eaa103d
Update CHANGELOG.next.asciidoc
constanca-m Feb 2, 2023
150df6b
Fix testdata testing function
constanca-m Feb 3, 2023
2693f39
Do not test data.json
constanca-m Feb 3, 2023
7eeeb91
Fix collector_test.go
constanca-m Feb 6, 2023
9d7e4c9
Fix path comment.
constanca-m Feb 6, 2023
b1ef5ad
Merge branch 'elastic:main' into refactor-test-data-mb
constanca-m Feb 9, 2023
5b7a2cd
Revert collector changes.
constanca-m Feb 9, 2023
b54289e
Move difference to the correct changelog.
constanca-m Feb 9, 2023
8682c37
Add comment to function.
constanca-m Feb 9, 2023
129baac
Fix comment to function.
constanca-m Feb 9, 2023
e5890e2
Fix collector files.
constanca-m Feb 9, 2023
e9fbddd
Fix collector files.
constanca-m Feb 9, 2023
b340c6c
Fix collector files.
constanca-m Feb 9, 2023
9d755ea
Fix collector files.
constanca-m Feb 9, 2023
b6b1a2d
Fix collector files.
constanca-m Feb 9, 2023
e0c13cc
Fix collector files.
constanca-m Feb 9, 2023
c36ebd9
Update optional string to mandatory string.
constanca-m Feb 9, 2023
5f512ed
Merge branch 'elastic:main' into refactor-test-data-mb
constanca-m Feb 9, 2023
a8aebff
Remove misplaced folder.
constanca-m Feb 9, 2023
e5be71c
Update README.md
constanca-m Feb 9, 2023
79f4804
Update README.md
constanca-m Feb 9, 2023
22abe62
Set default data.json location
constanca-m Feb 14, 2023
5a8fa8c
Update readme
constanca-m Feb 14, 2023
febd2e2
Update readme
constanca-m Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion metricbeat/mb/testing/data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ An alternative is to just run from metricbeat `mage mockedTests` to achieve the
### Available settings in `config.yml`

- `path`: (string) Path to reach the directory containing the files to read from. Default is "_meta/testdata".
- `wirtepath`: (string) Path to the directory where the expected files are going to be written. Default is "_meta/testdata".
- `writepath`: (string) Path to the directory where the expected files are going to be written. Default is "_meta/testdata".
- `datapath`: (string) Path to the directory where the data.json file is going to be written. Default is "_meta".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please somewhere add a comment why we have data.json file and that is used/might be used for our public documentation (or link to the place where it is mentioned, but I couldn't find it)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can try, but I am not sure I understand the reasoning for that file since it was already there

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking about adding smth like data.json file is used to render example events published in our official documentation
at least for me it wasn't clear at the moment of asking why we generated those files in this comment #34467 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, done that! I was thinking something more complex, but as you wrote it, it makes perfect sense. I don't want to link to the line code because I would have to use one fixed commit and that might end up not making sense if we are on the branch main and are sent to a possible very old one.

- `type`: (string) The type of the test to run. At the moment, only `http` is supported.
- `url`: (string) This is the URL path that the module usually fetches to get metrics. For example, in case of Apache module this url is `/server-status?auto=`
- `suffix`: (string) The suffix that the input file has. By default `json` other common suffixes are `plain` (string) for plain text files.
Expand Down