cookbook 'sonarqube', '~> 0.3.3'
sonarqube (9) Versions 0.3.3 Follow15
Installs/Configures SonarQube
cookbook 'sonarqube', '~> 0.3.3', :supermarket
knife supermarket install sonarqube
knife supermarket download sonarqube
sonarqube
Installs and configures SonarQube server and the SonarQube Scanner.
Provides a LWRP for for installing
SonarQube plugins.
Requirements
Platforms
- CentOS
- Ubuntu
Tested on:
- CentOS 6.4
- Ubuntu 12.04
Dependencies
SonarQube requires JDK 1.7 or later. Use the Java Cookbook
to install a suitable Oracle JDK or OpenJDK.
Recipes
default
Installs SonarQube Server and manages sonar.properties
.
scanner
Installs SonarQube Scanner and manages sonar-runner.properties
.
Adds the SonarQube Scanner to all users' PATH
via /etc/profile.d
.
LWRP
sonarqube_plugin
This LWRP manages SonarQube plugins.
The :install
action installs a SonarQube plugin to an existing SonarQube Server instance.
Plugins are retrieved from
SonarSource's distribution mirror.
The plugin version must be specifed.
# Installs version 1.3 of the SonarQube Groovy plugin sonarqube_plugin 'groovy' do version 1.3 end
The :uninstall
action removes a SonarQube plugin.
sonarqube_plugin 'groovy' do version 1.3 action :uninstall end
Usage
SonarQube Server
On systems that should be SonarQube servers, add recipe[sonarqube]
to the runlist.
By default, the SonarQube server will connect to an embedded H2 database.
To connect to a different database, override:
node['sonarqube']['jdbc']['username']
node['sonarqube']['jdbc']['password']
node['sonarqube']['jdbc']['url']
SonarQube Scanner
On systems that need to invoke SonarQube analyses against an existing SonarQube Server
(such as a CI machine), add recipe[sonarqube::scanner]
to the runlist.
By default, the SonarQube Scanner will search for a SonarQube server running on localhost:9000
.
To connect to a different SonarQube Server, override:
node['sonarqube']['scanner']['host']['url']
If the SonarQube Server prohibits anonymous users from executing analyses, also override:
node['sonarqube']['scanner']['host']['username']
node['sonarqube']['scanner']['host']['password']
Advanced Attributes
Browse the attributes
directory to view advanced attributes.
Notes
- Does not run
apt::default
on Ubuntu- add
apt::default
to your run list before anything else if you need it (ie. for the Java installation as described in the previous bullet)
- add
- Does not configure firewall settings, again, in case you have specific needs
Contributing
Prerequisites
- ChefDK
- Recent RuboCop
chef gem install rubocop
Testing
Test changes using
chef exec rake
chef exec kitchen verify
Publishing
chef exec knife cookbook site share sonarqube "Monitoring & Trending"
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
0.3.3 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.3.3 failed this metric
FC064: Ensure issues_url is set in metadata: sonarqube/metadata.rb:1
FC065: Ensure source_url is set in metadata: sonarqube/metadata.rb:1
FC066: Ensure chef_version is set in metadata: sonarqube/metadata.rb:1
FC092: Custom resources should not define actions: sonarqube/resources/plugin.rb:4
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.3.3 passed this metric
Testing File Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.3 failed this metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.3.3 failed this metric
FC064: Ensure issues_url is set in metadata: sonarqube/metadata.rb:1
FC065: Ensure source_url is set in metadata: sonarqube/metadata.rb:1
FC066: Ensure chef_version is set in metadata: sonarqube/metadata.rb:1
FC092: Custom resources should not define actions: sonarqube/resources/plugin.rb:4
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.3.3 passed this metric
Testing File Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.3 failed this metric
FC065: Ensure source_url is set in metadata: sonarqube/metadata.rb:1
FC066: Ensure chef_version is set in metadata: sonarqube/metadata.rb:1
FC092: Custom resources should not define actions: sonarqube/resources/plugin.rb:4
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.3.3 passed this metric
Testing File Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.3 failed this metric
0.3.3 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number