buftesting

Documentation

Overview

Package buftesting provides helpers for testing.

Index

• func DiffImagesJSON(one bufpb.Image, two bufpb.Image, name string) (string, error)
• func DiffImagesText(one bufpb.Image, two bufpb.Image, name string) (string, error)
• func GetGithubArchive(ctx context.Context, outputDirPath string, owner string, repository string, ...) error
• func GetProtocImage(ctx context.Context, roots []string, realFilePaths []string, ...) (bufpb.Image, error)
• func ImagesEqual(one bufpb.Image, two bufpb.Image) (bool, error)

Functions

func DiffImagesJSON

func DiffImagesJSON(one bufpb.Image, two bufpb.Image, name string) (string, error)

DiffImagesJSON diffs the two Images using jsonpb.

func DiffImagesText

func DiffImagesText(one bufpb.Image, two bufpb.Image, name string) (string, error)

DiffImagesText diffs the two Images using proto.MarshalText.

func GetGithubArchive

func GetGithubArchive(
	ctx context.Context,
	outputDirPath string,
	owner string,
	repository string,
	ref string,
) error

GetGithubArchive gets the GitHub archive and untars it to the output directory path.

The root directory within the tarball is stripped. If the directory already exists, this is a no-op.

func GetProtocImage

func GetProtocImage(
	ctx context.Context,
	roots []string,
	realFilePaths []string,
	includeImports bool,
	includeSourceInfo bool,
) (bufpb.Image, error)

GetProtocImage gets the Image for the realFilePaths using protoc and wkt's on the current PATH.

func ImagesEqual

func ImagesEqual(one bufpb.Image, two bufpb.Image) (bool, error)

ImagesEqual checks if the images are equal.