aboutsummaryrefslogtreecommitdiffhomepage
path: root/http/response/html
diff options
context:
space:
mode:
Diffstat (limited to 'http/response/html')
-rw-r--r--http/response/html/doc.go10
-rw-r--r--http/response/html/html.go92
-rw-r--r--http/response/html/html_test.go212
3 files changed, 276 insertions, 38 deletions
diff --git a/http/response/html/doc.go b/http/response/html/doc.go
new file mode 100644
index 0000000..91d3543
--- /dev/null
+++ b/http/response/html/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the MIT license
+// that can be found in the LICENSE file.
+
+/*
+
+Package html contains HTML response functions.
+
+*/
+package html // import "miniflux.app/http/response/html"
diff --git a/http/response/html/html.go b/http/response/html/html.go
index 65a4649..f173fdb 100644
--- a/http/response/html/html.go
+++ b/http/response/html/html.go
@@ -1,6 +1,6 @@
// Copyright 2018 Frédéric Guillot. All rights reserved.
-// Use of this source code is governed by the Apache 2.0
-// license that can be found in the LICENSE file.
+// Use of this source code is governed by the MIT license
+// that can be found in the LICENSE file.
package html // import "miniflux.app/http/response/html"
@@ -11,48 +11,64 @@ import (
"miniflux.app/logger"
)
-// OK writes a standard HTML response.
-func OK(w http.ResponseWriter, r *http.Request, b []byte) {
- w.Header().Set("Content-Type", "text/html; charset=utf-8")
- response.Compress(w, r, b)
+// OK creates a new HTML response with a 200 status code.
+func OK(w http.ResponseWriter, r *http.Request, body interface{}) {
+ builder := response.New(w, r)
+ builder.WithHeader("Content-Type", "text/html; charset=utf-8")
+ builder.WithHeader("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store")
+ builder.WithBody(body)
+ builder.Write()
}
-// ServerError sends a 500 error to the browser.
-func ServerError(w http.ResponseWriter, err error) {
- w.Header().Set("Content-Type", "text/plain; charset=utf-8")
- w.WriteHeader(http.StatusInternalServerError)
-
- if err != nil {
- logger.Error("[Internal Server Error] %v", err)
- w.Write([]byte("Internal Server Error: " + err.Error()))
- } else {
- w.Write([]byte("Internal Server Error"))
- }
+// ServerError sends an internal error to the client.
+func ServerError(w http.ResponseWriter, r *http.Request, err error) {
+ logger.Error("[HTTP:Internal Server Error] %s => %v", r.URL, err)
+
+ builder := response.New(w, r)
+ builder.WithStatus(http.StatusInternalServerError)
+ builder.WithHeader("Content-Type", "text/html; charset=utf-8")
+ builder.WithHeader("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store")
+ builder.WithBody(err)
+ builder.Write()
+}
+
+// BadRequest sends a bad request error to the client.
+func BadRequest(w http.ResponseWriter, r *http.Request, err error) {
+ logger.Error("[HTTP:Bad Request] %s => %v", r.URL, err)
+
+ builder := response.New(w, r)
+ builder.WithStatus(http.StatusBadRequest)
+ builder.WithHeader("Content-Type", "text/html; charset=utf-8")
+ builder.WithHeader("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store")
+ builder.WithBody(err)
+ builder.Write()
}
-// BadRequest sends a 400 error to the browser.
-func BadRequest(w http.ResponseWriter, err error) {
- w.Header().Set("Content-Type", "text/plain; charset=utf-8")
- w.WriteHeader(http.StatusBadRequest)
-
- if err != nil {
- logger.Error("[Bad Request] %v", err)
- w.Write([]byte("Bad Request: " + err.Error()))
- } else {
- w.Write([]byte("Bad Request"))
- }
+// Forbidden sends a forbidden error to the client.
+func Forbidden(w http.ResponseWriter, r *http.Request) {
+ logger.Error("[HTTP:Forbidden] %s", r.URL)
+
+ builder := response.New(w, r)
+ builder.WithStatus(http.StatusForbidden)
+ builder.WithHeader("Content-Type", "text/html; charset=utf-8")
+ builder.WithHeader("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store")
+ builder.WithBody("Access Forbidden")
+ builder.Write()
}
-// NotFound sends a 404 error to the browser.
-func NotFound(w http.ResponseWriter) {
- w.Header().Set("Content-Type", "text/plain; charset=utf-8")
- w.WriteHeader(http.StatusNotFound)
- w.Write([]byte("Page Not Found"))
+// NotFound sends a page not found error to the client.
+func NotFound(w http.ResponseWriter, r *http.Request) {
+ logger.Error("[HTTP:Not Found] %s", r.URL)
+
+ builder := response.New(w, r)
+ builder.WithStatus(http.StatusNotFound)
+ builder.WithHeader("Content-Type", "text/html; charset=utf-8")
+ builder.WithHeader("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store")
+ builder.WithBody("Page Not Found")
+ builder.Write()
}
-// Forbidden sends a 403 error to the browser.
-func Forbidden(w http.ResponseWriter) {
- w.Header().Set("Content-Type", "text/plain; charset=utf-8")
- w.WriteHeader(http.StatusForbidden)
- w.Write([]byte("Access Forbidden"))
+// Redirect redirects the user to another location.
+func Redirect(w http.ResponseWriter, r *http.Request, uri string) {
+ http.Redirect(w, r, uri, http.StatusFound)
}
diff --git a/http/response/html/html_test.go b/http/response/html/html_test.go
new file mode 100644
index 0000000..91c2b74
--- /dev/null
+++ b/http/response/html/html_test.go
@@ -0,0 +1,212 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the MIT license
+// that can be found in the LICENSE file.
+
+package html // import "miniflux.app/http/response/html"
+
+import (
+ "errors"
+ "net/http"
+ "net/http/httptest"
+ "testing"
+)
+
+func TestOKResponse(t *testing.T) {
+ r, err := http.NewRequest("GET", "/", nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ w := httptest.NewRecorder()
+
+ handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ OK(w, r, "Some HTML")
+ })
+
+ handler.ServeHTTP(w, r)
+ resp := w.Result()
+
+ expectedStatusCode := http.StatusOK
+ if resp.StatusCode != expectedStatusCode {
+ t.Fatalf(`Unexpected status code, got %d instead of %d`, resp.StatusCode, expectedStatusCode)
+ }
+
+ expectedBody := `Some HTML`
+ actualBody := w.Body.String()
+ if actualBody != expectedBody {
+ t.Fatalf(`Unexpected body, got %s instead of %s`, actualBody, expectedBody)
+ }
+
+ headers := map[string]string{
+ "Content-Type": "text/html; charset=utf-8",
+ "Cache-Control": "no-cache, max-age=0, must-revalidate, no-store",
+ }
+
+ for header, expected := range headers {
+ actual := resp.Header.Get(header)
+ if actual != expected {
+ t.Fatalf(`Unexpected header value, got %q instead of %q`, actual, expected)
+ }
+ }
+}
+
+func TestServerErrorResponse(t *testing.T) {
+ r, err := http.NewRequest("GET", "/", nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ w := httptest.NewRecorder()
+
+ handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ ServerError(w, r, errors.New("Some error"))
+ })
+
+ handler.ServeHTTP(w, r)
+ resp := w.Result()
+
+ expectedStatusCode := http.StatusInternalServerError
+ if resp.StatusCode != expectedStatusCode {
+ t.Fatalf(`Unexpected status code, got %d instead of %d`, resp.StatusCode, expectedStatusCode)
+ }
+
+ expectedBody := `Some error`
+ actualBody := w.Body.String()
+ if actualBody != expectedBody {
+ t.Fatalf(`Unexpected body, got %s instead of %s`, actualBody, expectedBody)
+ }
+
+ expectedContentType := "text/html; charset=utf-8"
+ actualContentType := resp.Header.Get("Content-Type")
+ if actualContentType != expectedContentType {
+ t.Fatalf(`Unexpected content type, got %q instead of %q`, actualContentType, expectedContentType)
+ }
+}
+
+func TestBadRequestResponse(t *testing.T) {
+ r, err := http.NewRequest("GET", "/", nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ w := httptest.NewRecorder()
+
+ handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ BadRequest(w, r, errors.New("Some error"))
+ })
+
+ handler.ServeHTTP(w, r)
+ resp := w.Result()
+
+ expectedStatusCode := http.StatusBadRequest
+ if resp.StatusCode != expectedStatusCode {
+ t.Fatalf(`Unexpected status code, got %d instead of %d`, resp.StatusCode, expectedStatusCode)
+ }
+
+ expectedBody := `Some error`
+ actualBody := w.Body.String()
+ if actualBody != expectedBody {
+ t.Fatalf(`Unexpected body, got %s instead of %s`, actualBody, expectedBody)
+ }
+
+ expectedContentType := "text/html; charset=utf-8"
+ actualContentType := resp.Header.Get("Content-Type")
+ if actualContentType != expectedContentType {
+ t.Fatalf(`Unexpected content type, got %q instead of %q`, actualContentType, expectedContentType)
+ }
+}
+
+func TestForbiddenResponse(t *testing.T) {
+ r, err := http.NewRequest("GET", "/", nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ w := httptest.NewRecorder()
+
+ handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ Forbidden(w, r)
+ })
+
+ handler.ServeHTTP(w, r)
+ resp := w.Result()
+
+ expectedStatusCode := http.StatusForbidden
+ if resp.StatusCode != expectedStatusCode {
+ t.Fatalf(`Unexpected status code, got %d instead of %d`, resp.StatusCode, expectedStatusCode)
+ }
+
+ expectedBody := `Access Forbidden`
+ actualBody := w.Body.String()
+ if actualBody != expectedBody {
+ t.Fatalf(`Unexpected body, got %s instead of %s`, actualBody, expectedBody)
+ }
+
+ expectedContentType := "text/html; charset=utf-8"
+ actualContentType := resp.Header.Get("Content-Type")
+ if actualContentType != expectedContentType {
+ t.Fatalf(`Unexpected content type, got %q instead of %q`, actualContentType, expectedContentType)
+ }
+}
+
+func TestNotFoundResponse(t *testing.T) {
+ r, err := http.NewRequest("GET", "/", nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ w := httptest.NewRecorder()
+
+ handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ NotFound(w, r)
+ })
+
+ handler.ServeHTTP(w, r)
+ resp := w.Result()
+
+ expectedStatusCode := http.StatusNotFound
+ if resp.StatusCode != expectedStatusCode {
+ t.Fatalf(`Unexpected status code, got %d instead of %d`, resp.StatusCode, expectedStatusCode)
+ }
+
+ expectedBody := `Page Not Found`
+ actualBody := w.Body.String()
+ if actualBody != expectedBody {
+ t.Fatalf(`Unexpected body, got %s instead of %s`, actualBody, expectedBody)
+ }
+
+ expectedContentType := "text/html; charset=utf-8"
+ actualContentType := resp.Header.Get("Content-Type")
+ if actualContentType != expectedContentType {
+ t.Fatalf(`Unexpected content type, got %q instead of %q`, actualContentType, expectedContentType)
+ }
+}
+
+func TestRedirectResponse(t *testing.T) {
+ r, err := http.NewRequest("GET", "/", nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ w := httptest.NewRecorder()
+
+ handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ Redirect(w, r, "/path")
+ })
+
+ handler.ServeHTTP(w, r)
+
+ resp := w.Result()
+ defer resp.Body.Close()
+
+ expectedStatusCode := http.StatusFound
+ if resp.StatusCode != expectedStatusCode {
+ t.Fatalf(`Unexpected status code, got %d instead of %d`, resp.StatusCode, expectedStatusCode)
+ }
+
+ expectedResult := "/path"
+ actualResult := resp.Header.Get("Location")
+ if actualResult != expectedResult {
+ t.Fatalf(`Unexpected redirect location, got %q instead of %q`, actualResult, expectedResult)
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 10:38:31 +0000