Sonarqube: Missing blame information for the following files

Question

I am getting the warning Missing blame information for the following files during analysis by SonarQube.

[INFO] [22:19:57.714] Sensor SCM Sensor
[INFO] [22:19:57.715] SCM provider for this project is: git
[INFO] [22:19:57.715] 48 files to be analyzed
[INFO] [22:19:58.448] 0/48 files analyzed
[WARN] [22:19:58.448] Missing blame information for the following files:
(snip 48 lines)
[WARN] [22:19:58.449] This may lead to missing/broken features in SonarQube
[INFO] [22:19:58.449] Sensor SCM Sensor (done) | time=735ms

I am using SonarQube 5.5, analysis is done by Maven in a Jenkins job, on a multi-module Java project. Git plugin 1.2 is installed.

Manually running git blame in a bash shell, on any of the offending files, gives an expected output.

Related questions I found were all about SVN, my issue is with Git.

How do I get git blame information on Sonarqube?

Solution 1

The cause was a JGit bug. JGit does not support .gitattributes. I had ident in my .gitattributes. Plain console git checked out the source, applied ident on $Id$ macros, but then JGit ignored that and saw a difference that wasn't committed, where there actually wasn't one.

The friendly people on the SonarQube mailing list helped me out, and suggested debugging with the standalone JGit command line distribution:

chmod +x /where/is/org.eclipse.jgit.pgm-<version>-r.sh
/where/is/org.eclipse.jgit.pgm-<version>-r.sh blame -w /path/to/offending/file

This particular JGit bug has not been solved for over 5 years and I have no hope that it will be solved anytime soon, so I removed the $Id$ macros from all my sources.

This is the (Bash) code I used, to remove all $Id$ macros:

find */src -name "*.java" | xargs -n 1 sed -i '/$Id.*$/d'
find */src -name "*.java" | xargs git add
git commit -m "Remove $Id$ macros"
git push

Solution 2

I ran into this issue with a build that stopped working after a Sonar upgrade.

The problem for me was that the Jenkins job was configured to do a Shallow Clone when pulling from git. This does not pull in enough history so Sonar 5.6.6 could not do an analysis because blame information was not included in the shallow copy. I used the -X option when running Sonar to view the actual commit number that it was choking on.

I'm my case I simply unchecked the shallow copy check box and BAM, it worked again (though more slowly)!

Solution 3

I had a similar issue: a file in my project was created during the build process and was not stored in source control. In my case it was api.json.

Within the SonarQube runner build step in Team City I added this file to the exclusions within the additional parameters

-Dsonar.exclusions=**/spec/api.json

and the error disappeared.

Comments

[S Atah Ahmed Khan]

What about windows machine user, How they can remove the $Id$ macros? I tried above lines but it's not working in Git Bash

[Amedee Van Gasse]

Install the Linux subsystem for Windows, or whatever the Linux-on-Windows is called nowadays, and you have a full Linux running native in Windows. But your question is outside of the scope of this question, if you still need help, start a new question.

[Amedee Van Gasse]

Your answer is unrelated to the question I asked, however it is still useful because it suppresses another warning message I got from SonarQube.

[John Mercier]

How it it unrelated if it results in the same warnings?

[Nestor Milyaev]

I've had the same problem, in Jenkins, and the shallow cloning was the preceding warning for me too. So to me that is a bona fide answer, in Jenkins context

[Sasha Bond]

in my project i have noticed that Missing blame information for the following files: has list of pom.xml and every java file excluded from the scan

[Amedee Van Gasse]

It is unrelated because it has nothing to do with the aforementioned ident bug in JGit.

[Amedee Van Gasse]

Not the exact same cause of the error as in my case, but maybe others are helped with your answer.

[Amedee Van Gasse]

Different causes can lead to similar results. You know, like all roads lead to Rome.

[neoscribe]

Yes, same error multiple causes. For me, shallow clone was eliminating some blame information. My solution gets you the blame info that Sonar was missing, which actually answers the question.. it just wasn't the same cause. Also the title doesn't ask a question it simply is the pasted error message which gets a top hit for us poor suckers who are scratching our head as to how to get rid of it, leads us here, thankful that you posted it.

[Amedee Van Gasse]

Does not appear to be relevant to the issue described. Please add more information.

[snark]

Similarly, my DevOps build process would automatically modify an existing version file to add information specific to that build. SonarQubeAnalyze would then warn about missing blame information until I added this file to sonar.exclusions as you suggested.