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.

Sign up for GitHub

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

Jump to bottom

[2.0] Misc fixups noticed when looking at the 1.14 merge #3860

Merged
merged 5 commits into from
Oct 5, 2021
Merged

[2.0] Misc fixups noticed when looking at the 1.14 merge #3860

merged 5 commits into from
Oct 5, 2021

Conversation

LukeShu
Copy link
Contributor

@LukeShu LukeShu commented Oct 4, 2021 •
edited
Loading

Description

When preparing #3859 we noticed several things that didn't quite look right in the base branch. Fix them.

Checklist

  • I made sure to update CHANGELOG.md. - no applicable changes

    Remember, the CHANGELOG needs to mention:

    • Any new features
    • Any changes to our included version of Envoy
    • Any non-backward-compatible changes
    • Any deprecations

  • This is unlikely to impact how Ambassador performs at scale.

    Remember, things that might have an impact at scale include:

    • Any significant changes in memory use that might require adjusting the memory limits
    • Any significant changes in CPU use that might require adjusting the CPU limits
    • Anything that might change how many replicas users should use
    • Changes that impact data-plane latency/scalability

  • My change is adequately tested. - The ignore_case thing could probably stand to have more testing.

    Remember when considering testing:

    • LEGACY MODE TESTS DO NOT RUN FOR EVERY PR. If your change is affected by legacy mode, you need
      to run legacy-mode tests manually (set AMBASSADOR_LEGACY_MODE=true and run the tests).
      (This will be fixed soon.)
    • Your change needs to be specifically covered by tests.
      • Tests need to cover all the states where your change is relevant: for example, if you add a behavior that can be enabled or disabled, you'll need tests that cover the enabled case and tests that cover the disabled case. It's not sufficient just to test with the behavior enabled.
    • You also need to make sure that the entire area being changed has adequate test coverage.
      • If existing tests don't actually cover the entire area being changed, add tests.
      • This applies even for aspects of the area that you're not changing – check the test coverage, and improve it if needed!
    • We should lean on the bulk of code being covered by unit tests, but...
    • ... an end-to-end test should cover the integration points

  • I updated DEVELOPING.md with any any special dev tricks I had to use to work on this code efficiently.

@LukeShu LukeShu requested review from aidanhahn and kflynn October 4, 2021 23:09
@LukeShu LukeShu force-pushed the lukeshu/2.0-fixup branch from 0e9f99c to 394482c Compare October 5, 2021 00:40
@LukeShu LukeShu mentioned this pull request Oct 5, 2021
Closed
4 tasks
@LukeShu
Fix the change in how we handle case-insensitive headers
8bf8196 
This was originally done in the commit pair 7aa61e0 (yank deprecated
config option, 2021-08-18) and 38c7f8f (v3 api needs ignore_case
specified for ext_authz headers, 2021-08-18) by Aidan in release/v1.14,
and rebased/cherry-picked on to release/v2.0 as 041f44e and bd39b6d by
Flynn.

However, as discussed with Flynn earlier today, there are two things
wrong:

 1. It missed a few cases where it needed to add ignore_case.
 2. It left in a comment about a line of code that no longer exists; we've
    removed the code, let's remove the comment.

I did not run with KAT_RUN_MODE=envoy to update the gold files, I simply
ran

    git grep -l '"exact"' python/tests/gold/ | \
      xargs sed -ri 's/^(\s*)"exact": ".*"$/&,\n\1"ignore_case": true/'

and then rolled back the 'globalcorstest' and 'plain' econf.jsons.

Signed-off-by: Luke Shumaker <[email protected]>
@LukeShu LukeShu force-pushed the lukeshu/2.0-fixup branch from 394482c to 8bf8196 Compare October 5, 2021 01:40
kflynn
kflynn approved these changes Oct 5, 2021
View reviewed changes
Copy link
Member

@kflynn kflynn left a comment

Choose a reason for hiding this comment

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

Hit it! We should definitely do a pytest-envoy run to doublecheck though.

@LukeShu
Copy link
Contributor Author

LukeShu commented Oct 5, 2021

Hit it! We should definitely do a pytest-envoy run to doublecheck though.

Isn't CI doing a pytest-envoy check these days? (that we want to get rid of?)

@LukeShu LukeShu merged commit b90f151 into release/v2.0 Oct 5, 2021
@LukeShu LukeShu deleted the lukeshu/2.0-fixup branch October 5, 2021 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kflynn kflynn kflynn approved these changes

@aidanhahn aidanhahn Awaiting requested review from aidanhahn

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LukeShu @kflynn