matrix

README

matrix

matrix is a utility for testing command line clients written in Go.

Documentation

Overview

Package matrix provides utilities for testing command line clients written in Go. Testing command line clients in this way is typically done by including the test cases in the main package so that the main() function can be called by the test case.

package main

import (
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"

	"github.com/jagoda/matrix"
)

var _ = Describe("Process", func() {
	var (
		process *matrix.Process
	)

	BeforeEach(func() {
		process = matrix.CaptureProcess()
		defer process.Restore()

		main()
	})

	It("captures the output", func() {
		Expect(process.Output()).To(Equal("hello\n"))
	})
})

Index

• type Process
  • func CaptureProcess() *Process
  • func (process *Process) Output() string
  • func (process *Process) Restore()
  • func (process *Process) SetArgs(values ...string)

Types

type Process

type Process struct {
	// contains filtered or unexported fields
}

Process represents simulated process state

func CaptureProcess

func CaptureProcess() *Process

CaptureProcess captures the current process state and provides simulated state useful for testing. The original process state is returned when Restore() is called.

func (*Process) Output

func (process *Process) Output() string

Output returns the combined data written to both stdout and stderr

func (*Process) Restore

func (process *Process) Restore()

Restore returns the process to it's original state before being captured

func (*Process) SetArgs

func (process *Process) SetArgs(values ...string)

SetArgs sets the process arguments