Refactor [Sonar]

[calebcartwright]

Close #1075

Things to note:

• Our badges will work with the SaaS SonarCloud.io and any other SonarQube deployment that can be reached
  • SonarCloud provides their own badges, but still good to have Shields support for consistent look and feel, customization/enhancement (many of the native SonarCloud badges use a dark grey color regardless of value), etc.
  • Added badge documentation to clearly explain that we work with both
• The legacy service had the optional version param as a route param prefix. I moved version from route param to query param, with a redirector service to prevent breaking existing badges
  • The Sonar API contract changed dramatically with version 5.4. For prior versions, we need to use the legacy API contract, and any user still using Sonar 5.3 or earlier can get badges working by specifying a value of <= 5.3 for the version param so we know to use the legacy api. The latest version of Sonar is now 7.6 so I believe that the version parameter (only needed for Sonar 5.3 and below) falls under the "not typically used" category, making it a better fit for a query param.
  • Added badge documentation to explain this
• There was a good chunk of untested code in the legacy service implementation, which I've attempted to address here
  • The Fortify Security Rating badge is using mocked tests, as I don't know of any live endpoint that can be used for test (not available on SonarCloud.io and no known SonarQube deployments with the Fortify plugin installed and in use). I added an inline comment in that tester for future awareness
• Added support for additional Sonar metrics (our legacy service recognized a few, but for the others would just display the raw value with brightgreen color)
  • Examples of "new" badge support: Quality Gate, Bugs, Code Smells, Duplicated Lines %, Lines of Code, Maintainability, Reliability, Security, Vulnerabilities, and Issues
  • The refactor alone will result in a decent sized diff, so I've decided to push adding these new metrics to future follow ups, and have opened Enhance Sonar Badges #3236 to track that follow up work
  • I went ahead and implemented new support QualityGate badges to serve as a reference

[shields-ci]

	Warnings
⚠️	📚 Remember to ensure any changes to serverSecrets in services/sonar/sonar-fortify-rating.tester.js are reflected in the server secrets documentation
⚠️	📚 Remember to ensure any changes to serverSecrets in services/sonar/sonar-base.js are reflected in the server secrets documentation

	Messages
📖	✨ Thanks for your contribution to Shields, @calebcartwright!

Generated by 🚫 dangerJS against e006670

[calebcartwright]

https://docs.sonarqube.org/latest/user-guide/metric-definitions/

[calebcartwright]

Alright I think I've figured out a way in which I can split up refactoring the existing Sonar badges and handling all the others in a follow up. Will open an issue to track that latter one shortly and then finish off the last couple pieces with the refactor here

[calebcartwright]

I know this has been running for a long time (it seems to keep spawning off new threads of work 😄) but I think it's finally just about done.

All that's left is to add the redirector service (to convert version to a query param to maintain support for old SonarQube versions) and update some the badge examples.

I'll mark the PR ready for review once I'm done with those, but it's probably ready now for some new eyes to review if anyone is up for looking at the rest of it.

[calebcartwright]

I elected to enumerate the various metrics in groups based on how Sonar docs typically group those metrics. I've still not had a chance to review each metric in detail, but I think that when implementing #3236 a reasonable starting point would be a service class for each group (I expect there will be a lot of similarity in how the related metrics are handled). Some of those metrics (like the coverage ones) could probably be tacked into one of the existing services

[chris48s]

I think this is good to merge. Cheers for persisting with it 👍

[calebcartwright]

I think this is good to merge

Thanks for all the feedback!

[shields-ci]

	Warnings
⚠️	📚 Remember to ensure any changes to serverSecrets in services/sonar/sonar-base.js are reflected in the server secrets documentation
⚠️	📚 Remember to ensure any changes to serverSecrets in services/sonar/sonar-fortify-rating.tester.js are reflected in the server secrets documentation

	Messages
📖	✨ Thanks for your contribution to Shields, @calebcartwright!

Generated by 🚫 dangerJS against 3ddd046

[shields-deployment]

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch: