Skip to content

Commit

Permalink
added syntactic sugar methods to make usual tests easier to read
Browse files Browse the repository at this point in the history
  • Loading branch information
@johnabass
johnabass committed Jul 5, 2023
1 parent fa0677f commit 179fdf7
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 27 deletions.
22 changes: 17 additions & 5 deletions httpmock/roundTripper.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,18 @@ func (rtc *RoundTripCall) Run(f func(mock.Arguments)) *RoundTripCall {
return rtc
}

// Response is a simpler form of Return that correctly sets this call to
// return an *http.Response with a nil error.
func (rtc *RoundTripCall) Response(r *http.Response) *RoundTripCall {
return rtc.Return(r, nil)
}

// Error is a simpler form of Return that correctly sets this call to
// return a nil *http.Response with the given error.
func (rtc *RoundTripCall) Error(err error) *RoundTripCall {
return rtc.Return(nil, err)
}

// Return establishes the return values for this RoundTrip invocation.
//
// If this method is not used, the Next round tripper set on the container
Expand Down Expand Up @@ -248,11 +260,11 @@ func (m *RoundTripper) AssertExpectations() {
// CloseIdler is a mocked httpaux.CloseIdler that also mocks http.RoundTripper.
// Typical construction is:
//
// func(t *testing.T) {
// ci := &CloseIdler{
// RoundTripper: NewRoundTripper(t),
// }
// }
// func(t *testing.T) {
// ci := &CloseIdler{
// RoundTripper: NewRoundTripper(t),
// }
// }
type CloseIdler struct {
*RoundTripper
}
Expand Down
86 changes: 64 additions & 22 deletions httpmock/roundTripper_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,59 +16,59 @@ import (
"github.com/stretchr/testify/suite"
)

type RoundTripperTestSuite struct {
type RoundTripperSuite struct {
suite.Suite

// server is used to test delegations
server *httptest.Server
}

var _ suite.SetupAllSuite = (*RoundTripperTestSuite)(nil)
var _ suite.TearDownAllSuite = (*RoundTripperTestSuite)(nil)
var _ suite.SetupAllSuite = (*RoundTripperSuite)(nil)
var _ suite.TearDownAllSuite = (*RoundTripperSuite)(nil)

// assertResponse verifies that the response came from the handler method
func (suite *RoundTripperTestSuite) assertResponse(r *http.Response) {
func (suite *RoundTripperSuite) assertResponse(r *http.Response) {
suite.Require().NotNil(r)

if suite.NotNil(r.Body) {
defer r.Body.Close()
b, err := ioutil.ReadAll(r.Body)
if suite.NoError(err) {
suite.Equal("RoundTripperTestSuite", string(b))
suite.Equal("RoundTripperSuite", string(b))
}
}

suite.Equal(
"true",
r.Header.Get("RoundTripperTestSuite"),
r.Header.Get("RoundTripperSuite"),
)

suite.Equal(299, r.StatusCode)
}

func (suite *RoundTripperTestSuite) newRequest(method, url string, body io.Reader) *http.Request {
func (suite *RoundTripperSuite) newRequest(method, url string, body io.Reader) *http.Request {
r, err := http.NewRequest(method, url, body)
suite.Require().NoError(err)
return r
}

func (suite *RoundTripperTestSuite) handler(rw http.ResponseWriter, r *http.Request) {
rw.Header().Set("RoundTripperTestSuite", "true")
func (suite *RoundTripperSuite) handler(rw http.ResponseWriter, r *http.Request) {
rw.Header().Set("RoundTripperSuite", "true")
rw.WriteHeader(299)
rw.Write([]byte("RoundTripperTestSuite"))
rw.Write([]byte("RoundTripperSuite"))
}

func (suite *RoundTripperTestSuite) SetupSuite() {
func (suite *RoundTripperSuite) SetupSuite() {
suite.server = httptest.NewServer(
http.HandlerFunc(suite.handler),
)
}

func (suite *RoundTripperTestSuite) TearDownSuite() {
func (suite *RoundTripperSuite) TearDownSuite() {
suite.server.Close()
}

func (suite *RoundTripperTestSuite) TestSuite() {
func (suite *RoundTripperSuite) TestSuite() {
var (
transport = NewRoundTripperSuite(suite)
expected = new(http.Response)
Expand All @@ -85,7 +85,7 @@ func (suite *RoundTripperTestSuite) TestSuite() {
transport.AssertExpectations()
}

func (suite *RoundTripperTestSuite) TestSimple() {
func (suite *RoundTripperSuite) testSimpleReturn() {
var (
testingT = wrapTestingT(suite.T())
transport = NewRoundTripper(testingT)
Expand All @@ -104,7 +104,49 @@ func (suite *RoundTripperTestSuite) TestSimple() {
transport.AssertExpectations()
}

func (suite *RoundTripperTestSuite) TestMockRequestAssertions() {
func (suite *RoundTripperSuite) testSimpleResponse() {
var (
testingT = wrapTestingT(suite.T())
transport = NewRoundTripper(testingT)
expected = new(http.Response)
)

transport.OnAny().Response(expected).Once()
actual, actualErr := transport.RoundTrip(new(http.Request))
suite.True(expected == actual)
suite.NoError(actualErr)

suite.Zero(testingT.Logs)
suite.Zero(testingT.Errors)
suite.Zero(testingT.Failures)
transport.AssertExpectations()
}

func (suite *RoundTripperSuite) testSimpleError() {
var (
testingT = wrapTestingT(suite.T())
transport = NewRoundTripper(testingT)
expected = errors.New("expected")
)

transport.OnAny().Error(expected).Once()
response, actual := transport.RoundTrip(new(http.Request))
suite.Nil(response)
suite.Same(expected, actual)

suite.Zero(testingT.Logs)
suite.Zero(testingT.Errors)
suite.Zero(testingT.Failures)
transport.AssertExpectations()
}

func (suite *RoundTripperSuite) TestSimple() {
suite.Run("Return", suite.testSimpleReturn)
suite.Run("Response", suite.testSimpleResponse)
suite.Run("Error", suite.testSimpleError)
}

func (suite *RoundTripperSuite) TestMockRequestAssertions() {
suite.Run("Pass", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -166,7 +208,7 @@ func (suite *RoundTripperTestSuite) TestMockRequestAssertions() {
})
}

func (suite *RoundTripperTestSuite) TestCallRequestAssertions() {
func (suite *RoundTripperSuite) TestCallRequestAssertions() {
suite.Run("Pass", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -232,7 +274,7 @@ func (suite *RoundTripperTestSuite) TestCallRequestAssertions() {
})
}

func (suite *RoundTripperTestSuite) TestOnRequest() {
func (suite *RoundTripperSuite) TestOnRequest() {
suite.Run("Pass", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -276,7 +318,7 @@ func (suite *RoundTripperTestSuite) TestOnRequest() {
})
}

func (suite *RoundTripperTestSuite) TestOnMatchAll() {
func (suite *RoundTripperSuite) TestOnMatchAll() {
suite.Run("Pass", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -344,7 +386,7 @@ func (suite *RoundTripperTestSuite) TestOnMatchAll() {
})
}

func (suite *RoundTripperTestSuite) TestOnMatchAny() {
func (suite *RoundTripperSuite) TestOnMatchAny() {
suite.Run("Pass", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -400,7 +442,7 @@ func (suite *RoundTripperTestSuite) TestOnMatchAny() {
})
}

func (suite *RoundTripperTestSuite) TestCustomRun() {
func (suite *RoundTripperSuite) TestCustomRun() {
suite.Run("NoAssertions", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -491,7 +533,7 @@ func (suite *RoundTripperTestSuite) TestCustomRun() {
})
}

func (suite *RoundTripperTestSuite) TestNext() {
func (suite *RoundTripperSuite) TestNext() {
suite.Run("Nil", func() {
var (
testingT = wrapTestingT(suite.T())
Expand Down Expand Up @@ -532,7 +574,7 @@ func (suite *RoundTripperTestSuite) TestNext() {
}

func TestRoundTripper(t *testing.T) {
suite.Run(t, new(RoundTripperTestSuite))
suite.Run(t, new(RoundTripperSuite))
}

func TestCloseIdler(t *testing.T) {
Expand Down

0 comments on commit 179fdf7

Please sign in to comment.