HTTP routes must include a prefix (#75)

Author: callumevans

offline/handler_server.go

@@ -13,8 +13,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/terrable-dev/terrable/utils"
-
 	"github.com/fatih/color"
 	"github.com/google/uuid"
 	"github.com/gorilla/mux"
@@ -40,7 +38,7 @@ func ServeHandler(handlerInstance *HandlerInstance, r *mux.Router) {
 	defer np.Close()
 
 	for method, path := range handlerInstance.handlerConfig.Http {
-		go r.HandleFunc(utils.NormalisePath(path), func(w http.ResponseWriter, r *http.Request) {
+		go r.HandleFunc(path, func(w http.ResponseWriter, r *http.Request) {
 			handlerExecutionMutex.Lock()
 			defer handlerExecutionMutex.Unlock()
 

offline/offline.go

@@ -1,11 +1,13 @@
 package offline
 
 import (
+	"errors"
 	"fmt"
 	"log"
 	"net"
 	"net/http"
 	"os"
+	"strings"
 	"sync"
 
 	"github.com/fatih/color"
@@ -22,10 +24,10 @@ func Run(filePath string, moduleName string, port string) error {
 		log.Fatalf("error running offline: %s", err)
 	}
 
-	// TODO: Validate config
+	err = validateConfig(terrableConfig)
 
 	if err != nil {
-		panic(fmt.Errorf("error parsing .terrable.toml file: %w", err))
+		return fmt.Errorf(`error validating configuration: %s`, err.Error())
 	}
 
 	listener, activePort, err := getListener(port)
@@ -81,6 +83,24 @@ func Run(filePath string, moduleName string, port string) error {
 	return nil
 }
 
+func validateConfig(config *config.TerrableConfig) error {
+	var errs []string
+
+	for _, handler := range config.Handlers {
+		for method, path := range handler.Http {
+			if !strings.HasPrefix(path, "/") {
+				errs = append(errs, fmt.Sprintf("Handler '%s' does not have a '/' prefix for the HTTP route %s '%s'.", handler.Name, method, path))
+			}
+		}
+	}
+
+	if len(errs) > 0 {
+		return errors.New(strings.Join(errs, "\n"))
+	}
+
+	return nil
+}
+
 func getListener(port string) (net.Listener, int, error) {
 	var specificPortDesired bool = (port != "")
 
@@ -133,7 +153,7 @@ func printConfig(config config.TerrableConfig, port int) {
 
 			url := fmt.Sprintf("%s%s",
 				hostColor(fmt.Sprintf("http://localhost:%d", port)),
-				pathColor(utils.NormalisePath(path)))
+				pathColor(path))
 
 			t.AppendRow(table.Row{
 				methodColor(method),

offline/offline_test.go

@@ -25,7 +25,7 @@ func TestPrintConfig(t *testing.T) {
 				Name:   "Handler2",
 				Source: "source2",
 				Http: map[string]string{
-					"GET": "path2",
+					"GET": "/path2",
 				},
 			},
 			{
@@ -71,3 +71,67 @@ func TestPrintConfig(t *testing.T) {
 		}
 	}
 }
+
+func TestValidateConfig(t *testing.T) {
+	tests := []struct {
+		name      string
+		config    *config.TerrableConfig
+		expectErr bool
+	}{
+		{
+			name: "ValidConfig",
+			config: &config.TerrableConfig{
+				Handlers: []config.HandlerMapping{
+					{
+						Name:   "Handler1",
+						Source: "source1",
+						Http: map[string]string{
+							"GET":  "/path1",
+							"POST": "/path1",
+						},
+					},
+					{
+						Name:   "Handler2",
+						Source: "source2",
+						Http: map[string]string{
+							"GET": "/path2",
+						},
+					},
+				},
+			},
+			expectErr: false,
+		},
+		{
+			name: "InvalidConfig",
+			config: &config.TerrableConfig{
+				Handlers: []config.HandlerMapping{
+					{
+						Name:   "Handler1",
+						Source: "source1",
+						Http: map[string]string{
+							"GET":  "path1",
+							"POST": "/path1",
+						},
+					},
+					{
+						Name:   "Handler2",
+						Source: "source2",
+						Http: map[string]string{
+							"GET": "path2",
+						},
+					},
+				},
+			},
+			expectErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := validateConfig(tt.config)
+			if (err != nil) != tt.expectErr {
+				t.Errorf("validateConfig() error = %v, expectErr %v", err, tt.expectErr)
+			}
+		})
+	}
+}

samples/simple/simple-api.tf

@@ -42,22 +42,21 @@ module "simple_api" {
         source = "./src/EchoCallback.ts"
         http = {
           GET = "/echo-callback"
-          PUT = "/echo-callback"
         }
     },
 
     # Echo Handler with no local environment variables
     EchoHandlerNoLocalEnv: {
         source = "./src/Echo.ts"
         http = {
-          GET = "/echo-no-env",
+          GET = "/echo-no-env"
         }
     },
 
     DelayedHandler: {
       source = "./src/Delayed.ts"
         http = {
-          GET = "/delayed",
+          GET = "/delayed"
         }
     },
 
@@ -74,13 +73,13 @@ module "simple_api" {
     CollisionOne: {
       source = "./src/Collision1/Collision.ts"
         http = {
-          GET = "/collision1",
+          GET = "/collision1"
         }
     },
     CollisionTwo: {
       source = "./src/Collision2/Collision.ts"
         http = {
-          GET = "/collision2",
+          GET = "/collision2"
         }
     }
   }

terrable_build

@@ -1 +1 @@
-version = 0.6.2
+version = 0.6.3