AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

SkyWalking agent 插件自动化测试实践

2020-06-15 1892
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 SLS，月写入数据量 50GB 1个月
应用实时监控服务ARMS - 应用监控，每月50GB免费额度
简介： ## 前言 本文主要介绍SkyWalking agent 插件自动化测试框架组成及测试流程，以及一个实际的自动化测试testcase。 ## SkyWalking 插件自动化测试框架介绍 相关文档： > [SkyWalking Plugin automatic test framework] (https://github.com/apache/skywalking/blob/m

前言

本文主要介绍SkyWalking agent 插件自动化测试框架组成及测试流程，以及一个实际的自动化测试testcase。

SkyWalking 插件自动化测试框架介绍

相关文档：

[SkyWalking Plugin automatic test framework]
(https://github.com/apache/skywalking/blob/master/docs/en/guides/Plugin-test.md)

这个自动化测试框架主要包含下面几个部分：

  1. 测试环境docker镜像
  2. 自动化测试脚本
  3. testcase工程
  4. 结果验证工具

测试环境docker镜像

提供了两种测试环境：JVM-container 和 Tomcat-container，可以在创建testcase工程时选择使用的测试环境，官方推荐使用JVM-container。
其中JVM-container 可以理解为用于运行基于SpringBoot的testcase项目，包含启动脚本，可以修改启动的JVM参数，灵活性更好。

自动化测试脚本

主要使用到两个脚本：

  • 创建testcase工程
    ${SKYWALKING_HOME}/test/plugin/generator.sh
    执行脚本后，根据提示输入testcase的类型，名称等信息，脚本自动创建一个可以编译运行的样例项目。

  • 运行测试案例
    ${SKYWALKING_HOME}/test/plugin/run.sh ${scenario_name}
    ${SKYWALKING_HOME}/test/plugin/run.sh -f ${scenario_name}
    ${SKYWALKING_HOME}/test/plugin/run.sh --debug ${scenario_name}

    参数说明：

    • -f 参数强制重新创建镜像，在修改SkyWalking agent或plugin后需要添加-f参数，否则不能更新测试镜像中的agent程序。只改动testcase时不需要-f参数，减少启动时间。
    • --debug 启用调试模式，推荐使用此参数，可以保留测试过程的logs。

testcase工程

这里只介绍JVM-container类型的工程，实际上为基于SpringBoot的testcase应用。

[plugin-scenario]
    |- [bin]
        |- startup.sh
    |- [config]
        |- expectedData.yaml
    |- [src]
        |- [main]
            |- ...
        |- [resource]
            |- log4j2.xml
    |- pom.xml
    |- configuration.yaml
    |- support-version.list

[] = directory

工程文件说明：

文件/目录 说明
bin/startup.sh testcase 应用启动脚本
config/expectedData.yaml 测试结果验证数据
configuration.yaml testcase 配置，包含类型、启动脚本、检测url等
support-version.list testcase支持的版本列表，默认为空不会进行检查，可以改为all表示全部
pom.xml maven 项目描述文件
[src] testcase 源码目录

其中对新手来说最难的是编写测试结果验证数据expectedData.yaml，数据格式不是很复杂，但要手写出来还是比较困难的。后面会提及一些技巧，可以从日志文件logs/validatolr.out中提取验证数据。

测试结果验证工具

SkyWalking 自动化测试工具的精髓所做应该就是自动验证测试结果数据，支持多种匹配条件表达式，可以灵活处理一些动态变化的数据。其中关键的是skywalking-validator-tools.jar工具，其源码repo为skywalking-agent-test-tool。
validator的代码量不大，通过阅读代码，可以了解expectedData.yaml的验证过程，理解验证数据的格式。

自动化测试流程

bash ./test/plugin/run.sh --debug xxxx-scenario
-> 准备测试的workspace 
-> 编译testcase工程
-> 启动plugin-runner-helper 生成docker启动脚本等
-> scenario.sh 
    -> 启动测试环境docker实例 
    -> docker容器中执行 /run.sh
        -> collector-startup.sh
            -> 启动skywalking-mock-collector（测试数据收集服务）
        -> testcase/bin/startup.sh 
            -> 启动testcase应用（-javaagent加载skywalking-agent.jar）
        -> 循环healthCheck，等待testcase应用启动完毕
        -> 访问entryService url，触发测试用例
        -> 接收测试数据，写入到data/actualData.yaml文件
        -> 启动skywalking-validator-tools.jar验证测试结果数据
        -> 结束

设计测试用例

测试结果验证工具只能收集testcase应用的APM数据，比如span和logEvent等，不能收集http请求的返回内容，但可以收集到请求的状态码。

测试用例交互过程

这里仅介绍通过http请求交互，收集http相关数据，其它的数据与具体插件相关。比如测试redis apm插件时，可以收集到redis事件，包含执行的redis命令语句。
通过test/plugin/generator.sh命令生成测试用例中包含两个url，一个是healthCheck，一个是entryService。
1）healthCheck一般不需要管，用于探测testcase应用是否启动成功。如果编写的testcase有需要初始化的数据，请在healthCheck返回成功之前进行处理。

2）entryService是测试的入口url，healthCheck通过后，会接着访问entryService。可以在entryService的方法中进行调用测试方法，失败时返回4xx/5xx状态码。
这里要注意一个问题：
org.apache.skywalking.apm.testcase.*包下面的类不会被SkyWalking agent增强，这意味着这个包里面所有的类都不会被插件增强处理，比如标注了@Controller、@Component等的类并不会被apm-spring-annotation-plugin-*.jar 插件增强。如果要测试类增强的相关代码在testcase中，则要将代码放到这个包里面test.org.apache.skywalking.apm.testcase.*。

如何通过收集的APM数据判断测试成功或者失败？

1）http处理成功返回200/3xx时收集到span信息没有status_code，处理异常返回4xx/5xx错误时会产生一个tag记录status_code，可以用于验证区分测试结果。参考代码如下：

@RequestMapping("/dosomething")  
public ResponseEntity dosomething() {  
  // check testcase is successful or not  
  if (isTestSuccess()) {  
      return ResponseEntity.ok("success");  
  } else {  
      return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("failure");  
  }  
}

2）还可以通过抛出异常来产生status_code和logEvent

  @RequestMapping("/xxx-scenario")  
  @ResponseBody  
  public String testcase() throws HttpStatusCodeException {  
    if (isTestSuccess()) {
        return "success";
    }
    throw new RuntimeException("failure");  
  }

编写测试结果验证数据（expectedData.yaml）

  1. 启用调试模式 (--debug），保留日志文件目录logs
    bash ./test/plugin/run.sh --debug mytest-scenario
  2. 从日志文件提取收集的数据
    日志文件目录：skywalking/test/plugin/workspace/mytest-scenario/all/logs

收集的数据可以从日志文件validatolr.out从提取到，找到后面的actual data：

[2020-06-10 07:31:56:674] [INFO] - org.apache.skywalking.plugin.test.agent.tool.validator.assertor.DataAssert.assertEquals(DataAssert.java:29) - actual data:
{
  "segmentItems": [
    {
      "serviceName": "mytest-scenario",
      "segmentSize": "2",
      "segments": [
        {
        ....
        }
      ]
    }
  ]
}
  1. 将actual data的json数据转换为yaml
    打开其他测试场景的expectedData.yaml，如httpclient-3.x-scenario/config/expectedData.yaml 的第一段内容：
segmentItems:  
- serviceName: httpclient-3.x-scenario  
  segmentSize: ge 3  
  segments:  
  - segmentId: not null  
    spans:  
    - operationName: /httpclient-3.x-scenario/case/context-propagate  
      operationId: 0  
      parentSpanId: -1  
      spanId: 0  
      spanLayer: Http  
      startTime: nq 0  
      endTime: nq 0  
      componentId: 1  
      isError: false  
      spanType: Entry  
      peer: ''  
      tags:  
      - {key: url, value: 'http://localhost:8080/httpclient-3.x-scenario/case/context-propagate'}  
      - {key: http.method, value: GET}  
      refs:  
      - {parentEndpoint: /httpclient-3.x-scenario/case/httpclient, networkAddress: 'localhost:8080',  
        refType: CrossProcess, parentSpanId: 1, parentTraceSegmentId: not null, parentServiceInstance: not  
          null, parentService: httpclient-3.x-scenario, traceId: not null}  
      skipAnalysis: 'false'

expectedData.yaml是用于检查测试结果的匹配模板，只有简单的几种匹配表达式如下表：

Operator for number

| Operator | Description |
| :--- | :--- |
| nq | Not equal |
| eq | Equal(default) |
| ge | Greater than or equal |
| gt | Greater than |

Operator for String

| Operator | Description |
| :--- | :--- |
| not null | Not null |
| null | Null or empty String |
| eq | Equal(default) |

比如segmentId是随机生成的，那么可以写成segmentId: not null 这样就可以匹配任意字符串。开始时间是变化的可以写成startTime: nq 0，只判断其是否大于0就可以。
对照获取到的actual data json，修改对应的字段就可以了。可以忽略检查healthCheck的数据，只需要写上关键的segment。看一个案例，actual data 如下：

{
  "segmentItems": [
    {
      "serviceName": "mytest-scenario",
      "segmentSize": "2",
      "segments": [
        { 
            ... healthCheck ...
        },
        { 
          "segmentId": "ab32f6a2774347958318b0fb06ccd2f0.33.15917743102950000",
          "spans": [
            { 
              "operationName": "/case/mytest-scenario",
              "operationId": "0",
              "parentSpanId": "-1",
              "spanId": "0",
              "spanLayer": "Http",
              "tags": [
                { 
                  "key": "url",
                  "value": "http://localhost:8080/case/mytest-scenario"
                },
                { 
                  "key": "http.method",
                  "value": "GET"
                }
              ],
              "startTime": "1591774310295",
              "endTime": "1591774310316",
              "componentId": "14",
              "spanType": "Entry",
              "peer": "",
              "skipAnalysis": "false"
            }
          ] 
        }
      ]       
    }         
  ]           
}

对应的expectedData.yaml（忽略检查healthCheck的数据）：

segmentItems:  
  - serviceName: mytest-scenario  
    segmentSize: ge 1  
    segments:  
      - segmentId: not null  
        spans:  
          - operationName: /case/mytest-scenario  
            operationId: 0  
            parentSpanId: -1  
            spanId: 0  
            spanLayer: Http  
            startTime: nq 0  
            endTime: nq 0  
            componentId: ge 1  
            isError: false  
            spanType: Entry  
            peer: ''  
            tags:  
              - {key: url, value: 'http://localhost:8080/case/mytest-scenario'}  
              - {key: http.method, value: GET}  
            skipAnalysis: 'false'

常见错误处理

  • docker 容器实例名冲突
    ./test/plugin/run.sh 出现下面的错误：

docker: Error response from daemon: Conflict. The container name "/xxxx-scenario-all-local" is already in use by container "42cdee17e557bb71...". You have to remove (or rename) that container to be able to reuse that name.
解决办法：
删除上次测试失败留下来的容器实例：docker rm xxxx-scenario-all-local

编写自动化测试testcase

1. 生成testcase工程

> cd skywalking
> bash ./test/plugin/generator.sh
Sets the scenario name
>: mytest-scenario
Chooses a type of container, 'jvm' or 'tomcat', which is 'jvm-container' or 'tomcat-container'
>: jvm
Gives an artifactId for your project (default: mytest-scenario)
>: 
Sets the entry name of scenario (default: mytest-scenario)
>: 
scenario_home: mytest-scenario
type: jvm
artifactId: mytest-scenario
scenario_case: mytest-scenario

Please confirm: [Y/N]
>: y
[INFO] Scanning for projects...

2. 修改配置文件

修改mytest-scenario/support-version.list，添加支持的版本，这里用全部版本all。注意，默认没有指定版本，不会启动测试场景。

# lists your version here  
all

3. 编写测试用例

@RestController  
@RequestMapping("/case")  
public class CaseController {  
  
  private static final String SUCCESS = "Success";  
  
  @RequestMapping("/mytest-scenario")  
  @ResponseBody  
  public ResponseEntity testcase() {  
        //这里简单模拟，随机返回成功或者失败
        SecureRandom random = new SecureRandom();  
        if (random.nextBoolean()) {  
            return ResponseEntity.ok(SUCCESS);  
        } else {  
            return ResponseEntity.notFound().build();  
        }  
    }  
  
  @RequestMapping("/healthCheck")  
  @ResponseBody  
  public String healthCheck() {  
      // your codes  
      return SUCCESS;  
    }  
}

4. 本地测试testcase

bash ./test/plugin/run.sh --debug mytest-scenario

5. 提取测试收集的数据

从日志文件提取收集的数据，actual data部分。
日志文件：skywalking/test/plugin/workspace/mytest-scenario/all/logs/validatolr.out

[2020-06-10 09:00:03:655] [INFO] - org.apache.skywalking.plugin.test.agent.tool.validator.assertor.DataAssert.assertEquals(DataAssert.java:29) - actual data:
{
  "segmentItems": [
    {
      "serviceName": "mytest-scenario",
      "segmentSize": "2",
      "segments": [
        {
          "segmentId": "bfddda9bb70f49c694a90924b258a6da.32.15917795967760000",
          "spans": [
            {
              "operationName": "/mytest-scenario/case/healthCheck",
              "operationId": "0",
              "parentSpanId": "-1",
              "spanId": "0",
              "spanLayer": "Http",
              "tags": [
                {
                  "key": "url",
                  "value": "http://localhost:8080/mytest-scenario/case/healthCheck"
                },
                {
                  "key": "http.method",
                  "value": "HEAD"
                }
              ],
              "startTime": "1591779596801",
              "endTime": "1591779597069",
              "componentId": "1",
              "spanType": "Entry",
              "peer": "",
              "skipAnalysis": "false"
            }
          ]
        },
        {
          "segmentId": "bfddda9bb70f49c694a90924b258a6da.33.15917795971310000",
          "spans": [
            {
              "operationName": "/mytest-scenario/case/mytest-scenario",
              "operationId": "0",
              "parentSpanId": "-1",
              "spanId": "0",
              "spanLayer": "Http",
              "tags": [
                {
                  "key": "url",
                  "value": "http://localhost:8080/mytest-scenario/case/mytest-scenario"
                },
                {
                  "key": "http.method",
                  "value": "GET"
                }
              ],
              "startTime": "1591779597132",
              "endTime": "1591779597141",
              "componentId": "1",
              "spanType": "Entry",
              "peer": "",
              "skipAnalysis": "false"
            }
          ]
        }
      ]
    }
  ]
}

6. 编写expectedData.yaml

segmentItems:  
  - serviceName: mytest-scenario  
    segmentSize: ge 1  
    segments:  
      - segmentId: not null  
        spans:  
          - operationName: /case/mytest-scenario  
            operationId: 0  
            parentSpanId: -1  
            spanId: 0  
            spanLayer: Http  
            startTime: nq 0  
            endTime: nq 0  
            componentId: ge 1  
            isError: false  
            spanType: Entry  
            peer: ''  
            tags:  
              - {key: url, value: 'http://localhost:8080/case/mytest-scenario'}  
              - {key: http.method, value: GET}  
            skipAnalysis: 'false'
文章标签：
应用实时监控服务
日志服务
Java
Shell
容器
测试技术
应用服务中间件
NoSQL
Docker
Redis
数据格式
JSON
关键词：
自动化实践
测试实践
自动化测试实践
通义星尘实践
插件测试
相关实践学习
通过云拨测对指定服务器进行Ping/DNS监测
本实验将通过云拨测对指定服务器进行Ping/DNS监测，评估网站服务质量和用户体验。
kylixs
目录
相关文章
游客7v53mftipku2u
|
3天前
|
运维 监控 安全
构建高效运维体系：从监控到自动化的全方位实践
本文深入探讨了构建高效运维体系的关键要素，从监控、日志管理、自动化工具、容器化与微服务架构、持续集成与持续部署（CI/CD）、虚拟化与云计算以及安全与合规等方面进行了全面阐述。通过引入先进的技术和方法，结合实际案例和项目经验，为读者提供了一套完整的运维解决方案，旨在帮助企业提升运维效率，降低运营成本，确保业务稳定运行。
游客7v53mftipku2u
24 2
叫个什么名字
|
1天前
|
机器学习/深度学习 运维 Prometheus
构建高效运维体系：从自动化部署到智能监控的全方位实践
在当今数字化时代，企业对运维效率和稳定性的要求越来越高。本文将探讨如何构建一个高效的运维体系，从自动化部署、持续集成与持续交付（CI/CD）、智能监控、故障管理以及数据驱动决策等方面进行深入分析和实践指导。通过这些方法，企业可以实现更快速、更可靠的软件发布和问题解决，提升整体运营效率。
叫个什么名字
12 4
小周sir
|
2天前
|
Kubernetes 持续交付 开发者
探索并实践Kubernetes集群管理与自动化部署
探索并实践Kubernetes集群管理与自动化部署
小周sir
19 4
请看我回答~
|
1天前
|
运维 负载均衡 Devops
DevOps实践：使用Ansible进行自动化部署
【9月更文挑战第19天】在软件开发的快节奏世界中，DevOps已成为提高效率和促进协作的关键。本文将通过一个实际案例，展示如何使用Ansible简化自动化部署过程，旨在帮助读者理解DevOps的核心价值并掌握Ansible的基本使用。从概念到实践，我们将一起探索如何通过编写简单的Playbook来自动化服务器配置和应用部署，最终实现快速、可靠的软件发布。
请看我回答~
9 2
萝卜带泥
|
4天前
|
机器学习/深度学习 人工智能 测试技术
软件测试中的自动化测试实践与挑战
本文深入探讨了软件测试领域中的自动化测试，从基本概念到实际应用案例，揭示了自动化测试在提升软件开发效率和质量中的关键作用。同时，文章也分析了在实施自动化测试过程中面临的主要挑战，并提出了相应的解决策略。
萝卜带泥
28 5
zhanbao
|
3天前
|
设计模式 人工智能 算法
PHP中的设计模式：策略模式的深入解析与实践软件测试中的人工智能革命：提升效率与准确性的新篇章
在PHP开发中，理解并运用设计模式是提升代码质量和可维护性的重要途径。本文聚焦于策略模式（Strategy Pattern），一种行为型设计模式，它允许在运行时选择算法或业务规则。通过本文，我们将深入探讨策略模式的定义、结构、使用场景以及如何在PHP项目中有效地实现和利用策略模式。不同于性能优化等技术性摘要，本文着重于提供对策略模式全面而实用的理解，助力开发者编写出更加灵活和可扩展的应用程序。 本文深入探讨了人工智能在软件测试领域的应用，揭示了其如何显著提高测试过程的效率和准确性。通过实际案例分析，展示了AI技术在自动化测试、缺陷检测及结果分析中的关键作用，并讨论了实施AI测试策略时面临的挑
zhanbao
14 3
请看我回答~
|
3天前
|
存储 运维 网络安全
自动化运维工具：Ansible入门与实践
【9月更文挑战第17天】本文将介绍Ansible的基本概念、安装和简单使用，以及如何编写一个简单的Ansible playbook。通过本文，您可以了解到Ansible的基本原理和使用方法，以及如何在实际工作中应用Ansible进行自动化运维。
请看我回答~
12 1
请看我回答~
|
5天前
|
Ubuntu jenkins 测试技术
软件测试中的自动化与持续集成实践
【9月更文挑战第15天】在软件开发的快节奏世界中，自动化测试和持续集成（CI）已成为确保质量和效率的关键策略。本文旨在揭示如何通过实施自动化测试框架和CI流程来优化开发周期，减少人为错误，并加快产品上市时间。我们将探讨一些实用的工具和技术，以及它们如何帮助团队实现更流畅、更可靠的软件发布。
请看我回答~
16 3
jiashufeng
|
6天前
|
监控 jenkins 测试技术
软件测试中的自动化测试策略与实践
本文将深入探讨自动化测试在软件开发中的重要性及其实施策略。我们将从自动化测试的基本概念入手，分析其在提高软件质量、缩短开发周期和降低维护成本方面的优势。通过具体案例，展示如何有效地规划和执行自动化测试，以及如何评估其效果。
jiashufeng
14 1
历年考试不作弊
|
2天前
|
安全 测试技术 持续交付
探索软件测试的奥秘：从理论到实践
【9月更文挑战第18天】在数字化浪潮中，软件测试是确保产品质量和用户体验的关键步骤。本文旨在通过深入浅出的方式，引导读者理解软件测试的重要性和基本概念，并分享实用的测试技巧。我们将一起探讨如何设计有效的测试用例，执行测试计划，以及如何通过持续集成（CI）/持续部署（CD）流程实现自动化测试，从而提升软件开发的效率和质量。无论你是初学者还是有经验的开发者，这篇文章都将为你提供宝贵的知识和启发。
历年考试不作弊
9 0

热门文章

最新文章

  • 1
    自动化测试开展的条件
  • 2
    《 自动化测试最佳实践：来自全球的经典自动化测试案例解析》一一0.3　总结
  • 3
    Windows phone 应用开发[10]-自动化测试
  • 4
    Python+Appium自动化测试(15)-使用Android模拟器（详细）（一）
  • 5
    关于项目自动化测试架构的改良计划 - XML格式转为json格式
  • 6
    android 自动化测试的傻瓜实践之旅(UI篇) -----小试身手
  • 7
    关于项目自动化测试架构的改良计划 - 对于内容文件动作指令信息
  • 8
    《 自动化测试最佳实践：来自全球的经典自动化测试案例解析》一一 2.12　致谢
  • 9
    接口自动化测试系列之PHPUnit-框架设计构思
  • 10
    安卓自动化测试案例(跑在MonkeyRunner上)
  • 1
    【AGI】智能体简介及场景分析
    142
  • 2
    【AI智能体】SuperAGI-开源AI Agent 管理平台
    451
  • 3
    Llama3 中文通用Agent微调模型来啦！（附手把手微调实战教程）
    2047
  • 4
    android-agent-web中js-bridge案例
    66
  • 5
    关于多智能体应用，这届年轻人这么做
    135
  • 6
    变革来袭！多Agent框架MuAgent带你解锁代码开发新姿势
    626
  • 7
    【AI Agent系列】【阿里AgentScope框架】实战1：利用AgentScope实现动态创建Agent和自由组织讨论
    578
  • 8
    【AI Agent系列】【阿里AgentScope框架】5. Pipeline模块的组合使用及Pipeline模块总结
    209
  • 9
    【AI Agent系列】【阿里AgentScope框架】4. 深入源码：Pipeline模块如何组织多智能体间的数据流？- 循环结构
    155
  • 10
    【AI Agent系列】【阿里AgentScope框架】3. 深入源码：Pipeline模块如何组织多智能体间的数据流？- 顺序结构与条件分支
    137

    • 相关课程

    更多
  • MSE微服务测试最佳实践 - 自动化回归
  • 最新大版本解读：Grafana 10 新特性 & 新能力
  • Cloud Toolkit 开发部署效率提升神器
  • Springboot项目云开发快速迁移
  • 线上问题排查利器 Alibaba Arthas（上）
  • 线上问题排查利器 Alibaba Arthas（下）

    • 相关电子书

    更多
  • 自动化、智能化网络运维
  • 从自动化到智能化的阿里运维体系
  • 小红书移动端自动化数据采集实践

    • 相关实验场景

    更多
  • 使用 Jenkins 创建微服务应用的持续集成
  • 基于 IntelliJ IDEA 插件部署微服务应用
  • 快速上手并跑通AnalyticDB PostgreSQL版TPC-H测试
  • 使用阿里云Elasticsearch快速搭建可观测系统
  • 基于Mappings自动化配置yum源
  • 使用资源编排自动化开通云服务
    • 下一篇
    通义千问API入门教程