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

Make ConditionCheck container names DNS-safe #3394

Merged
merged 1 commit into from
Oct 15, 2020

Conversation

mattmoor
Copy link
Member

Changes

My recent change uncovered a latent bug where especially long test names result in especially long container names, which fails certain validations. Unfortunately it slipped in because the test was expected to fail.

This leverages an upstream helper we created to solve ~exactly this problem. You get DNS-safe short names based on an input name and a suffix, which are deterministic, and are friendly for suitably short inputs.

Fixes: #3393

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

Fixes a bug where condition validation may fail with long condition names.

/kind bug

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. labels Oct 15, 2020
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 15, 2020
@mattmoor
Copy link
Member Author

/assign @imjasonh @afrittoli @vdemeester

Copy link
Member

@imjasonh imjasonh left a comment

Choose a reason for hiding this comment

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

We use our own method in the names package to generate truncated names, we should stay consistent here too.

If we decide to move to kmeta in all places we can discuss that too but that seems like a bigger piece of work.

@mattmoor
Copy link
Member Author

TIL, I can try to find it and use that instead.

My recent change uncovered a latent bug where especially long test names result in especially long container names, which fails certain validations.  Unfortunately it slipped in because the test was expected to fail.

This leverages the names.SimpleNameGenerator.RestrictLength helper to solve this problem.

Fixes: tektoncd#3393
@mattmoor mattmoor changed the title Use kmeta.ChildName to create DNS-safe names. Make ConditionCheck container names DNS-safe Oct 15, 2020
@mattmoor
Copy link
Member Author

Alright, I think this is now done. LMK if this is/isn't what you meant.

@imjasonh
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 15, 2020
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thanks!
/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 15, 2020
@tekton-robot tekton-robot merged commit d876923 into tektoncd:master Oct 15, 2020
@mattmoor mattmoor deleted the long-name branch October 15, 2020 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Invalid step name in conditions
5 participants