美文网首页
【Jenkins】Check items的配置

【Jenkins】Check items的配置

作者: 代码搬运小萌新 | 来源:发表于2020-03-11 11:00 被阅读0次

    Jenkins提供了很多插件,用于展示代码测试、检测后的报告。
    最近当前项目需要完成这些插件的配置,于是便做了一些了解和探索,在这里简单罗列一些插件的作用及用法,以备查阅。

    项目是用Swift开发的,相关插件的配置也是针对Swift。

    Code Coverage

    代码覆盖率用来衡量,当你跑测试的时候,你有多少代码没有覆盖到。

    在iOS开发中,已经为我们提供了工具,用于生成代码覆盖率数据。
    项目名"PROJECT",scheme名为"SCHEME"

    Xcodebuild

    执行测试命令,设置-enableCodeCoverageYES表明需要生成代码覆盖率数据,

    xcodebuild test \
        -workspace PROJECT.xcworkspace \
        -scheme SCHEME \
        -configuration Debug \
        -destination 'platform=iOS Simulator,name=iPhone 8' \
        -enableCodeCoverage YES \
    

    执行完成后,会在derivedData中生成coverage.profdata,里面存放的就是代码覆盖率的数据。

    针对这样一份数据,我们并不认识,所以需要借助另一个工具来解析。

    Slather

    Slather
    Generate test coverage reports for Xcode projects & hook it into CI.
    文档中详细地描述了slather能够做的事情,目前对我来说,它最大的作用就是将coverage.profdata转换成cobertura类型的xml文件。

    关于Cobetrura,我的理解是,它是一个生成代码覆盖率的工具的java工具,它生成的结果是xml,而jenkins上有相应插件能够展示这个xml。*
    对于我们而言,我们这里让slather帮助我们生成了这个能够在jenkins上展示的xml,这就足够了。*

    执行slather命令,

    slather coverage -x \
        --scheme SCHEME \
        --workspace PROJECT.xcworkspace \
        --binary-basename DISPLAY_NAME \
        PROJECT.xcodeproj
    

    -x:生成cobertura格式的xml
    --binary-basename: Display name

    这里遇到了两个坑,

    1. 官方使用了-s进行简单的输出,于是我使用-s -x输出文档,但xml没有生成,只是用-x解决这个问题
    2. 不添加--binary-basename,导致提示找不到数据。

    在Jenkins的Publish Cobertura Coverage Report中填入相关xml文件即可。


    SLOCCount / cloc

    SLOCCountcloc都是用来检测源码的行数的,它们很类似,生成的xml也能够通用。
    SLOCCount的Jenkins插件的描述中提到了一句:

    Cloc (Count Lines of Code) is a tool similar to SLOCCount. It provides output to a XML file that can be simply transformed to the SLOCCount format and used in this plugin. Cloc is written in Perl and should be better portable than SLOCCount.

    项目中,我实际上用的是cloc,

    cloc --by-file --xml --out=OUTPUT_PATH DIRECTORY_PATH
    

    Jenkins中使用Publish SLOCCount analysis results来展示,同样填入xml路径即可。


    Swiftlint

    Swiftlint这个工具相对常用很多,为了生成checkstyle类型的文件,
    .swiftlint.yml配置文件,添加如下配置,

    reporter: "checkstyle"
    

    然后根据需求执行swiftlint相关命令就行

    最后在Jenkins的Publish Checkstyle analysis results中填入xml文件即可。

    PMD

    PMD这次没有用到,但我也看了一下它的overview,感觉跟Swiftlint很类似,但是多了CPD(copy-paste-detector),以后用到再详细了解。

    相关文章

      网友评论

          本文标题:【Jenkins】Check items的配置

          本文链接:https://www.haomeiwen.com/subject/wggfjhtx.html