Go
Latest commit 4442edb Dec 10, 2016 @dlebech dlebech committed on GitHub Update README.md
Permalink
Failed to load latest commit information.
.gitignore initial commit Feb 24, 2014
.travis.yml Add note on V1 update and test more Go versions Dec 10, 2016
LICENSE
README.md Update README.md Dec 10, 2016
doc.go
env.go env test Feb 24, 2014
env_test.go fix broken tests May 29, 2014
response.go Merge pull request #8 from pires/add_content_type_xml_header Aug 1, 2015
response_test.go Merge pull request #8 from pires/add_content_type_xml_header Aug 1, 2015
transport.go be able to handle custom http Roundtrippers Jul 28, 2015
transport_test.go added test for ActivateNonDefault Jul 28, 2015

README.md

httpmock Build Status

Easy mocking of http responses from external resources.

Update December 2016 Due to this library not receiving updates for more than a year, a new V1 branch has been created that is now the most current branch with the latest changes. The new changes are not compatible with older Go versions (1.5 and below) so the branch was created to prevent breaking projects out in the wild :-)

Install

Two versions are available:

V0. (not maintained, not recommended) Supports Go 1.3 to 1.7. Uses the current master branch to prevent breaking existing projects using this library.

go get github.com/jarcoal/httpmock

V1. (Active, recommended) Currently supports Go 1.7 but also works with 1.6 for now. Uses gopkg to read from v1 branch:

go get gopkg.in/jarcoal/httpmock.v1

You can also use vendoring for the v1 branch if you feel so inclined.

Simple Example:

func TestFetchArticles(t *testing.T) {
    httpmock.Activate()
    defer httpmock.DeactivateAndReset()

    httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles.json",
        httpmock.NewStringResponder(200, `[{"id": 1, "name": "My Great Article"}]`))

    // do stuff that makes a request to articles.json
}

Advanced Example:

func TestFetchArticles(t *testing.T) {
    httpmock.Activate()
    defer httpmock.DeactivateAndReset()

    // our database of articles
    articles := make([]map[string]interface{}, 0)

    // mock to list out the articles
    httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles.json",
        func(req *http.Request) (*http.Response, error) {
            resp, err := httpmock.NewJsonResponse(200, articles)
            if err != nil {
                return httpmock.NewStringResponse(500, ""), nil
            }
            return resp, nil
        },
    )

    // mock to add a new article
    httpmock.RegisterResponder("POST", "https://api.mybiz.com/articles.json",
        func(req *http.Request) (*http.Response, error) {
            article := make(map[string]interface{})
            if err := json.NewDecoder(req.Body).Decode(&article); err != nil {
                return httpmock.NewStringResponse(400, ""), nil
            }

            articles = append(articles, article)

            resp, err := httpmock.NewJsonResponse(200, article)
            if err != nil {
                return httpmock.NewStringResponse(500, ""), nil
            }
            return resp, nil
        },
    )

    // do stuff that adds and checks articles
}

Ginkgo Example:

// article_suite_test.go

import (
    // ...
    "github.com/jarcoal/httpmock"
)
// ...
var _ = BeforeSuite(func() {
    // block all HTTP requests
    httpmock.Activate()
})

var _ = BeforeEach(func() {
    // remove any mocks
    httpmock.Reset()
})

var _ = AfterSuite(func() {
    httpmock.DeactivateAndReset()
})


// article_test.go

import (
    // ...
    "github.com/jarcoal/httpmock"
)

var _ = Describe("Articles", func() {
    It("returns a list of articles", func() {
        httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles.json",
            httpmock.NewStringResponder(200, `[{"id": 1, "name": "My Great Article"}]`))

        // do stuff that makes a request to articles.json
    })
})