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

Declare expected volumes explicitly 🗣️ #1481

Closed

Conversation

bobcatfish
Copy link
Collaborator

Changes

The test was dynamically adding the expected PVC volumes. This created
two problems:

  1. If there was a bug in the logic that was adding them dynamically, we
    we could end up covering a bug
  2. This made it confusing to try to reason about what the actual
    expected pod structure was. In Add "volume" PipelineResource 🔊 #1417 I had to make a lot of changes
    to these tests and it was super confusing to look at the expected
    structure and sometimes see no volumes (or even volumes: nil) when
    you knew volumes were supposed to be there (I was scared there was a
    serious bug for a while)

So now the expected state explicitly lists all the volumes it expects.
This also revealed that one test case was using pipelinerun-parent as
the name of the parent pipelinerun even though all the rest used just
pipelinerun which was also confusing when I was making changes b/c I
initially thought there was some special case where tekton itself would
add "parent" but no.

Submitter Checklist

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

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.

@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Oct 25, 2019
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 25, 2019
@bobcatfish
Copy link
Collaborator Author

I am definitely missing some kinda linting in my editor 🤔

The test was dynamically adding the expected PVC volumes. This created
two problems:
1. If there was a bug in the logic that was adding them dynamically, we
   we could end up covering a bug
2. This made it confusing to try to reason about what the actual
   expected pod structure was. In tektoncd#1417 I had to make a lot of changes
   to these tests and it was super confusing to look at the expected
   structure and sometimes see no volumes (or even volumes: nil) when
   you knew volumes were supposed to be there (I was scared there was a
   serious bug for a while)

So now the expected state explicitly lists all the volumes it expects.
This also revealed that one test case was using `pipelinerun-parent` as
the name of the parent pipelinerun even though all the rest used just
`pipelinerun` which was also confusing when I was making changes b/c I
initially thought there was some special case where tekton itself would
add "parent" but no.
@dlorenc
Copy link
Contributor

dlorenc commented Oct 26, 2019

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 26, 2019
@ghost
Copy link

ghost commented Oct 28, 2019

/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg

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 28, 2019
@tekton-robot
Copy link
Collaborator

@bobcatfish: The following tests failed, say /retest to rerun them all:

Test name Commit Details Rerun command
pull-tekton-pipeline-build-tests b0aef0d link /test pull-tekton-pipeline-build-tests
pull-tekton-pipeline-integration-tests b0aef0d link /test pull-tekton-pipeline-integration-tests
pull-tekton-pipeline-unit-tests b0aef0d link /test tekton-pipeline-unit-tests

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@ghost
Copy link

ghost commented Oct 29, 2019

oh dear; merge conflicts appear to also break the test runnings

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 for this!
+1000 for tests to be more explicit.
The change looks good, but it may need a rebase 👼

@bobcatfish
Copy link
Collaborator Author

After looking into the merge conflict, it looks like in ffadda1#diff-db3818c61ae7be4751c7dfe8fc32f74e @dlorenc and I made this exact same change (with some questionable whitespace / newline use, but que sera sera XD

So i'm gonna close this!

@bobcatfish bobcatfish closed this Nov 26, 2019
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. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants