[api] support zone/env overrides in ns handler

src/query/api/v1/handler/allowed_services.go

@@ -0,0 +1,54 @@
+// Copyright (c) 2019 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package handler
+
+type allowedServicesSet map[string]struct{}
+
+func (a allowedServicesSet) String() []string {
+	s := make([]string, 0, len(a))
+	for key := range a {
+		s = append(s, key)
+	}
+	return s
+}
+
+var (
+	allowedServices = allowedServicesSet{
+		M3DBServiceName:          struct{}{},
+		M3AggregatorServiceName:  struct{}{},
+		M3CoordinatorServiceName: struct{}{},
+	}
+)
+
+// IsAllowedService returns whether a service name is a valid M3 service.
+func IsAllowedService(svc string) bool {
+	_, ok := allowedServices[svc]
+	return ok
+}
+
+// AllowedServices returns the list of valid M3 services.
+func AllowedServices() []string {
+	svcs := make([]string, 0, len(allowedServices))
+	for svc := range allowedServices {
+		svcs = append(svcs, svc)
+	}
+	return svcs
+}

src/query/api/v1/handler/allowed_services_test.go

@@ -0,0 +1,45 @@
+// Copyright (c) 2019 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package handler
+
+import (
+	"sort"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestIsAllowedService(t *testing.T) {
+	assert.True(t, IsAllowedService("m3db"))
+	assert.False(t, IsAllowedService("foo"))
+}
+
+func TestAllowedServices(t *testing.T) {
+	exp := []string{
+		"m3aggregator",
+		"m3coordinator",
+		"m3db",
+	}
+
+	svcs := AllowedServices()
+	sort.Strings(svcs)
+	assert.Equal(t, exp, svcs)
+}

src/query/api/v1/handler/database/create.go

@@ -41,7 +41,7 @@ import (
 	"github.com/m3db/m3/src/query/api/v1/handler/placement"
 	"github.com/m3db/m3/src/query/generated/proto/admin"
 	"github.com/m3db/m3/src/query/util/logging"
-	"github.com/m3db/m3/src/x/net/http"
+	xhttp "github.com/m3db/m3/src/x/net/http"
 
 	"github.com/golang/protobuf/jsonpb"
 	"go.uber.org/zap"
@@ -162,7 +162,7 @@ func (h *createHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		logger = logging.WithContext(ctx)
 	)
 
-	currPlacement, _, err := h.placementGetHandler.Get(placement.M3DBServiceName, nil)
+	currPlacement, _, err := h.placementGetHandler.Get(handler.M3DBServiceName, nil)
 	if err != nil {
 		logger.Error("unable to get placement", zap.Error(err))
 		xhttp.Error(w, err, http.StatusInternalServerError)
@@ -205,7 +205,8 @@ func (h *createHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	nsRegistry, err = h.namespaceAddHandler.Add(namespaceRequest)
+	opts := handler.NewServiceOptions(handler.M3DBServiceName, r.Header, nil)
+	nsRegistry, err = h.namespaceAddHandler.Add(namespaceRequest, opts)
 	if err != nil {
 		logger.Error("unable to add namespace", zap.Error(err))
 		xhttp.Error(w, err, http.StatusInternalServerError)
@@ -241,7 +242,7 @@ func (h *createHandler) maybeInitPlacement(
 		// If we're here then there is no existing placement, so just create it. This is safe because in
 		// the case where a placement did not already exist, the parse function above validated that we
 		// have all the required information to create a placement.
-		newPlacement, err := h.placementInitHandler.Init(placement.M3DBServiceName, r, placementRequest)
+		newPlacement, err := h.placementInitHandler.Init(handler.M3DBServiceName, r, placementRequest)
 		if err != nil {
 			return nil, false, err
 		}

src/query/api/v1/handler/database/create_test.go

@@ -92,6 +92,7 @@ func testLocalType(t *testing.T, providedType string, placementExists bool) {
 	defer ctrl.Finish()
 
 	mockClient, mockKV, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil).AnyTimes()
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 
@@ -245,6 +246,7 @@ func TestLocalTypeWithNumShards(t *testing.T) {
 	defer ctrl.Finish()
 
 	mockClient, mockKV, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil).AnyTimes()
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 
@@ -349,6 +351,7 @@ func TestLocalWithBlockSizeNanos(t *testing.T) {
 	defer ctrl.Finish()
 
 	mockClient, mockKV, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil).AnyTimes()
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 
@@ -454,6 +457,7 @@ func TestLocalWithBlockSizeExpectedSeriesDatapointsPerHour(t *testing.T) {
 	defer ctrl.Finish()
 
 	mockClient, mockKV, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil).AnyTimes()
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 
@@ -571,6 +575,7 @@ func TestClusterTypeHostsPlacementAlreadyExistsHostsProvided(t *testing.T) {
 	defer ctrl.Finish()
 
 	mockClient, _, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(nil, nil).AnyTimes()
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 
@@ -669,6 +674,7 @@ func testClusterTypeHosts(t *testing.T, placementExists bool) {
 	defer ctrl.Finish()
 
 	mockClient, mockKV, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil).AnyTimes()
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 
@@ -810,6 +816,8 @@ func TestClusterTypeHostsWithIsolationGroup(t *testing.T) {
 	defer ctrl.Finish()
 
 	mockClient, mockKV, mockPlacementService := SetupDatabaseTest(t, ctrl)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil)
+
 	createHandler := NewCreateHandler(mockClient, config.Configuration{}, testDBCfg)
 	w := httptest.NewRecorder()
 

src/query/api/v1/handler/headers.go

@@ -32,4 +32,18 @@ const (
 
 	// DeprecatedHeader is the M3 deprecated header
 	DeprecatedHeader = "M3-Deprecated"
+
+	// DefaultServiceEnvironment is the default service ID environment.
+	DefaultServiceEnvironment = "default_env"
+	// DefaultServiceZone is the default service ID zone.
+	DefaultServiceZone = "embedded"
+
+	// HeaderClusterEnvironmentName is the header used to specify the environment
+	// name.
+	HeaderClusterEnvironmentName = "Cluster-Environment-Name"
+	// HeaderClusterZoneName is the header used to specify the zone name.
+	HeaderClusterZoneName = "Cluster-Zone-Name"
+	// HeaderDryRun is the header used to specify whether this should be a dry
+	// run.
+	HeaderDryRun = "Dry-Run"
 )

src/query/api/v1/handler/namespace/add.go

@@ -28,6 +28,7 @@ import (
 	"path"
 
 	clusterclient "github.com/m3db/m3/src/cluster/client"
+	"github.com/m3db/m3/src/cluster/kv"
 	nsproto "github.com/m3db/m3/src/dbnode/generated/proto/namespace"
 	"github.com/m3db/m3/src/dbnode/storage/namespace"
 	"github.com/m3db/m3/src/query/api/v1/handler"
@@ -72,7 +73,8 @@ func (h *AddHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	nsRegistry, err := h.Add(md)
+	opts := handler.NewServiceOptions("kv", r.Header, nil)
+	nsRegistry, err := h.Add(md, opts)
 	if err != nil {
 		if err == errNamespaceExists {
 			logger.Error("namespace already exists", zap.Error(err))
@@ -108,15 +110,19 @@ func (h *AddHandler) parseRequest(r *http.Request) (*admin.NamespaceAddRequest,
 }
 
 // Add adds a namespace.
-func (h *AddHandler) Add(addReq *admin.NamespaceAddRequest) (nsproto.Registry, error) {
+func (h *AddHandler) Add(addReq *admin.NamespaceAddRequest, opts handler.ServiceOptions) (nsproto.Registry, error) {
 	var emptyReg = nsproto.Registry{}
 
 	md, err := namespace.ToMetadata(addReq.Name, addReq.Options)
 	if err != nil {
 		return emptyReg, fmt.Errorf("unable to get metadata: %v", err)
 	}
 
-	store, err := h.client.KV()
+	kvOpts := kv.NewOverrideOptions().
+		SetEnvironment(opts.ServiceEnvironment).
+		SetZone(opts.ServiceZone)
+
+	store, err := h.client.Store(kvOpts)
 	if err != nil {
 		return emptyReg, err
 	}

src/query/api/v1/handler/namespace/add_test.go

@@ -64,6 +64,7 @@ const testAddJSON = `
 func TestNamespaceAddHandler(t *testing.T) {
 	mockClient, mockKV, _ := SetupNamespaceTest(t)
 	addHandler := NewAddHandler(mockClient)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil)
 
 	// Error case where required fields are not set
 	w := httptest.NewRecorder()
@@ -108,6 +109,7 @@ func TestNamespaceAddHandler(t *testing.T) {
 func TestNamespaceAddHandler_Conflict(t *testing.T) {
 	mockClient, mockKV, ctrl := SetupNamespaceTest(t)
 	addHandler := NewAddHandler(mockClient)
+	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil)
 
 	// Ensure adding an existing namespace returns 409
 	req := httptest.NewRequest("POST", "/namespace", strings.NewReader(testAddJSON))