feat(httpx): improve testing using the fakefiller (#649)
This diff extracts the fakefiller inside of internal/ooapi (a currently unused package) into its own package. The fakefiller knows how to fill many fields that are typically shared as data structures across processes. It is not perfect in that it cannot fill logger or http client fields, but still helps with better filling and testing. So, here we're using the fakefiller to improve testing of httpx and, nicely enough, we've already catched a bug in the way in which APIClientTemplate.Build misses to forward Authorization from the original template. Yay! Work part of https://github.com/ooni/probe/issues/1951
This commit is contained in:
Simone Basso
GitHub
parent
eed51978ca
commit
93f084598e
24 changed files with 433 additions and 337 deletions
|
|
@ -1,146 +0,0 @@
|
|||
package ooapi
|
||||
|
||||
import (
|
||||
"math/rand"
|
||||
"reflect"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/ooni/probe-cli/v3/internal/ooapi/apimodel"
|
||||
)
|
||||
|
||||
// fakeFill fills specific data structures with random data. The only
|
||||
// exception to this behaviour is time.Time, which is instead filled
|
||||
// with the current time plus a small random number of seconds.
|
||||
//
|
||||
// We use this implementation to initialize data in our model. The code
|
||||
// has been written with that in mind. It will require some hammering in
|
||||
// case we extend the model with new field types.
|
||||
type fakeFill struct {
|
||||
mu sync.Mutex
|
||||
now func() time.Time
|
||||
rnd *rand.Rand
|
||||
}
|
||||
|
||||
func (ff *fakeFill) getRandLocked() *rand.Rand {
|
||||
if ff.rnd == nil {
|
||||
now := time.Now
|
||||
if ff.now != nil {
|
||||
now = ff.now
|
||||
}
|
||||
ff.rnd = rand.New(rand.NewSource(now().UnixNano()))
|
||||
}
|
||||
return ff.rnd
|
||||
}
|
||||
|
||||
func (ff *fakeFill) getRandomString() string {
|
||||
defer ff.mu.Unlock()
|
||||
ff.mu.Lock()
|
||||
rnd := ff.getRandLocked()
|
||||
n := rnd.Intn(63) + 1
|
||||
// See https://stackoverflow.com/a/31832326
|
||||
var letterRunes = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
|
||||
b := make([]rune, n)
|
||||
for i := range b {
|
||||
b[i] = letterRunes[rnd.Intn(len(letterRunes))]
|
||||
}
|
||||
return string(b)
|
||||
}
|
||||
|
||||
func (ff *fakeFill) getRandomInt64() int64 {
|
||||
defer ff.mu.Unlock()
|
||||
ff.mu.Lock()
|
||||
rnd := ff.getRandLocked()
|
||||
return rnd.Int63()
|
||||
}
|
||||
|
||||
func (ff *fakeFill) getRandomBool() bool {
|
||||
defer ff.mu.Unlock()
|
||||
ff.mu.Lock()
|
||||
rnd := ff.getRandLocked()
|
||||
return rnd.Float64() >= 0.5
|
||||
}
|
||||
|
||||
func (ff *fakeFill) getRandomSmallPositiveInt() int {
|
||||
defer ff.mu.Unlock()
|
||||
ff.mu.Lock()
|
||||
rnd := ff.getRandLocked()
|
||||
return int(rnd.Int63n(8)) + 1 // safe cast
|
||||
}
|
||||
|
||||
func (ff *fakeFill) doFill(v reflect.Value) {
|
||||
for v.Type().Kind() == reflect.Ptr {
|
||||
if v.IsNil() {
|
||||
// if the pointer is nil, allocate an element
|
||||
v.Set(reflect.New(v.Type().Elem()))
|
||||
}
|
||||
// switch to the element
|
||||
v = v.Elem()
|
||||
}
|
||||
switch v.Type().Kind() {
|
||||
case reflect.String:
|
||||
v.SetString(ff.getRandomString())
|
||||
case reflect.Int64:
|
||||
v.SetInt(ff.getRandomInt64())
|
||||
case reflect.Bool:
|
||||
v.SetBool(ff.getRandomBool())
|
||||
case reflect.Struct:
|
||||
if v.Type().String() == "time.Time" {
|
||||
// Implementation note: we treat the time specially
|
||||
// and we avoid attempting to set its fields.
|
||||
v.Set(reflect.ValueOf(time.Now().Add(
|
||||
time.Duration(ff.getRandomSmallPositiveInt()) * time.Second)))
|
||||
return
|
||||
}
|
||||
for idx := 0; idx < v.NumField(); idx++ {
|
||||
ff.doFill(v.Field(idx)) // visit all fields
|
||||
}
|
||||
case reflect.Slice:
|
||||
kind := v.Type().Elem()
|
||||
total := ff.getRandomSmallPositiveInt()
|
||||
for idx := 0; idx < total; idx++ {
|
||||
value := reflect.New(kind) // make a new element
|
||||
ff.doFill(value)
|
||||
v.Set(reflect.Append(v, value.Elem())) // append to slice
|
||||
}
|
||||
case reflect.Map:
|
||||
if v.Type().Key().Kind() != reflect.String {
|
||||
return // not supported
|
||||
}
|
||||
v.Set(reflect.MakeMap(v.Type())) // we need to init the map
|
||||
total := ff.getRandomSmallPositiveInt()
|
||||
kind := v.Type().Elem()
|
||||
for idx := 0; idx < total; idx++ {
|
||||
value := reflect.New(kind)
|
||||
ff.doFill(value)
|
||||
v.SetMapIndex(reflect.ValueOf(ff.getRandomString()), value.Elem())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// fill fills in with random data.
|
||||
func (ff *fakeFill) fill(in interface{}) {
|
||||
ff.doFill(reflect.ValueOf(in))
|
||||
}
|
||||
|
||||
func TestFakeFillAllocatesIntoAPointerToPointer(t *testing.T) {
|
||||
var req *apimodel.URLsRequest
|
||||
ff := &fakeFill{}
|
||||
ff.fill(&req)
|
||||
if req == nil {
|
||||
t.Fatal("we expected non nil here")
|
||||
}
|
||||
}
|
||||
|
||||
func TestFakeFillAllocatesIntoAMapLike(t *testing.T) {
|
||||
var resp apimodel.TorTargetsResponse
|
||||
ff := &fakeFill{}
|
||||
ff.fill(&resp)
|
||||
if resp == nil {
|
||||
t.Fatal("we expected non nil here")
|
||||
}
|
||||
if len(resp) < 1 {
|
||||
t.Fatal("we expected some data here")
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue