Shulou(Shulou.com)06/03 Report--

I. Overview of Sonar

Sonar is an open platform for code quality management. Through the plug-in mechanism, Sonar can integrate different testing tools, code analysis tools, and continuous integration tools.

Different from continuous integration tools (such as Hudson/Jenkins, etc.), Sonar does not simply display the results of different code inspection tools (such as FindBugs,PMD, etc.) directly on the Web page, but reprocesses these results through different plug-ins and measures the change of code quality in a quantitative way, so that it is convenient to manage code quality for projects of different sizes and types.

In terms of support for other tools, Sonar not only provides support for IDE, you can view the results online in tools such as Eclipse and IntelliJ IDEA; at the same time, Sonar also provides interface support for a large number of continuous integration tools, which makes it easy to use Sonar in continuous integration.

In addition, Sonar plug-ins can also provide support for programming languages other than Java, as well as good support for internationalization and reporting documentation.

The function of Sonar is to check whether the code has BUG. In addition to checking whether the code has bug, there are other functions, such as: what is the comment rate of your code, some suggestions for code, and suggestions for writing syntax. So it is called quality management.

Downloads and documentation for Sonar can be found at the following link: http://www.sonarqube.org/downloads/.

It should be noted that the latest version of Sonar requires at least JDK 1.8 or above.

II. Deploy Sonar

Note: the next configuration needs to be deployed in a continuous integration environment based on blog Jenkins+Gitlab.

Software packages and plug-ins required in the deployment environment can be downloaded from this link.

Plug-ins for Sonar can also be downloaded from https://docs.sonarqube.org/display/PLUG!

[root@jenkins ~] # wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-5.6.zip[root@jenkins ~] # unzip sonarqube-5.6.zip [root@jenkins ~] # mv sonarqube-5.6 / usr/local/sonarqube [root@jenkins ~] # ln-s / usr/local/sonarqube/bin/linux-x86-64/sonar.sh / usr/local/bin III. Install MySQL database

Sonar needs to use database, MySQL, Oracle, SQL server are supported, this blog uses MySQL database. If the MySQL database already exists in the environment, you don't need to deploy it again, just create the corresponding database and users!

In order to deploy the Mysql database simply and quickly, install the Mysql database by script, download and install mysql with one click

Reminder: sonar does not seem to support mysql 5.5. it is recommended to install mysql 5.6 or higher. The script provided installs the mysql5.7 version!

[root@jenkins ~] # ls mysql*mysql-5.7.22-linux-glibc2.12-x86_64.tar.gz mysql.sh [root@jenkins ~] # sh mysql.sh Starting MySQL.. SUCCESS! Mysql: [Warning] Using a password on the command line interface can be insecure. [root@jenkins ~] # mysql-u root-p123 # script provides the password of root: log in to mysql database mysql > create database sonar character set utf8 collate utf8_general_ci;mysql > grant all on sonar.* to 'sonar'@'%' identified by' 123.com. login to MySQL > grant all on sonar.* to 'sonar'@'localhost' identified by' 123.com. login to MySQL > flush privileges 3. Configure Sonar [root@jenkins ~] # vim / usr/local/sonarqube/conf/sonar.properties# Edit sonar's main configuration file sonar.jdbc.username=sonarsonar.jdbc.password=123.com # specify the user and password used to connect to the database sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerforman# define the address and port to connect to the mysql database (the default exists to remove comments) sonar .web.host = 0.0.0.0sonar.web.port=9000 # defines the IP address and port through which Sonar provides Web page listening # then configure sonar to support Chinese pages and support PHP language [root@jenkins] # cd / usr/local/sonarqube/extensions/plugins/ [root@jenkins plugins] # ls * .jar # ensure that these two jar packages sonar-l10n-zh-plugin are available in this directory -1.11.jar sonar-php-plugin-2.9-RC1.jar [root@jenkins ~] # sonar.sh start # launch Sonar [root @ jenkins ~] # tail-2 / usr/local/sonarqube/logs/sonar.log2020.02.13 14:59:03 INFO ce [o.s.ce.app.CeServer] Compute Engine is up2020.02.13 14:59:03 INFO app [o.s.p.m.Monitor] Process [ce] is up# The above two lines appear in the log keeping sonar [root@jenkins ~] # ss-lnt | grep 9000LISTEN 0 25 *: 9000 *: * # make sure that the port of sonar is already listening

Visit the web page of sonar as follows:

