55bdebe8b2
* internal/engine/ooapi: auto-generated API client * feat: introduce the callers abstraction * feat: implement API caching on disk * feat: implement cloneWithToken when we require login * feat: implement login * fix: do not cache all APIs * feat: start making space for more tests * feat: implement caching policy * feat: write tests for caching layer * feat: add integration tests and fix some minor issues * feat: write much more unit tests * feat: add some more easy unit tests * feat: add tests that use a local server While there, make sure many fields we care about are OK. * doc: write basic documentation * fix: tweak sentence * doc: improve ooapi documentation * doc(ooapi): other documentation improvements * fix(ooapi): remove caching for most APIs We discussed this topic yesterday with @FedericoCeratto. The only place where we want LRU caching is MeasurementMeta. * feat(ooapi): improve handling of errors during login This was also discussed yesterday with @FedericoCeratto * fix(swaggerdiff_test.go): temporarily disable Before I work on this, I need to tend onto other tasks. * fix(ootest): add one more test case We're going towards 100% coverage of this package, as it ought to be. * feat(ooapi): test cases for when the probe clock is off * fix(ooapi): change test to have 100% unittest coverage * feat: sync server and client APIs definition Companion PR: https://github.com/ooni/api/pull/218 * fix(ooapi): start testing again against API * fix(ooapi): only generate each file once * chore: set version to 3.7.0-alpha While there, make sure we don't always skip a currently failing riseupvpn test, and slightly clarify the readme. * fix(kvstore): less scoped error message
81 lines
2.5 KiB
Go
81 lines
2.5 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"reflect"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
func (d *Descriptor) genNewResponse(sb *strings.Builder) {
|
|
fmt.Fprintf(sb,
|
|
"func (api *%s) newResponse(resp *http.Response, err error) (%s, error) {\n",
|
|
d.APIStructName(), d.ResponseTypeName())
|
|
|
|
fmt.Fprint(sb, "\tif err != nil {\n")
|
|
fmt.Fprint(sb, "\t\treturn nil, err\n")
|
|
fmt.Fprint(sb, "\t}\n")
|
|
fmt.Fprint(sb, "\tif resp.StatusCode == 401 {\n")
|
|
fmt.Fprint(sb, "\t\treturn nil, ErrUnauthorized\n")
|
|
fmt.Fprint(sb, "\t}\n")
|
|
fmt.Fprint(sb, "\tif resp.StatusCode != 200 {\n")
|
|
fmt.Fprint(sb, "\t\treturn nil, newHTTPFailure(resp.StatusCode)\n")
|
|
fmt.Fprint(sb, "\t}\n")
|
|
fmt.Fprint(sb, "\tdefer resp.Body.Close()\n")
|
|
fmt.Fprint(sb, "\treader := io.LimitReader(resp.Body, 4<<20)\n")
|
|
fmt.Fprint(sb, "\tdata, err := ioutil.ReadAll(reader)\n")
|
|
fmt.Fprint(sb, "\tif err != nil {\n")
|
|
fmt.Fprint(sb, "\t\treturn nil, err\n")
|
|
fmt.Fprint(sb, "\t}\n")
|
|
|
|
switch d.ResponseTypeKind() {
|
|
case reflect.Map:
|
|
fmt.Fprintf(sb, "\tout := %s{}\n", d.ResponseTypeName())
|
|
case reflect.Struct:
|
|
fmt.Fprintf(sb, "\tout := &%s{}\n", d.ResponseTypeNameAsStruct())
|
|
}
|
|
|
|
switch d.ResponseTypeKind() {
|
|
case reflect.Map:
|
|
fmt.Fprint(sb, "\tif err := api.jsonCodec().Decode(data, &out); err != nil {\n")
|
|
case reflect.Struct:
|
|
fmt.Fprint(sb, "\tif err := api.jsonCodec().Decode(data, out); err != nil {\n")
|
|
}
|
|
|
|
fmt.Fprint(sb, "\t\treturn nil, err\n")
|
|
fmt.Fprint(sb, "\t}\n")
|
|
|
|
switch d.ResponseTypeKind() {
|
|
case reflect.Map:
|
|
// For rationale, see https://play.golang.org/p/m9-MsTaQ5wt and
|
|
// https://play.golang.org/p/6h-v-PShMk9.
|
|
fmt.Fprint(sb, "\tif out == nil {\n")
|
|
fmt.Fprint(sb, "\t\treturn nil, ErrJSONLiteralNull\n")
|
|
fmt.Fprint(sb, "\t}\n")
|
|
case reflect.Struct:
|
|
// nothing
|
|
}
|
|
fmt.Fprintf(sb, "\treturn out, nil\n")
|
|
fmt.Fprintf(sb, "}\n\n")
|
|
}
|
|
|
|
// GenResponsesGo generates responses.go.
|
|
func GenResponsesGo(file string) {
|
|
var sb strings.Builder
|
|
fmt.Fprint(&sb, "// Code generated by go generate; DO NOT EDIT.\n")
|
|
fmt.Fprintf(&sb, "// %s\n\n", time.Now())
|
|
fmt.Fprint(&sb, "package ooapi\n\n")
|
|
fmt.Fprintf(&sb, "//go:generate go run ./internal/generator -file %s\n\n", file)
|
|
fmt.Fprint(&sb, "import (\n")
|
|
fmt.Fprint(&sb, "\t\"io\"\n")
|
|
fmt.Fprint(&sb, "\t\"io/ioutil\"\n")
|
|
fmt.Fprint(&sb, "\t\"net/http\"\n")
|
|
fmt.Fprint(&sb, "\n")
|
|
fmt.Fprint(&sb, "\t\"github.com/ooni/probe-cli/v3/internal/engine/ooapi/apimodel\"\n")
|
|
fmt.Fprint(&sb, ")\n\n")
|
|
for _, desc := range Descriptors {
|
|
desc.genNewResponse(&sb)
|
|
}
|
|
writefile(file, &sb)
|
|
}
|