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

golangci.yml: silence invalid linter complaints on use of logp.TestingSetup #36474

Merged
merged 1 commit into from
Aug 31, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Aug 31, 2023

Proposed commit message

A logp.TestingSetup call can only fail when no logp.ToObserverOutput() option has been provided and one of syslog, file or event log output has been selected. There is no case in the code base where this is true. So disable the errcheck linter for this function.

The only way that the function can return an error is when a user makes use of a custom logp.Option function since none of the provided Options alter the logp.Config to cause output to failable destinations.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

…gSetup

A logp.TestingSetup call can only fail when no logp.ToObserverOutput()
option has been provided and one of syslog, file or event log output has
been selected. There is no case in the code base where this is true.
So disable the errcheck linter for this function.

The only way that the function can return an error is when a user makes
use of a custom logp.Option function since none of the provided Options
alter the logp.Config to cause output to failable destinations.
@efd6 efd6 added enhancement Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.11-candidate labels Aug 31, 2023
@efd6 efd6 self-assigned this Aug 31, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Aug 31, 2023
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-08-31T05:15:31.904+0000

  • Duration: 13 min 15 sec

Test stats 🧪

Test Results
Failed 0
Passed 3
Skipped 0
Total 3

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review August 31, 2023 06:08
@efd6 efd6 requested a review from a team as a code owner August 31, 2023 06:08
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@efd6 efd6 merged commit ac5f806 into elastic:main Aug 31, 2023
5 checks passed
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
…gSetup (elastic#36474)

A logp.TestingSetup call can only fail when no logp.ToObserverOutput()
option has been provided and one of syslog, file or event log output has
been selected. There is no case in the code base where this is true.
So disable the errcheck linter for this function.

The only way that the function can return an error is when a user makes
use of a custom logp.Option function since none of the provided Options
alter the logp.Config to cause output to failable destinations.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.11-candidate backport-skip Skip notification from the automated backport with mergify enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants