TykTechnologies / tyk

Tyk Open Source API Gateway written in Go, supporting REST, GraphQL, TCP and gRPC protocols
Other
9.51k stars 1.07k forks source link

[TT-12575] Add coverage to gitignore, add package to regression to fix api changes #6400

Closed titpetric closed 1 month ago

titpetric commented 1 month ago

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

Description


Changes walkthrough ๐Ÿ“

Relevant files
Enhancement
regression.go
Add new Go package for regression tests                                   

tests/regression/regression.go
  • Added a new Go package named regression.
  • Included a comment explaining the need for the package to support go
    doc change reporting.
  • +4/-0     

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

    github-actions[bot] commented 1 month ago

    API Changes

    --- prev.txt    2024-07-11 08:14:58.687084906 +0000
    +++ current.txt 2024-07-11 08:14:55.723086439 +0000
    @@ -12051,6 +12051,8 @@
     func MyPluginReturningError(rw http.ResponseWriter, r *http.Request)
     # Package: ./tests/regression
    
    +package regression // import "github.com/TykTechnologies/tyk/tests/regression"
    +
     # Package: ./trace
    
     package trace // import "github.com/TykTechnologies/tyk/trace"
    github-actions[bot] commented 1 month ago

    PR Reviewer Guide ๐Ÿ”

    โฑ๏ธ Estimated effort to review: 1 ๐Ÿ”ตโšชโšชโšชโšช
    ๐Ÿงช No relevant tests
    ๐Ÿ”’ No security concerns identified
    โšก No key issues to review
    github-actions[bot] commented 1 month ago

    PR Code Suggestions โœจ

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Add a descriptive package declaration comment ___ **It is recommended to include a package declaration comment directly above the
    package statement to clarify the purpose of the package. This is especially useful
    in a test directory where the purpose might not be immediately clear.** [tests/regression/regression.go [1]](https://github.com/TykTechnologies/tyk/pull/6400/files#diff-4b98736bd1eadf9ac1c9735ef633fc19b5b9df2a41d503a1ab2b6ef255125e0bR1-R1) ```diff +// Package regression provides utilities to handle API regression tests. package regression ```
    Suggestion importance[1-10]: 8 Why: Adding a descriptive package declaration comment improves code readability and maintainability by clarifying the purpose of the package, which is especially useful in a test directory.
    8
    sonarcloud[bot] commented 1 month ago

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues
    0 Accepted issues

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

    See analysis details on SonarCloud