备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

SkyWalking agent 插件自动化测试实践

2020-06-15 1794
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
云拨测，每月3000次拨测额度
简介： ## 前言 本文主要介绍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
关键词：
自动化实践
测试实践
自动化测试实践
通义星尘测试
插件自动化
kylixs
目录
相关文章
龙蜥社区（OpenAnolis）
|
22天前
|
安全 Linux 测试技术
提升龙蜥内核测试能力！探究持续性模糊测试优化实践
清华大学软件学院对Anolis OS使用靶向模糊测试方法将测试工作引向修改的代码，进而提高对业务代码的测试能力。
龙蜥社区（OpenAnolis）
23 2
shuj
|
30天前
|
运维 监控 持续交付
构建高效自动化运维体系：策略与实践
在数字化时代，企业IT基础设施的管理和维护变得日益复杂。为了提高效率、降低错误率并快速响应市场变化，构建一个高效的自动化运维体系至关重要。本文将探讨自动化运维的核心策略，并通过实际案例分析展示如何将这些策略应用于日常管理中，以实现IT运维的优化。
shuj
17 0
游客799
|
7天前
|
敏捷开发 监控 前端开发
深入理解自动化测试框架Selenium的架构与实践
【4月更文挑战第16天】 在现代软件开发过程中，自动化测试已成为确保产品质量和加快迭代速度的关键手段。Selenium作为一种广泛使用的自动化测试工具，其开源、跨平台的特性使得它成为业界的首选之一。本文旨在剖析Selenium的核心架构，并结合实际案例探讨其在复杂Web应用测试中的高效实践方法。通过详细解读Selenium组件间的交互机制以及如何优化测试脚本，我们希望为读者提供深入理解Selenium并有效运用于日常测试工作的参考。
游客799
14 1
肥猪肥猪-17824
|
8天前
|
自然语言处理 测试技术 API
深入理解自动化测试框架Selenium的设计理念与实践
【4月更文挑战第15天】 在现代软件开发过程中，自动化测试已成为确保产品质量和加速迭代的关键手段。Selenium作为一种广泛使用的自动化测试框架，提供了对多种浏览器和平台的支持，极大地促进了Web应用的功能测试。本文旨在剖析Selenium的核心设计理念，探讨其在实际项目中的应用，并指出常见的误区及最佳实践，以期帮助测试工程师更高效地利用Selenium进行测试工作。
肥猪肥猪-17824
26 12
请看我回答~
|
8天前
|
运维 Kubernetes Devops
构建高效自动化运维体系：DevOps与容器技术融合实践
【4月更文挑战第15天】 在当今快速发展的信息技术时代，传统的IT运维模式已难以满足业务敏捷性的需求。本文旨在探讨如何通过整合DevOps理念和容器技术来构建一个高效的自动化运维体系。文章将详细阐述DevOps的核心原则、容器技术的基础知识，以及两者结合的优势。此外，文中还将分享一系列实践经验，包括持续集成/持续部署(CI/CD)流程的搭建、微服务架构的应用，以及监控和日志管理策略的优化，以期帮助企业实现快速、可靠且安全的软件交付过程。
请看我回答~
14 0
1941623231718325
|
8天前
|
测试技术 持续交付 Docker
Django中的自动化部署与持续集成实践
【4月更文挑战第15天】本文介绍了Django项目中自动化部署与持续集成的实践方法。自动化部署通过选择Ansible、Fabric或Docker等工具，编写部署脚本，配置持续集成工具（如Jenkins、GitLab CI），确保服务器环境一致，实现快速应用上线。持续集成则涉及配置版本控制系统，设置自动化构建和测试，编写全面的测试用例，集成代码质量检查工具，并配置通知机制，以提升代码质量和开发效率。这两者结合能有效提升项目的迭代速度和可靠性。
1941623231718325
10 1
历年考试不作弊
|
10天前
|
人工智能 运维 监控
构建高效自动化运维体系的实践与思考
【4月更文挑战第14天】在数字化转型的浪潮中，自动化运维作为提升系统稳定性和效率的关键手段，受到了企业的广泛关注。本文将深入探讨如何构建一个高效的自动化运维体系，涵盖从基础设施的搭建到流程的优化等多个方面。通过分析当前自动化运维的挑战及解决方案，文章旨在为读者提供一套实用的策略框架，帮助企业实现运维工作的高效化、标准化和智能化。
历年考试不作弊
34 5
请看我回答~
|
15天前
|
运维 监控 Kubernetes
构建高效自动化运维体系的实践与思考
【4月更文挑战第8天】在数字化时代，IT基础设施的复杂性日益增加，传统的手工运维模式已经难以满足快速响应和高效率的需求。本文将探讨如何通过自动化工具和策略构建一个高效的自动化运维体系，旨在提高系统的稳定性、减少人为错误以及优化资源分配。文章首先分析了自动化运维的必要性，接着介绍了实现自动化的关键技术和工具，并通过案例分析展示自动化运维体系的实际效果。最后，对自动化运维的未来发展趋势进行了展望。
请看我回答~
13 0
肥猪肥猪-17824
|
17天前
|
安全 测试技术
深入理解白盒测试：方法、工具与实践
【4月更文挑战第7天】 在软件开发的质量控制过程中，白盒测试是确保代码逻辑正确性的关键步骤。不同于黑盒测试关注于功能和系统的外部行为，白盒测试深入到程序内部，检验程序结构和内部逻辑的正确性。本文将探讨白盒测试的核心技术，包括控制流测试、数据流测试以及静态分析等方法，同时介绍当前流行的白盒测试工具，并讨论如何在实际项目中有效实施白盒测试。文章的目标是为软件测试工程师提供一份综合性指南，帮助他们更好地理解和应用白盒测试技术。
肥猪肥猪-17824
10 1
游客799
|
29天前
|
敏捷开发 测试技术 持续交付
深入探索软件测试自动化：框架与实践
在快速演进的软件行业中，测试自动化已成为确保产品质量和加快上市速度的关键因素。本文将深入分析测试自动化框架的构建要点，探讨其在实际应用中的效益，以及实施过程中可能面临的挑战。通过对比手动测试与自动化测试的优势与局限，本文旨在为读者提供一套系统化的测试自动化实践指南，以支持更高效、可靠的软件开发周期。
游客799
11 0

热门文章

最新文章

  • 1
    【软件设计师备考 专题 】模块测试的方法和实践
  • 2
    【软件设计师备考 专题 】系统实施：程序设计和系统测试
  • 3
    【软件设计师备考 专题 】如何编写有效的测试报告
  • 4
    【软件设计师备考 专题 】测试要求说明书的编写和应用
  • 5
    【软件设计师备考 专题 】可靠性测试和可靠性评估
  • 6
    【软件设计师备考 专题 】系统集成测试的准备和执行
  • 7
    如何入门做物联网系统压测？
  • 8
    【软件设计师备考 专题 】性能测试和性能评估
  • 9
    渗透测试工程师面试题大全
  • 10
    【软件设计师备考 专题 】软件测试的原则与方法：确保软件质量的关键步骤
  • 1
    智能体DS-Agent基于案例推理，让GPT-4数据科学任务接近100%
    24
  • 2
    Agent调研--19类Agent框架对比（上）
    156
  • 3
    让智能体像孩子一样观察别人学习动作，跨视角技能学习数据集EgoExoLearn来了
    14
  • 4
    招募！阿里云x魔搭社区发起Create@AI创客松邀你探索下一代多维智能体应用
    277
  • 5
    Multi-Agent实践第7期：智能体的高效协作
    219
  • 6
    Multi-Agent实践第6期：面向智能体编程：狼人杀在AgentScope
    216
  • 7
    ChaosBlade常见问题之agent-pod 一直在重启如何解决
    15
  • 8
    LangChain Agent：赋予 LLM 行动力的神秘力量
    149
  • 9
    一个案例，看懂AI Agent厂商的商业落地路径
    76
  • 10
    AI大模型运维开发探索第三篇：深入浅出运维智能体
    243

    • 相关课程

    更多
  • MSE微服务测试最佳实践 - 自动化回归
  • Cloud Toolkit 开发部署效率提升神器
  • 线上问题排查利器 Alibaba Arthas（上）
  • 线上问题排查利器 Alibaba Arthas（下）
  • 自动化运维工具Ansible实战
  • Flume基础应用实战 - 企业全场景解决方案

    • 相关电子书

    更多
  • 新一代自动化渗透平台的设计与实现
  • 自动化、智能化网络运维
  • 无人值守自动化测试的实践之路

    • 相关实验场景

    更多
  • 快速体验智能体API应用
  • 云原生场景自动化响应ECS系统事件
  • 测试场景（RDS无优惠）
  • 基于OpenTelemetry构建全链路追踪与监控
  • 极致弹性的PolarDB Serverless确保数据业务持续在线
  • 基于Mappings自动化配置yum源
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）