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 test YAML helpers #3905

Merged
merged 1 commit into from
Apr 30, 2021
Merged

Add test YAML helpers #3905

merged 1 commit into from
Apr 30, 2021

Conversation

imjasonh
Copy link
Member

These helpers take a YAML string and return parsed, deserialized typed objects. They're intended to be easier to use than Go structs or test builders, focused on showing the YAML a user would write to specify our objects.

I proposed these a long time ago, but never merged them and I don't remember why. Talking to @bobcatfish today she mentioned she might like to use them, so I'm bringing them up again. Please let me know what you think! 🙏

Some future improvements we might consider:

  • exporting the helper methods so they can be used in code outside of test/, e.g., in unit tests
  • basic templating using text/template, possibly taking an optional map of key/value replacements in the helper methods.

/kind misc

Submitter Checklist

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

  • [n] Docs included if any changes are user facing
  • [y] Tests included if any functionality added or changed
  • [y] Follows the commit message standard
  • [y] Meets the Tekton contributor standards (including
    functionality, content, code)
  • [y] Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

NONE

These helpers take a YAML string and return parsed, deserialized typed
objects. They're intended to be easier to use than Go structs or test
builders, focused on showing the YAML a user would write to specify our
objects.
@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/misc Categorizes issue or PR as a miscellaneuous one. labels Apr 29, 2021
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 29, 2021
@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
test/yaml.go Do not exist 0.0%

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 30, 2021
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

/lgtm
/meow

@tekton-robot
Copy link
Collaborator

@vdemeester: cat image

In response to this:

/lgtm
/meow

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.

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 30, 2021
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg, vdemeester

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 merged commit d825648 into tektoncd:main Apr 30, 2021
@bobcatfish
Copy link
Collaborator

I LOVE THIS

image

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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants