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

Improve the logging in pkg/git testing #4191

Merged
merged 1 commit into from
Aug 25, 2021

Conversation

mattmoor
Copy link
Member

Currently the "fetch" testing nicely captures logs (to examine output), but doesn't actually surface them on failures.

This change adds a deferred function that stream the output to t.Log so that git failures can be debugged.

For example, when I introduce a typo into the "commit" command, it now prints:

=== RUN   TestFetch/test-clone-with-sparse-checkout
    git_test.go:299: exit status 1
    git_test.go:216: ["error" git]: Error running git [codmmit --allow-empty -m Hello Moto]: exit status 1
        git: 'codmmit' is not a git command. See 'git --help'.

        The most similar command is
                commit

Previously, this would only print the exit status, which isn't particularly useful.

/kind cleanup

Submitter Checklist

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

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

Release Notes

NONE

Currently the "fetch" testing nicely captures logs (to examine output), but doesn't actually surface them on failures.

This change adds a `defer`red function that stream the output to `t.Log` so that `git` failures can be debugged.

For example, when I introduce a typo into the "commit" command, it now prints:

```
=== RUN   TestFetch/test-clone-with-sparse-checkout
    git_test.go:299: exit status 1
    git_test.go:216: ["error" git]: Error running git [codmmit --allow-empty -m Hello Moto]: exit status 1
        git: 'codmmit' is not a git command. See 'git --help'.

        The most similar command is
                commit
```

Previously, this would only print the exit status, which isn't particularly useful.
@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Aug 24, 2021
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 24, 2021
@imjasonh
Copy link
Member

/lgtm

Thanks!

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 24, 2021
@mattmoor
Copy link
Member Author

I think this is a flake, but gubernator displays things oddly... Let's see

/retest

@mattmoor
Copy link
Member Author

gonna have to close/reopen to kick the kind job

@mattmoor mattmoor closed this Aug 24, 2021
@mattmoor mattmoor reopened this Aug 24, 2021
@mattmoor
Copy link
Member Author

Hmm that didn't do it, so I'll go for a walk and try again 😉

@mattmoor mattmoor closed this Aug 24, 2021
@mattmoor mattmoor reopened this Aug 24, 2021
@mattmoor
Copy link
Member Author

/retest

@vdemeester
Copy link
Member

/test check-pr-has-kind-label

@tekton-robot tekton-robot merged commit 94f5d71 into tektoncd:main Aug 25, 2021
@mattmoor mattmoor deleted the improve-git-logging branch August 27, 2021 21:52
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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. 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.

4 participants