技术文章和通讯

用于验证Simulink模型的持续集成金宝app

作者:David Boissy, Paul Urban, Krishna Balasubramanian, Pablo Romero Cumbreras, and Colin Branch, MathWorks


持续集成(CI)越来越受欢迎,成为基于模型的设计的组成部分。但是ci是什么?它有什么好处,它试图解决的问题是什么?Simulink如金宝app何如何®是否适合CI生态系统?如何在项目中最好地利用CI ?

如果您熟悉基于模型的设计,但不熟悉CI,那么您可能会问自己这些问题。在这篇技术文章中,我们将探索一个常见的CI工作流,并将其应用到基于模型的设计中。然后,我们使用Jenkins™,GitLab来演示该工作流的一个示例®,以及Sim金宝appulink Test™。

本例中使用的项目是可供下载

词是什么?

CI是一种敏捷方法的最佳实践,在这种实践中,开发人员定期将他们的源代码更改提交并合并到中央存储库中。然后自动构建、限定和发布这些“变更集”。图1说明了这个基本CI工作流以及开发工作流。

图1.CI工作流。

在工作流的开发部分,模型和测试被开发、验证、合并、评审并提交到开发人员桌面上的版本控制系统。然后,版本控制系统触发工作流的自动CI部分。CI工作流的关键部分是:

构建:源代码和模型变成了目标文件和可执行文件。

测试:测试是作为质量门来执行的。

包裹:可执行文件、文档、工件和其他可交付内容被捆绑在一起,以交付给最终用户。

部署:包被部署到生产环境中。

在一起,这四个步骤称为CI“管道”。管道通常是自动化的,具体情况可能需要几分钟到数天才能完成,具体取决于系统。值得注意的是,在整个步骤中,创建了许多文物,例如材料账单,测试结果和报告。

CI工作流程通常与与版本控制系统相关的开发人员工作流配对。在这些工作流程中,开发人员通常会在本地存储库中保持更改,并使用本地CI管道在部署之前符合其更改。

CI的好处是什么?

已实施CI的团队通常报告以下福利:

  • 可重复性。CI管道为构建、测试、打包和部署提供了一致的、可重复的自动化过程。可重复自动化允许开发人员专注于必要的工作,并在项目上节省时间。这也是降低风险的一个重要方面,并且通常是认证的要求。
  • 质量保证。手工测试是有效的,但它通常基于几天前的快照,缺乏可重复性。使用CI,更改总是针对最新的代码库进行测试。
  • 减少开发时间。具有内置质量保证的可重复流程可更快地交付高质量产品。下载188bet金宝搏自动部署意味着您的代码始终可以用于生产。
  • 改进的协作。使用CI,开发人员具有定义的过程,用于管理更改集并将其代码合并到生产线中。一致的过程使管理大型团队成为可能并降低新开发人员升高的成本。
  • 审计就绪代码。CI工作流提供了广泛的审计跟踪。对于通过CI管道进行的每个更改,都可以确定是谁进行了更改、谁审查了更改、更改的性质、依赖项、测试及其结果,以及在此过程中生成的任何数量的相关报告和工件。

基于模型的设计如何适应CI?

按照设计,CI工作流和工具是与语言和领域无关的。这意味着挑战是CI工具、系统和流程说话基于模型的设计——换句话说,就是制作Simulink金宝app®以及相关的工具通用语CI工作流程。

这可以通过将基于模型的设计的三个关键组件集成到CI工作流程中:验证,代码生成和测试(图2)。基于模型的设计强调早期验证,将其映射到CI管线,并在构建阶段之前的验证阶段映射。代码生成在构建阶段进行。通过模拟和生成代码的静态分析可以在测试阶段进行动态测试。

图2。基于模型的设计映射到CI管道。

下面是我们如何ci工作流程说话基于模型的设计:

发展。MATLAB®、S金宝appimulink、编码器和工具箱用于开发活动。MATLAB项目用于组织工作、协作以及与版本控制系统的接口。

测试。金宝app模拟链路检查™ 用于在模拟和代码生成之前执行模型质量检查。模拟试验™ 用于开发、管理和执行基于仿真的测试。模拟链路覆盖™ 用于测量覆盖率和评估测试有效性。然后,质量检查、测试结果和覆盖率指标可以用作开发人员鉴定其工作的质量关卡。

合并。MATLAB的比较文件和文件夹功能用于比较和合并MATLAB文件。模型比较工具用于比较和合并Simulink模型。金宝app

复习。在变更提交到版本控制系统之前,评审是质量过程的最后一步。这里回顾了MATLAB脚本和Simulink模型的变化。金宝app资格预审的测试结果在提交之前也要作为最终的质量门进行审查。

提交。MATLAB项目提供了一个版本控制系统的接口。

核实。金宝appSimulink Check与用于本地验证的工具相同,用于CI系统中的自动验证。

构建。MATLAB编码器™,Simu金宝applink编码器™,嵌入式编码器®用于为软件在环(SIL)测试生成代码。

测试。金宝appSimulink Test,与用于本地测试的工具相同,也用于CI系统中的自动化测试。

打包和部署。打包是将可执行文件、文档、工件和其他可交付成果捆绑起来交付给最终用户的地方。部署是打包软件的发布。在基于模型的设计的工作流中,这些阶段在不同的组织和团队中差异很大,通常涉及将不同的构建和认证工件捆绑到一个产品中,以准备交付给其他团队。

现代开发工具和实践使开发人员能够尽早创建更强大的系统和测试功能。当CI系统集成到工作流程中时,自动化单元级测试和系统级测试。这意味着开发人员可以专注于开发新功能,而不是验证功能已正确集成。

下面的案例研究描述了一个集成了CI和基于模型的设计的工作流。

案例研究:在CI系统中验证、金宝app构建和测试的Simulink模型

在本例中,我们使用基于模型的设计和CI在汽车车道跟踪系统上执行基于需求的测试(图3)。

图3.车道跟驰系统模型。

我们将使用的管道(图4)在每次Jenkins构建时执行。

图4.道路后示例的管道。

管道中的阶段如下所示:

  1. 验证符合标准:一个MATLAB Unit脚本运行一个简单的Model Advisor检查。评估标准确保模型没有未连接的线路。
  2. 构建模型:一个MATLAB单元测试文件为我们的模型构建生产SIL代码。如果生成成功而没有警告,则评估标准通过。
  3. 执行测试用例:Simulink test中的测试套件使用几个驾驶场景来测金宝app试车道跟踪控制器。用三个评价标准来验证控制器的运行是否令人满意:
    • 避免碰撞:在驾驶场景中,ego汽车在任何时候都不会与领头车发生碰撞。
    • 安全距离维护:自我车与领先车的时间间隔在1.5秒以上。两辆车之间的时间间隔定义为计算出的车头时距与自我车速的比值。
    • 车道跟随:与车道中心线的横向偏差在0.2 m以内。
  4. 打包工件:前面的每个阶段都会生成工件,包括Model Advisor报告、生成的可执行文件和一组可以存档以供将来使用或参考的测试结果。

工作流步骤

工作流包括以下步骤(图5):

  1. 触发在Jenkins中进行构建,并观察验证和构建阶段是否通过。
  2. 检测Jenkins中的测试用例失败。
  3. 复制我们桌面Matlab上的问题。
  4. 解决问题在模型中,通过放宽评估标准。
  5. 在本地测试确保测试用例通过。
  6. 合并和审查测试分支上的更改。
  7. 提交对Git的更改并触发Jenkins中的构建。
  8. 验证,构建和测试在詹金斯。

图5。工作流示例。

左上角显示了我们第一次失败的CI循环。它显示了CI测试失败、局部复制、标准放松和CI工作流成功完成。

