envoyproxy/envoy

enhance router_check_tool to allow going through listeners as well

Open

#12,393 opened on Jul 30, 2020

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

Repository metrics

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

Description

Currently, router_check_tool takes in a route as input. This makes the tool somewhat whitebox - the user first needs to figure out which route they care about, then they can write a test for it. Ideally, its completely black box - the user gives the full Envoy config (really just Listeners and Routes) and a set of queries, and checks the result.

This is useful as well to test complex listeners with many different filter chain matches.

Alternatives considered:

  • Implement the logic for determining a route from the request ourselves. This would involve re-implementing the filter chain/listener matching logic which is likely to be incorrect and fall out of sync
  • Use the tool as is. This doesn't mean the requirement of black box testing, relies test writers to know Envoy implementation details
  • Send real traffic against a real envoy instead. This is slower and more complex

Contributor guide

Research direction
Study the existing router check tool code and understand how it currently takes a route. Then modify it to accept a full Envoy configuration (listeners and routes) and implement the logic to select the appropriate route from request headers, leveraging Envoy's own filter chain matching logic if possible.
Tech stack
cpp
Domain
backendapi
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Envoy configrouter check tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40