add start option for hoverctl to enable middleware api

Author: tommysitu

functional-tests/hoverctl/start_test.go

@@ -1,9 +1,12 @@
 package hoverctl_suite
 
 import (
-	"github.com/antonholmquist/jason"
+	"io"
 	"io/ioutil"
 	"strconv"
+	"strings"
+
+	"github.com/antonholmquist/jason"
 
 	"github.com/SpectoLabs/hoverfly/core/authentication/backends"
 	"github.com/SpectoLabs/hoverfly/functional-tests"
@@ -327,7 +330,21 @@ var _ = Describe("hoverctl `start`", func() {
 		})
 	})
 
-	Context("with pac-file", func() {
+ Context("with enable-middleware-api", func() {
+ 		It("enables middleware API when flag is provided", func() {
+ 			output := functional_tests.Run(hoverctlBinary, "start", "--enable-middleware-api")
+ 			Expect(output).To(ContainSubstring("Hoverfly is now running"))
+
+ 			// Attempt to set middleware via Admin API should be allowed (200)
+ 			req := sling.New().Put("http://localhost:8888/api/v2/hoverfly/middleware")
+ 			// Use a valid echo middleware that reads from STDIN and outputs the JSON payload unchanged
+ 			req.Body(strings.NewReader(`{"binary":"ruby", "script":"#!/usr/bin/env ruby\n# encoding: utf-8\nwhile payload = STDIN.gets\nnext unless payload\n\nSTDOUT.puts payload\nend"}`))
+ 			res := functional_tests.DoRequest(req)
+ 			Expect(res.StatusCode).To(Equal(200))
+ 		})
+ 	})
+
+ 	Context("with pac-file", func() {
 		BeforeEach(func() {
 		})
 
@@ -338,7 +355,7 @@ var _ = Describe("hoverctl `start`", func() {
 
 			response := functional_tests.DoRequest(sling.New().Get("http://localhost:8888/api/v2/hoverfly/pac"))
 			Expect(response.StatusCode).To(Equal(200))
-			responseBody, err := ioutil.ReadAll(response.Body)
+			responseBody, err := io.ReadAll(response.Body)
 			Expect(err).To(BeNil())
 			Expect(string(responseBody)).To(ContainSubstring(`function FindProxyForURL(url, host) {`))
 		})

hoverctl/cmd/start.go

@@ -78,6 +78,9 @@ hoverctl configuration file.
 
 		target.Simulations, _ = cmd.Flags().GetStringSlice("import")
 
+		// Feature flags
+		target.EnableMiddlewareAPI, _ = cmd.Flags().GetBool("enable-middleware-api")
+
 		if pacFileLocation, _ := cmd.Flags().GetString("pac-file"); pacFileLocation != "" {
 
 			pacFileData, err := configuration.ReadFile(pacFileLocation)
@@ -199,4 +202,7 @@ func init() {
 	startCmd.Flags().StringSlice("logs-output", []string{}, "Locations for log output, \"console\"(default) or \"file\"")
 	startCmd.Flags().String("logs-file", "", "Log file name. Use \"hoverfly-<target name>.log\" if not provided")
 	startCmd.Flags().String("log-level", "info", "Set log level (panic, fatal, error, warn, info or debug)")
+
+	// Feature flags
+	startCmd.Flags().Bool("enable-middleware-api", false, "Enable the admin API to set middleware (PUT /api/v2/hoverfly/middleware)")
 }

hoverctl/configuration/target.go

@@ -33,6 +33,9 @@ type Target struct {
 	ClientAuthenticationClientKey   string `yaml:",omitempty"`
 	ClientAuthenticationCACert      string `yaml:",omitempty"`
 
+	// Feature flags
+	EnableMiddlewareAPI bool `yaml:",omitempty"`
+
 	AuthEnabled bool
 	Username    string
 	Password    string
@@ -171,5 +174,10 @@ func (this Target) BuildFlags() Flags {
 		}
 	}
 
+	// Feature flags
+	if this.EnableMiddlewareAPI {
+		flags = append(flags, "-enable-middleware-api")
+	}
+
 	return flags
 }