Golang测试跳过长用例，Short与Skip详解

Golang小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《Golang测试跳过长用例，Short模式与Skip详解》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

在Golang测试中跳过长时间运行的用例，可通过testing.Short()和t.Skip()实现。1. testing.Short()用于根据go test -short标志决定是否跳过测试，若设置了-short标志，则调用t.Skip()跳过耗时任务；2. t.Skip()可在测试函数内部根据条件跳过测试，如环境变量未设置时跳过依赖外部资源的测试；3. 使用t.Skipf()可格式化跳过信息，适合需要动态构建跳过原因的场景；4. 对于依赖外部资源的测试，可使用mock/stub、测试容器、集成测试环境或条件编译等方式处理；5. CI/CD中可在提交时运行go test -short快速验证，在夜间或发布构建中运行完整测试。

Golang测试中跳过长时间运行的用例，通常是为了加快测试速度，尤其是在持续集成环境中。你可以使用testing.Short()函数和t.Skip()方法来实现。testing.Short()允许你根据go test -short标志来控制是否运行某些测试。t.Skip()则允许你在测试函数内部，根据特定条件跳过测试。

解决方案

1. 使用testing.Short(): 在你的测试用例中，首先检查是否设置了short标志。如果设置了，就跳过那些耗时的测试。

   

   package yourpackage
   
   import (
       "testing"
       "time"
   )
   
   func TestLongRunningTask(t *testing.T) {
       if testing.Short() {
           t.Skip("skipping long running test in short mode")
       }
   
       // 模拟一个长时间运行的任务
       time.Sleep(5 * time.Second)
       // 一些断言
       if true != true {
           t.Errorf("Something went wrong")
       }
   }

   运行测试时，使用go test将运行所有测试，而使用go test -short将跳过TestLongRunningTask。

2. 使用t.Skip(): t.Skip()方法允许你在测试函数内部跳过测试，这在你有更复杂的条件来决定是否运行测试时非常有用。

   

   package yourpackage
   
   import (
       "os"
       "testing"
   )
   
   func TestExternalResource(t *testing.T) {
       if os.Getenv("EXTERNAL_RESOURCE_AVAILABLE") == "" {
           t.Skip("skipping test because external resource is not available")
       }
   
       // 测试依赖于外部资源的代码
       // ...
   }

   在这个例子中，如果环境变量EXTERNAL_RESOURCE_AVAILABLE未设置，测试将被跳过。

如何在CI/CD环境中运用Short模式？

CI/CD环境通常需要快速反馈，但又需要全面测试。一个策略是：在每次提交时运行go test -short，快速验证代码的基本功能。然后，在夜间构建或发布构建中运行完整的go test，包含所有长时间运行的测试。 你可以在CI/CD配置中设置不同的测试命令，例如：

# .gitlab-ci.yml 示例
stages:
  - test

short_test:
  stage: test
  script:
    - go test -short ./...

full_test:
  stage: test
  script:
    - go test ./...
  only:
    - schedules # 只在定时任务中运行

t.Skip()和t.Skipf()的区别是什么？何时使用哪个？

t.Skip()和t.Skipf()都用于跳过测试，但t.Skipf()允许你格式化一个跳过信息。选择哪个取决于你是否需要提供更详细的跳过原因。

• t.Skip(args ...interface{}): 接受一个或多个interface{}类型的参数，这些参数会被连接成一个字符串作为跳过的原因。

  t.Skip("Skipping because of reason X")

• t.Skipf(format string, args ...interface{}): 接受一个格式化字符串和一个或多个interface{}类型的参数，类似于fmt.Printf。

  t.Skipf("Skipping because version is %s", version)

  如果你需要动态地构建跳过信息，比如包含变量的值，那么t.Skipf()是更好的选择。

如何处理依赖外部资源或服务的测试？

处理依赖外部资源或服务的测试是一个常见的挑战。除了使用环境变量和t.Skip()之外，还可以考虑以下策略：

1. 使用Mock和Stub: 使用mock对象或stub来模拟外部资源的行为，这样你的测试就不再依赖于真实的外部资源。GoMock是一个流行的 mocking 框架。

   // 假设你有一个依赖外部服务的接口
   type ExternalService interface {
       GetData() (string, error)
   }
   
   // 使用GoMock生成一个mock对象
   //go:generate mockgen -destination=mock_external_service.go -package=yourpackage yourpackage ExternalService
   
   // 在测试中使用mock对象
   func TestWithMock(t *testing.T) {
       ctrl := gomock.NewController(t)
       defer ctrl.Finish()
   
       mockService := NewMockExternalService(ctrl)
       mockService.EXPECT().GetData().Return("mock data", nil)
   
       // 使用mockService进行测试
       // ...
   }

2. 使用测试容器: 使用Docker等容器技术，在测试环境中启动一个轻量级的外部服务实例。Testcontainers是一个用于在测试中管理Docker容器的库。

3. 使用集成测试环境: 设置一个专门的集成测试环境，其中包含所有必要的外部资源和服务。然后，只在这个环境中运行需要访问外部资源的测试。

4. 条件编译: 使用go:build指令，根据不同的构建标签选择性地编译测试代码。

   //go:build integration
   
   package yourpackage
   
   import "testing"
   
   func TestIntegration(t *testing.T) {
       // 集成测试代码
   }

   使用go test -tags=integration来运行带有integration标签的测试。

选择哪种策略取决于你的具体需求和项目的复杂性。通常，mock和stub是单元测试的首选，而测试容器和集成测试环境更适合集成测试。

今天带大家了解了的相关知识，希望对你有所帮助；关于Golang的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~