AI测试 ChatGPT 生成单元测试实践(Golang)

TestGPT · 2023年04月01日 · 11730 次阅读

目前 gpt 本质上是续写,所以在待测函数函数定义清晰的情况下,单元测试可以适当依赖它进行生成。

收益是什么:

辅助生成测试用例&测试代码,降低单元测试编写的心智成本

辅助 code review,帮助发现代码显式/潜在问题

本文测试环境:

gpt: gpt-3.5-turbo

go:go 1.17

本文实践场景:企业微信美图鉴赏机器人

生成单元测试的工作流如下:

选定你的待测函数

分析函数的依赖:结构体定义、repo 依赖、repo interface 抽象(用 fx 和 wire 等依赖注入框架的话会方便很多)

组织 prompt,准备施法

吟唱魔法,得到输出单元测试代码

copy 到 ide 里面缝缝补补,与预期出入太多的话,调整 prompt 重来/要求 gpt 按照某个标准重写(比如:请按照 testCases 的写法重写组织测试数据)

运行测试用例

话不多说,先上基础 prompt:

写下列写下列代码中 [待测函数名] 函数的单测,要求覆盖全部逻辑。
断言使用 require 包。
测试用例以 testCases 的形式输出。
下面的部分,我按照工作流的繁杂程度,简单区分了下 easy/normal/hard 情况。

Part1 easy:单个函数,无复杂依赖
单个函数,并且外部依赖都是开源库,那么直接把代码贴上去就行。

这里我们用图片压缩的独立函数举例:(prompt 前摇咒语 + 代码片段)

写下列代码中 CompressPicture 函数的单测,要求覆盖全部逻辑。
断言使用 require 包。
测试用例以 testCases 的形式输出。


// CompressPicture the picture by resizing it to the specified width.
func CompressPicture(picData []byte, width uint) ([]byte, error) {
   // Decode the input image.
   oldBuffer := bytes.NewBuffer(picData)
   inputImg, _, err := image.Decode(oldBuffer)
   if err != nil {
      return nil, err
   }
   // Resize the image to the specified width.
   outputImg := resize.Resize(width, 0, inputImg, resize.Lanczos3)
   // Encode the output image as PNG and write it to a buffer.
   newBuffer := new(bytes.Buffer)
   err = png.Encode(newBuffer, outputImg)
   if err != nil {
      return nil, err
   }
   // Return the compressed image as a byte slice.
   return newBuffer.Bytes(), nil
}
ChatGPT输出的代码块如下

func TestCompressPicture(t *testing.T) {
   // Setup test data
   imgData, err := os.ReadFile("test-image.png")
   if err != nil {
      t.Fatalf("failed to read test image file: %v", err)
   }
   testCases := []struct {
      name  string
      width uint
   }{
      {"compress with a valid width", 500},
      {"compress with an invalid width", 0},
   }
   for _, tc := range testCases {
      t.Run(tc.name, func(t *testing.T) {
         // Invoke the function being tested.
         compressedData, err := CompressPicture(imgData, tc.width)

         // Check the result.
         if err != nil {
            t.Fatalf("unexpected error: %v", err)
         }
         if len(compressedData) == 0 {
            t.Fatalf("compressed data is empty")
         }
         create, err := os.Create("test-image-compressed.png")
         if err != nil {
            return
         }
         defer create.Close()
         _, err = create.Write(compressedData)
      })

   }
}

放到 ide 里,完美运行,说明简单函数的单元测试生成还是很强的~

完美运行,覆盖率 100%

Part2 normal :里面有一些外部 import

有外部定义引入的时候,最好把外部定义直接贴上(不涉及 mock)。

这里举例的函数出现了外部依赖 entity.ArchiveWithData 等定义,所以最好要加上外部定义在输入中:

写下列代码中 ConvertArchiveWithDataToBotTextMsg 函数的单测,要求覆盖全部逻辑。
断言使用 require 包。
测试用例以 testCases 的形式输出。

// ConvertArchiveWithDataToBotTextMsg 将画作稿件信息转换为企微机器人文本消息
func ConvertArchiveWithDataToBotTextMsg(data *entity.ArchiveWithData) *entity.BotMsgReq {
   var MentionedList []string
   proxyUrl := data.Info.Urls.Original
   rawPixivUrl := fmt.Sprintf("https://www.pixiv.net/artworks/%d", data.Info.Pid)
   txt := &entity.BotText{
      Content:       fmt.Sprintf("proxy图源:%s\npixiv图源:%s", proxyUrl, rawPixivUrl),
      MentionedList: MentionedList,
   }
   postText := &entity.BotMsgReq{
      MsgType: entity.BotMsgText,
      Text:    txt,
   }
   return postText
}

一些导入的定义如下:

type BotText struct {
   Content       string   `json:"content"`
   MentionedList []string `json:"mentioned_list"`
}
type BotMsgReq struct {
   MsgType BotMsgType `json:"msgtype"`
   Text    *BotText   `json:"text,omitempty"`
}
const (
   BotMsgText  BotMsgType = "text"
)

type ArchiveWithData struct {
   Info Archive
   Data []byte
}

下面是生成的代码,经过少量修改后可以直接运行:

(因为少输入了一个结构体的定义,导致它猜测了一些字段)

func Test_ConvertArchiveWithDataToBotTextMsg(t *testing.T) {
   testCases := []struct {
      name     string
      data     *entity.ArchiveWithData
      expected *entity.BotMsgReq
   }{
      {
         name: "regular data",
         data: &entity.ArchiveWithData{
            Info: entity.Archive{
               Pid: 123456,
               Urls: entity.PicUrl{
                  Original: "https://example.com/image.jpg",
               },
            },
            Data: []byte{},
         },
         expected: &entity.BotMsgReq{
            MsgType: entity.BotMsgText,
            Text: &entity.BotText{
               Content: "proxy图源:https://example.com/image.jpg\npixiv图源:https://www.pixiv.net/artworks/123456",
            },
         },
      },
      {
         name: "data with special characters",
         data: &entity.ArchiveWithData{
            Info: entity.Archive{
               Pid: 789012,
               Urls: entity.PicUrl{
                  Original: "https://example.com/image(with)special&characters.jpg",
               },
            },
            Data: []byte{},
         },
         expected: &entity.BotMsgReq{
            MsgType: entity.BotMsgText,
            Text: &entity.BotText{
               Content: "proxy图源:https://example.com/image(with)special&characters.jpg\npixiv图源:https://www.pixiv.net/artworks/789012",
            },
         },
      },
   }

   for _, tc := range testCases {
      t.Run(tc.name, func(t *testing.T) {
         result := ConvertArchiveWithDataToBotTextMsg(tc.data)
         require.Equal(t, tc.expected, result)
      })
   }
}

小修小补就能跑啦

Part3 hard:对外部 repo 进行 mock(gomock 举例)

外部依赖越多,prompt template 的构建可能就越复杂

ps.实际上 gomonkey 它也可以写

外部依赖 repo 的部分,要求 gpt 使用 gomock 进行对应 repo 的 mock 即可。

外部定义最好进行剪枝。

写下列代码中 getSeTuDescSlice 函数的单测,要求覆盖全部逻辑。
断言使用 require 包。
测试用例以 testCases 的形式输出。
对于 m.repoSeTu.GetArchiveInfoSlice 的调用,使用 gomock 进行 mock 处理,假设已经有 mock 文件。

func (m *CronTab) getSeTuDescSlice(ctx context.Context, seTuConfig config.SeTuConfig) (entity.QueryResult, error) {
   queryResSlice, err := m.repoSeTu.GetArchiveInfoSlice(ctx, &entity.Query{
      R18:   seTuConfig.R18,
      Num:   1,
      Tag:   seTuConfig.Tags,
      Size:  seTuConfig.PicSize,
      Proxy: seTuConfig.Proxy,
   })
   if err != nil {
      return entity.QueryResult{}, err
   }
   return queryResSlice, nil
}

下面是外部依赖的定义:

type SeTuConfig struct {
   SetuApiUrl string   `yaml:"setu_api_url"`
   QWAuth     []string `yaml:"qw_auth"`
   CronStr    string   `yaml:"cron_str"`
   R18        int64    `yaml:"r_18"`
   Tags       []string `yaml:"tags"`
   PicSize    []string `yaml:"pic_size"`
   Proxy      string   `yaml:"proxy"`
}

// QueryResult 请求结果
type QueryResult struct {
   Error        string    `json:"error"`
   ArchiveSlice []Archive `json:"data"`
   //picPaths     []string
}

输出:

假设已经有 mock 文件:

// mock_repoSetu 是通过mockgen自动生成的,用于模拟repoSetu接口的mock文件

func TestCronTab_getSeTuDescSlice(t *testing.T) {
    testCases := []struct{
        name string
        seTuConfig config.SeTuConfig
        getArchiveInfoSliceRes entity.QueryResult
        getArchiveInfoSliceErr error
        wantErr bool
    }{
        {
            name: "success",
            seTuConfig: config.SeTuConfig{
                R18: 0,
                Tags: []string{"tag1", "tag2"},
                PicSize: []string{"large"},
                Proxy: "",
            },
            getArchiveInfoSliceRes: entity.QueryResult{
                ArchiveSlice: []entity.Archive{
                    {
                        Urls: []string{"pic1.url", "pic2.url"},
                        Title: "pic1",
                        Artists: []string{"artist1"},
                    },
                },
            },
            getArchiveInfoSliceErr: nil,
            wantErr: false,
        },
        {
            name: "error",
            seTuConfig: config.SeTuConfig{
                R18: 1,
                Tags: []string{"tag3"},
                PicSize: []string{"small", "medium"},
                Proxy: "",
            },
            getArchiveInfoSliceRes: entity.QueryResult{},
            getArchiveInfoSliceErr: errors.New("get archive info slice error"),
            wantErr: true,
        },
    }

    for _, tc := range testCases {
        t.Run(tc.name, func(t *testing.T) {
            ctx := context.Background()

            // 创建mock对象
            mockRepoSeTu := mock_repoSetu.NewMockRepoSeTu(ctrl)

            m := &CronTab{repoSeTu: mockRepoSeTu}

            // 设置mock对象返回值
            mockRepoSeTu.EXPECT().GetArchiveInfoSlice(ctx, &entity.Query{
                R18: tc.seTuConfig.R18,
                Num: 1,
                Tag: tc.seTuConfig.Tags,
                Size: tc.seTuConfig.PicSize,
                Proxy: tc.seTuConfig.Proxy,
            }).Return(tc.getArchiveInfoSliceRes, tc.getArchiveInfoSliceErr)

            res, err := m.getSeTuDescSlice(ctx, tc.seTuConfig)
            if tc.wantErr {
                require.Error(t, err)
            } else {
                require.NoError(t, err)
                require.Equal(t, tc.getArchiveInfoSliceRes, res)
            }
        })
    }
}

测试用例解释:
测试用例"success"模拟了 getSeTuDescSlice 调用成功的情况,设置查询条件 R18=0,Tags="tag1", "tag2",PicSize="large",期望返回多条图片信息;
测试用例"error"模拟了 getSeTuDescSlice 调用失败的情况,设置查询条件 R18=1,Tags="tag3",PicSize="small", "medium",期望返回错误信息。
生成的代码太长,几点总结:

1.gomock 代码可以正常生成,但是外部 repo 定义最好清晰明了,可以直接把 interface 定义贴上去,会被认知到。

2.粘贴到 ide 中,发现主要问题是包名导入问题,简单修改即可

类型&package 名错误
小修小补
修改后运行成功:

run!
如果需要生成后人工修改量更低的话,需要更精确的上下文信息(包名、函数定义、描述等)

一些痛点

1.需要外部 repo mock 的待测函数,需要的上下文很多,并且引入的无关字段需要剪枝避免污染输入

2.一些复杂的私有包,看起来是比较不好支持的(尝试过在 prompt 中教会他,但是效果不好)

3.一些复杂逻辑和边界情况,ai 可能口是心非(写的用例和表述不一致,比如经典的 20%*20%=400%,但是他知道这是错的)

4.对于分层不是很清晰的项目,对函数/repo 打桩可能很困难,这个时候要描述清楚就比较困难了,gomonkey 可能比较适用

其他用法

1.写好测试方法,让 gpt 帮助扩充用例集

2.code review,下面的代码就是 gpt 给出的代码建议

帮我优化下面的代码

// picCompress Modify size to compress pictures.
func picCompress(picData []byte) (newPicData []byte, err error) {
   oldBuf := bytes.NewBuffer(picData)
   pic, _, err := image.Decode(oldBuf)
   if err != nil {
      return
   }
   newPic := resize.Resize(uint(pic.Bounds().Dx()/2), 0, pic, resize.Lanczos3)
   var newBuf bytes.Buffer
   err = png.Encode(&newBuf, newPic)
   if err != nil {
      return
   }
   newPicData, err = ioutil.ReadAll(&newBuf)
   if err != nil {
      return
   }
   return
}

ChatGPT 给出的优化建议:

您好!下面是一个优化版的代码,主要改进在于:
减少对象的创建,避免额外的内存分配和垃圾回收。
增加错误检查,避免可能的错误被忽略。
以下是优化版代码:

// picCompress Modify size to compress pictures.
func picCompress(picData []byte) ([]byte, error) {
    reader := bytes.NewReader(picData)
    pic, _, err := image.Decode(reader)
    if err != nil {
        return nil, err
    }
    newPic := resize.Resize(uint(pic.Bounds().Dx()/2), 0, pic, resize.Lanczos3)
    var writer bytes.Buffer
    err = png.Encode(&writer, newPic)
    if err != nil {
        return nil, err
    }
    return writer.Bytes(), nil
}

尝试减少了对象的创建,使用了 bytes.Reader 代替了 bytes.NewBuffer 和 ioutil.ReadAll。
在处理图片过程中,使用 bytes.Buffer 代替了 newBuf 这个额外的对象。
同时也将函数的返回值简化,只返回处理后的 [] byte 和可能的错误,避免了空值的返回。最后,增加错误检查,保证代码健壮性。

暂无回复。
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册