[TT-11627] Migrate failling to golangci-lint/forbidigo, fix issues

[titpetric]

User description

Tests only changes.

https://tyktech.atlassian.net/browse/TT-11627

---

Type

enhancement, tests

---

Description

• 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.

---

Changes walkthrough

	Relevant files
Tests	linter_test.go Replace fmt.Printf with t.Logf in OAS Linter Tests              apidef/oas/linter_test.go Replaced fmt.Printf with t.Logf for error logging in tests. +1/-2      root_test.go Improve Error Handling and Logging in OAS Root Tests          apidef/oas/root_test.go Added error handling for json.MarshalIndent. Replaced fmt.Println with t.Logf for logging in tests. +4/-2      main_test.go Use t.Logf for Version Logging in Python Tests                      dlpython/main_test.go Replaced fmt.Printf with t.Logf for version logging in tests. +1/-2      host_checker_test.go Replace fmt.Printf with t.Logf in Gateway Host Checker Tests gateway/host_checker_test.go Replaced fmt.Printf with t.Logf for logging in tests. +2/-3      custom_policies_test.go Correct Test Metadata in Custom Policies Tests                      user/custom_policies_test.go Replaced fmt.Print with TestSessionState_SetCustomPolicies in test metadata. +1/-2
Configuration changes	.golangci.yml Configure forbidigo Linter and Adjust Issue Handling          .golangci.yml Enabled forbidigo linter and configured it to forbid fmt.Print* and top-level net/http package functions. Added rules to exclude forbidigo linter in the cli package and adjusted issue handling settings. +15/-1    Makefile Remove faillint Tool from Linting Process                                Makefile Removed faillint tool installation and usage. +0/-2

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

API Changes

no api changes detected

[github-actions]

PR Description updated to latest commit (16d6713)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward, focusing on replacing logging functions and improving error handling in tests. The configuration changes are also clear and well-documented.
🧪 Relevant tests	Yes
🔍 Possible issues	Possible Bug: In user/custom_policies_test.go, replacing fmt.Print with TestSessionState_SetCustomPolicies in the MetaData map might not be intended. This change alters the test's behavior significantly.
🔒 Security concerns	No

Code feedback:

---

relevant file	user/custom_policies_test.go
suggestion	Verify if replacing fmt.Print with TestSessionState_SetCustomPolicies was intentional. If the goal was to remove fmt.Print, consider using a different approach that doesn't alter the test logic. [important]
relevant line	MetaData: map[string]interface{}{"policies": []interface{}{TestSessionState_SetCustomPolicies}},

---

relevant file	.golangci.yml
suggestion	There's a typo in the configuration key for forbidigo. It should be forbidigo instead of fobidigo. Correcting this will ensure the linter is properly configured. [important]
relevant line	fobidigo:

---

relevant file	.golangci.yml
suggestion	Consider adding fmt.Fprintf and fmt.Fprintln to the list of forbidden functions in the forbidigo configuration to cover all variants of fmt.Print* functions. [medium]
relevant line	- p: ^fmt\.Print.*$

---

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

Category	Suggestions
Best practice	Use t.Errorf for concise test failure reporting. Consider using t.Errorf instead of t.Logf followed by t.Fail for more concise and idiomatic test failure reporting. This approach allows you to directly indicate the test failure with a descriptive message. apidef/oas/linter_test.go [103-105] -t.Logf("%s\n", err) -t.Fail() +t.Errorf("%s", err)
	Remove unnecessary newline character in log message. For consistency and to avoid the extra newline character, consider removing \n from the log message since t.Logf already appends a newline at the end of each message. dlpython/main_test.go [14] -t.Logf("Using Python %s for tests\n", testVersion) +t.Logf("Using Python %s for tests", testVersion)
Performance	Avoid unnecessary string conversion in logging. Instead of manually converting ss to a string for logging, consider directly passing the byte slice to t.Logf. This avoids unnecessary type conversion and makes the code slightly more efficient. apidef/oas/root_test.go [88] -t.Logf("JSON from filled old:\n%s", string(ss)) +t.Logf("JSON from filled old:\n%s", ss)
Maintainability	Combine log messages for clarity and reduced redundancy. The log messages within the conditional block could be combined into a single t.Logf call to reduce redundancy and improve readability. gateway/host_checker_test.go [216-217] -t.Logf("Stop loop: %v\n", !ts.Gw.GlobalHostChecker.stopLoop) -t.Logf("Am I pooling: %v\n", ts.Gw.GlobalHostChecker.AmIPolling()) +t.Logf("Stop loop: %v, Am I pooling: %v", !ts.Gw.GlobalHostChecker.stopLoop, ts.Gw.GlobalHostChecker.AmIPolling())
Possible issue	Correct the typo in the forbidigo configuration key. There's a typo in the configuration key for forbidigo. It should be forbidigo instead of fobidigo. Correcting this typo will ensure that the linter is properly configured and can enforce the specified rules. .golangci.yml [91] -fobidigo: +forbidigo:

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[github-actions]

💥 CI tests failed 🙈

git-state

all ok

Please look at the run or in the Checks tab.

[github-actions]

💥 CI tests failed 🙈

git-state

all ok

Please look at the run or in the Checks tab.

[github-actions]

💥 CI tests failed 🙈

git-state

diff --git a/dlpython/main_test.go b/dlpython/main_test.go
index 338c4b3..3550025 100644
--- a/dlpython/main_test.go
+++ b/dlpython/main_test.go
@@ -3,8 +3,6 @@ package python
 import (
 	"os"
 	"testing"
-
-	log "github.com/sirupsen/logrus"
 )
 
 var testVersion = "3.5"

Please look at the run or in the Checks tab.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[titpetric]

/release to release-5-lts

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@titpetric Succesfully merged PR

[titpetric]

/release to release-5.3

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

Still working...

[tykbot]

@titpetric Succesfully merged PR