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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
|
package statuscake
import (
"encoding/json"
"fmt"
"net/url"
"reflect"
"strings"
)
const queryStringTag = "querystring"
// Test represents a statuscake Test
type Test struct {
// TestID is an int, use this to get more details about this test. If not provided will insert a new check, else will update
TestID int `json:"TestID" querystring:"TestID" querystringoptions:"omitempty"`
// Sent tfalse To Unpause and true To Pause.
Paused bool `json:"Paused" querystring:"Paused"`
// Website name. Tags are stripped out
WebsiteName string `json:"WebsiteName" querystring:"WebsiteName"`
// CustomHeader. A special header that will be sent along with the HTTP tests.
CustomHeader string `json:"CustomHeader" querystring:"CustomHeader"`
// Use to populate the test with a custom user agent
UserAgent string `json:"UserAgent" queryString:"UserAgent"`
// Test location, either an IP (for TCP and Ping) or a fully qualified URL for other TestTypes
WebsiteURL string `json:"WebsiteURL" querystring:"WebsiteURL"`
// A Port to use on TCP Tests
Port int `json:"Port" querystring:"Port"`
// Contact group ID - deprecated in favor of ContactGroup but still provided in the API detail response
ContactID int `json:"ContactID"`
// Contact group IDs - will return list of ints or empty if not provided
ContactGroup []string `json:"ContactGroup" querystring:"ContactGroup"`
// Current status at last test
Status string `json:"Status"`
// 1 Day Uptime
Uptime float64 `json:"Uptime"`
// Any test locations seperated by a comma (using the Node Location IDs)
NodeLocations []string `json:"NodeLocations" querystring:"NodeLocations"`
// Timeout in an int form representing seconds.
Timeout int `json:"Timeout" querystring:"Timeout"`
// A URL to ping if a site goes down.
PingURL string `json:"PingURL" querystring:"PingURL"`
Confirmation int `json:"Confirmation,string" querystring:"Confirmation"`
// The number of seconds between checks.
CheckRate int `json:"CheckRate" querystring:"CheckRate"`
// A Basic Auth User account to use to login
BasicUser string `json:"BasicUser" querystring:"BasicUser"`
// If BasicUser is set then this should be the password for the BasicUser
BasicPass string `json:"BasicPass" querystring:"BasicPass"`
// Set 1 to enable public reporting, 0 to disable
Public int `json:"Public" querystring:"Public"`
// A URL to a image to use for public reporting
LogoImage string `json:"LogoImage" querystring:"LogoImage"`
// Set to 0 to use branding (default) or 1 to disable public reporting branding
Branding int `json:"Branding" querystring:"Branding"`
// Used internally by the statuscake API
WebsiteHost string `json:"WebsiteHost" querystring:"WebsiteHost"`
// Enable virus checking or not. 1 to enable
Virus int `json:"Virus" querystring:"Virus"`
// A string that should either be found or not found.
FindString string `json:"FindString" querystring:"FindString"`
// If the above string should be found to trigger a alert. true will trigger if FindString found
DoNotFind bool `json:"DoNotFind" querystring:"DoNotFind"`
// What type of test type to use. Accepted values are HTTP, TCP, PING
TestType string `json:"TestType" querystring:"TestType"`
// Use 1 to TURN OFF real browser testing
RealBrowser int `json:"RealBrowser" querystring:"RealBrowser"`
// How many minutes to wait before sending an alert
TriggerRate int `json:"TriggerRate" querystring:"TriggerRate"`
// Tags should be seperated by a comma - no spacing between tags (this,is,a set,of,tags)
TestTags []string `json:"TestTags" querystring:"TestTags"`
// Comma Seperated List of StatusCodes to Trigger Error on (on Update will replace, so send full list each time)
StatusCodes string `json:"StatusCodes" querystring:"StatusCodes" querystringoptions:"omitempty"`
// Set to 1 to enable the Cookie Jar. Required for some redirects.
UseJar int `json:"UseJar" querystring:"UseJar"`
// Raw POST data seperated by an ampersand
PostRaw string `json:"PostRaw" querystring:"PostRaw"`
// POST Body data, json
PostBody string `json:"PostBody" querystring:"PostBody"`
// Use to specify the expected Final URL in the testing process
FinalEndpoint string `json:"FinalEndpoint" querystring:"FinalEndpoint"`
// Use to enable SSL validation
EnableSSLAlert bool `json:"EnableSSLAlert" querystring:"EnableSSLAlert"`
// Use to specify whether redirects should be followed
FollowRedirect bool `json:"FollowRedirect" querystring:"FollowRedirect"`
// DNS Tests only. Hostname or IP of DNS server to use.
DNSServer string `json:"DNSServer" querystring:"DNSServer"`
// DNS Tests only. IP to compare against WebsiteURL value.
DNSIP string `json:"DNSIP" querystring:"DNSIP"`
}
// Validate checks if the Test is valid. If it's invalid, it returns a ValidationError with all invalid fields. It returns nil otherwise.
func (t *Test) Validate() error {
e := make(ValidationError)
if t.WebsiteName == "" {
e["WebsiteName"] = "is required"
}
if t.WebsiteURL == "" {
e["WebsiteURL"] = "is required"
}
if t.Timeout != 0 && (t.Timeout < 6 || t.Timeout > 99) {
e["Timeout"] = "must be 0 or between 6 and 99"
}
if t.Confirmation < 0 || t.Confirmation > 9 {
e["Confirmation"] = "must be between 0 and 9"
}
if t.CheckRate < 0 || t.CheckRate > 23999 {
e["CheckRate"] = "must be between 0 and 23999"
}
if t.Public < 0 || t.Public > 1 {
e["Public"] = "must be 0 or 1"
}
if t.Virus < 0 || t.Virus > 1 {
e["Virus"] = "must be 0 or 1"
}
if t.TestType != "HTTP" && t.TestType != "TCP" && t.TestType != "PING" && t.TestType != "DNS" {
e["TestType"] = "must be HTTP, TCP, DNS or PING"
}
if t.RealBrowser < 0 || t.RealBrowser > 1 {
e["RealBrowser"] = "must be 0 or 1"
}
if t.TriggerRate < 0 || t.TriggerRate > 59 {
e["TriggerRate"] = "must be between 0 and 59"
}
if t.PostRaw != "" && t.TestType != "HTTP" {
e["PostRaw"] = "must be HTTP to submit a POST request with PostRaw"
}
if t.PostBody != "" && t.TestType != "HTTP" {
e["PostBody"] = "must be HTTP to submit a POST request with PostBody"
}
if t.FinalEndpoint != "" && t.TestType != "HTTP" {
e["FinalEndpoint"] = "must be a Valid URL"
}
if t.TestType == "DNS" && t.DNSIP == "" {
e["DNSIP"] = "is required"
}
if t.DNSServer != "" && t.TestType != "DNS" {
e["DNSServer"] = "must be only used for DNS type tests"
}
if t.DNSIP != "" && t.TestType != "DNS" {
e["DNSIP"] = "must be only used for DNS type tests"
}
if t.CustomHeader != "" {
var jsonVerifiable map[string]interface{}
if json.Unmarshal([]byte(t.CustomHeader), &jsonVerifiable) != nil {
e["CustomHeader"] = "must be provided as json string"
}
}
if len(e) > 0 {
return e
}
return nil
}
// ToURLValues returns url.Values of all fields required to create/update a Test.
func (t Test) ToURLValues() url.Values {
values := make(url.Values)
st := reflect.TypeOf(t)
sv := reflect.ValueOf(t)
for i := 0; i < st.NumField(); i++ {
sf := st.Field(i)
tag := sf.Tag.Get(queryStringTag)
ft := sf.Type
if ft.Name() == "" && ft.Kind() == reflect.Ptr {
// Follow pointer.
ft = ft.Elem()
}
v := sv.Field(i)
options := sf.Tag.Get("querystringoptions")
omit := options == "omitempty" && isEmptyValue(v)
if tag != "" && !omit {
values.Set(tag, valueToQueryStringValue(v))
}
}
return values
}
func isEmptyValue(v reflect.Value) bool {
switch v.Kind() {
case reflect.Array, reflect.Map, reflect.Slice, reflect.String:
return v.Len() == 0
case reflect.Bool:
return !v.Bool()
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
return v.Int() == 0
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
return v.Uint() == 0
case reflect.Float32, reflect.Float64:
return v.Float() == 0
case reflect.Interface, reflect.Ptr:
return v.IsNil()
}
return false
}
func valueToQueryStringValue(v reflect.Value) string {
if v.Type().Name() == "bool" {
if v.Bool() {
return "1"
}
return "0"
}
if v.Type().Kind() == reflect.Slice {
if ss, ok := v.Interface().([]string); ok {
return strings.Join(ss, ",")
}
}
return fmt.Sprint(v)
}
// Tests is a client that implements the `Tests` API.
type Tests interface {
All() ([]*Test, error)
AllWithFilter(url.Values) ([]*Test, error)
Detail(int) (*Test, error)
Update(*Test) (*Test, error)
Delete(TestID int) error
}
type tests struct {
client apiClient
}
func newTests(c apiClient) Tests {
return &tests{
client: c,
}
}
func (tt *tests) All() ([]*Test, error) {
resp, err := tt.client.get("/Tests", nil)
if err != nil {
return nil, err
}
defer resp.Body.Close()
var tests []*Test
err = json.NewDecoder(resp.Body).Decode(&tests)
return tests, err
}
func (tt *tests) AllWithFilter(filterOptions url.Values) ([]*Test, error) {
resp, err := tt.client.get("/Tests", filterOptions)
if err != nil {
return nil, err
}
defer resp.Body.Close()
var tests []*Test
err = json.NewDecoder(resp.Body).Decode(&tests)
return tests, err
}
func (tt *tests) Update(t *Test) (*Test, error) {
resp, err := tt.client.put("/Tests/Update", t.ToURLValues())
if err != nil {
return nil, err
}
defer resp.Body.Close()
var ur updateResponse
err = json.NewDecoder(resp.Body).Decode(&ur)
if err != nil {
return nil, err
}
if !ur.Success {
return nil, &updateError{Issues: ur.Issues, Message: ur.Message}
}
t2 := *t
t2.TestID = ur.InsertID
return &t2, err
}
func (tt *tests) Delete(testID int) error {
resp, err := tt.client.delete("/Tests/Details", url.Values{"TestID": {fmt.Sprint(testID)}})
if err != nil {
return err
}
defer resp.Body.Close()
var dr deleteResponse
err = json.NewDecoder(resp.Body).Decode(&dr)
if err != nil {
return err
}
if !dr.Success {
return &deleteError{Message: dr.Error}
}
return nil
}
func (tt *tests) Detail(testID int) (*Test, error) {
resp, err := tt.client.get("/Tests/Details", url.Values{"TestID": {fmt.Sprint(testID)}})
if err != nil {
return nil, err
}
defer resp.Body.Close()
var dr *detailResponse
err = json.NewDecoder(resp.Body).Decode(&dr)
if err != nil {
return nil, err
}
return dr.test(), nil
}
|