去为 gcp compute sdk 创建一个 mock

Question

我使用下面的函数，我需要提高它的覆盖率(如果可能到100%)，问题是我通常使用interface来处理Go 中的这种情况以及对于这种特定情况不确定如何去做，因为这有点棘手，有什么想法吗？

包 https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/compute/v1

我使用的没有 interface 所以不确定我该如何模拟它？

import (
    "context"
    "errors"
    "fmt"
    "os"

    compute "cloud.google.com/go/compute/apiv1"
    "google.golang.org/api/iterator"
    "google.golang.org/api/option"
    computev1 "google.golang.org/genproto/googleapis/cloud/compute/v1"
)

func Res(ctx context.Context, project string, region string,vpc string,secret string) error {

    c, err := compute.NewAddressesRESTClient(ctx, option.WithCredentialsFile(secret))

    if err != nil {
        return err
    }

    defer c.Close()
    addrReq := &computev1.ListAddressesRequest{
        Project: project,
        Region:  region,
    }
    it := c.List(ctx, addrReq)

    for {
        resp, err := it.Next()
        if err == iterator.Done {
            break
        }
        if err != nil {
            return err
        }
        if *(resp.Status) != "IN_USE" {
            return ipConverter(*resp.Name, vpc)
        }
    }
    return nil
}

Answer 1

每当我遇到这种情况时，我发现最简单的解决方案是自己创建缺失 接口(interface)。我将这些接口(interface)限制为我正在使用的类型和函数，而不是为整个库编写接口(interface)。然后，在我的代码中，我不接受第三方具体类型，而是接受我的这些类型的接口(interface)。然后我像往常一样使用 gomock 为这些接口(interface)生成模拟。

以下是受您的代码启发的描述性示例。

type RestClient interface {
    List(context.Context, *computev1.ListAddressesRequest) (ListResult, error) // assuming List returns ListResult type.
    Close() error
}

func newRestClient(ctx context.Context, secret string) (RestClient, error) {
    return compute.NewAddressesRESTClient(ctx, option.WithCredentialsFile(secret))
}

func Res(ctx context.Context, project string, region string, vpc string, secret string) error {
    c, err := newRestClient(ctx, secret)
    if err != nil {
        return err
    }

    defer c.Close()
    return res(ctx, project, region, vpc, c)
}

func res(ctx context.Context, project string, region string, vpc string, c RestClient) error {
    addrReq := &computev1.ListAddressesRequest{
        Project: project,
        Region:  region,
    }

    it, err := c.List(ctx, addrReq)
    if err != nil {
        return err
    }

    for {
        resp, err := it.Next()
        if err == iterator.Done {
            break
        }

        if err != nil {
            return err
        }

        if *(resp.Status) != "IN_USE" {
            return ipConverter(*resp.Name, vpc)
        }
    }

    return nil
}

现在您可以通过将模拟 RestClient 注入(inject)内部 res 函数来测试 Res 函数的重要部分。