envoyproxy/envoy

config validation: validator only checks for file presence not content

Open

#36,289 opened on Sep 23, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/config_validationhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

when file system is used to configure Envoy, the config validator (-mode validate) only checks if files are present but does not load those files to check if their content is valid.

In this super simple config:

dynamic_resources:
  cds_config:
    resource_api_version: V3
    path_config_source:
      path: /test/cds.yaml
  lds_config:
    resource_api_version: V3
    path_config_source:
      path: /test/lds.yaml

the validator will accept empty and non-yaml files when run in validate mode.

Contributor guide

Research direction
Examine the config validation flow in Envoy's source code, particularly how files are loaded during validation. Look for the function that checks file existence without parsing content, and modify it to parse and validate the file contents.
Tech stack
cpp
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
C++Envoy configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60