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.

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

repo reorg: move ext auth filters #2923

Merged
merged 7 commits into from
Mar 28, 2018
Merged

repo reorg: move ext auth filters #2923

merged 7 commits into from
Mar 28, 2018

Conversation

mattklein123
Copy link
Member

Demonstrates common code across multiple filters.

Risk Level: Low
Testing: N/A
Docs Changes: N/A
Release Notes: N/A

Demonstrates common code across multiple filters.

Signed-off-by: Matt Klein <[email protected]>
Signed-off-by: Matt Klein <[email protected]>
Signed-off-by: Matt Klein <[email protected]>
@mattklein123
Copy link
Member Author

@alyssawilk and @envoyproxy/maintainers PTAL at the docs that I added.

Copy link
Member

@htuch htuch left a comment

Choose a reason for hiding this comment

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

REPO_LAYOUT.md looks good, some minor feedback.

REPO_LAYOUT.md Outdated
* [bazel/](bazel/): Configuration for Envoy's use of [Bazel](https://bazel.build/).
* [ci/](ci/): Scripts used both during CI as well as to build Docker containers.
* [configs/](configs/): Example Envoy configurations.
* [docs/](docs/): Project level documentation is well as scripts for publishing final docs during
Copy link
Member

Choose a reason for hiding this comment

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

Nit: s/is well as/as well as/

Copy link
Contributor

@alyssawilk alyssawilk Mar 28, 2018

Choose a reason for hiding this comment

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

pinging this one. otherwise LGTM

Copy link
Member Author

Choose a reason for hiding this comment

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

oops sorry missed it

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

REPO_LAYOUT.md Outdated

## [source/](source/)

* [common/](source/[common/): Core Envoy code (not specific to extensions) that is also not
Copy link
Member

Choose a reason for hiding this comment

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

Path typo?

REPO_LAYOUT.md Outdated
* [extensions/](source/extensions/): Extensions to the core Envoy code. The layout of this
directory is discussed in further detail below.
* [server/](source/server/): Code specific to running Envoy as a standalone server. E.g,
configuration, server startup, workers, etc. Overtime, the line between `common/` and `server/`
Copy link
Member

Choose a reason for hiding this comment

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

Nit: "over time"

REPO_LAYOUT.md Outdated
* Extension unit tests also match their source equivalents in [extensions/](test/extensions/).
* [integration/](test/integration/) holds end-to-end integration tests using roughly the real
Envoy server code, fake downstream clients, and fake upstream servers. Integration tests also
test some of the extensions found in the repository.
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't seem ideal, aren't we going to push these into the extension specific dirs?

Copy link
Member Author

Choose a reason for hiding this comment

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

This was my plan originally but @alyssawilk objected. Or maybe I misunderstood the objection @alyssawilk?

Copy link
Contributor

Choose a reason for hiding this comment

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

We may - I'd asked we defer that until after the filter moves as I think there's a bunch of code which tests various filters, or tests core components (flow control) using extensions (various filters which buffer).

It's pretty non-trivial to tease these out.

Copy link
Contributor

@alyssawilk alyssawilk Mar 28, 2018

Choose a reason for hiding this comment

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

Also, we've been organizing our HTTP tests around codec so you can "easily" add a cors test for HTTP/2, HTTP, HTTP/2 upstream etc. I think we need an integration test rewrite to make it easier to have "the cors filter test" which runs the test for the varions combinations and permutations, rather than having 3 integration tests per filter which would be really crummy from a scaling perspective. I think if we do that refactor we could encourage folks to add new integration tests under their filter directories, and move the easy-to-tease-apart tests to their directories for reference implementations. Still not sure how we want to handle testing core features which require filters without implementing a bunch of fake test filters (which we could totally do, but don't have yet) so I think this will be a series of TODOs and follow-up PRs.

In the interim we could move the existing tests to http/common and network/common if we think it's worth an interim move.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I agree that more thinking is needed here. I would prefer that we not let "perfect be the enemy of the good" on this so I will add some aspirational text on where we would like this to go.

Copy link
Contributor

@alyssawilk alyssawilk left a comment

Choose a reason for hiding this comment

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

I love this documentation so much. Above and beyond what I'd expected 🥇

The usual nits follow :-P

REPO_LAYOUT.md Outdated
* [docs/](docs/): Project level documentation is well as scripts for publishing final docs during
releases.
* [examples/](examples/): Larger Envoy examples using Docker and Docker Compose.
* [include/](include/): "Public" interface headers for "core" Envoy (not extensions). In general,
Copy link
Contributor

Choose a reason for hiding this comment

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

this is a bit confusingly phrased, given it includes the interfaces for major extensions, i.e. tcp proxying, http stream etc.

REPO_LAYOUT.md Outdated
* Extension unit tests also match their source equivalents in [extensions/](test/extensions/).
* [integration/](test/integration/) holds end-to-end integration tests using roughly the real
Envoy server code, fake downstream clients, and fake upstream servers. Integration tests also
test some of the extensions found in the repository.
Copy link
Contributor

Choose a reason for hiding this comment

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

We may - I'd asked we defer that until after the filter moves as I think there's a bunch of code which tests various filters, or tests core components (flow control) using extensions (various filters which buffer).

It's pretty non-trivial to tease these out.

@alyssawilk alyssawilk self-assigned this Mar 28, 2018
@mattklein123
Copy link
Member Author

@htuch @alyssawilk updated PTAL

Signed-off-by: Matt Klein <[email protected]>
Copy link
Member

@htuch htuch left a comment

Choose a reason for hiding this comment

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

LGTM, thanks, this is a nice writeup.

@mattklein123 mattklein123 merged commit 218da90 into master Mar 28, 2018
@mattklein123 mattklein123 deleted the move_ext_auth branch March 28, 2018 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants