package iris_test import ( "encoding/json" "encoding/xml" "fmt" "io/ioutil" "net/http" "net/url" "strconv" "strings" "testing" "time" "github.com/iris-contrib/httpexpect" "gopkg.in/kataras/iris.v6" "gopkg.in/kataras/iris.v6/adaptors/httprouter" "gopkg.in/kataras/iris.v6/httptest" ) // White-box testing * func TestContextDoNextStop(t *testing.T) { var context iris.Context ok := false afterStop := false context.Middleware = iris.Middleware{iris.HandlerFunc(func(*iris.Context) { ok = true }), iris.HandlerFunc(func(*iris.Context) { ok = true }), iris.HandlerFunc(func(*iris.Context) { // this will never execute afterStop = true })} context.Do() if context.Pos != 0 { t.Fatalf("Expecting position 0 for context's middleware but we got: %d", context.Pos) } if !ok { t.Fatalf("Unexpected behavior, first context's middleware didn't executed") } ok = false context.Next() if int(context.Pos) != 1 { t.Fatalf("Expecting to have position %d but we got: %d", 1, context.Pos) } if !ok { t.Fatalf("Next context's middleware didn't executed") } context.StopExecution() if context.Pos != 255 { t.Fatalf("Context's StopExecution didn't worked, we expected to have position %d but we got %d", 255, context.Pos) } if !context.IsStopped() { t.Fatalf("Should be stopped") } context.Next() if afterStop { t.Fatalf("We stopped the execution but the next handler was executed") } } type pathParameter struct { Key string Value string } type pathParameters []pathParameter // White-box testing * func TestContextParams(t *testing.T) { context := &iris.Context{} params := pathParameters{ pathParameter{Key: "testkey", Value: "testvalue"}, pathParameter{Key: "testkey2", Value: "testvalue2"}, pathParameter{Key: "id", Value: "3"}, pathParameter{Key: "bigint", Value: "548921854390354"}, } for _, p := range params { context.Set(p.Key, p.Value) } if v := context.Param(params[0].Key); v != params[0].Value { t.Fatalf("Expecting parameter value to be %s but we got %s", params[0].Value, context.Param("testkey")) } if v := context.Param(params[1].Key); v != params[1].Value { t.Fatalf("Expecting parameter value to be %s but we got %s", params[1].Value, context.Param("testkey2")) } if context.ParamsLen() != len(params) { t.Fatalf("Expecting to have %d parameters but we got %d", len(params), context.ParamsLen()) } if vi, err := context.ParamInt(params[2].Key); err != nil { t.Fatalf("Unexpecting error on context's ParamInt while trying to get the integer of the %s", params[2].Value) } else if vi != 3 { t.Fatalf("Expecting to receive %d but we got %d", 3, vi) } if vi, err := context.ParamInt64(params[3].Key); err != nil { t.Fatalf("Unexpecting error on context's ParamInt while trying to get the integer of the %s", params[2].Value) } else if vi != 548921854390354 { t.Fatalf("Expecting to receive %d but we got %d", 548921854390354, vi) } // end-to-end test now, note that we will not test the whole mux here, this happens on http_test.go app := iris.New() app.Adapt(httprouter.New()) expectedParamsStr := "param1=myparam1,param2=myparam2,param3=myparam3afterstatic,anything=/andhere/anything/you/like" app.Get("/path/:param1/:param2/staticpath/:param3/*anything", func(ctx *iris.Context) { paramsStr := ctx.ParamsSentence() ctx.WriteString(paramsStr) }) httptest.New(app, t).GET("/path/myparam1/myparam2/staticpath/myparam3afterstatic/andhere/anything/you/like").Expect().Status(iris.StatusOK).Body().Equal(expectedParamsStr) } func TestContextURLParams(t *testing.T) { app := iris.New() app.Adapt(newTestNativeRouter()) passedParams := map[string]string{"param1": "value1", "param2": "value2"} app.Get("/", func(ctx *iris.Context) { params := ctx.URLParams() ctx.JSON(iris.StatusOK, params) }) e := httptest.New(app, t) e.GET("/").WithQueryObject(passedParams).Expect().Status(iris.StatusOK).JSON().Equal(passedParams) } // hoststring returns the full host, will return the HOST:IP func TestContextHostString(t *testing.T) { app := iris.New(iris.Configuration{VHost: "0.0.0.0:8080"}) app.Adapt(newTestNativeRouter()) app.Get("/", func(ctx *iris.Context) { ctx.WriteString(ctx.Host()) }) app.Get("/wrong", func(ctx *iris.Context) { ctx.WriteString(ctx.Host() + "w") }) e := httptest.New(app, t) e.GET("/").Expect().Status(iris.StatusOK).Body().Equal(app.Config.VHost) e.GET("/wrong").Expect().Body().NotEqual(app.Config.VHost) } // VirtualHostname returns the hostname only, // if the host starts with 127.0.0.1 or localhost it gives the registered hostname part of the listening addr func TestContextVirtualHostName(t *testing.T) { vhost := "mycustomvirtualname.com" app := iris.New(iris.Configuration{VHost: vhost + ":8080"}) app.Adapt(newTestNativeRouter()) app.Get("/", func(ctx *iris.Context) { ctx.WriteString(ctx.VirtualHostname()) }) app.Get("/wrong", func(ctx *iris.Context) { ctx.WriteString(ctx.VirtualHostname() + "w") }) e := httptest.New(app, t) e.GET("/").Expect().Status(iris.StatusOK).Body().Equal(vhost) e.GET("/wrong").Expect().Body().NotEqual(vhost) } func TestContextFormValueString(t *testing.T) { app := iris.New() app.Adapt(httprouter.New()) var k, v string k = "postkey" v = "postvalue" app.Post("/", func(ctx *iris.Context) { ctx.WriteString(k + "=" + ctx.FormValue(k)) }) e := httptest.New(app, t) e.POST("/").WithFormField(k, v).Expect().Status(iris.StatusOK).Body().Equal(k + "=" + v) } func TestContextSubdomain(t *testing.T) { app := iris.New(iris.Configuration{VHost: "mydomain.com:9999"}) app.Adapt(httprouter.New()) //Default.Config.Tester.ListeningAddr = "mydomain.com:9999" // Default.Config.Tester.ExplicitURL = true app.Party("mysubdomain.").Get("/mypath", func(ctx *iris.Context) { ctx.WriteString(ctx.Subdomain()) }) e := httptest.New(app, t) e.GET("/").WithURL("http://mysubdomain.mydomain.com:9999").Expect().Status(iris.StatusNotFound) e.GET("/mypath").WithURL("http://mysubdomain.mydomain.com:9999").Expect().Status(iris.StatusOK).Body().Equal("mysubdomain") // e.GET("http://mysubdomain.mydomain.com:9999").Expect().Status(iris.StatusNotFound) // e.GET("http://mysubdomain.mydomain.com:9999/mypath").Expect().Status(iris.StatusOK).Body().Equal("mysubdomain") } func TestLimitRequestBodySizeMiddleware(t *testing.T) { const maxBodySize = 1 << 20 app := iris.New() app.Adapt(newTestNativeRouter()) // or inside handler: ctx.SetMaxRequestBodySize(int64(maxBodySize)) app.Use(iris.LimitRequestBodySize(maxBodySize)) app.Post("/", func(ctx *iris.Context) { b, err := ioutil.ReadAll(ctx.Request.Body) if len(b) > maxBodySize { // this is a fatal error it should never happened. t.Fatalf("body is larger (%d) than maxBodySize (%d) even if we add the LimitRequestBodySize middleware", len(b), maxBodySize) } // if is larger then send a bad request status if err != nil { ctx.WriteHeader(iris.StatusBadRequest) ctx.Writef(err.Error()) return } ctx.Write(b) }) // UseGlobal should be called at the end used to prepend handlers // app.UseGlobal(iris.LimitRequestBodySize(int64(maxBodySize))) e := httptest.New(app, t) // test with small body e.POST("/").WithBytes([]byte("ok")).Expect().Status(iris.StatusOK).Body().Equal("ok") // test with equal to max body size limit bsent := make([]byte, maxBodySize, maxBodySize) e.POST("/").WithBytes(bsent).Expect().Status(iris.StatusOK).Body().Length().Equal(len(bsent)) // test with larger body sent and wait for the custom response largerBSent := make([]byte, maxBodySize+1, maxBodySize+1) e.POST("/").WithBytes(largerBSent).Expect().Status(iris.StatusBadRequest).Body().Equal("http: request body too large") } type testBinderData struct { Username string Mail string Data []string `form:"mydata" json:"mydata"` } type testBinderXMLData struct { XMLName xml.Name `xml:"info"` FirstAttr string `xml:"first,attr"` SecondAttr string `xml:"second,attr"` Name string `xml:"name" json:"name"` Birth string `xml:"birth" json:"birth"` Stars int `xml:"stars" json:"stars"` } type testBinder struct { //pointer of testBinderDataJSON or testBinderXMLData vp interface{} m iris.Unmarshaler shouldError bool } func (tj *testBinder) Decode(data []byte) error { if tj.shouldError { return fmt.Errorf("Should error") } return tj.m.Unmarshal(data, tj.vp) } func testUnmarshaler(app *iris.Framework, t *testing.T, tb *testBinder, write func(ctx *iris.Context)) *httpexpect.Request { // a very dirty and awful way but here we must test in deep // the custom object's decoder error with the custom // unmarshaler result whenever the testUnmarshaler called. if tb.shouldError == false { tb.shouldError = true testUnmarshaler(app, t, tb, write) tb.shouldError = false } h := func(ctx *iris.Context) { err := ctx.UnmarshalBody(tb.vp, tb.m) if tb.shouldError && err == nil { t.Fatalf("Should prompted for error 'Should error' but not error returned from the custom decoder!") } else if err != nil { t.Fatalf("Error when parsing the body: %s", err.Error()) } if write != nil { write(ctx) } if app.Config.DisableBodyConsumptionOnUnmarshal { rawData, _ := ioutil.ReadAll(ctx.Request.Body) if len(rawData) == 0 { t.Fatalf("Expected data to NOT BE consumed by the previous UnmarshalBody call but we got empty body.") } } } app.Post("/bind_req_body", h) e := httptest.New(app, t) return e.POST("/bind_req_body") } // same as DecodeBody // JSON, XML by DecodeBody passing the default unmarshalers func TestContextBinders(t *testing.T) { passed := map[string]interface{}{"Username": "myusername", "Mail": "mymail@iris-go.com", "mydata": []string{"mydata1", "mydata2"}} expectedObject := testBinderData{Username: "myusername", Mail: "mymail@iris-go.com", Data: []string{"mydata1", "mydata2"}} // JSON vJSON := &testBinder{&testBinderData{}, iris.UnmarshalerFunc(json.Unmarshal), false} // XML expectedObj := testBinderXMLData{ XMLName: xml.Name{Local: "info", Space: "info"}, FirstAttr: "this is the first attr", SecondAttr: "this is the second attr", Name: "Iris web framework", Birth: "13 March 2016", Stars: 5758, } expectedAndPassedObjText := `<` + expectedObj.XMLName.Local + ` first="` + expectedObj.FirstAttr + `" second="` + expectedObj.SecondAttr + `">` + expectedObj.Name + `` + expectedObj.Birth + `` + strconv.Itoa(expectedObj.Stars) + `` vXML := &testBinder{&testBinderXMLData{}, iris.UnmarshalerFunc(xml.Unmarshal), false} app := iris.New() app.Adapt(httprouter.New()) testUnmarshaler(app, t, vXML, func(ctx *iris.Context) { ctx.XML(iris.StatusOK, vXML.vp) }). WithText(expectedAndPassedObjText). Expect(). Status(iris.StatusOK). Body().Equal(expectedAndPassedObjText) app2 := iris.New() app2.Adapt(httprouter.New()) testUnmarshaler(app2, t, vJSON, func(ctx *iris.Context) { ctx.JSON(iris.StatusOK, vJSON.vp) }). WithJSON(passed). Expect(). Status(iris.StatusOK). JSON().Object().Equal(expectedObject) // JSON with DisableBodyConsumptionOnUnmarshal app3 := iris.New() app3.Adapt(httprouter.New()) app3.Config.DisableBodyConsumptionOnUnmarshal = true testUnmarshaler(app3, t, vJSON, func(ctx *iris.Context) { ctx.JSON(iris.StatusOK, vJSON.vp) }). WithJSON(passed). Expect(). Status(iris.StatusOK). JSON().Object().Equal(expectedObject) } func TestContextReadForm(t *testing.T) { app := iris.New() app.Adapt(httprouter.New()) app.Post("/form", func(ctx *iris.Context) { obj := testBinderData{} err := ctx.ReadForm(&obj) if err != nil { t.Fatalf("Error when parsing the FORM: %s", err.Error()) } ctx.JSON(iris.StatusOK, obj) }) e := httptest.New(app, t) passed := map[string]interface{}{"Username": "myusername", "Mail": "mymail@iris-go.com", "mydata": url.Values{"[0]": []string{"mydata1"}, "[1]": []string{"mydata2"}}} expectedObject := testBinderData{Username: "myusername", Mail: "mymail@iris-go.com", Data: []string{"mydata1", "mydata2"}} e.POST("/form").WithForm(passed).Expect().Status(iris.StatusOK).JSON().Object().Equal(expectedObject) } func TestRedirectHTTP(t *testing.T) { host := "localhost:" + strconv.Itoa(getRandomNumber(1717, 9281)) app := iris.New(iris.Configuration{VHost: host}) app.Adapt(httprouter.New()) expectedBody := "Redirected to /redirected" app.Get("/redirect", func(ctx *iris.Context) { ctx.Redirect("/redirected") }) app.Get("/redirected", func(ctx *iris.Context) { ctx.Text(iris.StatusOK, "Redirected to "+ctx.Path()) }) e := httptest.New(app, t) e.GET("/redirect").Expect().Status(iris.StatusOK).Body().Equal(expectedBody) } func TestRedirectHTTPS(t *testing.T) { app := iris.New() app.Adapt(httprouter.New()) host := "localhost:" + strconv.Itoa(getRandomNumber(1717, 9281)) expectedBody := "Redirected to /redirected" app.Get("/redirect", func(ctx *iris.Context) { ctx.Redirect("/redirected") }) app.Get("/redirected", func(ctx *iris.Context) { ctx.Text(iris.StatusOK, "Redirected to "+ctx.Path()) }) defer listenTLS(app, host)() e := httptest.New(app, t) e.GET("/redirect").Expect().Status(iris.StatusOK).Body().Equal(expectedBody) } // TestContextRedirectTo tests the named route redirect action func TestContextRedirectTo(t *testing.T) { app := iris.New() app.Adapt(httprouter.New()) h := func(ctx *iris.Context) { ctx.WriteString(ctx.Path()) } app.Get("/mypath", h).ChangeName("my-path") app.Get("/mypostpath", h).ChangeName("my-post-path") app.Get("mypath/with/params/:param1/:param2", func(ctx *iris.Context) { if l := ctx.ParamsLen(); l != 2 { t.Fatalf("Strange error, expecting parameters to be two but we got: %d", l) } ctx.WriteString(ctx.Path()) }).ChangeName("my-path-with-params") app.Get("/redirect/to/:routeName/*anyparams", func(ctx *iris.Context) { routeName := ctx.Param("routeName") var args []interface{} anyparams := ctx.Param("anyparams") if anyparams != "" && anyparams != "/" { params := strings.Split(anyparams[1:], "/") // firstparam/secondparam for _, s := range params { args = append(args, s) } } ctx.RedirectTo(routeName, args...) }) e := httptest.New(app, t) e.GET("/redirect/to/my-path/").Expect().Status(iris.StatusOK).Body().Equal("/mypath") e.GET("/redirect/to/my-post-path/").Expect().Status(iris.StatusOK).Body().Equal("/mypostpath") e.GET("/redirect/to/my-path-with-params/firstparam/secondparam").Expect().Status(iris.StatusOK).Body().Equal("/mypath/with/params/firstparam/secondparam") } func TestContextUserValues(t *testing.T) { app := iris.New() app.Adapt(httprouter.New()) testCustomObjUserValue := struct{ Name string }{Name: "a name"} values := map[string]interface{}{"key1": "value1", "key2": "value2", "key3": 3, "key4": testCustomObjUserValue, "key5": map[string]string{"key": "value"}} app.Get("/test", func(ctx *iris.Context) { for k, v := range values { ctx.Set(k, v) } }, func(ctx *iris.Context) { for k, v := range values { userValue := ctx.Get(k) if userValue != v { t.Fatalf("Expecting user value: %s to be equal with: %#v but got: %#v", k, v, userValue) } if m, isMap := userValue.(map[string]string); isMap { if m["key"] != v.(map[string]string)["key"] { t.Fatalf("Expecting user value: %s to be equal with: %#v but got: %#v", k, v.(map[string]string)["key"], m["key"]) } } else { if userValue != v { t.Fatalf("Expecting user value: %s to be equal with: %#v but got: %#v", k, v, userValue) } } } }) e := httptest.New(app, t) e.GET("/test").Expect().Status(iris.StatusOK) } func TestContextCookieSetGetRemove(t *testing.T) { app := iris.New() app.Adapt(httprouter.New()) key := "mykey" value := "myvalue" app.Get("/set", func(ctx *iris.Context) { ctx.SetCookieKV(key, value) // should return non empty cookies }) app.Get("/set_advanced", func(ctx *iris.Context) { c := &http.Cookie{} c.Name = key c.Value = value c.HttpOnly = true c.Expires = time.Now().Add(time.Duration((60 * 60 * 24 * 7 * 4)) * time.Second) ctx.SetCookie(c) }) app.Get("/get", func(ctx *iris.Context) { ctx.WriteString(ctx.GetCookie(key)) // should return my value }) app.Get("/remove", func(ctx *iris.Context) { ctx.RemoveCookie(key) cookieFound := false ctx.VisitAllCookies(func(k, v string) { cookieFound = true }) if cookieFound { t.Fatalf("Cookie has been found, when it shouldn't!") } ctx.WriteString(ctx.GetCookie(key)) // should return "" }) e := httptest.New(app, t) e.GET("/set").Expect().Status(iris.StatusOK).Cookies().NotEmpty() e.GET("/get").Expect().Status(iris.StatusOK).Body().Equal(value) e.GET("/remove").Expect().Status(iris.StatusOK).Body().Equal("") // test again with advanced set e.GET("/set_advanced").Expect().Status(iris.StatusOK).Cookies().NotEmpty() e.GET("/get").Expect().Status(iris.StatusOK).Body().Equal(value) e.GET("/remove").Expect().Status(iris.StatusOK).Body().Equal("") }