vectordotdev/vector

Provide generic `generate_config` and `test_generate_config`

Open

#21,865 opened on Nov 21, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (21,837 stars) (2,126 forks)batch import
domain: configdomain: devgood first issue

Description

Currently these work with Toml::Values however YAML is now the first class format in Vector.

See https://github.com/vectordotdev/vector/blob/v0.42.0/src/test_util/mod.rs#L95-L103

We can also support JSON values.

Contributor guide

Tech stack
rust
Domain
testingtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Rust genericsKnowledge of Vector's test util module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing `generate config` and `test generate config` functions in `src/test util/mod.rs` (lines 95-103) which currently work with `Toml::Value`. Understand how to generalize them to support YAML and JSON values. Check if there are any existing traits or conversion functions in the codebase that can facilitate generating configs in different formats. Consider using serde or similar for serialization.