Initial main

.travis.yml

@@ -8,7 +8,4 @@ env:
 sudo: required
 dist: trusty
 script:
- - make lint
- - make test-ci-unit
- - make test-ci-integration
- - make m3ctl
+ - make all

Makefile

@@ -42,6 +42,9 @@ services-linux-amd64:
 
 $(foreach SERVICE,$(SERVICES),$(eval $(SERVICE_RULES)))
 
+all: lint test-ci-unit services
+	@echo Made all successfully
+
 lint:
 	@which golint > /dev/null || go get -u github.com/golang/lint/golint
 	$(lint_check)

glide.yaml

@@ -0,0 +1,11 @@
+package: github.com/m3db/m3ctl
+
+import:
+- package: github.com/m3db/m3cluster
+  version: d64606edb68599677fd335ceed86d990d13d2991
+- package: github.com/m3db/m3metrics
+  version: 18bc01a7057d55b78e528236e0e9db297bcd4fa3
+- package: github.com/m3db/m3x
+  version: bd6be18ffb184691512eb442561b16a59c15d797
+- package: github.com/stretchr/testify
+  version: 6fe211e493929a8aac0469b93f28b1d0688a9a3a

handler/common.go

@@ -0,0 +1,60 @@
+// Copyright (c) 2017 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 (
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+const (
+	mimeTypeApplicationJSON = "application/json"
+)
+
+// NotSupportdResponse is data for a method not supported response
+type NotSupportdResponse struct {
+	Error            string
+	MethodName       string
+	URI              string
+	SupportedMethods []string
+}
+
+// MethodNotSupportedResponse writes a method not supported response to the writer
+func MethodNotSupportedResponse(w http.ResponseWriter, r *http.Request, supported []string) error {
+	w.WriteHeader(http.StatusMethodNotAllowed)
+	response := NotSupportdResponse{
+		Error:            "Method not supported",
+		URI:              r.RequestURI,
+		MethodName:       r.Method,
+		SupportedMethods: supported}
+	body, err := json.Marshal(response)
+	if err != nil {
+		return fmt.Errorf("Could not generate MethodNotSupportedResponse for %s - %s", r.Method, r.RequestURI)
+	}
+	w.Write(body)
+	return nil
+}
+
+// InitJSONResponse sets common headers for m3ctl on a ResponseWriter
+func InitJSONResponse(w http.ResponseWriter) {
+	w.Header().Set("Content-Type", mimeTypeApplicationJSON)
+}

handler/common_test.go

@@ -0,0 +1,62 @@
+// 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 (
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestMethodNotSupportedResponse(t *testing.T) {
+	rr := httptest.NewRecorder()
+	goodMethods := []string{http.MethodDelete, http.MethodConnect}
+
+	// Create a request to pass to our handler. We don't have any query parameters for now, so we'll
+	// pass 'nil' as the third parameter.
+	req := http.Request{Method: "GET", RequestURI: "/badMethod"}
+
+	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		MethodNotSupportedResponse(w, r, goodMethods)
+	})
+
+	// Our handlers satisfy http.Handler, so we can call their ServeHTTP method
+	// directly and pass in our Request and ResponseRecorder.
+	handler.ServeHTTP(rr, &req)
+
+	rawResult := make([]byte, rr.Body.Len())
+	_, err := rr.Body.Read(rawResult)
+	require.NoError(t, err, "Encountered error parsing reponse")
+
+	var actualResult NotSupportdResponse
+	json.Unmarshal(rawResult, &actualResult)
+
+	expectedResult := NotSupportdResponse{
+		Error:            "Method not supported",
+		URI:              "/badMethod",
+		MethodName:       "GET",
+		SupportedMethods: goodMethods,
+	}
+
+	require.Equal(t, rr.Code, http.StatusMethodNotAllowed)
+	require.Equal(t, expectedResult, actualResult)
+}

handler/controller.go

@@ -0,0 +1,29 @@
+// Copyright (c) 2017 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 "net/http"
+
+// Controller defines functions around a controllable entity
+type Controller interface {
+	// Registers the handlers for this controll with the given ServeMux
+	RegisterHandlers(*http.ServeMux) error
+}