Jenkins构建Android项目持续集成之findbugs的使用

题外话

这篇本来和之前的系列要一起出的，但是因为中间公司要发布一个版本，给耽搁了，今天工作做完了，又闲了下来。所以就又来继续jenkins构建Android项目持续集成系列的findbugs篇。

Findbugs简介

关于findbugs的介绍，可以自行百度下，这里贴下百度百科的介绍。findbugs是一个静态分析工具，它检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。这组缺陷模式是可配置的，通过配置，可以过滤掉一些我们不想或不需要检测的问题。

findbugs在gradle中的配置

理论的部分就不多阐述了，我们直接来看看项目中怎么使用findbugs吧。

首先，在build.gradle引入findbugs插件

apply plugin: ‘findbugs‘

然后，添加一个task

task findbugs(type: FindBugs,dependsOn:"connectedAndroidTest") {//
    ignoreFailures = true
    effort = "default"
    reportLevel = "medium"
    //这里填写项目classes目录
    classes = files("${project.rootDir}/andbase-core/build/intermediates/classes")
    source = fileTree(‘src/main/java‘)
    classpath = files()
    reports {
        //只能开启一个
        xml.enabled = false
        html.enabled = true
    }
}

注意：凡是task有依赖connectedAndroidTest的，都需要连接着模拟器或者真机，否则会报错

以下是我build.gradle的内容：

apply plugin: ‘com.android.library‘
//代码覆盖率插件
apply plugin: ‘jacoco‘
//findbugs
apply plugin: ‘findbugs‘
android {
    compileSdkVersion 22
    buildToolsVersion ‘22.0.1‘
    defaultConfig {
        minSdkVersion 8
        targetSdkVersion 22
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile(‘proguard-android.txt‘), ‘proguard-rules.pro‘
        }
        debug{
            testCoverageEnabled true
        }
    }
    lintOptions {
        abortOnError false
    }
    packagingOptions {
        exclude ‘META-INF/NOTICE‘
        exclude ‘META-INF/LICENSE‘
    }
    jacoco{
        version "0.7.4.201502262128"
    }
}

task findbugs(type: FindBugs,dependsOn:"connectedAndroidTest") {//
    ignoreFailures = true
    effort = "default"
    reportLevel = "medium"
    //这里填写项目classes目录
    classes = files("${project.rootDir}/andbase-core/build/intermediates/classes")
    source = fileTree(‘src/main/java‘)
    classpath = files()
    reports {
        //只能开启一个
        xml.enabled = false
        html.enabled = true
    }
}

task jacocoTestReport(type:JacocoReport){//,dependsOn:"connectedAndroidTest"
    group = "Reporting"
    description = "Generate Jacoco coverage reports after running tests."
    reports{
        xml.enabled = false
        html.enabled = true
        csv.enabled = false
    }
    classDirectories = fileTree(
            dir : "$buildDir/intermediates/classes/debug",
            excludes : [
                    ‘**/*Test.class‘,
                    ‘**/R.class‘,
                    ‘**/R$*.class‘,
                    ‘**/BuildConfig.*‘,
                    ‘**/Manifest*.*‘
            ]
    )
    def coverageSourceDirs = [‘src/main/java‘]
    additionalSourceDirs = files(coverageSourceDirs)
    sourceDirectories = files(coverageSourceDirs)
    additionalClassDirs = files(coverageSourceDirs)
    executionData = files("$buildDir/outputs/code-coverage/connected/coverage.ec")
}

dependencies {
    compile fileTree(dir: ‘libs‘, include: [‘*.jar‘])
    compile ‘com.android.support:appcompat-v7:22.2.1‘
}

然后在Terminal输入命令

gradlew findbugs

执行成功之后，会在项目根目录下build\reports\findbugs生成findbugs.html文件，打开就是查虫结果

这里可以看到总体的一些警告情况。

但是当你往下查看具体的某些问题时，会发现一些R$anim 之类的

而在Android中，R文件是自动生成，我们查虫是不需要检查该文件的。这时候过滤配置就派上用场了。

findgbugs过滤器配置

在项目根目录下新建一个findbug_filter.xml文件，内容如下

<?xml version="1.0" encoding="UTF-8"?>
<FindBugsFilter>
    <Match>
        <!-- ignore all issues in resource generation -->
        <Class name="~.*\.R\$.*"/>
    </Match>

    <Match>
        <Class name="~.*\.Manifest\$.*"/>
    </Match>

    <Match>
        <Class name="~.*\.*Test" />
        <!-- test classes are suffixed by ‘Test‘ -->
        <Not>
            <Bug code="IJU" /> <!-- ‘IJU‘ is the code for bugs related to JUnit test code -->
        </Not>
    </Match>
</FindBugsFilter>

上面match到的是要过滤掉，而不是要捕捉的，所以我们过滤掉了R文件、manifest文件和测试用例类。

相应的，我们需要修改gradle配置，让过滤器生效，在task findbugs 配置如下：

task findbugs(type: FindBugs,dependsOn:"connectedAndroidTest") {//
    ignoreFailures = true
    effort = "default"
    reportLevel = "medium"
    //过滤器
    excludeFilter = new File("${project.rootDir}/findbug_filter.xml")
    //这里填写项目classes目录
    classes = files("${project.rootDir}/andbase-core/build/intermediates/classes")
    source = fileTree(‘src/main/java‘)
    classpath = files()
    reports {
        //只能开启一个
        xml.enabled = false
        html.enabled = true
    }
}

然后在Teminal再执行gradlew findbugs，重新查看报告，之前的那些关于‘R$’的警告都没有了，说明过滤器生效了。

再者，我们可能有这样的需求，可能每个人的查看报告的侧重点不同，所以想，报告是否可以更个性化一些。同样的，我们可以根据过滤器实现。

<?xml version="1.0" encoding="UTF-8"?>
<FindBugsFilter>
    <Match>
        <!-- ignore all issues in resource generation -->
        <Class name="~.*\.R\$.*"/>
    </Match>

    <Match>
        <Class name="~.*\.Manifest\$.*"/>
    </Match>

    <Match>
        <Class name="~.*\.*Test" />
        <!-- test classes are suffixed by ‘Test‘ -->
        <Not>
            <Bug code="IJU" /> <!-- ‘IJU‘ is the code for bugs related to JUnit test code -->
        </Not>
    </Match>
    <!--过滤掉一些bug-->
    <Match>
        <!--1、性能问题-->
        <!--<Bug category="PERFORMANCE" />-->
        <!--2、一般正确性问题-->
        <!--<Bug category="CORRECTNESS" />-->
        <!--3、多线程正确性问题-->
        <!--<Bug category="MT_CORRECTNESS" />-->
        <!--4、恶意代码，有可能成为攻击点-->
        <!--<Bug category="MALICIOUS_CODE" />-->

        <Or>
            <!--Field names should start with a lower case letter-->
            <BugCode name="Nm"/>
            <!--Method ignores exceptional return value or Return value of method without side effect is ignored-->
            <BugCode name="RV"/>
            <!--国际化-->
            <BugCode name="Dm"/>
        </Or>
    </Match>
</FindBugsFilter>

其中，

<Bug category="MT_CORRECTNESS" />

是以一大类bug相关的来设置过滤器的，category的值有哪些呢？有PERFORMANCE（性能问题）、CORRECTNESS（一般正确性问题）、MT_CORRECTNESS（多线程正确性问题）、MALICIOUS_CODE（恶意代码），这四大类。

<BugCode name="Dm"/>

而BugCode是category类下的细分，而它们的name值有哪些呢，这里可以从报告中查看得知：

上图是Performance Category，Code列就是BugCode name的可选值。

通过过滤器的配置，我们可以个性化的定制报告了。

Jenkins配置findbugs

增加构建后操作步骤

看说明，该路径配置是获取xml文件的，但是，之前我们获取到的是html文件，怎么办？所以，这里我们要修改一下gradle配置。

task findbugs(type: FindBugs,dependsOn:"connectedAndroidTest") {//
    ignoreFailures = true
    effort = "default"
    reportLevel = "medium"
    //过滤器
    excludeFilter = new File("${project.rootDir}/findbug_filter.xml")
    //这里填写项目classes目录
    classes = files("${project.rootDir}/andbase-core/build/intermediates/classes")
    source = fileTree(‘src/main/java‘)
    classpath = files()
    reports {
        //只能开启一个
        xml.enabled = true
        html.enabled = false
    }
}

我们将xml.enabled设置为true，html.enabled设置为false。

然后，构建命令也要添加findbugs

邮箱也相应添加findbugs报告

保存配置，立即构建。如果运行正常的话，可以看到如下的报告

你也可以从邮箱内容打开链接查看报告

总结

至此，本系列也差不多讲完了。这套持续集成是我们公司正在用的，所以实用性还是蛮高的，用起来有很多好处，不管是对开发、测试都有很大的便利性，大大的提高了项目的质量和可控性。往大的说，它也为敏捷开发提供了可行性基础。第一次写这样的系列，有什么错的或者建议，希望能看到你的提出。

看下其他文章：

1、Jenkins构建Android项目持续集成之简介篇

2、Jenkins构建Android项目持续集成之Jenkins的安装篇

3、Jenkins构建Android项目持续集成之系统配置篇

4、Jenkins构建Android项目持续集成之创建项目

5、Jenkins构建Android项目持续集成之单元测试及代码覆盖率

6、Jenkins构建Android项目持续集成之findbugs的使用

时间： 2024-10-16 13:43:06

Jenkins构建Android项目持续集成之findbugs的使用的相关文章

使用jenkins进行Android的持续集成

