-
Notifications
You must be signed in to change notification settings - Fork 0
/
example_test.go
184 lines (146 loc) · 4.16 KB
/
example_test.go
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// Copyright 2021 The webserver Authors. All rights reserved.
// Use of this source code is governed by a MIT
// license that can be found in the LICENSE file.
package webserver_test
import (
"errors"
"fmt"
"io"
"net/http"
"os"
"strings"
"sync"
"time"
"github.com/thalesfsp/randomness"
"github.com/thalesfsp/webserver"
"github.com/thalesfsp/webserver/handler"
)
const serverName = "test-server"
// Logs, and exit.
//
//nolint:forbidigo
func logAndExit(msg string) {
fmt.Println(msg)
os.Exit(1)
}
//nolint:noctx
func callAndExpect(port int, url string, sc int, expectedBodyContains string) (int, string) {
c := http.Client{Timeout: time.Duration(10) * time.Second}
resp, err := c.Get(fmt.Sprintf("http://0.0.0.0:%d/%s", port, url))
if err != nil {
logAndExit(err.Error())
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
logAndExit(err.Error())
}
if sc != 0 {
if resp.StatusCode != sc {
logAndExit(fmt.Sprintf("Expect %v got %v\n", sc, resp.StatusCode))
}
}
bodyS := string(body)
if expectedBodyContains != "" {
if !strings.Contains(bodyS, expectedBodyContains) {
logAndExit(fmt.Sprintf("Expect %v got %v\n", expectedBodyContains, bodyS))
}
}
return resp.StatusCode, bodyS
}
//////
// Examples.
//////
// Example showing how to use the Web Server.
func ExampleNew() {
// Probe results accumulator. Golang's example requires some output to be
// tested against. This accumulator will serve it.
probeResults := []string{}
probeResultsLocker := sync.Mutex{}
// Part of the readiness simulation.
readinessFlag := handler.NewReadinessDeterminer("tunnel")
// Golang's example are like tests, it's a bad practice to have a hardcoded
// port because of the possibility of collision. Generate a random port.
r, err := randomness.New(3000, 7000, 10, true)
if err != nil {
logAndExit(err.Error())
}
port := r.MustGenerate()
// Setup server settings some options.
testServer, err := webserver.New(serverName, fmt.Sprintf("0.0.0.0:%d", port),
// Sets server readiness.
webserver.WithReadiness(readinessFlag),
)
if err != nil {
logAndExit(err.Error())
}
// Start server, non-blocking way.
go func() {
if err := testServer.Start(); err != nil {
if errors.Is(err, http.ErrServerClosed) {
fmt.Println("server stopped")
} else {
logAndExit(err.Error())
}
}
}()
// Ensures enough time for the server to be up, and ready - just for testing.
time.Sleep(3 * time.Second)
// Simulates a Readiness probe, for example, Kubernetes.
go func() {
for {
_, body := callAndExpect(int(port), "/readiness", 0, "")
probeResultsLocker.Lock()
probeResults = append(probeResults, body)
probeResultsLocker.Unlock()
// Probe wait time.
time.Sleep(500 * time.Millisecond)
}
}()
// Simulates some action which indicates server is ready, example data was
// loaded from DB, or got updated data from another service.
go func() {
time.Sleep(2 * time.Second)
readinessFlag.SetReadiness(true)
}()
// Hold the server online for testing.
time.Sleep(5 * time.Second)
// Satisfies Golang example output need.
probeResultsLocker.Lock()
fmt.Println(strings.Contains(strings.Join(probeResults, ","), "OK"))
probeResultsLocker.Unlock()
// output:
// true
}
func ExampleNewDefault() {
// Golang's example are like tests, it's a bad practice to have a hardcoded
// port because of the possibility of collision. Generate a random port.
r, err := randomness.New(3000, 7000, 10, true)
if err != nil {
logAndExit(err.Error())
}
port := r.MustGenerate()
// Setup server settings some options.
testServer, err := webserver.NewDefault(serverName, fmt.Sprintf("0.0.0.0:%d", port))
if err != nil {
logAndExit(err.Error())
}
// Start server, non-blocking way.
go func() {
if err := testServer.Start(); err != nil {
if errors.Is(err, http.ErrServerClosed) {
fmt.Println("server stopped")
} else {
logAndExit(err.Error())
}
}
}()
// Ensures enough time for the server to be up, and ready - just for testing.
time.Sleep(1 * time.Second)
responseCode, body := callAndExpect(int(port), "/api/v1/", 200, "OK")
fmt.Println(responseCode)
fmt.Println(body)
// output:
// 200
// OK
}