Merge feature pull request

Author: EAddario

README.md

@@ -11,6 +11,8 @@ Parameters:
     	use JSON log format
   -level string
     	one of debug/warn/error/off (default "info")
+  -path string
+    	path to search recursively for X-Erised-Response-File (default ".")
   -port int
     	port to listen (default 8080)
   -read int
@@ -47,6 +49,7 @@ Response behaviour is controlled via custom headers in the http request:
 |X-Erised-Headers|Returns the value(s) in the response header. Values **must** be in a JSON key/value list|
 |X-Erised-Location|Sets the response _Location_ to the new (redirected) URL or path, when 300 ≤ _X-Erised-Status-Code_ < 310|
 |X-Erised-Response-Delay|Number of **milliseconds** to wait before sending response back to client|
+|X-Erised-Response-File|Returns the contents of **file** in the response body. If present, _X-Erised-Data_ is ignored|
 |X-Erised-Status-Code|Sets the HTTP Status Code|
 
 By design, no validation is performed on _X-Erised-Data_ or _X-Erised-Location_.
@@ -89,6 +92,7 @@ NetworkAuthenticationRequired or 511
 Any other value will resolve to 200 (OK)
 
 # Release History
+* v0.5.3 - Add file based responses
 * v0.4.1 - Add route concurrency, update tests and dependencies
 * v0.3.4 - Add [gomega](https://onsi.github.io/gomega/) assertion library, refactor tests to use Ω assertions and minor bug fixes
 * v0.3.0 - Add [goblin](https://github.com/franela/goblin) framework and unit tests

cmd/erised/main.go

@@ -13,19 +13,20 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-const version = "v0.4.1"
+const version = "v0.5.3"
 
 type server struct {
 	mux *http.ServeMux
 	cfg *http.Server
+	pth *string
 }
 
 func init() {
 	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: time.RFC3339})
 	zerolog.SetGlobalLevel(zerolog.InfoLevel)
 }
 
-func newServer(port, read, write, idle int) *server {
+func newServer(port, read, write, idle int, path string) *server {
 	log.Debug().Msg("entering newServer")
 
 	s := &server{}
@@ -37,6 +38,7 @@ func newServer(port, read, write, idle int) *server {
 		WriteTimeout: time.Duration(write) * time.Second,
 		IdleTimeout:  time.Duration(idle) * time.Second,
 	}
+	s.pth = &path
 	s.routes()
 
 	log.Log().
@@ -45,6 +47,7 @@ func newServer(port, read, write, idle int) *server {
 		Str("readTimeout", s.cfg.ReadTimeout.String()).
 		Str("writeTimeout", s.cfg.WriteTimeout.String()).
 		Str("idleTimeout", s.cfg.IdleTimeout.String()).
+		Str("path", path).
 		Msg("erised server running")
 
 	log.Debug().Msg("leaving newServer")
@@ -66,6 +69,7 @@ func setupFlags(f *flag.FlagSet) {
 		fmt.Println("X-Erised-Headers:\t\tReturns the value(s) in the response header(s). Values must be in a JSON array")
 		fmt.Println("X-Erised-Location:\t\tSets the response Location when 300 ≤ X-Erised-Status-Code < 310")
 		fmt.Println("X-Erised-Response-Delay:\tNumber of milliseconds to wait before sending response back to client")
+		fmt.Println("X-Erised-Response-File:\t\tReturns the contents of file in the response body. If present, X-Erised-Data is ignored")
 		fmt.Println("X-Erised-Status-Code:\t\tSets the HTTP Status Code")
 		fmt.Println()
 	}
@@ -82,6 +86,7 @@ func main() {
 	it := flag.Int("idle", 120, "maximum time in seconds to wait for the next request when keep-alive is enabled")
 	lv := flag.String("level", "info", "one of debug/info/warn/error/off")
 	lf := flag.Bool("json", false, "use JSON log format")
+	ph := flag.String("path", ".", "path to search recursively for X-Erised-Response-File")
 
 	setupFlags(flag.CommandLine)
 	flag.Parse()
@@ -103,7 +108,7 @@ func main() {
 		log.Logger = zerolog.New(os.Stderr).With().Timestamp().Logger()
 	}
 
-	srv := newServer(*pt, *rt, *wt, *it)
+	srv := newServer(*pt, *rt, *wt, *it, *ph)
 
 	if err := srv.cfg.ListenAndServe(); err != nil {
 		switch err {

cmd/erised/serverRoutes.go

@@ -4,7 +4,10 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io/ioutil"
 	"net/http"
+	"os"
+	"path/filepath"
 	"strconv"
 	"strings"
 	"time"
@@ -34,6 +37,7 @@ func (s *server) handleLanding() http.HandlerFunc {
 			Str("method", req.Method).
 			Str("host", req.Host).
 			Str("uri", req.RequestURI).
+			Str("searchPath", *s.pth).
 			Msg("handleLanding")
 
 		delay := time.Duration(0)
@@ -64,7 +68,35 @@ func (s *server) handleLanding() http.HandlerFunc {
 		}
 
 		res.WriteHeader(sc)
-		data := req.Header.Get("X-Erised-Data")
+
+		data := ""
+		if fn := req.Header.Get("X-Erised-Response-File"); fn != "" {
+
+			err := filepath.Walk(*s.pth, func(path string, info os.FileInfo, err error) error {
+
+				if err != nil {
+					log.Error().Msg("Invalid path: " + path)
+					return nil
+				}
+
+				if !info.IsDir() && filepath.Base(path) == fn {
+					if ct, err := ioutil.ReadFile(path); err != nil {
+						log.Error().Msg("Unable to open the file: " + path)
+					} else {
+						data = string(ct)
+					}
+				}
+
+				return nil
+			})
+
+			if data == "" || err != nil {
+				log.Error().Msg("File not found: " + fn)
+			}
+
+		} else {
+			data = req.Header.Get("X-Erised-Data")
+		}
 		s.respond(res, enc, delay, data)
 
 		log.Debug().Msg("leaving handleLanding")

cmd/erised/serverRoutes_test.go

@@ -86,11 +86,12 @@ func TestErisedHeadersRoute(t *testing.T) {
 	})
 }
 
-func TestErisedLandingRouteNoWait(t *testing.T) {
+func TestErisedLandingRoute(t *testing.T) {
 	zerolog.SetGlobalLevel(zerolog.Disabled)
 	g := goblin.Goblin(t)
 	RegisterFailHandler(func(m string, _ ...int) { g.Fail(m) })
-	svr := server{}
+	path := "."
+	svr := server{pth: &path}
 
 	g.Describe("Test /", func() {
 		g.It("Should return StatusOK", func() {
@@ -183,6 +184,20 @@ func TestErisedLandingRouteNoWait(t *testing.T) {
 			Ω(res.Header().Get("X-Headers-Two")).Should(Equal("I'm header two"))
 		})
 
+		g.It("Should return serverRoutes_test.json file content in body", func() {
+			exp := `{"Name":"serverRoutes_test"}`
+			res := httptest.NewRecorder()
+			req := httptest.NewRequest(http.MethodGet, "http://localhost:8080/", nil)
+			req.Header.Set("X-Erised-Content-Type", "json")
+			req.Header.Set("X-Erised-Response-File", "serverRoutes_test.json")
+			svr.handleLanding().ServeHTTP(res, req)
+
+			Ω(res).Should(HaveHTTPStatus(http.StatusOK))
+			Ω(res.Header().Get("Content-Type")).Should(Equal("application/json"))
+			Ω(res.Header().Get("Content-Encoding")).Should(Equal("identity"))
+			Ω(res.Body.String()).Should(Equal(exp))
+		})
+
 		g.It("Should not fail", func() {
 			exp := `{"hello":"world"}`
 			res := httptest.NewRecorder()
@@ -201,21 +216,6 @@ func TestErisedLandingRouteNoWait(t *testing.T) {
 			Ω(res.Header().Get("hello")).Should(Equal("world"))
 			Ω(res.Body.String()).Should(Equal(exp))
 		})
-	})
-}
-
-func TestErisedLandingRouteWait(t *testing.T) {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-	g := goblin.Goblin(t)
-	RegisterFailHandler(func(m string, _ ...int) { g.Fail(m) })
-	svr := server{}
-
-	g.Describe("Test /", func() {
-
-		res := httptest.NewRecorder()
-		req := httptest.NewRequest(http.MethodGet, "http://localhost:8080/", nil)
-		req.Header.Set("X-Erised-Response-Delay", "2000")
-		svr.handleLanding().ServeHTTP(res, req)
 
 		g.It("Should wait about 2000ms (±10ms)", func() {
 			res := httptest.NewRecorder()

cmd/erised/serverRoutes_test.json

@@ -0,0 +1 @@
+{"Name":"serverRoutes_test"}