工作流详细信息

  1. 我们首先开始触发通过选择在Jenkins中构建现在构建.Simu金宝applink检查检查和代码生成通过。
  1. 接下来,我们检测在第二验证阶段的测试用例失败。测试用例LFACC_Curve_CutInOut_TooClose在测试套件LaneFollowingTestScenarios不符合考核标准。
  1. 为了更好地理解失败,我们复制使用Simulink测试在本地失败。金宝app我们打开测试文件LaneFollowingTestScenarios.mldatx并运行测试用例LFACC_Curve_CutInOut_TooClose.注意,它不符合安全距离评估标准。在建立引导车和自我车之间的时间间隔时需要更灵活。
  1. 随着对这个问题的了解,我们现在解决问题. 我们打开LaneFollowingTestBenchExample.slx模型并导航到碰撞检测/测试评估测试序列块。第一个评估断言,自我和领先车之间的时间差距不应低于1.5秒,每次不应超过2秒。

这种评估对正在测试的激进驾驶机动有太多的限制。出于本例的目的,我们放宽了评估标准,以确保时间间隔每次不会低于0.8秒,时间间隔每次不会超过5秒。

  1. 这个问题在我们的模拟中已经修复。确认,我们在本地测试,保存模型并在测试管理器中重新运行测试。注意,它通过了新的评估标准。
  1. 我们已经解决了这个问题,并在当地进行了验证。现在,我们使用模型比较工具回顾将更改提交到版本控制之前的更改。

我们还可以使用模型比较工具的发布特性来检查代码。

  1. 修复了bug后,我们使用MATLAB项目将这些更改推送到GitLab,并添加一条提交消息来记录评估标准的更改。

然后我们注意到GitLab中的最新提交。

Gitlab会自动触发Jenkins的构建。Jenkins项目仪表板显示构建状态和进度。

  1. Jenkins构建运行。我们看到验证、构建和测试管道阶段现在通过。

我们现在可以启动一个合并请求,将测试分支中的更改合并到主分支中。在GitLab中,在Repository下选择Branches,然后单击合并请求在测试分支上最新提交的旁边。

我们完成表格并提交合并请求。

作为分支的所有者,我们可以通过单击merge按钮来接受合并请求。所有更改现在都在主分支上捕获。

使用示例:工具、资源和需求

以下部分概述了帮助您入门的资源、您将需要的工具以及应该如何配置它们。

配置系统

Jenkins是我们的CI系统,GitLab是我们的版本控制系统。MATLAB、Jenkins和GitLab必须被配置成协同工作。下面的教程将帮助您进行设置。

配置我们的MATLAB项目

配置詹金斯

配置GitLab触发Jenkins

本教程专门针对GitLab和Jenkins,但其概念也适用于其他版本控制和CI系统。

需要工具

本例中需要准备的工具如下:

  • 詹金斯安装版本2.7.3及以上。Jenkins用于持续集成。
  • MATLAB插件版本1.0.3或更高版本。MATLAB、S金宝appimulink和Simulink Test都利用这个插件与Jenkins进行通信。更多信息请访问GitHub
  • 额外的插件要求:
  • GitLab帐户。GitLab用于源代码控制,并可作为云服务使用。MATLAB项目包括一个用于与GitLab通信的Git接口。

对CI的许可考虑

如果您计划在许多主机或云上执行CI,请联系continuous-integration@mathworks.com寻求帮助。注意:转换产品(如MathWorks编码器和编下载188bet金宝搏译器产品)可能需要客户端访问许可证(CAL)。

附录:配置Matlab,Gitlab和Jenkins

步骤1。配置MATLAB项目使用源码控制

我们示例中的第一步是将项目配置为使用GitLab的源代码管理。

  1. 创建一个新目录mbdexamplewithgitandjenkins.,将示例加载到它中,打开matlab项目MBDExampleWithGitAndJenkins.prj
  2. 在GitLab中,创建一个将作为远程存储库的新项目。它的名字mbdexamplewithgitandjenkins.并记录其托管的URL。
  3. 在MATLAB中,将项目转换为使用源代码管理。在“项目”选项卡上,单击使用源代码管理

点击将项目添加到源代码控制

  1. 点击转换
    1. 点击开放项目当完成。

    该项目现在处于本地Git源代码控制之下。

    步骤2。提交更改并将本地存储库推到GitLab

    1. 在“项目”选项卡上,单击远程
    1. 在GitLab中指定远程源的URL。

    点击验证为确保与远程存储库连接成功,请单击好吧.项目现在配置为使用GitLab推拉更改。

    1. 点击提交执行初始提交。
    1. 点击将所有更改从本地存储库推到远程GitLab存储库。
    1. 刷新GitLab仪表板,观察MATLAB项目的内容。

    第3步:创建测试分支

    在这一步中,我们创建了一个测试分支,用于在与主分支合并之前测试和验证更改。

    1. 点击分支机构
    1. 扩大分支和标签创建section,将分支命名为“Test”,然后单击创建
    1. 观察分支浏览器中的测试。从测试分支单击转换然后关闭
    1. 在MATLAB选择将这些更改推送到GitLab并观察GitLab中的测试分支。

    第4步:配置Jenkins调用MATLAB

    1. 安装两个必需的插件:
      • GitLab插件–此插件允许GitLab触发Jenkins构建并在GitLab UI中显示其结果。
      • MATLAB插件- 此插件将Matlab与Jenkins集成并提供Jenkins接口来调用Matlab和Simulink。金宝app
    2. 选择新项目并创建一个名为MBDExampleUsingGitAndJenkins
    3. 在源代码管理下,使能Git,Point Jenkins指向我们的Gitlab存储库,然后输入测试建立分支。注意:需要登录或密码和GitLab API令牌。
    1. 配置构建触发器,以便在向GitLab中的Test分支发出推请求时运行构建。在“构建触发器”部分中选择高级>秘密令牌。GitLab使用此令牌请求生成并向Jenkins进行身份验证。记下秘密令牌和GitLab webhook。
    1. 配置构建环境。选择使用MATLAB版本然后输入MATLAB根。
    1. 配置构建步骤。

    点击添加构建步骤并选择运行MATLAB命令.输入的命令openProject(“SltestLaneFollowingExample.prj”);LaneFollowingExecModelAdvisor
    打开项目并运行模型顾问检查。

    点击添加构建步骤并选择运行MATLAB命令一次。输入命令:openProject(“SltestLaneFollowingExample.prj”);LaneFollowingExecControllerBuild.

    点击添加构建步骤并选择MATLAB运行测试.选择利用测试结果Cobertura代码覆盖率以完成构建配置。

    第5步。出版挖掘结果

    点击添加构建后操作>发布TAP结果.输入发布TAP测试结果的相对路径。

    此操作解析TAP测试结果,并使它们在选择TAP扩展测试结果时可见。输出包含执行的测试用例的概述、结果摘要和来自MATLAB控制台的日志。

    TAP插件还收集最新测试执行的结果,并显示如下所示的运行状况图。您可以通过单击图表访问任何以前的构建。

    步骤6。发布HTML报告

    点击添加构建后操作>发布HTML报告.输入HTML报告将被发布的相对根路径,以及该路径中索引页的文件名。

    添加尽可能多的条目以发布HTML报告。在此场景中,有两个web报告:Model Advisor摘要和代码生成报告。这些是使用MATLAB内置函数创建的标准报告。您可以添加自定义HTML报告。

    您将在Jenkins作业主页面上找到与每个HTML报告的最后构建相对应的报告链接。如果你激活了发布选项下的复选框“总是链接到最后的构建”,插件将发布最后的构建报告,而不管构建状态如何。如果这个复选框没有被激活,插件只会链接到最后一个“成功”的构建。

    第七步。配置GitLab以触发Jenkins中的构建

    配置GitLab以在主分支上发生新推送时触发Jenkins中的自动构建。要做到这一点,导航到设置>人则.使用构建触发器配置中的webhook URL和Jenkins提供的秘密令牌并选择推送事件

    注意:在URL部分使用完全限定的域名来代替localhost,这样GitLab就可以找到Jenkins安装。

    测试下拉,选择推动事件测试集成。GitLab将显示消息“Hook执行成功:HTTP 200”,Jenkins将启动构建。

    步骤8.将Jenkins配置为GitLab身份验证

    要在GitLab上自动发布Jenkins构建状态,必须配置Jenkins- To -GitLab身份验证。

    1. 在选中API作用域的GitLab上创建个人访问令牌。
    1. 复制令牌并在Jenkins配置系统下创建GitLab连接。
      注意:连接可以在多个Jenkins作业上重用,如果用户至少拥有“维护者”权限,则可以全局配置连接。

    第9步。将Jenkins集成到GitLab管道中

    要将Jenkins集成到GitLab管道中,必须在Jenkins中配置GitLab连接,并将作业状态发布到GitLab。

    1. 在Jenkins作业的General部分中选择GitLab连接。
    1. 添加一个构建后操作以将构建状态发布到GitLab。
      注意:此操作没有参数,将使用现有的GitLab连接在GitLab上发布构建状态,并为每个提交和合并请求创建双向跟踪。

    步骤10:可视化基于需求的测试指标(R2020b)

    基于需求测试指标用于评估基于需求的测试活动的状态和质量。可以使用模型测试仪表板可视化度量结果。

    1. 创建一个名为collectModelTestingResults.m基于如下所示的功能。此功能将初始化度量引擎基础结构并收集所有可用的模型度量。
    函数collectmodeltingresults()%在R2020A中添加的%度量能力如果存在('metric')MetricIds = [...“ConditionCoverageBreateDrown”...“DecondedCoverageBreateBrea”...“McDCCoverageBreateBreake”......“McDccoverageBreakDown”......“SaleConditionCoverage”......“SalidEcisionCoverage”“OverallexecutionCoverage”...“ResementWithTestCaseDistRibution”的“Residmemcdcomoverage”......“ResignderTestCaseDistrage”的要求“ResignderTestCaseDistRibution”...“TestCasestatusDistribution”...“TestCasestatusPercentAction”“TestCaseTag“......”testCaseTagdistribution“”testCaseType“...”TestCaseTypeDistribution“”TestCaseWithRequirement“...”TestCaseWithRequirmentDistribution“”TestCasePerrequirmentPercentage“......”TestCasesPerrequirement“”TestCasesPerrequirmentDistibution“......];%收集初始协调e = metric.engine()的所有指标;执行(e,MetricID);结束
    1. 将此文件添加到项目和路径中。
    2. 通过调用新的collectModelTestingResults函数两次。第一个调用初始化与Simulink Test Manager的度量集成。金宝app第二种方法使用导出的Simulink Test Manager结果收集度量结果。金宝app
      1. 点击添加构建步骤并选择运行MATLAB命令一次。输入命令:openProject(“SltestLaneFollowingExample.prj”);collectModelTestingResults
        将这个构建步骤放置在MATLAB运行测试构建步骤。
      2. 点击添加构建步骤并选择运行MATLAB命令一次。再次输入命令:openProject(“SltestLaneFollowingExample.prj”);collectModelTestingResults
        将这个构建步骤放置在MATLAB运行测试构建步骤。

    3检查金宝appSimulink测试管理器结果MATLAB运行测试构建步骤。

    1. 将度量结果归档到派生目录中。您还必须归档导出的测试管理器结果,因为它们将允许在加载回MATLAB时对Metric结果进行完整导航。

    点击添加post-build行动并选择存档的工件。输入路径派生/**,matlabTestArtifacts/*.mldatx存档保存到该目录的所有文件。

    注意:要在测试机器以外的机器上使用MATLAB查看这些结果,请执行以下操作:

    • 下载归档的工件(派生目录和测试结果.mldatx文件)。
    • 提取并复制到用于运行CI作业的项目的相同版本的本地副本中。
    • 在MATLAB中打开项目并启动模型测试仪表板。

    CI产生的结果将显示在仪表板

    2021年出版的