summaryrefslogtreecommitdiffstats
path: root/src/orchestrator/api
diff options
context:
space:
mode:
Diffstat (limited to 'src/orchestrator/api')
-rw-r--r--src/orchestrator/api/api.go38
-rw-r--r--src/orchestrator/api/projecthandler.go105
-rw-r--r--src/orchestrator/api/projecthandler_test.go228
-rw-r--r--src/orchestrator/api/testing.go31
4 files changed, 402 insertions, 0 deletions
diff --git a/src/orchestrator/api/api.go b/src/orchestrator/api/api.go
new file mode 100644
index 00000000..83f17bbe
--- /dev/null
+++ b/src/orchestrator/api/api.go
@@ -0,0 +1,38 @@
+/*
+Copyright 2018 Intel Corporation.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package api
+
+import (
+ "github.com/onap/multicloud-k8s/src/orchestrator/internal/project"
+
+ "github.com/gorilla/mux"
+)
+
+// NewRouter creates a router that registers the various urls that are supported
+func NewRouter(projectClient project.ProjectManager) *mux.Router {
+
+ router := mux.NewRouter().PathPrefix("/v2").Subrouter()
+
+ if projectClient == nil {
+ projectClient = project.NewProjectClient()
+ }
+ projHandler := projectHandler{
+ client: projectClient,
+ }
+ router.HandleFunc("/project", projHandler.createHandler).Methods("POST")
+ router.HandleFunc("/project/{project-name}", projHandler.getHandler).Methods("GET")
+ router.HandleFunc("/project/{project-name}", projHandler.deleteHandler).Methods("DELETE")
+
+ return router
+}
diff --git a/src/orchestrator/api/projecthandler.go b/src/orchestrator/api/projecthandler.go
new file mode 100644
index 00000000..30f21de3
--- /dev/null
+++ b/src/orchestrator/api/projecthandler.go
@@ -0,0 +1,105 @@
+/*
+ * Copyright 2019 Intel Corporation, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package api
+
+import (
+ "encoding/json"
+ "io"
+ "net/http"
+
+ "github.com/onap/multicloud-k8s/src/orchestrator/internal/project"
+
+ "github.com/gorilla/mux"
+)
+
+// Used to store backend implementations objects
+// Also simplifies mocking for unit testing purposes
+type projectHandler struct {
+ // Interface that implements Project operations
+ // We will set this variable with a mock interface for testing
+ client project.ProjectManager
+}
+
+// Create handles creation of the Project entry in the database
+func (h projectHandler) createHandler(w http.ResponseWriter, r *http.Request) {
+ var p project.Project
+
+ err := json.NewDecoder(r.Body).Decode(&p)
+ switch {
+ case err == io.EOF:
+ http.Error(w, "Empty body", http.StatusBadRequest)
+ return
+ case err != nil:
+ http.Error(w, err.Error(), http.StatusUnprocessableEntity)
+ return
+ }
+
+ // Name is required.
+ if p.ProjectName == "" {
+ http.Error(w, "Missing name in POST request", http.StatusBadRequest)
+ return
+ }
+
+ ret, err := h.client.Create(p)
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+
+ w.Header().Set("Content-Type", "application/json")
+ w.WriteHeader(http.StatusCreated)
+ err = json.NewEncoder(w).Encode(ret)
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+}
+
+// Get handles GET operations on a particular Project Name
+// Returns a rb.Project
+func (h projectHandler) getHandler(w http.ResponseWriter, r *http.Request) {
+ vars := mux.Vars(r)
+ name := vars["project-name"]
+
+ ret, err := h.client.Get(name)
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+
+ w.Header().Set("Content-Type", "application/json")
+ w.WriteHeader(http.StatusOK)
+ err = json.NewEncoder(w).Encode(ret)
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+}
+
+// Delete handles DELETE operations on a particular Project Name
+func (h projectHandler) deleteHandler(w http.ResponseWriter, r *http.Request) {
+ vars := mux.Vars(r)
+ name := vars["project-name"]
+
+ err := h.client.Delete(name)
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+
+ w.WriteHeader(http.StatusNoContent)
+}
diff --git a/src/orchestrator/api/projecthandler_test.go b/src/orchestrator/api/projecthandler_test.go
new file mode 100644
index 00000000..2699f2e3
--- /dev/null
+++ b/src/orchestrator/api/projecthandler_test.go
@@ -0,0 +1,228 @@
+/*
+ * Copyright 2018 Intel Corporation, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package api
+
+import (
+ "bytes"
+ "encoding/json"
+ "io"
+ "net/http"
+ "net/http/httptest"
+ "reflect"
+ "testing"
+
+ "github.com/onap/multicloud-k8s/src/orchestrator/internal/project"
+
+ pkgerrors "github.com/pkg/errors"
+)
+
+//Creating an embedded interface via anonymous variable
+//This allows us to make mockDB satisfy the DatabaseConnection
+//interface even if we are not implementing all the methods in it
+type mockProjectManager struct {
+ // Items and err will be used to customize each test
+ // via a localized instantiation of mockProjectManager
+ Items []project.Project
+ Err error
+}
+
+func (m *mockProjectManager) Create(inp project.Project) (project.Project, error) {
+ if m.Err != nil {
+ return project.Project{}, m.Err
+ }
+
+ return m.Items[0], nil
+}
+
+func (m *mockProjectManager) Get(name string) (project.Project, error) {
+ if m.Err != nil {
+ return project.Project{}, m.Err
+ }
+
+ return m.Items[0], nil
+}
+
+func (m *mockProjectManager) Delete(name string) error {
+ return m.Err
+}
+
+func TestProjectCreateHandler(t *testing.T) {
+ testCases := []struct {
+ label string
+ reader io.Reader
+ expected project.Project
+ expectedCode int
+ projectClient *mockProjectManager
+ }{
+ {
+ label: "Missing Body Failure",
+ expectedCode: http.StatusBadRequest,
+ projectClient: &mockProjectManager{},
+ },
+ {
+ label: "Create Project",
+ expectedCode: http.StatusCreated,
+ reader: bytes.NewBuffer([]byte(`{
+ "project-name":"testProject",
+ "description":"Test Project used for unit testing"
+ }`)),
+ expected: project.Project{
+ ProjectName: "testProject",
+ Description: "Test Project used for unit testing",
+ },
+ projectClient: &mockProjectManager{
+ //Items that will be returned by the mocked Client
+ Items: []project.Project{
+ {
+ ProjectName: "testProject",
+ Description: "Test Project used for unit testing",
+ },
+ },
+ },
+ },
+ {
+ label: "Missing Project Name in Request Body",
+ reader: bytes.NewBuffer([]byte(`{
+ "description":"test description"
+ }`)),
+ expectedCode: http.StatusBadRequest,
+ projectClient: &mockProjectManager{},
+ },
+ }
+
+ for _, testCase := range testCases {
+ t.Run(testCase.label, func(t *testing.T) {
+ request := httptest.NewRequest("POST", "/v2/project", testCase.reader)
+ resp := executeRequest(request, NewRouter(testCase.projectClient))
+
+ //Check returned code
+ if resp.StatusCode != testCase.expectedCode {
+ t.Fatalf("Expected %d; Got: %d", testCase.expectedCode, resp.StatusCode)
+ }
+
+ //Check returned body only if statusCreated
+ if resp.StatusCode == http.StatusCreated {
+ got := project.Project{}
+ json.NewDecoder(resp.Body).Decode(&got)
+
+ if reflect.DeepEqual(testCase.expected, got) == false {
+ t.Errorf("createHandler returned unexpected body: got %v;"+
+ " expected %v", got, testCase.expected)
+ }
+ }
+ })
+ }
+}
+
+func TestProjectGetHandler(t *testing.T) {
+
+ testCases := []struct {
+ label string
+ expected project.Project
+ name, version string
+ expectedCode int
+ projectClient *mockProjectManager
+ }{
+ {
+ label: "Get Project",
+ expectedCode: http.StatusOK,
+ expected: project.Project{
+ ProjectName: "testProject",
+ Description: "A Test project for unit testing",
+ },
+ name: "testProject",
+ projectClient: &mockProjectManager{
+ Items: []project.Project{
+ {
+ ProjectName: "testProject",
+ Description: "A Test project for unit testing",
+ },
+ },
+ },
+ },
+ {
+ label: "Get Non-Exiting Project",
+ expectedCode: http.StatusInternalServerError,
+ name: "nonexistingproject",
+ projectClient: &mockProjectManager{
+ Items: []project.Project{},
+ Err: pkgerrors.New("Internal Error"),
+ },
+ },
+ }
+
+ for _, testCase := range testCases {
+ t.Run(testCase.label, func(t *testing.T) {
+ request := httptest.NewRequest("GET", "/v2/project/"+testCase.name, nil)
+ resp := executeRequest(request, NewRouter(testCase.projectClient))
+
+ //Check returned code
+ if resp.StatusCode != testCase.expectedCode {
+ t.Fatalf("Expected %d; Got: %d", testCase.expectedCode, resp.StatusCode)
+ }
+
+ //Check returned body only if statusOK
+ if resp.StatusCode == http.StatusOK {
+ got := project.Project{}
+ json.NewDecoder(resp.Body).Decode(&got)
+
+ if reflect.DeepEqual(testCase.expected, got) == false {
+ t.Errorf("listHandler returned unexpected body: got %v;"+
+ " expected %v", got, testCase.expected)
+ }
+ }
+ })
+ }
+}
+
+func TestProjectDeleteHandler(t *testing.T) {
+
+ testCases := []struct {
+ label string
+ name string
+ version string
+ expectedCode int
+ projectClient *mockProjectManager
+ }{
+ {
+ label: "Delete Project",
+ expectedCode: http.StatusNoContent,
+ name: "testProject",
+ projectClient: &mockProjectManager{},
+ },
+ {
+ label: "Delete Non-Exiting Project",
+ expectedCode: http.StatusInternalServerError,
+ name: "testProject",
+ projectClient: &mockProjectManager{
+ Err: pkgerrors.New("Internal Error"),
+ },
+ },
+ }
+
+ for _, testCase := range testCases {
+ t.Run(testCase.label, func(t *testing.T) {
+ request := httptest.NewRequest("DELETE", "/v2/project/"+testCase.name, nil)
+ resp := executeRequest(request, NewRouter(testCase.projectClient))
+
+ //Check returned code
+ if resp.StatusCode != testCase.expectedCode {
+ t.Fatalf("Expected %d; Got: %d", testCase.expectedCode, resp.StatusCode)
+ }
+ })
+ }
+}
diff --git a/src/orchestrator/api/testing.go b/src/orchestrator/api/testing.go
new file mode 100644
index 00000000..e99ec75b
--- /dev/null
+++ b/src/orchestrator/api/testing.go
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2018 Intel Corporation, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package api
+
+import (
+ "net/http"
+ "net/http/httptest"
+
+ "github.com/gorilla/mux"
+)
+
+func executeRequest(request *http.Request, router *mux.Router) *http.Response {
+ recorder := httptest.NewRecorder()
+ router.ServeHTTP(recorder, request)
+ resp := recorder.Result()
+ return resp
+}