File: doc.go

package info (click to toggle)
golang-github-jarcoal-httpmock 1.0.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 220 kB
  • sloc: makefile: 2
file content (81 lines) | stat: -rw-r--r-- 2,931 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
Package httpmock provides tools for mocking HTTP responses.

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

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

    // Regexp match (could use httpmock.RegisterRegexpResponder instead)
    httpmock.RegisterResponder("GET", `=~^https://api\.mybiz\.com/articles/id/\d+\z`,
      httpmock.NewStringResponder(200, `{"id": 1, "name": "My Great Article"}`))

    // do stuff that makes a request to articles

    // get count info
    httpmock.GetTotalCallCount()

    // get the amount of calls for the registered responder
    info := httpmock.GetCallCountInfo()
    info["GET https://api.mybiz.com/articles"]             // number of GET calls made to https://api.mybiz.com/articles
    info["GET https://api.mybiz.com/articles/id/12"]       // number of GET calls made to https://api.mybiz.com/articles/id/12
    info[`GET =~^https://api\.mybiz\.com/articles/id/\d+\z`] // number of GET calls made to https://api.mybiz.com/articles/id/<any-number>
  }

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",
      func(req *http.Request) (*http.Response, error) {
        resp, err := httpmock.NewJsonResponse(200, articles)
        if err != nil {
          return httpmock.NewStringResponse(500, ""), nil
        }
        return resp, nil
      },
    )

    // return an article related to the request with the help of regexp submatch (\d+)
    httpmock.RegisterResponder("GET", `=~^https://api\.mybiz\.com/articles/id/(\d+)\z`,
      func(req *http.Request) (*http.Response, error) {
        // Get ID from request
        id := httpmock.MustGetSubmatchAsUint(req, 1) // 1=first regexp submatch
        return httpmock.NewJsonResponse(200, map[string]interface{}{
          "id":   id,
          "name": "My Great Article",
        })
      },
    )

    // mock to add a new article
    httpmock.RegisterResponder("POST", "https://api.mybiz.com/articles",
      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
  }
*/
package httpmock