feat(serve): add --static dir to serve static files

Author: lunjon

cli/command.go

@@ -334,12 +334,15 @@ func buildServe(cfg cliConfig) *cobra.Command {
 	port := options.NewPortOption()
 	statusFlagName := "show-status"
 	listFlagName := "list"
+	staticFlagName := "static"
 
 	c := &cobra.Command{
 		Use:   "serve",
 		Short: "Starts an HTTP server on localhost",
-		Long: `Starts an HTTP server on localhost.
-Useful for local testing and debugging.`,
+		Long: `Starts an HTTP server on localhost. Useful for local testing.
+
+If --static DIR is provided the server hosts the files
+in that directory. Otherwise the default API is started (use --list to see endoints).`,
 		Run: func(cmd *cobra.Command, args []string) {
 			flags := cmd.Flags()
 
@@ -350,10 +353,12 @@ Useful for local testing and debugging.`,
 			}
 
 			showStatus, _ := flags.GetBool(statusFlagName)
+			staticRoot, _ := flags.GetString(staticFlagName)
 
 			opts := server.Options{
 				Port:       port.Value(),
 				ShowStatus: showStatus,
+				StaticRoot: staticRoot,
 			}
 
 			server := server.New(opts)
@@ -380,6 +385,7 @@ Useful for local testing and debugging.`,
 	}
 
 	c.Flags().VarP(port, "port", "p", "Port to listen on. Must be valid number in the range 1024-65535.")
+	c.Flags().String(staticFlagName, "", "Serve static files from this directory.")
 	c.Flags().Bool(statusFlagName, false, "Shows current status instead of showing each request.")
 	c.Flags().Bool(listFlagName, false, "List predefined routes.")
 	return c

cli/formatter.go

@@ -10,8 +10,6 @@ import (
 
 	"github.com/lunjon/http/internal/client"
 	"github.com/lunjon/http/internal/history"
-	"github.com/lunjon/http/internal/style"
-	"github.com/lunjon/http/internal/types"
 )
 
 var ResponseComponents = []string{"status", "headers", "body"}
@@ -78,23 +76,11 @@ func readBody(r *http.Response) ([]byte, error) {
 	return buf.Bytes(), err
 }
 
-func (f *textFormatter) addHeaders(w io.Writer, r *http.Response) {
-	taber := types.NewTaber("")
-	for name, value := range headerToMap(r.Header) {
-		n := fmt.Sprintf("%s:", name)
-		v := fmt.Sprint(value)
-		taber.WriteLine(style.Bold.Render(n), v)
-	}
-	fmt.Fprint(w, taber.String())
-}
-
 func (f *textFormatter) FormatHistory([]history.Entry) ([]byte, error) {
 	return nil, nil
 }
 
-type jsonFormatter struct {
-	components []string
-}
+type jsonFormatter struct{}
 
 func (f *jsonFormatter) FormatResponse(r *http.Response) ([]byte, error) {
 	output := struct {

flake.nix

@@ -24,6 +24,19 @@
           vendorHash = "sha256-h27uHmOQMECkGHFsDggGfm+hRohTVYIkvF7zWFdwlTM=";
           doCheck = false;
         };
+        devShells.default = pkgs.mkShell {
+          name = "http";
+          shellHook = ''
+            exec nu
+          '';
+          packages = builtins.attrValues {
+            inherit (pkgs)
+              go
+              gopls
+              go-tools
+              ;
+          };
+        };
       }
     );
 }

internal/server/handler.go

@@ -1,8 +1,10 @@
 package server
 
 import (
+	"math/rand"
 	"net/http"
 	"strconv"
+	"strings"
 	"time"
 )
 
@@ -27,11 +29,18 @@ func (h *requestHandler) handleWithCode(w http.ResponseWriter, r *http.Request)
 	h.ch <- r
 
 	code := r.PathValue("code")
-	status := http.StatusOK
-	if code != "" {
+	var status int
+	if strings.ToLower(code) == "random" {
+		// Get a random status code
+		status = statuses[rnd.Intn(len(statuses))]
+	} else if code != "" {
 		if n, err := strconv.Atoi(code); err == nil {
 			status = n
+		} else {
+			status = http.StatusTeapot
 		}
+	} else {
+		status = http.StatusNotFound
 	}
 
 	w.WriteHeader(status)
@@ -41,3 +50,27 @@ func (h *requestHandler) handleTimeout(w http.ResponseWriter, r *http.Request) {
 	h.ch <- r
 	time.Sleep(time.Minute * 5)
 }
+
+var (
+	rnd      = rand.New(rand.NewSource(time.Now().Unix()))
+	statuses = []int{
+		// 2XX
+		http.StatusOK,
+		http.StatusCreated,
+		http.StatusAccepted,
+		http.StatusNoContent,
+		// 4XX
+		http.StatusUnauthorized,
+		http.StatusPaymentRequired,
+		http.StatusForbidden,
+		http.StatusNotFound,
+		http.StatusMethodNotAllowed,
+		http.StatusConflict,
+		http.StatusTeapot,
+		// 5XX
+		http.StatusInternalServerError,
+		http.StatusNotImplemented,
+		http.StatusServiceUnavailable,
+		http.StatusGatewayTimeout,
+	}
+)

internal/server/server.go

@@ -10,6 +10,7 @@ import (
 type Options struct {
 	Port       uint
 	ShowStatus bool
+	StaticRoot string
 }
 
 type Server struct {
@@ -26,9 +27,16 @@ func New(opts Options) *Server {
 
 	handler := newHandler(ch)
 	mux := http.NewServeMux()
-	mux.HandleFunc("/~/with-status/{code}", handler.handleWithCode)
-	mux.HandleFunc("/~/timeout", handler.handleTimeout)
-	mux.HandleFunc("/", handler.handleDefault)
+
+	if opts.StaticRoot != "" {
+		root := http.Dir(opts.StaticRoot)
+		fs := http.FileServer(root)
+		mux.Handle("/", fs)
+	} else {
+		mux.HandleFunc("/~/status/{code}", handler.handleWithCode)
+		mux.HandleFunc("/~/timeout", handler.handleTimeout)
+		mux.HandleFunc("/", handler.handleDefault)
+	}
 
 	s := &http.Server{
 		Addr:    fmt.Sprintf(":%d", opts.Port),
@@ -68,7 +76,8 @@ func (s *Server) Close() error {
 }
 
 func ListRoutes() {
-	fmt.Println("/~/with-status/{code}   Respond with the given code as status.")
-	fmt.Println("/~/timeout              Endpoint that hangs the request (for 5 min).")
-	fmt.Println("/*                      Echo the request with 200 OK status code.")
+	fmt.Println("/~/status/{code}  Respond with the given code as status.")
+	fmt.Println("                  Send 'random' as the path parameter to get a random status.")
+	fmt.Println("/~/timeout        Endpoint that hangs the request (for 5 min).")
+	fmt.Println("/*                Echo the request with 200 OK status code.")
 }