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

Add conversion for v1 Task #5202

Merged
merged 1 commit into from
Aug 1, 2022
Merged

Add conversion for v1 Task #5202

merged 1 commit into from
Aug 1, 2022

Conversation

lbernick
Copy link
Member

Changes

This commit adds conversion functions between v1beta1 and v1 Task.
It does not handle fields deprecated in v1beta1 that will not be present in v1.
It implements ConvertTo and ConvertFrom for v1beta1 Task, and leaves
these functions unimplemented for v1 Task, since it is the highest known version.

Part n of #4984.

Conversions for all types are basically deep copies, rather than using the same struct
definition for both API versions. This will allow us to iterate on v1 without making additional
changes to v1beta1, after v1 is the stored version, as discussed in #5181.

/kind misc

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • n/a Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • n/a Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • n/a Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot
Copy link
Collaborator

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/misc Categorizes issue or PR as a miscellaneuous one. labels Jul 22, 2022
@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 22, 2022
@lbernick
Copy link
Member Author

Needs #5201 and #5199

@lbernick lbernick marked this pull request as ready for review July 25, 2022 16:24
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 25, 2022
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/container_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/param_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/result_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/workspace_conversion.go Do not exist 100.0%

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/container_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/param_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/result_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/workspace_conversion.go Do not exist 100.0%

@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 26, 2022
@afrittoli afrittoli added kind/misc Categorizes issue or PR as a miscellaneuous one. and removed kind/misc Categorizes issue or PR as a miscellaneuous one. labels Jul 27, 2022
@afrittoli
Copy link
Member

/kind misc

@tekton-robot tekton-robot added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Jul 27, 2022
@afrittoli afrittoli removed the kind/misc Categorizes issue or PR as a miscellaneuous one. label Jul 27, 2022
@afrittoli
Copy link
Member

/kind misc

@tekton-robot tekton-robot added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Jul 27, 2022
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 27, 2022
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_conversion.go Do not exist 66.7%
pkg/apis/pipeline/v1beta1/container_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/param_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/result_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/task_conversion.go 66.7% 97.4% 30.7
pkg/apis/pipeline/v1beta1/workspace_conversion.go Do not exist 100.0%

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_conversion.go Do not exist 66.7%
pkg/apis/pipeline/v1beta1/container_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/param_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/result_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/task_conversion.go 66.7% 97.4% 30.7
pkg/apis/pipeline/v1beta1/workspace_conversion.go Do not exist 100.0%

@abayer
Copy link
Contributor

abayer commented Jul 29, 2022

/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abayer

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 Jul 29, 2022
@JeromeJu
Copy link
Member

JeromeJu commented Jul 29, 2022

LGTM. Thanks Lee!

Thoughts:

  • Does it make sense for us to have a conversion directory?
  • Or does it sound good to have a generic api/func that recursively handles the conversion for each struct?

@lbernick
Copy link
Member Author

lbernick commented Aug 1, 2022

  • Does it make sense for us to have a conversion directory?

I think pointer receivers need to be implemented in the package where the struct is defined, so probably not.

  • Or does it sound good to have a generic api/func that recursively handles the conversion for each struct?

I'm not sure how this would work exactly; this sounds like something that would accept an interface{} but it's a function that really does need to know the type of the object. When we're implementing apis.Convertible, the first thing we do is check if it's a crd of the same kind and cast it if so. So I think it would be hard to make this generic, but I'm open to suggestions.

pkg/apis/pipeline/v1/task_conversion.go Outdated Show resolved Hide resolved
sink.StdoutConfig = (*v1.StepOutputConfig)(s.StdoutConfig)
sink.StderrConfig = (*v1.StepOutputConfig)(s.StderrConfig)

// TODO(#4546): Handle deprecated fields
Copy link
Member

Choose a reason for hiding this comment

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

Q: Will conversions fail if we do not implement this in this PR?

Copy link
Member Author

Choose a reason for hiding this comment

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

no, since we don't have the v1 version added to our CRD yet. I have a follow-up PR almost ready that adds conversion for Resources. If we did have v1 versions in the task crd, conversion wouldn't fail, but it would silently drop any resources the user has defined. (I think this may only be backwards incompatible once we update the storage version of the crd but I'm not completely sure)

@dibyom
Copy link
Member

dibyom commented Aug 1, 2022

LGTM! Just a typo and a question!

This commit adds conversion functions between v1beta1 and v1 Task.
It does not handle fields deprecated in v1beta1 that will not be present in v1.
It implements ConvertTo and ConvertFrom for v1beta1 Task, and leaves
these functions unimplemented for v1 Task, since it is the highest known version.

Conversions for all types are basically deep copies, rather than using the same struct
definition for both API versions. This will allow us to iterate on v1 without making additional
changes to v1beta1, after v1 is the stored version.
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_conversion.go Do not exist 66.7%
pkg/apis/pipeline/v1beta1/container_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/param_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/result_conversion.go Do not exist 100.0%
pkg/apis/pipeline/v1beta1/task_conversion.go 66.7% 97.4% 30.7
pkg/apis/pipeline/v1beta1/workspace_conversion.go Do not exist 100.0%

@dibyom
Copy link
Member

dibyom commented Aug 1, 2022

Filed #5250

@dibyom
Copy link
Member

dibyom commented Aug 1, 2022

/test tekton-pipeline-unit-tests

@dibyom
Copy link
Member

dibyom commented Aug 1, 2022

Different flake this time :(

@dibyom
Copy link
Member

dibyom commented Aug 1, 2022

/test tekton-pipeline-unit-tests

@dibyom
Copy link
Member

dibyom commented Aug 1, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2022
@tekton-robot tekton-robot merged commit e4dd1e2 into tektoncd:main Aug 1, 2022
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/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants