Ignore duplicate text warning in _tests_ only for Go using sonar-project.properties

SonarQube Cloud
1

Hello dear community! :slight_smile:

We are using SonarCloud analysis on GitHub. I would like to ignore checks made for duplicate text found in test files only. I’m trying to do this using the sonar-project.properties files and was trying to read the documentation on Analysis Scope. Honestly, it’s a tough read. :smiley:

I think this is what I’m looking for maybe?

sonar.cpd.exclusions = **/*_test.go

Is this correct? But if I understand correctly, this would ignore the complete duplication check for tests, right? Is there a way to scope this even further to just ignore duplicate Text?

Disclaimer: I don’t have access to project administration so I’m looking for using this property setting instead. Reading the docs, I think that’s the right way?

Thank you! :slight_smile:

2

Hey there.

Can you give an example of a duplicate text warning (a screenshot would be great)? For CPD detection (copy-paste detection), I’m pretty sure we ignore string literals.

3

Hello!

Sure. :slight_smile: Here is an actual check to it:

https://sonarcloud.io/project/issues?sinceLeakPeriod=true&issueStatuses=OPEN%2CCONFIRMED&pullRequest=4317&id=external-secrets_external-secrets&open=AZSHAq3eHZghvZxx3jiy

I think you should be able to access that as it’s a public link.

4

Hey @Skarlso!

Thanks for following up. I think I see what’s going on here.

go:S1192 and sonar.cpd.exclusions are unrelated. The former is a rule detecting duplicate string literals, and the latter is a measurement detecting duplicate… well, everything except string literals.

So what you probably want to do is to turn off S1192 on test files. There are a couple ways of going about this.

  • Most rules are excluded on test files by default, as long as sonar.tests and sonar.test.inclusions are configured to index test files as test files. You can see an example here
  • If you don’t want to do that (because you see value in other rules being applied to test files), you can ignore specific rules on specific files. This is easiest to set in the Project Administration UI, but also possible via analysis parameters.
sonar.issue.ignore.multicriteria=1
sonar.issue.ignore.multicriteria.1.resourceKey=**/*_test.go
sonar.issue.ignore.multicriteria.1.ruleKey=go:S1192
1 Like
5

Thank you so much, this is what I was looking for.

Yes, I do not wish the exclude all checks, just this duplication check. :slight_smile: Thank you so much, Colin! :slight_smile: Much appreciated.

1 Like
6

humm, humm, this did not, in the end, ignore the warnings. It’s a Go based project. Any trouble we should be aware off? Also, I called the file sonar-project.properties but some call it .sonarcloud.properties. Which one is it? :smiley:

7

It depends if you’re using Automatic Analysis (.sonarcloud.properties) or CI-Based Analysis (sonar-project.properties).

If it’s the former – you won’t be able to set sonar.issue.ignore.multicriteria in a config file and you’ll have to ask a project administrator to set them in the project settings.

8

This is the config that ended up working in the end:

sonar.organization=external-secrets
sonar.projectKey=external-secrets_external-secrets

# Path to sources
sonar.sources=.
sonar.exclusions=**/*_test.go, **/zz_generated.deepcopy.go, e2e/**

# Path to tests
sonar.tests=.
sonar.test.inclusions=**/*_test.go, e2e/**

# Issues to ignore
sonar.issue.ignore.multicriteria=g1

# Ignore "Define a constant instead of duplicating this literal" in tests
sonar.issue.ignore.multicriteria.g1.ruleKey=go:S1192
sonar.issue.ignore.multicriteria.g1.resourceKey=**/*_test.go, e2e/**

¯\_(ツ)_/¯

9

:face_with_raised_eyebrow: That shouldn’t work, at least it isn’t documented to. I’ll try on my own.

1 Like
10

Hey @Skarlso

I can’t get it working on my end! Not sure if it’s worth your time troubleshooting further since it works for you. :thinking:

11

I don’t know. :smiley: I’m checking the stats and it looks okay. I’m not sure how much it is omitting from testing the _test files. I feel like now it’s ignore it completely, which is not so good. But it’s difficult to test the property file because it seems it’s only being picked up once it’s merged to main.

12

Ah :man_facepalming: I was so focused on sonar.issue.ignore.multicriteria I ignored the fact that you took my previous advice about setting sonar.tests as well.

So that’s what’s having the impact here. So like I said earlier, if you want test files to continue to be analyzed for other things:

1 Like
13

Ah okay, gotcha. Thank you!