IV. Configure Sonar implementation code to scan [root@jenkins ~] # wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.3.0.1492-linux.zip[root@jenkins ~] # unzip sonar-scanner-cli-3.3.0.1492-linux.zip [root@jenkins ~] # mv sonar-scanner-3.3.0.1492-linux/ / usr/local/sonar-scanner [root@jenkins ~] # ln-s / usr / local/sonar-scanner/bin/sonar-scanner / usr/local/bin/ [root@jenkins ~] # ln-s / usr/local/sonar-scanner/bin/sonar-scanner / usr/bin [root@jenkins ~] # vim / usr/local/sonar-scanner/conf/sonar-scanner.propertiessonar.host.url= http://localhost:9000sonar.sourceEncoding=UTF-8# the following is copied from the main configuration file of sonar: / usr/local/sonarqube/conf/sonar.properties Used to connect to the database sonar.jdbc.username=sonarsonar.jdbc.password=123.comsonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance. Test code scanning function [root@jenkins ~] # unzip testalyzer-master.zip # this package can obtain [root@jenkins ~] # cd testalyzer-master/projects/languages/php/php-sonar-runner-unit-tests/ [root@jenkins php-sonar-runner-unit-tests] # cat sonar-project.properties # from the connection at the beginning of the blog post to see what sonar.projectKey=org.sonarqube:php-ut-sq-scanner # custom keys are contained in the following file If the secret key is the same Will automatically overwrite the previous test results sonar.projectName=PHP:: PHPUnit:: SonarQube Scanner # web interface display name sonar.projectVersion=1.0 # version sonar.sources=src # package storage path sonar.tests=tests # test path sonar.language=php # language to be tested sonar.sourceEncoding=UTF-8 # encoding format sonar.php.coverage.reportPath=reports/phpunit.coverage.xmlsonar.php.tests. ReportPath=reports/phpunit.xml# means that you must have this configuration file in the project to scan # Test PHP code [root@jenkins php-sonar-runner-unit-tests] # pwd # make sure to test in the current path / usr/src/testalyzer-master/projects/languages/php/php-sonar-runner-unit-tests [root@jenkins php-sonar-runner-unit-tests] # sonar-scanner # Test js code [root Jenkins php-sonar-runner-unit-tests] # cd / root/testalyzer-master/projects/languages/javascript/javascript-sonar-runner [root@jenkins javascript-sonar-runner] # sonar-scanner # to test

When you have finished testing js and PHP, you can see the following in the web interface of sonar:

Click to view the details, as shown in the figure:

6. Configure Jenkins to enable Sonar

To log in to the web interface of Jenkins, you need to install plug-ins. There are two ways: online installation and offline installation. I choose offline installation here. You can install online by yourself.

1) Click: system Management-> plug-in Management-> Advanced, and then drop down the page:

Download the required plug-ins and install them according to "sonar"-> "gerrit-trigger"-- > "sonar-gerrit". The online installation order is: "SonarQube Scanner"-> "Gerrit Trigger"-- > "Sonar Gerrit Plugin".

As shown in the figure:

2) Click: system Management-> system Settings, and the configuration is as follows:

3) Click: system Management-> Global tool configuration, and then drop down the page:

4) enter the project built in the previous blog post, as follows:

For ease of differentiation, enter the following code:

Sonar.projectKey=web-demosonar.projectName=web-demosonar.projectVersion=1.0sonar.sources=srcsonar.tests=testssonar.language=phpsonar.sourceEncoding=UTF-8 sonar.php.coverage.reportPath=reports/phpunit.coverage.xmlsonar.php.tests.reportPath=reports/phpunit.xml

5) when you return to the terminal and submit the code to gitlab, Sonar can automatically scan [root@jenkins ~] # cp-r testalyzer-master/projects/languages/php/php-sonar-runner-unit-tests/* test01/ [root@jenkins ~] # cd test01/ [root@jenkins test01] # git add. [root@jenkins test01] # git commit-m "test sonar" [root@jenkins test01] # git push origin master

As shown in the figure:

If it does not appear, it is recommended to go to the Jenkins page to see if the build is successful!

7. Configure Jenkins to realize email alarm 1) get the authorization code of mailbox

Take QQ Mail as an example this time:

2) configure email alarm:

In the web interface of Jenkins, click: system Administration-> system Settings, and then enter the email address of the system administrator and save:

Drop-down list, continue to fill in!

3) configure the project

4) Test

Restart the gitlab service and rebuild the project, as follows:

[root@jenkins ~] # gitlab-ctl restart

As shown in the figure:

The e-mail received is as follows:

-that's all for this article. Thank you for reading-

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.