Disabled set middleware api by default

Author: tommysitu

core/admin.go

@@ -99,7 +99,7 @@ func getAllHandlers(hoverfly *Hoverfly) []handlers.AdminHandler {
 		&v2.HoverflyHandler{Hoverfly: hoverfly},
 		&v2.HoverflyDestinationHandler{Hoverfly: hoverfly},
 		&v2.HoverflyModeHandler{Hoverfly: hoverfly},
-		&v2.HoverflyMiddlewareHandler{Hoverfly: hoverfly},
+		&v2.HoverflyMiddlewareHandler{Hoverfly: hoverfly, Enabled: hoverfly.Cfg.EnableMiddlewareAPI},
 		&v2.HoverflyUsageHandler{Hoverfly: hoverfly},
 		&v2.HoverflyVersionHandler{Hoverfly: hoverfly},
 		&v2.HoverflyUpstreamProxyHandler{Hoverfly: hoverfly},

core/cmd/hoverfly/main.go

@@ -121,6 +121,9 @@ var (
 	cors          = flag.Bool("cors", false, "Enable CORS support")
 	noImportCheck = flag.Bool("no-import-check", false, "Skip duplicate request check when importing simulations")
 
+	// Feature flags
+	enableMiddlewareAPI = flag.Bool("enable-middleware-api", false, "Enable the admin API to set middleware (PUT /api/v2/hoverfly/middleware)")
+
 	pacFile = flag.String("pac-file", "", "Path to the pac file to be imported on startup")
 
 	clientAuthenticationDestination = flag.String("client-authentication-destination", "", "Regular expression of destination with client authentication")
@@ -403,6 +406,9 @@ func main() {
 		log.Info("Import check has been disabled")
 	}
 
+	// Feature flags
+	cfg.EnableMiddlewareAPI = *enableMiddlewareAPI
+
 	cfg.ClientAuthenticationDestination = *clientAuthenticationDestination
 	cfg.ClientAuthenticationClientCert = *clientAuthenticationClientCert
 	cfg.ClientAuthenticationClientKey = *clientAuthenticationClientKey

core/handlers/v2/hoverfly_middleware_handler.go

@@ -16,6 +16,7 @@ type HoverflyMiddleware interface {
 
 type HoverflyMiddlewareHandler struct {
 	Hoverfly HoverflyMiddleware
+	Enabled  bool
 }
 
 func (this *HoverflyMiddlewareHandler) RegisterRoutes(mux *bone.Mux, am *handlers.AuthHandler) {
@@ -24,10 +25,12 @@ func (this *HoverflyMiddlewareHandler) RegisterRoutes(mux *bone.Mux, am *handler
 		negroni.HandlerFunc(this.Get),
 	))
 
-	mux.Put("/api/v2/hoverfly/middleware", negroni.New(
-		negroni.HandlerFunc(am.RequireTokenAuthentication),
-		negroni.HandlerFunc(this.Put),
-	))
+	if this.Enabled {
+		mux.Put("/api/v2/hoverfly/middleware", negroni.New(
+			negroni.HandlerFunc(am.RequireTokenAuthentication),
+			negroni.HandlerFunc(this.Put),
+		))
+	}
 	mux.Options("/api/v2/hoverfly/middleware", negroni.New(
 		negroni.HandlerFunc(this.Options),
 	))
@@ -60,6 +63,10 @@ func (this *HoverflyMiddlewareHandler) Put(w http.ResponseWriter, req *http.Requ
 }
 
 func (this *HoverflyMiddlewareHandler) Options(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
-	w.Header().Add("Allow", "OPTIONS, GET, PUT")
+	allow := "OPTIONS, GET"
+	if this.Enabled {
+		allow += ", PUT"
+	}
+	w.Header().Add("Allow", allow)
 	handlers.WriteResponse(w, []byte(""))
 }

core/handlers/v2/hoverfly_middleware_handler_test.go

@@ -130,7 +130,7 @@ func Test_HoverflyMiddlewareHandler_Options_GetsOptions(t *testing.T) {
 	RegisterTestingT(t)
 
 	var stubHoverfly HoverflyMiddlewareStub
-	unit := HoverflyMiddlewareHandler{Hoverfly: &stubHoverfly}
+	unit := HoverflyMiddlewareHandler{Hoverfly: &stubHoverfly, Enabled: true}
 
 	request, err := http.NewRequest("OPTIONS", "/api/v2/hoverfly/middleware", nil)
 	Expect(err).To(BeNil())

core/settings.go

@@ -1,11 +1,12 @@
 package hoverfly
 
 import (
-	"github.com/SpectoLabs/hoverfly/core/cors"
 	"os"
 	"strconv"
 	"sync"
 
+	"github.com/SpectoLabs/hoverfly/core/cors"
+
 	"strings"
 
 	"github.com/SpectoLabs/hoverfly/core/middleware"
@@ -52,6 +53,9 @@ type Configuration struct {
 	ResponsesBodyFilesPath           string
 	ResponsesBodyFilesAllowedOrigins []string
 
+	// Feature flags
+	EnableMiddlewareAPI bool
+
 	ProxyControlWG sync.WaitGroup
 
 	mu sync.Mutex

functional-tests/core/api/middleware_api_v2_test.go

@@ -18,7 +18,7 @@ var _ = Describe("/api/v2/hoverfly/middleware", func() {
 
 	BeforeEach(func() {
 		hoverfly = functional_tests.NewHoverfly()
-		hoverfly.Start()
+		hoverfly.Start("-enable-middleware-api")
 	})
 
 	AfterEach(func() {

functional-tests/core/ft_simulate_mode_test.go

@@ -21,7 +21,7 @@ var _ = Describe("When I run Hoverfly in simulate mode", func() {
 
 	BeforeEach(func() {
 		hoverfly = functional_tests.NewHoverfly()
-		hoverfly.Start()
+		hoverfly.Start("-enable-middleware-api")
 		hoverfly.SetMode("simulate")
 	})
 

functional-tests/hoverctl/middleware_test.go

@@ -23,7 +23,7 @@ var _ = Describe("When I use hoverctl", func() {
 
 		BeforeEach(func() {
 			hoverfly = functional_tests.NewHoverfly()
-			hoverfly.Start()
+			hoverfly.Start("-enable-middleware-api")
 			hoverfly.SetMiddleware("ruby", "#!/usr/bin/env ruby\n# encoding: utf-8\nwhile payload = STDIN.gets\nnext unless payload\n\nSTDOUT.puts payload\nend")
 
 			functional_tests.Run(hoverctlBinary, "targets", "update", "local", "--admin-port", hoverfly.GetAdminPort())

functional-tests/hoverctl/status_test.go

@@ -16,7 +16,7 @@ var _ = Describe("when I use hoverctl status", func() {
 
 		BeforeEach(func() {
 			hoverfly = functional_tests.NewHoverfly()
-			hoverfly.Start()
+			hoverfly.Start("-enable-middleware-api")
 
 			functional_tests.Run(hoverctlBinary, "targets", "update", "local", "--admin-port", hoverfly.GetAdminPort())
 		})