Merging to release-5-lts: [TT-11627] Migrate failling to golangci-lint/forbidigo, fix issues (#6152) #6153
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…6152) Tests only changes. https://tyktech.atlassian.net/browse/TT-11627 ___ enhancement, tests ___ - Migrated from `faillint` to `golangci-lint/forbidigo` and fixed issues by replacing `fmt.Printf` with `t.Logf` in various test files for better logging practices. - Added error handling for `json.MarshalIndent` in `apidef/oas/root_test.go`. - Configured `forbidigo` linter to forbid `fmt.Print*` and top-level `net/http` package functions, enhancing code quality. - Removed `faillint` tool installation and usage from the Makefile, streamlining the linting process. ___ <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Tests</strong></td><td><table> <tr> <td> <details> <summary><strong>linter_test.go</strong><dd><code>Replace fmt.Printf with t.Logf in OAS Linter Tests</code> </dd></summary> <hr> apidef/oas/linter_test.go - Replaced `fmt.Printf` with `t.Logf` for error logging in tests. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-b92239afd81e77a829fe7fe8410044dfd4dfda525d17dbf5f8811714a9c986d3">+1/-2</a> </td> </tr> <tr> <td> <details> <summary><strong>root_test.go</strong><dd><code>Improve Error Handling and Logging in OAS Root Tests</code> </dd></summary> <hr> apidef/oas/root_test.go <li>Added error handling for <code>json.MarshalIndent</code>.<br> <li> Replaced <code>fmt.Println</code> with <code>t.Logf</code> for logging in tests.<br> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-4d144465b7fabaf2db8915de1ce3b6ff8c91a93c62d614c38fa38bdae28e23a2">+4/-2</a> </td> </tr> <tr> <td> <details> <summary><strong>main_test.go</strong><dd><code>Use t.Logf for Version Logging in Python Tests</code> </dd></summary> <hr> dlpython/main_test.go - Replaced `fmt.Printf` with `t.Logf` for version logging in tests. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-f8e159e1152ee20ea353fb647d7a7344414006fbd259c4e7073b47c96e8745cb">+1/-2</a> </td> </tr> <tr> <td> <details> <summary><strong>host_checker_test.go</strong><dd><code>Replace fmt.Printf with t.Logf in Gateway Host Checker Tests</code></dd></summary> <hr> gateway/host_checker_test.go - Replaced `fmt.Printf` with `t.Logf` for logging in tests. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-cfc8f5368c14d8fa56d845b1250f465b78c8aa6bfc5b47d0a556d706fa6b8622">+2/-3</a> </td> </tr> <tr> <td> <details> <summary><strong>custom_policies_test.go</strong><dd><code>Correct Test Metadata in Custom Policies Tests</code> </dd></summary> <hr> user/custom_policies_test.go <li>Replaced <code>fmt.Print</code> with <code>TestSessionState_SetCustomPolicies</code> in test <br>metadata.<br> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-c7b1cd92c4c30590d5da9f0d601d6a4957bedded8680da8434c4b76be5a5ed4c">+1/-2</a> </td> </tr> </table></td></tr><tr><td><strong>Configuration changes</strong></td><td><table> <tr> <td> <details> <summary><strong>.golangci.yml</strong><dd><code>Configure forbidigo Linter and Adjust Issue Handling</code> </dd></summary> <hr> .golangci.yml <li>Enabled <code>forbidigo</code> linter and configured it to forbid <code>fmt.Print*</code> and <br>top-level <code>net/http</code> package functions.<br> <li> Added rules to exclude <code>forbidigo</code> linter in the <code>cli</code> package and <br>adjusted issue handling settings.<br> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-6179837f7df53a6f05c522b6b7bb566d484d5465d9894fb04910dd08bb40dcc9">+15/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>Makefile</strong><dd><code>Remove faillint Tool from Linting Process</code> </dd></summary> <hr> Makefile - Removed `faillint` tool installation and usage. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6152/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52">+0/-2</a> </td> </tr> </table></td></tr></tr></tbody></table> ___ > ✨ **PR-Agent usage**: >Comment `/help` on the PR to get a list of all available PR-Agent tools and their descriptions --------- Co-authored-by: Tit Petric <tit@tyk.io> (cherry picked from commit 3c796bf)
💥 CI tests failed 🙈git-stateall okPlease look at the run or in the Checks tab. |
|
API Changes no api changes detected |
💥 CI tests failed 🙈git-stateall okPlease look at the run or in the Checks tab. |
|
jeffy-mathew
approved these changes
Mar 15, 2024
titpetric
deleted the
merge/release-5-lts/3c796bf9b2dd02b4a19e77480fe7332805a9aac0
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TT-11627 Migrate failling to golangci-lint/forbidigo, fix issues (#6152)
User description
Tests only changes.
https://tyktech.atlassian.net/browse/TT-11627
Type
enhancement, tests
Description
faillinttogolangci-lint/forbidigoand fixed issuesby replacing
fmt.Printfwitht.Logfin various test files for betterlogging practices.
json.MarshalIndentinapidef/oas/root_test.go.forbidigolinter to forbidfmt.Print*and top-levelnet/httppackage functions, enhancing code quality.faillinttool installation and usage from the Makefile,streamlining the linting process.
Changes walkthrough
linter_test.go
Replace fmt.Printf with t.Logf in OAS Linter Testsapidef/oas/linter_test.go
fmt.Printfwitht.Logffor error logging in tests.root_test.go
Improve Error Handling and Logging in OAS Root Testsapidef/oas/root_test.go
json.MarshalIndent.fmt.Printlnwitht.Logffor logging in tests.main_test.go
Use t.Logf for Version Logging in Python Testsdlpython/main_test.go
fmt.Printfwitht.Logffor version logging in tests.host_checker_test.go
Replace fmt.Printf with t.Logf in Gateway Host Checker Testsgateway/host_checker_test.go
fmt.Printfwitht.Logffor logging in tests.custom_policies_test.go
Correct Test Metadata in Custom Policies Testsuser/custom_policies_test.go
fmt.PrintwithTestSessionState_SetCustomPoliciesin testmetadata.
.golangci.yml
Configure forbidigo Linter and Adjust Issue Handling.golangci.yml
forbidigolinter and configured it to forbidfmt.Print*andtop-level
net/httppackage functions.forbidigolinter in theclipackage andadjusted issue handling settings.
Makefile
Remove faillint Tool from Linting ProcessMakefile
faillinttool installation and usage.Co-authored-by: Tit Petric tit@tyk.io