mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
FN_ prefix env vars
this adds `FN_` in front of env vars that we are injecting into calls, for namespacing reasons. this will break code relying on the current variables but if we want to do this, the chance is now really. alternatively, we could maintain both the old and new for a short period of time to ease the adjustment (speak now...). updated the docs, as well. this also adds tests for the notoriously finicky configuration of the env vars and headers when setting up a call. this won't test the container / request for the call is actually receiving them, but it's a decent start and will yell loudly enough upon formatting breakage. added back FXLB_WAIT to a couple places so the lb can ride again one thing for feedback: headers are a bit confusing at the moment (not from this change, but that behavior is kept here for now), we've a chance to fix them. currently, headers in the request __are not__ prefixed with `FN_HEADER_`, i.e. 'hot'+sync containers will receive `Content-Length` in the http request headers, yet a 'cold' container from the same request would receive `FN_HEADER_Content-Length` in its environment. This is additionally confusing because if this function were hot+async, it would receive `FN_HEADER_Content-Length` in the headers, where just changing it to sync goes back to `Content-Length`. If that was confusing, then point made ;) I propose to remove the `FN_HEADER_` prefix for request headers in the environment, so that the request headers and env will match, as request headers already are of this format (not prefixed). please lmk thoughts here Would be fine with going back to the 'plain' vars too, then this patch will mostly just be adding tests and changing `FN_FORMAT` to `FORMAT`. obviously, from the examples, it's a bit ingrained now. anyway, entirely up to y'all.
This commit is contained in:
Reed Allman
268
api/agent/agent_test.go
Normal file
268
api/agent/agent_test.go
Normal file
@@ -0,0 +1,268 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/fnproject/fn/api/datastore"
|
||||
"github.com/fnproject/fn/api/models"
|
||||
"github.com/fnproject/fn/api/mqs"
|
||||
)
|
||||
|
||||
func TestCallConfigurationRequest(t *testing.T) {
|
||||
appName := "myapp"
|
||||
path := "/sleeper"
|
||||
image := "fnproject/sleeper"
|
||||
const timeout = 1
|
||||
const idleTimeout = 20
|
||||
const memory = 256
|
||||
|
||||
cfg := models.Config{"APP_VAR": "FOO"}
|
||||
rCfg := models.Config{"ROUTE_VAR": "BAR"}
|
||||
|
||||
ds := datastore.NewMockInit(
|
||||
[]*models.App{
|
||||
{Name: appName, Config: cfg},
|
||||
},
|
||||
[]*models.Route{
|
||||
{
|
||||
Config: rCfg,
|
||||
Path: path,
|
||||
AppName: appName,
|
||||
Image: image,
|
||||
Type: "sync",
|
||||
Format: "default",
|
||||
Timeout: timeout,
|
||||
IdleTimeout: idleTimeout,
|
||||
Memory: memory,
|
||||
},
|
||||
}, nil,
|
||||
)
|
||||
|
||||
a := New(ds, new(mqs.Mock))
|
||||
defer a.Close()
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
method := "GET"
|
||||
url := "http://127.0.0.1:8080/r/" + appName + path
|
||||
payload := "payload"
|
||||
contentLength := strconv.Itoa(len(payload))
|
||||
req, err := http.NewRequest(method, url, strings.NewReader(payload))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
req.Header.Add("MYREALHEADER", "FOOLORD")
|
||||
req.Header.Add("MYREALHEADER", "FOOPEASANT")
|
||||
req.Header.Add("Content-Length", contentLength)
|
||||
|
||||
call, err := a.GetCall(
|
||||
WithWriter(w), // XXX (reed): order matters [for now]
|
||||
FromRequest(appName, path, req),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
model := call.Model()
|
||||
|
||||
// make sure the values are all set correctly
|
||||
if model.ID == "" {
|
||||
t.Fatal("model does not have id, GetCall should assign id")
|
||||
}
|
||||
if model.AppName != appName {
|
||||
t.Fatal("app name mismatch", model.AppName, appName)
|
||||
}
|
||||
if model.Path != path {
|
||||
t.Fatal("path mismatch", model.Path, path)
|
||||
}
|
||||
if model.Image != image {
|
||||
t.Fatal("image mismatch", model.Image, image)
|
||||
}
|
||||
if model.Type != "sync" {
|
||||
t.Fatal("route type mismatch", model.Type)
|
||||
}
|
||||
if model.Priority == nil {
|
||||
t.Fatal("GetCall should make priority non-nil so that async works because for whatever reason some clowns plumbed it all over the mqs even though the user can't specify it gg")
|
||||
}
|
||||
if model.Timeout != timeout {
|
||||
t.Fatal("timeout mismatch", model.Timeout, timeout)
|
||||
}
|
||||
if model.IdleTimeout != idleTimeout {
|
||||
t.Fatal("idle timeout mismatch", model.IdleTimeout, idleTimeout)
|
||||
}
|
||||
if time.Time(model.CreatedAt).IsZero() {
|
||||
t.Fatal("GetCall should stamp CreatedAt, got nil timestamp")
|
||||
}
|
||||
if model.URL != url {
|
||||
t.Fatal("url mismatch", model.URL, url)
|
||||
}
|
||||
if model.Method != method {
|
||||
t.Fatal("method mismatch", model.Method, method)
|
||||
}
|
||||
if model.Payload != "" { // NOTE: this is expected atm
|
||||
t.Fatal("GetCall FromRequest should not fill payload, got non-empty payload", model.Payload)
|
||||
}
|
||||
|
||||
expectedBase := map[string]string{
|
||||
"FN_FORMAT": "default",
|
||||
"FN_APP_NAME": appName,
|
||||
"FN_ROUTE": path,
|
||||
"FN_MEMORY_MB": strconv.Itoa(memory),
|
||||
"APP_VAR": "FOO",
|
||||
"ROUTE_VAR": "BAR",
|
||||
}
|
||||
|
||||
expectedEnv := make(map[string]string)
|
||||
for k, v := range expectedBase {
|
||||
expectedEnv[k] = v
|
||||
}
|
||||
|
||||
for k, v := range expectedBase {
|
||||
if v2 := model.BaseEnv[k]; v2 != v {
|
||||
t.Fatal("base var mismatch", k, v, v2, model.BaseEnv)
|
||||
}
|
||||
delete(expectedBase, k)
|
||||
}
|
||||
|
||||
if len(expectedBase) > 0 {
|
||||
t.Fatal("got extra vars in base env set, add me to tests ;)", expectedBase)
|
||||
}
|
||||
|
||||
expectedEnv["FN_CALL_ID"] = model.ID
|
||||
expectedEnv["FN_METHOD"] = method
|
||||
expectedEnv["FN_REQUEST_URL"] = url
|
||||
|
||||
// do this before the "real" headers get sucked in cuz they are formatted differently
|
||||
expectedHeaders := make(http.Header)
|
||||
for k, v := range expectedEnv {
|
||||
expectedHeaders.Add(k, v)
|
||||
}
|
||||
|
||||
// from the request headers (look different in env than in req.Header, idk, up to user anger)
|
||||
// req headers down cases things
|
||||
expectedEnv["FN_HEADER_Myrealheader"] = "FOOLORD, FOOPEASANT"
|
||||
expectedEnv["FN_HEADER_Content_Length"] = contentLength
|
||||
|
||||
for k, v := range expectedEnv {
|
||||
if v2 := model.EnvVars[k]; v2 != v {
|
||||
t.Fatal("env var mismatch", k, v, v2, model.EnvVars)
|
||||
}
|
||||
delete(expectedEnv, k)
|
||||
}
|
||||
|
||||
if len(expectedEnv) > 0 {
|
||||
t.Fatal("got extra vars in base env set, add me to tests ;)", expectedBase)
|
||||
}
|
||||
|
||||
expectedHeaders.Add("MYREALHEADER", "FOOLORD")
|
||||
expectedHeaders.Add("MYREALHEADER", "FOOPEASANT")
|
||||
expectedHeaders.Add("Content-Length", contentLength)
|
||||
|
||||
for k, vs := range req.Header {
|
||||
for i, v := range expectedHeaders[k] {
|
||||
if i >= len(vs) || vs[i] != v {
|
||||
t.Fatal("header mismatch", k, vs)
|
||||
}
|
||||
}
|
||||
delete(expectedHeaders, k)
|
||||
}
|
||||
|
||||
if len(expectedHeaders) > 0 {
|
||||
t.Fatal("got extra headers, bad")
|
||||
}
|
||||
|
||||
if w.Header()["Fn_call_id"][0] != model.ID {
|
||||
t.Fatal("response writer should have the call id, or else")
|
||||
}
|
||||
|
||||
// TODO check response writer for route headers
|
||||
|
||||
// TODO idk what param even is or how to get them, but need to test those
|
||||
// TODO we should double check the things we're rewriting defaults of, like type, format, timeout, idle_timeout
|
||||
}
|
||||
|
||||
func TestCallConfigurationModel(t *testing.T) {
|
||||
appName := "myapp"
|
||||
path := "/sleeper"
|
||||
image := "fnproject/sleeper"
|
||||
const timeout = 1
|
||||
const idleTimeout = 20
|
||||
const memory = 256
|
||||
method := "GET"
|
||||
url := "http://127.0.0.1:8080/r/" + appName + path
|
||||
payload := "payload"
|
||||
env := map[string]string{
|
||||
"FN_FORMAT": "default",
|
||||
"FN_APP_NAME": appName,
|
||||
"FN_ROUTE": path,
|
||||
"FN_MEMORY_MB": strconv.Itoa(memory),
|
||||
"APP_VAR": "FOO",
|
||||
"ROUTE_VAR": "BAR",
|
||||
"DOUBLE_VAR": "BIZ, BAZ",
|
||||
}
|
||||
|
||||
cm := &models.Call{
|
||||
BaseEnv: env,
|
||||
EnvVars: env,
|
||||
AppName: appName,
|
||||
Path: path,
|
||||
Image: image,
|
||||
Type: "sync",
|
||||
Format: "default",
|
||||
Timeout: timeout,
|
||||
IdleTimeout: idleTimeout,
|
||||
Memory: memory,
|
||||
Payload: payload,
|
||||
URL: url,
|
||||
Method: method,
|
||||
}
|
||||
|
||||
// FromModel doesn't need a datastore, for now...
|
||||
ds := datastore.NewMockInit(nil, nil, nil)
|
||||
|
||||
a := New(ds, new(mqs.Mock))
|
||||
defer a.Close()
|
||||
|
||||
callI, err := a.GetCall(FromModel(cm))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// make sure headers seem reasonable
|
||||
req := callI.(*call).req
|
||||
|
||||
// NOTE these are added as is atm, and if the env vars were comma joined
|
||||
// they are not again here comma separated.
|
||||
expectedHeaders := make(http.Header)
|
||||
for k, v := range env {
|
||||
expectedHeaders.Add(k, v)
|
||||
}
|
||||
|
||||
for k, vs := range req.Header {
|
||||
for i, v := range expectedHeaders[k] {
|
||||
if i >= len(vs) || vs[i] != v {
|
||||
t.Fatal("header mismatch", k, vs)
|
||||
}
|
||||
}
|
||||
delete(expectedHeaders, k)
|
||||
}
|
||||
|
||||
if len(expectedHeaders) > 0 {
|
||||
t.Fatal("got extra headers, bad")
|
||||
}
|
||||
|
||||
var b bytes.Buffer
|
||||
io.Copy(&b, req.Body)
|
||||
|
||||
if b.String() != payload {
|
||||
t.Fatal("expected payload to match, but it was a lie")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user