关于持续集成的定义和意义可以参考它的 百度百科 主要意义有以下几点: 减少风险 减少重复过程 任何时间.任何地点生成可部署的软件 增强项目的可见性 建立团队对开发产品的信心 持续集成的实施 持续集成的工具有多个,本人实施的时候采用了Jenkins,它的前身是Hudson. 关于Jenkins的介绍可自行搜索,其主要特点是支持多种插件. 下面说说如何针对Android搭建一个可用的持续集成的系统. 用到的工具: 1.Android 完整的开发环境 : Android  SDK AndroidStu

Docker+Jenkins实现spring-boot项目持续集成

环境Jenkins安装,准备一台server,安装略,百度一下.Docker安装,准备一台server,安装略,百度一下. Jenkins上配置 新建一Maven的Job项目. Jenkins配置-源码 Jenkins配置-构建触发器 Jenkins配置-构建环境构建前,从集中存放配置文件的GitLab中拉取最新配置文件,包含Dockerfile,后面开始构建会引用最新文件. cd /data/httpd/release/b2b-configuration;git pull sleep 3; y

Net 项目构建基于Jenkins + Github + Mono 的持续集成环境

Net 项目构建基于Jenkins + Github + Mono 的持续集成环境 阅读目录 1 安装 2 配置 3 测试 在Redhat enterprise 6.5 的服务器上,为在gutub 上的 .net 项目构建一个持续集成环境,用到了Jenkins和mono.因公司的服务器在内网,访问外网时要通过代理,所以在很多步骤都加上了代理,如果你的服务器可以直接访问外网,则可以去掉代理. 回到顶部 1 安装 首先要在Redhat服务器上安装必要的工具. 1.1 安装Java 先检查版本,要求1

Jenkins+Maven进行Java项目持续集成

最近配置了Jenkins服务器,记录下基本过程.(当然还遇到了若干小问题,兵来将挡水来土掩就是了) Jenkins安装 安装Tomcat 从Jenkins官网下载jenkins.war文件.官网地址:http://jenkins-ci.org/,注意选择最新版本的Long-Term Support Release 把war文件部署到Tomcat中 启动Tomcat 在浏览器中配置Jenkins,浏览器地址:http://{Tomcat IP}:{Tomcat port}/jenkins/ Jen

自动化测试项目持续集成到jenkins

之前项目将接口自动化项目持续集成到了jenkins上,这次专门写篇文章记录下. 持续集成时,主要分为以下几个步骤: 1. 服务器安装jdk:2.maven的安装及配置:3.git的安装及配置:4.jenkins的安装及运行:5.将接口自动化项目持续集成到jenkins:6.在线测试报告的产出 一.jdk安装 这个网上有很多教程,本文不再赘述. 二.maven的安装和配置 1. 下载压缩包,使用1.1或者1.2都可以: 1.1 通过自己的电脑将压缩包上传至服务器: a. 进入maven官网下载 b

使用Jenkins进行android项目的自动构建（3）

建立Jenkins项目 1. "新增作业"->填写作业名称->选择"建置 Maven 2 或 3 專案"->OK.新增成功后会进入"組態設定",暂时先保留默认值,稍后再进行设定. 2. 按一下"马上建置",会显示"已排入建置",然后在"建置歷程"会见到#1的链接,点入该链接并选择"終端機輸出",这时会见到一个失败的构建记录.当然会失败,因为我们还未为

使用Jenkins进行android项目的自动构建（4）

加入单元测试 android单元测试很多都是使用Instrumentation进行的,这里讲的是试用JUnit,为什么用JUnit呢?因为使用Instrumentation需要打包apk安装,然后再进行测试,即需要用一个项目去测试另一个项目.我现在想做的单元测试是在打包前进行一些测试验证,所以需要用JUnit.至于使用Instrumentation的单元测试,以后再详述. maven默认的源代码src目录和测试代码test目录的结构是 src/main/java test/java 实际使用中发

使用Gradle构建Android项目

新项目中,使用了Google I/O 2013发布的新工具,使用Gradle构建android项目,并且在新版的Intellig IDEA以及google的Android Studio对其支持.本文就介绍一下怎么使用gradle构建android项目,进行多个版本编译. Gradle是什么? Gradle是以Groovy为基础,面向java应用,基于DSL语法的自动化构建工具.是google引入,替换ant和maven的新工具,其依赖兼容maven和ivy. 使用gradle的目的: 更容易重用

Jenkins构建Python项目提示：&#39;python&#39; 不是内部或外部命令，也不是可运行的程序

问题描述: jenkin集成python项目,立即构建后,发现未执行成功,查看Console Output 提示:'Python' 不是内部或外部命令,也不是可运行的程序,如下图: 1.在 Windows 提示符下运行是没有问题. 2.把Jenkins项目配置中 python main.py   修改成python可执行文件全路径:D:\Python35\python.exe main.py ,再次构建也没有问题. 这是因为 Jenkins 缺少环境配置. 解决方法: 配置构建执行状态: 1.回