remote

Documentation

Index

• type ForwardingReporter
  • func NewForwardingReporter(serverHost string, poster Poster, outputInterceptor OutputInterceptor) *ForwardingReporter
  • func (reporter *ForwardingReporter) ExampleDidComplete(exampleSummary *types.ExampleSummary)
  • func (reporter *ForwardingReporter) ExampleWillRun(exampleSummary *types.ExampleSummary)
  • func (reporter *ForwardingReporter) SpecSuiteDidEnd(summary *types.SuiteSummary)
  • func (reporter *ForwardingReporter) SpecSuiteWillBegin(conf config.GinkgoConfigType, summary *types.SuiteSummary)
• type OutputInterceptor
  • func NewOutputInterceptor() OutputInterceptor
• type Poster
• type Server
  • func NewServer() (*Server, error)
  • func (server *Server) Address() string
  • func (server *Server) RegisterReporters(reporters ...reporters.Reporter)
  • func (server *Server) Start()
  • func (server *Server) Stop()

Types

type ForwardingReporter

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

func NewForwardingReporter

func NewForwardingReporter(serverHost string, poster Poster, outputInterceptor OutputInterceptor) *ForwardingReporter

func (*ForwardingReporter) ExampleDidComplete

func (reporter *ForwardingReporter) ExampleDidComplete(exampleSummary *types.ExampleSummary)

func (*ForwardingReporter) ExampleWillRun

func (reporter *ForwardingReporter) ExampleWillRun(exampleSummary *types.ExampleSummary)

func (*ForwardingReporter) SpecSuiteDidEnd

func (reporter *ForwardingReporter) SpecSuiteDidEnd(summary *types.SuiteSummary)

func (*ForwardingReporter) SpecSuiteWillBegin

func (reporter *ForwardingReporter) SpecSuiteWillBegin(conf config.GinkgoConfigType, summary *types.SuiteSummary)

type OutputInterceptor

type OutputInterceptor interface {
	StartInterceptingOutput() error
	StopInterceptingAndReturnOutput() (string, error)
}

The OutputInterceptor is used by the ForwardingReporter to intercept and capture all stdin and stderr output during a test run.

func NewOutputInterceptor

func NewOutputInterceptor() OutputInterceptor

type Poster

type Poster interface {
	Post(url string, bodyType string, body io.Reader) (resp *http.Response, err error)
}

An interface to net/http's client to allow the injection of fakes under test

type Server

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

Server spins up on an automatically selected port and listens for communication from the forwarding reporter. It then forwards that communication to attached reporters.

func NewServer

func NewServer() (*Server, error)

Create a new server, automatically selecting a port

func (*Server) Address

func (server *Server) Address() string

The address the server can be reached it. Pass this into the `ForwardingReporter`.

func (*Server) RegisterReporters

func (server *Server) RegisterReporters(reporters ...reporters.Reporter)

The server will forward all received messages to Ginkgo reporters registered with `RegisterReporters`

func (*Server) Start

func (server *Server) Start()

Start the server. You don't need to `go s.Start()`, just `s.Start()`

func (*Server) Stop

func (server *Server) Stop()

Stop the server