From a0ae5c296d8baf3290ffc4973cf96e526cb1efaa Mon Sep 17 00:00:00 2001 From: Alexander Nyquist Date: Fri, 4 Jul 2014 10:12:28 +0200 Subject: [PATCH 1/3] Started writing unit tests --- gin_test.go | 290 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 290 insertions(+) create mode 100644 gin_test.go diff --git a/gin_test.go b/gin_test.go new file mode 100644 index 00000000..eb6ccce0 --- /dev/null +++ b/gin_test.go @@ -0,0 +1,290 @@ +package gin + +import( + "testing" + "html/template" + "net/http" + "net/http/httptest" +) + +// TestRouterGroupGETRouteOK tests that GET route is correctly invoked. +func TestRouterGroupGETRouteOK(t *testing.T) { + req, _ := http.NewRequest("GET", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.GET("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("GET route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + +// TestRouterGroupPOSTRouteOK tests that POST route is correctly invoked. +func TestRouterGroupPOSTRouteOK(t *testing.T) { + req, _ := http.NewRequest("POST", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.POST("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("POST route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + +// TestRouterGroupDELETERouteOK tests that DELETE route is correctly invoked. +func TestRouterGroupDELETERouteOK(t *testing.T) { + req, _ := http.NewRequest("DELETE", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.DELETE("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("DELETE route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + +// TestRouterGroupPATCHRouteOK tests that PATCH route is correctly invoked. +func TestRouterGroupPATCHRouteOK(t *testing.T) { + req, _ := http.NewRequest("PATCH", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.PATCH("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("PATCH route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + +// TestRouterGroupPUTRouteOK tests that PUT route is correctly invoked. +func TestRouterGroupPUTRouteOK(t *testing.T) { + req, _ := http.NewRequest("PUT", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.PUT("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("PUT route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + + +// TestRouterGroupOPTIONSRouteOK tests that OPTIONS route is correctly invoked. +func TestRouterGroupOPTIONSRouteOK(t *testing.T) { + req, _ := http.NewRequest("OPTIONS", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.OPTIONS("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("OPTIONS route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + + +// TestRouterGroupHEADRouteOK tests that HEAD route is correctly invoked. +func TestRouterGroupHEADRouteOK(t *testing.T) { + req, _ := http.NewRequest("HEAD", "/test", nil) + w := httptest.NewRecorder() + passed := false + + r := Default() + r.HEAD("/test", func (c *Context) { + passed = true + }) + + r.ServeHTTP(w, req) + + if passed == false { + t.Errorf("HEAD route handler was not invoked.") + } + + if w.Code != http.StatusOK { + t.Errorf("Status code should be %v, was %d", http.StatusOK, w.Code) + } +} + + +// TestRouterGroup404 tests that 404 is returned for a route that does not exist. +func TestEngine404(t *testing.T) { + req, _ := http.NewRequest("GET", "/", nil) + w := httptest.NewRecorder() + + r := Default() + r.ServeHTTP(w, req) + + if w.Code != http.StatusNotFound { + t.Errorf("Response code should be %v, was %d", http.StatusNotFound, w.Code) + } +} + +// TestContextParamsGet tests that a parameter can be parsed from the URL. +func TestContextParamsByName(t *testing.T) { + req, _ := http.NewRequest("GET", "/test/alexandernyquist", nil) + w := httptest.NewRecorder() + name := "" + + r := Default() + r.GET("/test/:name", func (c *Context) { + name = c.Params.ByName("name") + }) + + r.ServeHTTP(w, req) + + if name != "alexandernyquist" { + t.Errorf("Url parameter was not correctly parsed. Should be alexandernyquist, was %s.", name) + } +} + +// TestContextSetGet tests that a parameter is set correctly on the +// current context and can be retrieved using Get. +func TestContextSetGet(t *testing.T) { + req, _ := http.NewRequest("GET", "/test", nil) + w := httptest.NewRecorder() + + r := Default() + r.GET("/test", func (c *Context) { + // Key should be lazily created + if c.Keys != nil { + t.Error("Keys should be nil") + } + + // Set + c.Set("foo", "bar") + + if v := c.Get("foo"); v != "bar" { + t.Errorf("Value should be bar, was %s", v) + } + }) + + r.ServeHTTP(w, req) +} + +// TestContextJSON tests that the response is serialized as JSON +// and Content-Type is set to application/json +func TestContextJSON(t *testing.T) { + req, _ := http.NewRequest("GET", "/test", nil) + w := httptest.NewRecorder() + + r := Default() + r.GET("/test", func (c *Context) { + c.JSON(200, H{"foo": "bar"}) + }) + + r.ServeHTTP(w, req) + + if w.Body.String() != "{\"foo\":\"bar\"}\n" { + t.Errorf("Response should be {\"foo\":\"bar\"}, was: %s", w.Body.String()) + } + + if w.HeaderMap.Get("Content-Type") != "application/json" { + t.Errorf("Content-Type should be application/json, was %s", w.HeaderMap.Get("Content-Type")) + } +} + +// TestContextHTML tests that the response executes the templates +// and responds with Content-Type set to text/html +func TestContextHTML(t *testing.T) { + req, _ := http.NewRequest("GET", "/test", nil) + w := httptest.NewRecorder() + + r := Default() + r.HTMLTemplates = template.Must(template.New("t").Parse(`Hello {{.Name}}`)) + + type TestData struct { Name string } + + r.GET("/test", func (c *Context) { + c.HTML(200, "t", TestData{"alexandernyquist"}) + }) + + r.ServeHTTP(w, req) + + if w.Body.String() != "Hello alexandernyquist" { + t.Errorf("Response should be Hello alexandernyquist, was: %s", w.Body.String()) + } + + if w.HeaderMap.Get("Content-Type") != "text/html" { + t.Errorf("Content-Type should be text/html, was %s", w.HeaderMap.Get("Content-Type")) + } +} + +// TestContextString tests that the response is returned +// with Content-Type set to text/plain +func TestContextString(t *testing.T) { + req, _ := http.NewRequest("GET", "/test", nil) + w := httptest.NewRecorder() + + r := Default() + r.GET("/test", func (c *Context) { + c.String(200, "test") + }) + + r.ServeHTTP(w, req) + + if w.Body.String() != "test" { + t.Errorf("Response should be test, was: %s", w.Body.String()) + } + + if w.HeaderMap.Get("Content-Type") != "text/plain" { + t.Errorf("Content-Type should be text/plain, was %s", w.HeaderMap.Get("Content-Type")) + } +} \ No newline at end of file From 70593e8dfe8874034a07157eaab169c948b7dd6d Mon Sep 17 00:00:00 2001 From: Alexander Nyquist Date: Fri, 4 Jul 2014 11:01:11 +0200 Subject: [PATCH 2/3] Added test for requests to / when no route for / is defined --- gin_test.go | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/gin_test.go b/gin_test.go index eb6ccce0..e66c5e3d 100644 --- a/gin_test.go +++ b/gin_test.go @@ -29,6 +29,24 @@ func TestRouterGroupGETRouteOK(t *testing.T) { } } +// TestRouterGroupGETNoRootExistsRouteOK tests that a GET requse to root is correctly +// handled (404) when no root route exists. +func TestRouterGroupGETNoRootExistsRouteOK(t *testing.T) { + req, _ := http.NewRequest("GET", "/", nil) + w := httptest.NewRecorder() + + r := Default() + r.GET("/test", func (c *Context) { + }) + + r.ServeHTTP(w, req) + + if w.Code != http.StatusNotFound { + // If this fails, it's because httprouter needs to be updated to at least f78f58a0db + t.Errorf("Status code should be %v, was %d. Location: %s", http.StatusNotFound, w.Code, w.HeaderMap.Get("Location")) + } +} + // TestRouterGroupPOSTRouteOK tests that POST route is correctly invoked. func TestRouterGroupPOSTRouteOK(t *testing.T) { req, _ := http.NewRequest("POST", "/test", nil) From f944cff1a8787874e6165d9ec9cfe119d9db7441 Mon Sep 17 00:00:00 2001 From: msoedov Date: Sat, 5 Jul 2014 18:04:11 +0300 Subject: [PATCH 3/3] Added tests for ServeFiles #37 --- gin_test.go | 116 +++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 93 insertions(+), 23 deletions(-) diff --git a/gin_test.go b/gin_test.go index e66c5e3d..c853b0f4 100644 --- a/gin_test.go +++ b/gin_test.go @@ -1,10 +1,14 @@ package gin -import( - "testing" +import ( "html/template" + "io/ioutil" "net/http" "net/http/httptest" + "os" + "path" + "strings" + "testing" ) // TestRouterGroupGETRouteOK tests that GET route is correctly invoked. @@ -14,7 +18,7 @@ func TestRouterGroupGETRouteOK(t *testing.T) { passed := false r := Default() - r.GET("/test", func (c *Context) { + r.GET("/test", func(c *Context) { passed = true }) @@ -34,9 +38,9 @@ func TestRouterGroupGETRouteOK(t *testing.T) { func TestRouterGroupGETNoRootExistsRouteOK(t *testing.T) { req, _ := http.NewRequest("GET", "/", nil) w := httptest.NewRecorder() - + r := Default() - r.GET("/test", func (c *Context) { + r.GET("/test", func(c *Context) { }) r.ServeHTTP(w, req) @@ -54,7 +58,7 @@ func TestRouterGroupPOSTRouteOK(t *testing.T) { passed := false r := Default() - r.POST("/test", func (c *Context) { + r.POST("/test", func(c *Context) { passed = true }) @@ -76,7 +80,7 @@ func TestRouterGroupDELETERouteOK(t *testing.T) { passed := false r := Default() - r.DELETE("/test", func (c *Context) { + r.DELETE("/test", func(c *Context) { passed = true }) @@ -98,7 +102,7 @@ func TestRouterGroupPATCHRouteOK(t *testing.T) { passed := false r := Default() - r.PATCH("/test", func (c *Context) { + r.PATCH("/test", func(c *Context) { passed = true }) @@ -120,7 +124,7 @@ func TestRouterGroupPUTRouteOK(t *testing.T) { passed := false r := Default() - r.PUT("/test", func (c *Context) { + r.PUT("/test", func(c *Context) { passed = true }) @@ -135,7 +139,6 @@ func TestRouterGroupPUTRouteOK(t *testing.T) { } } - // TestRouterGroupOPTIONSRouteOK tests that OPTIONS route is correctly invoked. func TestRouterGroupOPTIONSRouteOK(t *testing.T) { req, _ := http.NewRequest("OPTIONS", "/test", nil) @@ -143,7 +146,7 @@ func TestRouterGroupOPTIONSRouteOK(t *testing.T) { passed := false r := Default() - r.OPTIONS("/test", func (c *Context) { + r.OPTIONS("/test", func(c *Context) { passed = true }) @@ -158,7 +161,6 @@ func TestRouterGroupOPTIONSRouteOK(t *testing.T) { } } - // TestRouterGroupHEADRouteOK tests that HEAD route is correctly invoked. func TestRouterGroupHEADRouteOK(t *testing.T) { req, _ := http.NewRequest("HEAD", "/test", nil) @@ -166,7 +168,7 @@ func TestRouterGroupHEADRouteOK(t *testing.T) { passed := false r := Default() - r.HEAD("/test", func (c *Context) { + r.HEAD("/test", func(c *Context) { passed = true }) @@ -181,15 +183,14 @@ func TestRouterGroupHEADRouteOK(t *testing.T) { } } - // TestRouterGroup404 tests that 404 is returned for a route that does not exist. func TestEngine404(t *testing.T) { req, _ := http.NewRequest("GET", "/", nil) w := httptest.NewRecorder() - + r := Default() r.ServeHTTP(w, req) - + if w.Code != http.StatusNotFound { t.Errorf("Response code should be %v, was %d", http.StatusNotFound, w.Code) } @@ -202,7 +203,7 @@ func TestContextParamsByName(t *testing.T) { name := "" r := Default() - r.GET("/test/:name", func (c *Context) { + r.GET("/test/:name", func(c *Context) { name = c.Params.ByName("name") }) @@ -220,7 +221,7 @@ func TestContextSetGet(t *testing.T) { w := httptest.NewRecorder() r := Default() - r.GET("/test", func (c *Context) { + r.GET("/test", func(c *Context) { // Key should be lazily created if c.Keys != nil { t.Error("Keys should be nil") @@ -244,7 +245,7 @@ func TestContextJSON(t *testing.T) { w := httptest.NewRecorder() r := Default() - r.GET("/test", func (c *Context) { + r.GET("/test", func(c *Context) { c.JSON(200, H{"foo": "bar"}) }) @@ -268,9 +269,9 @@ func TestContextHTML(t *testing.T) { r := Default() r.HTMLTemplates = template.Must(template.New("t").Parse(`Hello {{.Name}}`)) - type TestData struct { Name string } + type TestData struct{ Name string } - r.GET("/test", func (c *Context) { + r.GET("/test", func(c *Context) { c.HTML(200, "t", TestData{"alexandernyquist"}) }) @@ -292,7 +293,7 @@ func TestContextString(t *testing.T) { w := httptest.NewRecorder() r := Default() - r.GET("/test", func (c *Context) { + r.GET("/test", func(c *Context) { c.String(200, "test") }) @@ -305,4 +306,73 @@ func TestContextString(t *testing.T) { if w.HeaderMap.Get("Content-Type") != "text/plain" { t.Errorf("Content-Type should be text/plain, was %s", w.HeaderMap.Get("Content-Type")) } -} \ No newline at end of file +} + +// TestHandleStaticFile - ensure the static file handles properly +func TestHandleStaticFile(t *testing.T) { + + testRoot, _ := os.Getwd() + + f, err := ioutil.TempFile(testRoot, "") + defer os.Remove(f.Name()) + + if err != nil { + t.Error(err) + } + + filePath := path.Join("/", path.Base(f.Name())) + req, _ := http.NewRequest("GET", filePath, nil) + + f.WriteString("Gin Web Framework") + f.Close() + + w := httptest.NewRecorder() + + r := Default() + r.ServeFiles("/*filepath", http.Dir("./")) + + r.ServeHTTP(w, req) + + if w.Code != 200 { + t.Errorf("Response code should be Ok, was: %s", w.Code) + } + + if w.Body.String() != "Gin Web Framework" { + t.Errorf("Response should be test, was: %s", w.Body.String()) + } + + if w.HeaderMap.Get("Content-Type") != "text/plain; charset=utf-8" { + t.Errorf("Content-Type should be text/plain, was %s", w.HeaderMap.Get("Content-Type")) + } +} + +// TestHandleStaticDir - ensure the root/sub dir handles properly +func TestHandleStaticDir(t *testing.T) { + + req, _ := http.NewRequest("GET", "/", nil) + + w := httptest.NewRecorder() + + r := Default() + r.ServeFiles("/*filepath", http.Dir("./")) + + r.ServeHTTP(w, req) + + if w.Code != 200 { + t.Errorf("Response code should be Ok, was: %s", w.Code) + } + + bodyAsString := w.Body.String() + + if len(bodyAsString) == 0 { + t.Errorf("Got empty body instead of file tree") + } + + if !strings.Contains(bodyAsString, "gin.go") { + t.Errorf("Can't find:`gin.go` in file tree: %s", bodyAsString) + } + + if w.HeaderMap.Get("Content-Type") != "text/html; charset=utf-8" { + t.Errorf("Content-Type should be text/plain, was %s", w.HeaderMap.Get("Content-Type")) + } +}