Jenkins、SonarQube的安装和简单使用

Jenkins、SonarQube的安装和简单使用

目录

1.Jenkins简介
2.Jenkins配套安装的组件
3.Jenkins的安装(CentOs为例)
4.Jenkins初始配置
5.Jenkins插件
6.Jenkins构建流程(Java)
7.Jenkins+Maven实现Java项目的自动化构建
8.Jenkins+Ant实现PHP项目的自动化构建
9.Jenkins常用问题解决
10.SonarQube的安装
11.Jenkins与SonarQube集成

1.Jenkins简介

Jenkins，之前叫做Hudson，是基于Java开发的一种持续集成工具，用于监控持续重复的工作，包括：

1.持续的软件版本发布/测试项目。
2.监控外部调用执行的工作。

2.Jenkins配套安装的组件

1. JDK
2. Tomcat
3. Maven
4. Ant
......

3.Jenkins的安装(CentOs为例)

JDK安装

1.Oracle官网下载最新的jdk版本(当前环境采用1.7)
2.将下载的jdk.**.tar.gz解压到系统相应位置，如/usr/local、jdk1.7.0_51
3.设置JDK的环境变量PATH和CLASSPATH,在/etc/profile文件中加入如下内容
    export JAVA_HOME=/usr/local/jdk1.7.0_51
    export PATH=$PATH:$JAVA_HOME/bin
    export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
    而后运行source /etc/profile，java -version观察是否能够打印出java版本信息，如能成功打印则表示安装成功

Tomcat安装

1.从Apache Tomcat官方下载最新的Tomcat版本，当前环境采用Tomcat7
2.将下载的tomcat**.tar.gz解压到系统的相应位置，如/web/tomcat7
3.进入tomcat中的bin目录，运行命令./startup.sh，而后运行ps -ef|grep tomcat观察tomcat是否启动成功

Maven安装

1.从Apache Maven官网下载最新的Maven版本，当前环境采用Maven3
2.将下载的maven**.tar.gz解压到系统的相应位置，如/usr/local/maven
3.设置Maven的环境变量，在/etc/profile中加入如下内容
    export MAVEN_HOME=/usr/local/maven
    而后运行source /etc/profile,mvn -version看是否能够打印maven的版本信息，如能成功打印出来则表示安装成功

Ant安装

1.从Apache Ant官网下载最新的Ant版本，当前环境采用Ant1.9
2.将下载的ant**.tar.gz解压到系统的相应位置，如/usr/local/ant
3.设置Ant的环境变量，在/etc/profile中加入如下内容
    export ANT_HOME=/usr/local/ant
    而后运行source /etc/profile，ant -version看是否能够打印ant的版本信息，如能成功打印出来则表示安装成功

Jenkins安装

1.从Jenkins官网下载最新的Jenkins的war包
2.将Jenkins.war放入到Tomcat中
3.打开WEB浏览器，访问http://IP:PORT/jenkins看是否能打开Jenkins的欢迎页面，如能正常打开则安装成功

4.Jenkins初始配置

进入Jenkins，点击系统管理，随后点击系统设置，在打开的页面中配置刚安装的JDK,MAVEN,ANT的安装路径

如图:

maven和ant相同，不再贴图展示

5.Jenkins插件

Jenkins拥有强大的插件库，可通过插件来增强Jenkins原声的功能，目前Jenkins的插件数量已经有500多
点击系统管理，而后点击管理插件可以看到Jenkins目前的所有插件，并可在当前页面下安装、卸载

如图:

当前建议安装的插件
    1:Deploy to container Plugin(用于将java包部署到相应的web容器中)
    2:Email-ext plugin(增强jenkins原有的邮件功能)
    3:Publish Over SSH(通过22端口执行命令或传输数据包)
    4:Disk Usage Plugin(监控jenkins每次构建形成的文件的大小)
    5:Workspace Cleanup Plugin(清理工作空间，避免缓存)
    ......

6.Jenkins构建流程(Java)

Jenkins对于Java项目的构建流程为:

下载源码=>编译源码=>执行单元测试=>打包=>部署

7.Jenkins+Maven实现Java项目的自动化构建

Jenkins+Maven实现Java项目的自动化构建配置步骤

1:在Jenkins中新建一个Maven项目
2:在打开的Maven项目配置中，输入项目的svn地址，注意此地址必须和pom.xml在同一个路径下
3:设置需要放置的java容器的地址信息

如图:

---

注：如需要将构建完成的war包放入到Tomcat中，需要更改Tomcat相关配置
进入Tomcat的conf目录，修改tomcat-users.xml文件，增加如下配置
  <role rolename="manager"/>
  <role rolename="manager-gui"/>
  <role rolename="admin"/>
  <role rolename="admin-gui"/>
  <role rolename="manager-script"/>
  <role rolename="manager-jmx"/>
  <role rolename="manager-status"/>
  <user username="admin" password="8565906" roles="manager,admin,manager-gui,admin-gui,manager-script,manager-jmx,manager-status"/>

8.Jenkins+Ant实现PHP项目的自动化构建

Jenkins+Ant实现PHP项目的自动化构建配置步骤

1:在Jenkins中新建一个自由项目
2:在打开的自由项目配置中，输入项目的svn地址，注意此地址必须和build.xml在同一个路径下
3:设置需要放置的服务器信息

build.xml文件内容为

<?xml version="1.0" encoding="UTF-8"?>
<project name="api" default="build">
    <target name="build" depends="tar"/>
    <property name="version-m"  value="1.1"/>
    <property name="version"    value="1.1.0"/>
    <property name="stability"  value="stable"/>
    <property name="tarfile"     value="${version-m}.tar.gz" />
    <property name="pkgfile"     value="${phing.project.name}.${version}.tgz" />
    <property name="distfile"    value="dist/${tarfile}" />
    <property name="tests.dir" value="test" />  
    <fileset id="api.tar.gz" dir=".">
        <include name="**/**"/>
    </fileset>
    <target name="clean">
        <delete dir="tt"/>
        <delete dir="dist"/>
    </target>
    <target name="make_runtime" depends="clean">
            <mkdir dir="tt/Runtime" />
            <mkdir dir="tt/build/logs" />
            <mkdir dir="tt/build/pdepend" />
            <mkdir dir="tt/build/code-browser" />
    </target>      
    <target name="tar" depends="make_runtime">
        <tar destfile="${distfile}" compression="gzip">
            <fileset refid="api.tar.gz"/>
        </tar>
    </target>
</project>

下面就此build.xml简单介绍

<fileset id="api.tar.gz" dir=".">
    <include name="**/**"/>
</fileset>
这段xml文件表示了需要打包的文件有哪些，**/**表示当前目录下的所有文件

 <target name="make_runtime" depends="clean">
        <mkdir dir="tt/Runtime" />
        <mkdir dir="tt/build/logs" />
        <mkdir dir="tt/build/pdepend" />
        <mkdir dir="tt/build/code-browser" />
 </target>
这段xml表示了在构建时，创建相关的文件夹，这些文件夹用来存放构建过程中生成的文件

<target name="tar" depends="make_runtime">
    <tar destfile="${distfile}" compression="gzip">
        <fileset refid="api.tar.gz"/>
    </tar>
</target>
这段xml表示将刚才fileset定义的所有文件进行打包，打包的格式为tar.gz

<target name="clean">
    <delete dir="tt"/>
    <delete dir="dist"/>
</target>
这段xml文件表示删除每次构建时产生的临时文件夹

由于PHP代码需要放置进入的服务器类型和java不同，所以Deploy to container Plugin插件无法用来部署PHP代码，目前使用Publish Over SSH插件，配置如下图

如图:

注:publish over ssh插件原理是使用Linux的sftp命令

9.Jenkins常用问题解决

1.Utf-8编码

Jenkins提示

Your container doesn't use UTF-8 to decode URLs,If you use non-ASCII characters a job name etc,this will cause problems,see Containers and Tomcat i18n for more details.

Jenkins建议在Tomcat中使用utf-8编码,配置tomcat下conf目录的servel.xml文件

<Connector port="8080" URLEncoding="UTF-8" protocol="HTTP/1.1"
    connectionTimeout="2000"
    redirectPort="8443" />

2.Jenkins造成Tomcat内存溢出

编辑Tomcat的bin目录下的catalina.sh文件，加入如下内容

export JAVA_OPTS='-server -Xms128m -Xmx256m -XX:PermSize=128M -XX:MaxPermSize=256M'
具体内存大小按照机器内存自行调节

3.Jenkins在安装插件和构建文件过多时，莫名关闭，并且Tomcat日志出现too many open files的错误提示

    vim /etc/security/limits.conf

在打开的文件中添加

   *              -       nproc           102400  
   *              -       nofile          102400  

10.SonarQube的安装

1Sonar介绍

"Sonar是一个用于代码质量管理的开源平台，用于管理Java源代码的质量。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。同时 Sonar 还对大量的持续集成工具提供了接口支持，可以很方便地在持续集成中使用 Sonar。此外，Sonar 的插件还可以对 Java 以外的其他编程语言提供支持，对国际化以及报告文档化也有良好的支持。

2.配置数据库

Apache Derby 是Sonar自带并且默认安装使用的数据库，此外Sonar对如下数据库提供支持：MySQL 5.x, Oracle 10g XE, Postgresql, MS SqlServer等，本文以mysql为例介绍如何配置数据库：

1）创建数据库
在mysql中执行如下脚本创建数据库及mysql用户
CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;

CREATE USER 'sonar' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
FLUSH PRIVILEGES;

2）编辑${SONAR_HOME}/conf/sonar.properties配置数据库:
sonar.jdbc.username:                       sonar
sonar.jdbc.password:                       sonar
sonar.jdbc.url:                            jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true

# Optional properties
sonar.jdbc.driverClassName:                com.mysql.jdbc.Driver

3.安装、配置Sonar

1)Sonar的运行需要 JDK 1.5+ , 从 http://www.sonarqube.org/downloads/ 下载sonar zip文件，本文以3.6版本为例。

2)创建运行sonar的CentOS账户sonar，并设置账户密码：
# useradd sonar
# passwd sonar
使用sonar账户登录CentOS。
Sonar默认集成了jetty容器，可以直接启动提供服务，也可以通过脚本构建为war包，部署在tomcat容器中。

3)直接启动
编辑.bash_profile，添加环境变量SONAR_HOME
$ vi $HOME/.bash_profile

修改成如下内容：
PATH=$PATH:$HOME/bin
SONAR_HOME=$HOME/sonar

export PATH SONAR_HOME
使环境变量生效
Source $HOME/.bash_profile

运行如下命令启动sonar，其它操作系统sonar均提供了启动脚本
$ ${SONAR_HOME}/bin/linux-x86-64/sonar.sh start

在浏览器中访问: http://localhost:9000/ ，运行界面如下：

Sonar默认的端口是”9000”、默认的上下文路径是”/”、默认的网络接口是”0.0.0.0”，默认的管理员帐号和密码为:admin/admin，这些参数都可以在配置文件中修改：
$ vi ${SONAR_HOME}/conf/sonar.properties

11.Jenkins与SonarQube集成

1、通过Maven进行集成

修改maven的主配置文件（${MAVEN_HOME}/conf/settings.xml文件或者 ~/.m2/settings.xml文件），在其中增加访问Sonar数据库及Sonar服务地址，添加如下配置：

    <profile>
            <id>sonar</id>

            <activation>
                    <activeByDefault>true</activeByDefault>
            </activation>

            <properties>
                    <sonar.jdbc.url>jdbc:mysql://192.168.8.102:3306/sonar?useUnicode=true&amp;characterEncoding=utf8</sonar.jdbc.url>
                    <sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
                    <sonar.jdbc.username>sonar</sonar.jdbc.username>
                    <sonar.jdbc.password>sonar</sonar.jdbc.password>
                    <sonar.host.url>http://localhost:9000/</sonar.host.url>
            </properties>
    </profile>

    <activeProfiles>
            <activeProfile>sonar</activeProfile>
    </activeProfiles>

    注:数据库连接信息自行设定
    同样，为了避免内存溢出，推荐增加内存堆栈的大小。设置MAVEN_OPTS环境变量：
    export MAVEN_OPTS=”-Xmx512m -XX:MaxPermSize=256m”

    此时即可运行mvn sonar:sonar命令

2直接与Jenkins集成

在jenkins的插件管理中选择安装sonar jenkins plugin，该插件可以使项目每次构建都调用sonar进行代码度量。
进入配置页面对sonar插件进行配置，如下图：

---

---