test

Documentation

Overview

Package test provides mock implementations of the APK v1 gRPC clients for use in unit tests.

Index

• type APKSummariesOnList
• type APKsOnList
• type MockAPKClient
  • func (m MockAPKClient) ListAPKSummaries(_ context.Context, given *apk.APKSummaryFilter, _ ...grpc.CallOption) (*apk.APKPackageSummaryList, error)
  • func (m MockAPKClient) ListAPKs(_ context.Context, given *apk.APKFilter, _ ...grpc.CallOption) (*apk.APKList, error)
• type MockAPKClients
  • func (m MockAPKClients) APK() apk.APKClient
  • func (m MockAPKClients) Close() error

Examples

• MockAPKClients

Types

type APKSummariesOnList

type APKSummariesOnList struct {
	Given *apk.APKSummaryFilter
	List  *apk.APKPackageSummaryList
	Error error
}

type APKsOnList

type APKsOnList struct {
	Given *apk.APKFilter
	List  *apk.APKList
	Error error
}

type MockAPKClient

type MockAPKClient struct {
	apk.APKClient

	OnListAPKs         []APKsOnList
	OnListAPKSummaries []APKSummariesOnList
}

func (MockAPKClient) ListAPKSummaries

func (m MockAPKClient) ListAPKSummaries(_ context.Context, given *apk.APKSummaryFilter, _ ...grpc.CallOption) (*apk.APKPackageSummaryList, error)

func (MockAPKClient) ListAPKs

func (m MockAPKClient) ListAPKs(_ context.Context, given *apk.APKFilter, _ ...grpc.CallOption) (*apk.APKList, error)

type MockAPKClients

type MockAPKClients struct {
	OnClose error

	APKClient MockAPKClient
}

Example

ExampleMockAPKClients demonstrates constructing a mock APK client.

package main

import (
	"fmt"

	apktest "chainguard.dev/sdk/proto/platform/apk/v1/test"
)

func main() {
	mock := apktest.MockAPKClients{}
	fmt.Println(mock.Close())
}

Output:
<nil>

func (MockAPKClients) APK

func (m MockAPKClients) APK() apk.APKClient

func (MockAPKClients) Close

func (m MockAPKClients) Close() error