prototesting

Documentation

Index

• func AssertFileDescriptorSetsEqual(t *testing.T, runner command.Runner, one *descriptorpb.FileDescriptorSet, ...)
• func DiffFileDescriptorSetsCompare(one *descriptorpb.FileDescriptorSet, two *descriptorpb.FileDescriptorSet) string
• func DiffFileDescriptorSetsJSON(ctx context.Context, runner command.Runner, ...) (string, error)
• func DiffFileDescriptorSetsWire(ctx context.Context, runner command.Runner, ...) (string, error)
• func GetProtocFileDescriptorSet(ctx context.Context, runner command.Runner, roots []string, ...) (_ *descriptorpb.FileDescriptorSet, retErr error)
• func GetProtocVersion(ctx context.Context) (string, error)
• func RunProtoc(ctx context.Context, runner command.Runner, roots []string, ...) error

Functions

func AssertFileDescriptorSetsEqual

func AssertFileDescriptorSetsEqual(
	t *testing.T,
	runner command.Runner,
	one *descriptorpb.FileDescriptorSet,
	two *descriptorpb.FileDescriptorSet,
)

AssertFileDescriptorSetsEqual asserts that the FileDescriptorSet are equal for JSON and compare.

func DiffFileDescriptorSetsCompare

func DiffFileDescriptorSetsCompare(
	one *descriptorpb.FileDescriptorSet,
	two *descriptorpb.FileDescriptorSet,
) string

DiffFileDescriptorSetsCompare diffs the two FileDescriptorSets using the cmp package.

func DiffFileDescriptorSetsJSON

func DiffFileDescriptorSetsJSON(
	ctx context.Context,
	runner command.Runner,
	one *descriptorpb.FileDescriptorSet,
	two *descriptorpb.FileDescriptorSet,
	oneName string,
	twoName string,
) (string, error)

DiffFileDescriptorSetsJSON diffs the two FileDescriptorSets using JSON.

func DiffFileDescriptorSetsWire

func DiffFileDescriptorSetsWire(
	ctx context.Context,
	runner command.Runner,
	one *descriptorpb.FileDescriptorSet,
	two *descriptorpb.FileDescriptorSet,
	oneName string,
	twoName string,
) (string, error)

DiffFileDescriptorSetsWire diffs the two FileDescriptorSets using proto.MarshalWire.

func GetProtocFileDescriptorSet

func GetProtocFileDescriptorSet(
	ctx context.Context,
	runner command.Runner,
	roots []string,
	realFilePaths []string,
	includeImports bool,
	includeSourceInfo bool,
) (_ *descriptorpb.FileDescriptorSet, retErr error)

GetProtocFileDescriptorSet gets the validated FileDescriptorSet using protoc and the Well-Known Types on the current PATH.

Only use for testing.

func GetProtocVersion

func GetProtocVersion(ctx context.Context) (string, error)

GetProtocVersion runs protoc --version with RunProtoc and returns the output sans the "libprotoc" prefix

func RunProtoc

func RunProtoc(
	ctx context.Context,
	runner command.Runner,
	roots []string,
	realFilePaths []string,
	includeImports bool,
	includeSourceInfo bool,
	env map[string]string,
	stdout io.Writer,
	extraFlags ...string,
) error

RunProtoc runs protoc.