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

SkyWalking agent 插件自动化测试实践

2020-06-15 1922
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
应用实时监控服务-应用监控，每月50GB免费额度
日志服务 SLS，月写入数据量 50GB 1个月
应用实时监控服务-用户体验监控，每月100OCU免费额度
简介： ## 前言 本文主要介绍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
目录
相关文章
ModelScope内容运营小助手
|
2月前
|
前端开发 API 决策智能
多智能体微调实践：α-UMi 开源
近年来，为了加强大型语言模型(Large-Language Models, LLM）实时信息处理、解决专业问题的能力，催生了工具调用智能体（Tool Integrated Agent）概念
ModelScope内容运营小助手
165 60
游客5fdji2pvmf8888
|
12天前
|
敏捷开发 人工智能 Devops
探索自动化测试的高效策略与实践###
当今软件开发生命周期中，自动化测试已成为提升效率、保障质量的关键工具。本文深入剖析了自动化测试的核心价值，探讨了一系列高效策略，包括选择合适的自动化框架、设计可维护的测试脚本、集成持续集成/持续部署（CI/CD）流程，以及有效管理和维护测试用例库。通过具体案例分析，揭示了这些策略在实际应用中的成效，为软件测试人员提供了宝贵的经验分享和实践指导。 ###
游客5fdji2pvmf8888
39 5
游客5fdji2pvmf8888
|
12天前
|
Java 测试技术 持续交付
探索自动化测试在软件开发中的关键作用与实践
在现代软件开发流程中，自动化测试已成为提升产品质量、加速交付速度的不可或缺的一环。本文深入探讨了自动化测试的重要性，分析了其在不同阶段的应用价值，并结合实际案例阐述了如何有效实施自动化测试策略，以期为读者提供一套可操作的实践指南。
游客5fdji2pvmf8888
27 3
肥猪肥猪-17824
|
3月前
|
敏捷开发 机器人 Java
自动化测试之美：从理论到实践
【9月更文挑战第28天】在软件开发的海洋中，自动化测试是一艘航向高效、精确和快速交付的船。它不仅减轻了手动测试的负担，还提升了软件质量的保障。本文将带你了解自动化测试的核心概念、流行的工具以及如何将这些理论应用到实践中去。我们将通过实际代码示例，探索自动化测试的魅力所在。
肥猪肥猪-17824
127 70
天下无贼001
|
12天前
|
Web App开发 敏捷开发 测试技术
探索自动化测试的奥秘：从理论到实践
【10月更文挑战第39天】在软件质量保障的战场上，自动化测试是提升效率和准确性的利器。本文将深入浅出地介绍自动化测试的基本概念、必要性以及如何实施自动化测试。我们将通过一个实际案例，展示如何利用流行的自动化测试工具Selenium进行网页测试，并分享一些实用的技巧和最佳实践。无论你是新手还是有经验的测试工程师，这篇文章都将为你提供宝贵的知识，帮助你在自动化测试的道路上更进一步。
天下无贼001
21 2
肥猪肥猪-17824
|
12天前
|
敏捷开发 Java 测试技术
探索自动化测试：从理论到实践
【10月更文挑战第39天】在软件开发的海洋中，自动化测试是一艘能够带领团队高效航行的船只。本文将作为你的航海图，指引你理解自动化测试的核心概念，并分享一段实际的代码旅程，让你领略自动化测试的魅力和力量。准备好了吗？让我们启航！
肥猪肥猪-17824
21 2
游客nj6eqye5l5yr6
|
16天前
|
数据采集 人工智能 自然语言处理
万字干货｜复杂表格多Agent方案：从LLM洞察、系统性 思考到实践经验总结
笔者结合实践经验以近期在负责的复杂表格智能问答为切入点，结合大模型的哲学三问（“是谁、从哪里来、到哪里去”），穿插阐述自己对大模型的一些理解与判断，以及面向公共云LLM的建设模式思考，并分享软件设计+模型算法结合的一些研发实践经验。
游客nj6eqye5l5yr6
139 4
最好zzz
|
17天前
|
Prometheus 监控 Java
深入探索：自制Agent监控API接口耗时实践
在微服务架构中，监控API接口的调用耗时对于性能优化至关重要。通过监控接口耗时，我们可以识别性能瓶颈，优化服务响应速度。本文将分享如何自己动手实现一个Agent来统计API接口的调用耗时，提供一种实用的技术解决方案。
最好zzz
27 3
楠竹11
|
25天前
|
人工智能 测试技术 Windows
Windows 竞技场：面向下一代AI Agent的测试集
【10月更文挑战第25天】随着人工智能的发展，大型语言模型（LLMs）在多模态任务中展现出巨大潜力。为解决传统基准测试的局限性，研究人员提出了Windows Agent Arena，一个在真实Windows操作系统中评估AI代理性能的通用环境。该环境包含150多个多样化任务，支持快速并行化评估。研究团队还推出了多模态代理Navi，在Windows领域测试中成功率达到19.5%。尽管存在局限性，Windows Agent Arena仍为AI代理的评估和研究提供了新机遇。
楠竹11
39 3
游客qf4jmczx4xu2y
|
27天前
|
监控 安全 jenkins
探索软件测试的奥秘：自动化测试框架的搭建与实践
【10月更文挑战第24天】在软件开发的海洋里，测试是确保航行安全的灯塔。本文将带领读者揭开软件测试的神秘面纱，深入探讨如何从零开始搭建一个自动化测试框架，并配以代码示例。我们将一起航行在自动化测试的浪潮之上，体验从理论到实践的转变，最终达到提高测试效率和质量的彼岸。
游客qf4jmczx4xu2y
31 1

热门文章

最新文章

  • 1
    将ssh key添加到ssh-agent使用命令ssh-add ~/.ssh/id_rsa结果报错
  • 2
    aix puppet agent
  • 3
    Flume的Agent
  • 4
    理解一个名词：用户代理(user agent)
  • 5
    Script:收集Enterprise Manager Grid Control/Agent/Database Control诊断信息
  • 6
    Symantec Backup Exec Agent For Linux防火墙问题
  • 7
    SQL SERVER 2014 Agent服务异常停止案例
  • 8
    JPDA 架构研究5 - Agent利用环境指针访问VM (内存管理篇）
  • 9
    SSH无密码登陆Agent admitted failure to sign using the key
  • 10
    08【在线日志分析】之Flume Agent(聚合节点) sink to kafka cluster
  • 1
    探索软件测试的未来：AI与自动化的融合
    47
  • 2
    探索软件测试的未来：自动化与人工智能的融合
    27
  • 3
    探索软件测试的未来：自动化与人工智能的融合
    39
  • 4
    代码提交即部署：Argo Workflows与EventBridge构建自动化CI
    80
  • 5
    DevOps实践之路：从自动化部署到持续交付
    91
  • 6
    浏览器自动化
    87
  • 7
    《手把手教你》系列基础篇（九十六）-java+ selenium自动化测试-框架之设计篇-跨浏览器（详解教程）
    101
  • 8
    自动化运维的利剑：Ansible在现代IT架构中的应用
    335
  • 9
    AIGC生图的自动化质量评估（2）
    226
  • 10
    AIGC生图的自动化质量评估（1）
    177

    • 相关课程

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

    • 相关电子书

    更多
  • 移动互联网测试到质量的转变
  • 给ITer的技术实战进阶课-阿里CIO学院独家教材（四）
  • 无人值守自动化测试的实践之路

    • 相关实验场景

    更多
  • 在SAE控制台极速部署个人LLM效能工具
  • 如何快速创建插件agent
  • 快速体验智能体API应用
  • 云原生场景自动化响应ECS系统事件
  • 安装配置Terraform环境
  • 使用资源编排自动化开通云服务
    • 下一篇
    无影云桌面