Skip to content

Merging to release-5-lts: [TT-11627] Migrate failling to golangci-lint/forbidigo, fix issues (#6152)#6153

Merged
titpetric merged 4 commits into
release-5-ltsfrom
merge/release-5-lts/3c796bf9b2dd02b4a19e77480fe7332805a9aac0
Mar 15, 2024
Merged

Merging to release-5-lts: [TT-11627] Migrate failling to golangci-lint/forbidigo, fix issues (#6152)#6153
titpetric merged 4 commits into
release-5-ltsfrom
merge/release-5-lts/3c796bf9b2dd02b4a19e77480fe7332805a9aac0

Conversation

@buger

@buger buger commented Mar 15, 2024

Copy link
Copy Markdown
Member

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

  • 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


    Co-authored-by: Tit Petric [email protected]

    …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>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; </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>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>
    
    <tr>
      <td>
        <details>
    <summary><strong>root_test.go</strong><dd><code>Improve Error Handling
    and Logging in OAS Root Tests</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    </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>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>
    
    <tr>
      <td>
        <details>
    <summary><strong>main_test.go</strong><dd><code>Use t.Logf for Version
    Logging in Python Tests</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp;
    &nbsp; &nbsp; </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>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>
    
    <tr>
      <td>
        <details>
    <summary><strong>custom_policies_test.go</strong><dd><code>Correct Test
    Metadata in Custom Policies Tests</code>&nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp;
    &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; </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>&nbsp;
    &nbsp; </td>
    </tr>
    
    <tr>
      <td>
        <details>
    <summary><strong>Makefile</strong><dd><code>Remove faillint Tool from
    Linting Process</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    </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>&nbsp;
    &nbsp; &nbsp; </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 <[email protected]>
    
    (cherry picked from commit 3c796bf)
    @github-actions

    Copy link
    Copy Markdown
    Contributor

    💥 CI tests failed 🙈

    git-state

    all ok

    Please look at the run or in the Checks tab.

    @github-actions

    Copy link
    Copy Markdown
    Contributor

    API Changes

    no api changes detected

    @titpetric
    titpetric marked this pull request as ready for review March 15, 2024 12:31
    @titpetric
    titpetric enabled auto-merge (squash) March 15, 2024 12:31
    @github-actions

    Copy link
    Copy Markdown
    Contributor

    💥 CI tests failed 🙈

    git-state

    all ok

    Please look at the run or in the Checks tab.

    @titpetric
    titpetric disabled auto-merge March 15, 2024 12:44
    @sonarqubecloud

    Copy link
    Copy Markdown

    Quality Gate Failed Quality Gate failed

    Failed conditions
    69.2% Coverage on New Code (required ≥ 80%)

    See analysis details on SonarCloud

    @titpetric
    titpetric enabled auto-merge (squash) March 15, 2024 13:09
    @titpetric
    titpetric requested a review from jeffy-mathew March 15, 2024 13:09
    @titpetric
    titpetric merged commit 0c089ac into release-5-lts Mar 15, 2024
    @titpetric
    titpetric deleted the merge/release-5-lts/3c796bf9b2dd02b4a19e77480fe7332805a9aac0 branch March 15, 2024 13:10
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    None yet

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants