chore: sonar ignore directories with their own go.mods #20509
Conversation
WalkthroughThe recent updates primarily focus on configuration adjustments for code quality and coverage tools. The Changes
Sequence Diagram(s) (Beta)No sequence diagrams are necessary for these changes as they are configuration file updates and do not alter the control flow or introduce new features. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- .golangci.yml (3 hunks)
- sonar-project.properties (1 hunks)
Additional comments not posted (2)
.golangci.yml (2)
5-5: Ensure the build tags are correctly used across the project.Verification successful
The build tags
e2e,ledger, andtest_ledger_mockare used correctly across the project.
- Instances of build tags are found in various files, including test files and source files.
- The usage of these tags is consistent and correctly formatted.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the build tags are used correctly in the project. # Test: Search for the usage of build tags. rg --type go $'// +build e2e|ledger|test_ledger_mock'Length of output: 11304
38-47: Review the necessity of each exclusion to ensure they are justified.Verification successful
The exclusions in the
.golangci.ymlfile appear to be justified based on the following observations:
- Test Files: Many files in the excluded directories are test files, which are typically excluded from linting to focus on the main codebase.
- Generated Files: Files with extensions
.pb.go,.pb.gw.go, and.pulsar.goare generated files, which are often excluded from linting because they are auto-generated and not manually edited.- Internal Implementation Details: Files in the
crypto/keys/secp256k1/internaldirectory are internal implementation details, which are usually excluded to avoid linting internal dependencies that are not part of the public API.Specific excluded files:
server/grpc/gogoreflection/fix_registration.goandfix_registration.goare present and likely serve a specific purpose that justifies their exclusion.types/coin_regex.gois also present and may contain specific logic that warrants exclusion from linting.Based on this analysis, the exclusions in the
.golangci.ymlfile are justified.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the necessity of each exclusion in the `.golangci.yml`. # Test: List files in the excluded directories and check for any Go files. fd --type f --extension go --exec echo {} \; | grep -E 'testutil/testdata|crypto/keys/secp256k1/internal|types'Length of output: 17085
Script:
#!/bin/bash # Description: Verify the necessity of each exclusion in the `.golangci.yml`. # Check if the excluded files are test files, generated files, or internal implementation details. # Check for test files grep -E 'test' <<< "$(fd --type f --extension go --exec echo {} \; | grep -E 'testutil/testdata|crypto/keys/secp256k1/internal|types')" # Check for generated files grep -E 'pb\.go|pb\.gw\.go|pulsar\.go' <<< "$(fd --type f --extension go --exec echo {} \; | grep -E 'testutil/testdata|crypto/keys/secp256k1/internal|types')" # Check for internal implementation details grep -E 'internal' <<< "$(fd --type f --extension go --exec echo {} \; | grep -E 'testutil/testdata|crypto/keys/secp256k1/internal|types')" # Check for specific excluded files fd --type f --extension go --exec echo {} \; | grep -E 'server/grpc/gogoreflection/fix_registration.go|fix_registration.go|types/coin_regex.go'Length of output: 10501
sonar-project.properties
Outdated
| @@ -6,7 +6,7 @@ sonar.project.monorepo.enabled=true | |||
|
|
|||
| sonar.sources=. | |||
| sonar.exclusions=**/*_test.go,**/*.pb.go,**/*.pulsar.go,**/*.pb.gw.go | |||
| sonar.coverage.exclusions=**/*_test.go,**/testutil/**,**/*.pb.go,**/*.pb.gw.go,**/*.pulsar.go,test_helpers.go,docs/** | |||
| sonar.coverage.exclusions=**/*_test.go,**/testutil/**,**/*.pb.go,**/*.pb.gw.go,**/*.pulsar.go,test_helpers.go,docs/**,server/v2/**,store/v2/**,x/tx/**,tools/**,cmd/**,app/**,simapp/**,testutil/**,test_helpers.go,tests/**,test_helpers.go,docs/**,server/v2/**,store/**,x/tx/**,tools/**,simapp/**,tests/**,orm/**,client/v2/**,runtime/v2/**,core/**,store/**,x/evidence,x/feegrant,x/authz,x/auth,x/bank,api,x/gov | |||
There was a problem hiding this comment.
Tip
Codebase Verification
The exclusions list in sonar-project.properties contains several duplicate entries that need to be removed:
- **/*.pb.go
- **/*.pb.gw.go
- **/*.pulsar.go
- test_helpers.go
- docs/**
- server/v2/**
- x/tx/**
- tools/**
- simapp/**
- tests/**
- store/**
- /testutil/
Please remove these duplicates to clean up the exclusions list.
Analysis chain
Ensure no duplicates in exclusions list.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for duplicate entries in the exclusions list.
# Test: Print duplicate entries if any.
awk -F',' '{for(i=1;i<=NF;i++) if(++dup[$i]>1) print $i}' sonar-project.properties
Length of output: 244
There was a problem hiding this comment.
@julienrbrt, thank you for confirming! If there's anything else you need help with or any other changes you'd like to review, feel free to let me know. I'm here to help!
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- sonar-project.properties (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- sonar-project.properties
sonar-project.properties
Outdated
| @@ -6,7 +6,7 @@ sonar.project.monorepo.enabled=true | |||
|
|
|||
| sonar.sources=. | |||
| sonar.exclusions=**/*_test.go,**/*.pb.go,**/*.pulsar.go,**/*.pb.gw.go | |||
There was a problem hiding this comment.
can we add *.java exclusion? https://github.com/cosmos/cosmos-sdk/actions/runs/9323449491/job/25666860500?pr=20488
Co-authored-by: Julien Robert <julien@rbrt.fr>
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- sonar-project.properties (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- sonar-project.properties
* main: docs: add docs on permissions (#20526) refactor(x/gov): set environment in context for legacy proposals (#20521) docs: migrate diagrams to mermaidjs (#20503) refactor(tools/hubl): don't use nil panic (#20515) refactor(x/authz): set environment in context (#20502) build(deps): Bump github.com/spf13/viper from 1.18.2 to 1.19.0 (#20519) feat(x/bank): Placing SendRestriction before Deduction of Coins in SendCoins (#20517) chore: sonar ignore directories with their own go.mods (#20509) ci: run action in merge queue (#20508)
* main: refactor(x/feegrant): set environment in context (#20529) refactor(x/accounts)!: accounts and auth module use the same account number tracking (#20405) chore: remove sonar from simapp (#20528) docs: add docs on permissions (#20526) refactor(x/gov): set environment in context for legacy proposals (#20521) docs: migrate diagrams to mermaidjs (#20503) refactor(tools/hubl): don't use nil panic (#20515) refactor(x/authz): set environment in context (#20502) build(deps): Bump github.com/spf13/viper from 1.18.2 to 1.19.0 (#20519) feat(x/bank): Placing SendRestriction before Deduction of Coins in SendCoins (#20517) chore: sonar ignore directories with their own go.mods (#20509) ci: run action in merge queue (#20508) refactor(server/v2/cometbft): update function comments (#20506)
Description
ignore sonar coverage when a go.mod is created in the main sonar cloud config
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit