test

Documentation

Overview

Package test provides mock implementations of the Chainguard platform gRPC clients for use in unit tests.

Index

• type MockOIDCClients
  • func (m MockOIDCClients) Auth() auth.AuthClient
  • func (m MockOIDCClients) Close() error
  • func (m MockOIDCClients) OIDC() oidc.Clients
  • func (m MockOIDCClients) OIDCPing() ping.Clients
• type MockPlatformClients
  • func (m MockPlatformClients) APK() apk.Clients
  • func (m MockPlatformClients) Advisory() advisory.Clients
  • func (m MockPlatformClients) Argos() argos.Clients
  • func (m MockPlatformClients) Close() error
  • func (m MockPlatformClients) Connection() *grpc.ClientConn
  • func (m MockPlatformClients) Ecosystems() ecosystems.Clients
  • func (m MockPlatformClients) IAM() iam.Clients
  • func (m MockPlatformClients) ImageMatcher() matcher.Clients
  • func (m MockPlatformClients) Libraries() libraries.Clients
  • func (m MockPlatformClients) Packages() packages.Clients
  • func (m MockPlatformClients) Ping() ping.Clients
  • func (m MockPlatformClients) Policies() policies.Clients
  • func (m MockPlatformClients) Registry() registry.Clients
  • func (m MockPlatformClients) Skills() skills.Clients
  • func (m MockPlatformClients) Vulnerabilities() vulnerabilities.Clients
• type MockPlatformServer
  • func (m *MockPlatformServer) StartPlatformServer(_ context.Context, t *testing.T) string

Examples

• MockPlatformClients

Types

type MockOIDCClients

type MockOIDCClients struct {
	OnError error

	AuthClient authtest.MockAuthClient
	OIDCClient oidctest.MockOIDCClient
	PingClient pingtest.MockPingServiceClients
}

func (MockOIDCClients) Auth

func (m MockOIDCClients) Auth() auth.AuthClient

func (MockOIDCClients) Close

func (m MockOIDCClients) Close() error

func (MockOIDCClients) OIDC

func (m MockOIDCClients) OIDC() oidc.Clients

func (MockOIDCClients) OIDCPing

func (m MockOIDCClients) OIDCPing() ping.Clients

type MockPlatformClients

type MockPlatformClients struct {
	OnError error
	Conn    *grpc.ClientConn

	IAMClient             iamtest.MockIAMClient
	RegistryClient        registrytest.MockRegistryClients
	AdvisoryClient        advisorytest.MockSecurityAdvisoryClients
	PingClient            pingtest.MockPingServiceClients
	APKClient             apktest.MockAPKClients
	EcosystemsClient      ecosystemstest.MockEcosystemsClients
	LibrariesClient       librariestest.MockLibrariesClients
	SkillsClient          skillstest.MockSkillsClients
	PackagesClient        packagestest.MockPackagesClients
	VulnerabilitiesClient vulnerabilitiestest.MockVulnerabilitiesClients
	ImageMatcherClient    matchertest.MockImageMatcherClients
	PoliciesClient        policiestest.MockPoliciesClients
	ArgosClient           argostest.MockArgosClients
}

Example

ExampleMockPlatformClients demonstrates constructing a mock platform client.

package main

import (
	"fmt"

	platformtest "chainguard.dev/sdk/proto/platform/test"
)

func main() {
	mock := platformtest.MockPlatformClients{}
	fmt.Println(mock.Close())
}

Output:
<nil>

func (MockPlatformClients) APK

func (m MockPlatformClients) APK() apk.Clients

func (MockPlatformClients) Advisory

func (m MockPlatformClients) Advisory() advisory.Clients

func (MockPlatformClients) Argos

func (m MockPlatformClients) Argos() argos.Clients

func (MockPlatformClients) Close

func (m MockPlatformClients) Close() error

func (MockPlatformClients) Connection

func (m MockPlatformClients) Connection() *grpc.ClientConn

func (MockPlatformClients) Ecosystems

func (m MockPlatformClients) Ecosystems() ecosystems.Clients

func (MockPlatformClients) IAM

func (m MockPlatformClients) IAM() iam.Clients

func (MockPlatformClients) ImageMatcher

func (m MockPlatformClients) ImageMatcher() matcher.Clients

func (MockPlatformClients) Libraries

func (m MockPlatformClients) Libraries() libraries.Clients

func (MockPlatformClients) Packages

func (m MockPlatformClients) Packages() packages.Clients

func (MockPlatformClients) Ping

func (m MockPlatformClients) Ping() ping.Clients

func (MockPlatformClients) Policies

func (m MockPlatformClients) Policies() policies.Clients

func (MockPlatformClients) Registry

func (m MockPlatformClients) Registry() registry.Clients

func (MockPlatformClients) Skills

func (m MockPlatformClients) Skills() skills.Clients

func (MockPlatformClients) Vulnerabilities

func (m MockPlatformClients) Vulnerabilities() vulnerabilities.Clients

type MockPlatformServer

type MockPlatformServer struct {
	GroupServer iamtest.MockGroupsServer
}

func (*MockPlatformServer) StartPlatformServer

func (m *MockPlatformServer) StartPlatformServer(_ context.Context, t *testing.T) string

StartPlatformServer starts the mock server and returns the connection string.