Add filters docs and external doc tests support #89
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add external documentation under `/docs` around filters and their configuration. * Add support for running tests in external docs. This includes adding a nightly compiler and updating cloudbuild to run them in ci. Work on #62
iffyio
commented
Aug 23, 2020
|
|
||
| * Although we have in this example, a filter called `drop`, every filter in the filter chain has the same ability to *drop* or *update* a packet - if any filter drops a packet then no more work needs to be done regarding that packet so the next filter in the pipeline never has any knowledge that the dropped packet ever existed. | ||
|
|
||
| * The filter chain is consulted for every received packet, in the same order regardless of the direction of the packet - a packet received downstream will be fed into `append` and the result from `drop` is forwarded upstream - a packet received upstream will be fed into `append` and the result from `drop` is forwarded downstream. |
There was a problem hiding this comment.
We need to instead go through the chain in reverse order when a packet goes in the opposite direction? so that e.g if we compress then encrypt, on the way back we decrypt first before decompressing.
There was a problem hiding this comment.
Yeah we do - this isn't implemented yet though. Would be good to have a good example (or these filters?), so we can test this is working as expected.
markmandel
reviewed
Aug 24, 2020
cloudbuild.yaml
Outdated
| @@ -23,6 +23,9 @@ steps: | |||
| args: ["clippy"] | |||
| id: clippy | |||
| - name: gcr.io/$PROJECT_ID/ci | |||
| args: ["test"] | |||
| args: ["test", "--lib"] | |||
There was a problem hiding this comment.
Reading https://doc.rust-lang.org/cargo/commands/cargo-test.html and testing this out, doesn't this skip the integration tests?
Would this be better served by --tests ?
There was a problem hiding this comment.
Yes, good point I didn't see that caveat. Updated to use --tests instead
markmandel
added
area/tests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/docsaround filtersand their configuration.
adding a nightly compiler and updating cloudbuild to run them
in ci.
Work on #62