(#35)

Author: callumevans

.github/workflows/offline-tests.yml

@@ -23,7 +23,7 @@ jobs:
 
       - name: Wait for API to be ready
         run: |
-          timeout 60s bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' 127.0.0.1:8080)" != "200" ]]; do sleep 2; done' || false
+          timeout 60s bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' 127.0.0.1:8081)" != "200" ]]; do sleep 2; done' || false
       
       - name: Install Hurl
         run: |

config/terrable_toml.go

@@ -16,11 +16,14 @@ type TerrableToml struct {
 type OfflineConfig struct {
 	File   string `toml:"file"`
 	Module string `toml:"module"`
+	Port   string `toml:"port"`
 }
 
-func ParseTerrableToml(directory string) (*TerrableToml, error) {
+func ParseTerrableToml() (*TerrableToml, error) {
+	workingDir, _ := os.Getwd()
+
 	// Attempt to find a .terrable.toml file in the active directory
-	filePath := filepath.Join(directory, ".terrable.toml")
+	filePath := filepath.Join(workingDir, ".terrable.toml")
 	_, err := os.Stat(filePath)
 
 	if os.IsNotExist(err) {

main.go

@@ -19,11 +19,11 @@ func main() {
 				Name:  "offline",
 				Usage: "",
 				Action: func(cCtx *cli.Context) error {
-					executablePath, _ := os.Getwd()
-					tomlConfig, _ := config.ParseTerrableToml(executablePath)
+					tomlConfig, _ := config.ParseTerrableToml()
 
 					filePath := cCtx.String("file")
 					moduleName := cCtx.String("module")
+					port := cCtx.String("port")
 
 					if filePath == "" {
 						filePath = tomlConfig.Offline.File
@@ -33,7 +33,10 @@ func main() {
 						moduleName = tomlConfig.Offline.Module
 					}
 
-					port := cCtx.String("port")
+					if port == "" {
+						port = tomlConfig.Offline.Port
+					}
+
 					err := offline.Run(filePath, moduleName, port)
 
 					if err != nil {
@@ -59,7 +62,6 @@ func main() {
 						Name:     "port",
 						Aliases:  []string{"p"},
 						Required: false,
-						Value:    "8080",
 						Usage:    "The port number that the local instance of the API should listen for requests at",
 					},
 				},

offline/offline.go

@@ -3,8 +3,8 @@ package offline
 import (
 	"fmt"
 	"log"
+	"net"
 	"net/http"
-	"path/filepath"
 	"strings"
 	"sync"
 
@@ -22,43 +22,86 @@ func Run(filePath string, moduleName string, port string) error {
 
 	// TODO: Validate config
 
-	tomlConfig, err := config.ParseTerrableToml(filepath.Dir(filePath))
+	tomlConfig, err := config.ParseTerrableToml()
 
 	if err != nil {
 		panic(fmt.Errorf("error parsing .terrable.toml file: %w", err))
 	}
 
-	printConfig(*terrableConfig, port)
+	listener, activePort, err := getListener(port)
+
+	if err != nil {
+		return err
+	}
+
+	defer listener.Close()
+
+	printConfig(*terrableConfig, activePort)
 
 	var wg sync.WaitGroup
-	defer wg.Done()
+	defer wg.Wait()
 
 	r := mux.NewRouter()
 
+	// Start compiling and serving each handler
 	for _, handler := range terrableConfig.Handlers {
-		go ServeHandler(&HandlerInstance{
-			handlerConfig: handler,
-			envVars:       tomlConfig.Environment,
-		}, r)
+		wg.Add(1)
+
+		go func(handler config.HandlerMapping) {
+			defer wg.Done()
+
+			ServeHandler(&HandlerInstance{
+				handlerConfig: handler,
+				envVars:       tomlConfig.Environment,
+			}, r)
+		}(handler)
 	}
 
-	fmt.Printf("Starting server on :%s\n", port)
+	fmt.Printf("Starting server on :%d\n", activePort)
+
+	server := &http.Server{
+		Handler: r,
+	}
 
-	if err := http.ListenAndServe(fmt.Sprintf("127.0.0.1:%s", port), r); err != nil {
-		return fmt.Errorf("could not start server on port %s. Error: %s", port, err.Error())
+	if err := server.Serve(listener); err != nil && err != http.ErrServerClosed {
+		return fmt.Errorf("could not start server on port %d. Error: %w", activePort, err)
 	}
 
 	return nil
 }
 
-func printConfig(config config.TerrableConfig, port string) {
+func getListener(port string) (net.Listener, int, error) {
+	var specificPortDesired bool = (port != "")
+
+	if port == "" {
+		port = "8080"
+	}
+
+	listener, err := net.Listen("tcp", fmt.Sprintf("127.0.0.1:%s", port))
+
+	if err != nil {
+		if specificPortDesired {
+			return nil, 0, fmt.Errorf("could not start server on specified port %s: %w", port, err)
+		}
+
+		// Try with a random free-port
+		listener, err = net.Listen("tcp", "127.0.0.1:0")
+		if err != nil {
+			return nil, 0, fmt.Errorf("could not start server on any available port: %w", err)
+		}
+	}
+
+	return listener, listener.Addr().(*net.TCPAddr).Port, nil
+}
+
+func printConfig(config config.TerrableConfig, port int) {
 	totalEndpoints := 0
 	printlines := []string{}
 
 	for _, handler := range config.Handlers {
 		for method, path := range handler.Http {
 			totalEndpoints += 1
-			printlines = append(printlines, fmt.Sprintf("   %-*s http://localhost:%s%s\n", 5, method, port, path))
+			printlines = append(printlines, fmt.Sprintf("   %-*s http://localhost:%d%s\n", 5, method, port, path))
 		}
 	}
 

offline/offline_test.go

@@ -38,7 +38,7 @@ func TestPrintConfig(t *testing.T) {
 	os.Stdout = w
 
 	// Call the function
-	printConfig(testConfig, "1234")
+	printConfig(testConfig, 1234)
 
 	// Restore stdout
 	w.Close()

samples/simple/.terrable.toml

@@ -1 +1 @@
-version = 0.1.6
+version = 0.1.7

terrable_build

@@ -0,0 +1,7 @@
+[environment]
+TOML_VAR = "hello toml"
+
+[offline]
+file    = "../samples/simple/simple-api.tf"
+module  = "simple_api"
+port    = "8081"

tests/.terrable.toml

@@ -1,2 +1,2 @@
 go build ../
-./terrable offline -f "../samples/simple/simple-api.tf" -m "simple_api"
+./terrable offline

tests/_start.sh

@@ -1,2 +1,2 @@
-DELETE http://127.0.0.1:8080/
+DELETE http://127.0.0.1:8081/
 HTTP 405

tests/parallel/echo_bad_method.hurl

@@ -1,4 +1,4 @@
-GET http://127.0.0.1:8080/
+GET http://127.0.0.1:8081/
 HTTP 200
 
 [Asserts]

tests/parallel/echo_get.hurl

@@ -1,4 +1,4 @@
-POST http://127.0.0.1:8080/
+POST http://127.0.0.1:8081/
 HTTP 200
 
 [Asserts]

tests/parallel/echo_post.hurl

@@ -1,5 +1,5 @@
-GET http://127.0.0.1:8080/
+GET http://127.0.0.1:8081/
 HTTP 200
 
 [Asserts]
-jsonpath "$.env.TEST_VAR" == "hello world"
+jsonpath "$.env.TOML_VAR" == "hello toml"

tests/parallel/env_vars.hurl

@@ -1,4 +1,4 @@
-GET http://127.0.0.1:8080/?firstQuery=123&secondQuery=hello
+GET http://127.0.0.1:8081/?firstQuery=123&secondQuery=hello
 HTTP 200
 
 [Asserts]

tests/parallel/query_string_parameters.hurl

@@ -1,4 +1,4 @@
-GET http://127.0.0.1:8080/
+GET http://127.0.0.1:8081/
 HTTP 200
 
 [Asserts]

tests/parallel/response_headers.hurl

@@ -1,4 +1,4 @@
-GET http://127.0.0.1:8080/delayed
+GET http://127.0.0.1:8081/delayed
 
 HTTP 200
 [Asserts]