Add create router version feature

api/api/specs/routers.yaml

@@ -22,7 +22,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project to retrieve routers from"
+          description: "id of the project to retrieve routers from"
           schema:
             <<: *id
           required: true
@@ -45,7 +45,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project to save router"
+          description: "id of the project to save router"
           schema:
             <<: *id
           required: true
@@ -74,7 +74,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project to retrieve routers from"
+          description: "id of the project to retrieve routers from"
           schema:
             <<: *id
           required: true
@@ -101,7 +101,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project of the router"
+          description: "id of the project of the router"
           schema:
             <<: *id
           required: true
@@ -136,7 +136,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project of the router"
+          description: "id of the project of the router"
           schema:
             <<: *id
           required: true
@@ -227,7 +227,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project to retrieve routers from"
+          description: "id of the project to retrieve routers from"
           schema:
             <<: *id
           required: true
@@ -250,6 +250,40 @@ paths:
           description: "Invalid project_id or router_id"
         404:
           description: "No router versions found"
+    post:
+      tags: *tags
+      summary: "Create router version without deploying it"
+      parameters:
+        - in: "path"
+          name: "project_id"
+          description: "id of the project of the router"
+          schema:
+            <<: *id
+          required: true
+        - in: "path"
+          name: "router_id"
+          description: "id of the router to create a new version for"
+          schema:
+            <<: *id
+          required: true
+      requestBody:
+        description: "router configuration to save"
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RouterVersionConfig"
+      responses:
+        200:
+          description: "OK"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RouterVersion"
+        400:
+          description: "Invalid project_id, router_id or router configuration"
+        500:
+          description: "Unable to save configuration"
 
   "/projects/{project_id}/routers/{router_id}/versions/{version}":
     get:
@@ -258,7 +292,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project to retrieve routers from"
+          description: "id of the project to retrieve routers from"
           schema:
             <<: *id
           required: true
@@ -292,7 +326,7 @@ paths:
       parameters:
         - in: "path"
           name: "project_id"
-          description: "project id of the project of the router"
+          description: "id of the project of the router"
           schema:
             <<: *id
           required: true
@@ -565,43 +599,46 @@ components:
           type: "string"
           pattern: '^[a-z0-9-]*$'
         config:
+          $ref: "#/components/schemas/RouterVersionConfig"
+
+    RouterVersionConfig:
+      type: "object"
+      required:
+        - routes
+        - default_route_id
+        - experiment_engine
+        - timeout
+        - log_config
+      properties:
+        routes:
+          type: "array"
+          items:
+            $ref: "#/components/schemas/Route"
+        rules:
+          type: "array"
+          items:
+            $ref: "#/components/schemas/TrafficRule"
+        default_route_id:
+          type: "string"
+        experiment_engine:
+          $ref: "experiment-engines.yaml#/components/schemas/ExperimentConfig"
+        resource_request:
+          $ref: "#/components/schemas/ResourceRequest"
+        timeout:
+          <<: *timeout
+        log_config:
           type: "object"
-          required:
-            - routes
-            - default_route_id
-            - experiment_engine
-            - timeout
-            - log_config
           properties:
-            routes:
-              type: "array"
-              items:
-                $ref: "#/components/schemas/Route"
-            rules:
-              type: "array"
-              items:
-                $ref: "#/components/schemas/TrafficRule"
-            default_route_id:
-              type: "string"
-            experiment_engine:
-              $ref: "experiment-engines.yaml#/components/schemas/ExperimentConfig"
-            resource_request:
-              $ref: "#/components/schemas/ResourceRequest"
-            timeout:
-              <<: *timeout
-            log_config:
-              type: "object"
-              properties:
-                result_logger_type:
-                  $ref: "#/components/schemas/ResultLoggerType"
-                bigquery_config:
-                  $ref: "#/components/schemas/BigQueryConfig"
-                kafka_config:
-                  $ref: "#/components/schemas/KafkaConfig"
-            enricher:
-              $ref: "#/components/schemas/Enricher"
-            ensembler:
-              $ref: "#/components/schemas/RouterEnsemblerConfig"
+            result_logger_type:
+              $ref: "#/components/schemas/ResultLoggerType"
+            bigquery_config:
+              $ref: "#/components/schemas/BigQueryConfig"
+            kafka_config:
+              $ref: "#/components/schemas/KafkaConfig"
+        enricher:
+          $ref: "#/components/schemas/Enricher"
+        ensembler:
+          $ref: "#/components/schemas/RouterEnsemblerConfig"
 
     Route:
       type: "object"

api/e2e/test/00_all_e2e_test.go

@@ -70,6 +70,7 @@ func TestEndToEnd(t *testing.T) {
 		t.Parallel()
 		t.Run("CreateRouter_KnativeServices", TestCreateRouter)
 		t.Run("UpdateRouter_InvalidConfig", TestUpdateRouterInvalidConfig)
+		t.Run("CreateRouterVersion", TestCreateRouterVersion)
 		t.Run("UndeployRouter", TestUndeployRouter)
 		t.Run("DeployRouterVersion_InvalidConfig", TestDeployRouterInvalidConfig)
 		t.Run("DeployRouter", TestDeployValidConfig)

api/e2e/test/03_create_router_version_test.go

@@ -0,0 +1,148 @@
+//go:build e2e
+// +build e2e
+
+package e2e
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"path/filepath"
+	"testing"
+
+	"github.com/tidwall/gjson"
+
+	"github.com/gojek/turing/api/turing/models"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+/*
+Pre:
+testCreateRouter run successfully.
+Steps:
+Create a router version with a valid router config
+b. GET router version 3 > shows status "undeployed"
+c. GET router > config still shows version 1
+d. Test cluster state that all deployments exist
+e. Make a request to the router, validate the response.
+*/
+func TestCreateRouterVersion(t *testing.T) {
+	// Read existing router that MUST have already exists from previous create router e2e test
+	// Router name is assumed to follow this format: e2e-experiment-{{.TestID}}
+	routerName := "e2e-experiment-" + globalTestContext.TestID
+	t.Log(fmt.Sprintf("Retrieving router with name '%s' created from previous test step", routerName))
+	existingRouter, err := getRouterByName(
+		globalTestContext.httpClient, globalTestContext.APIBasePath, globalTestContext.ProjectID, routerName)
+	require.NoError(t, err)
+
+	// Read router config test data
+	data := makeRouterPayload(filepath.Join("testdata", "create_router_version.json.tmpl"), globalTestContext)
+
+	// Update router
+	url := fmt.Sprintf(
+		"%s/projects/%d/routers/%d/versions",
+		globalTestContext.APIBasePath,
+		globalTestContext.ProjectID,
+		existingRouter.ID,
+	)
+	t.Log("Creating router version: POST " + url)
+	req, err := http.NewRequest("POST", url, bytes.NewReader(data))
+	require.NoError(t, err)
+	req.Header.Set("Content-Type", "application/json")
+	resp, err := globalTestContext.httpClient.Do(req)
+	require.NoError(t, err)
+	assert.Equal(t, http.StatusOK, resp.StatusCode, readBody(t, resp))
+
+	// Get router version 3
+	t.Log("Testing GET router version")
+	routerVersion, err := getRouterVersion(
+		globalTestContext.httpClient,
+		globalTestContext.APIBasePath,
+		globalTestContext.ProjectID,
+		int(existingRouter.ID),
+		3,
+	)
+	require.NoError(t, err)
+	assert.Equal(t, models.RouterVersionStatusUndeployed, routerVersion.Status)
+
+	t.Log("Ensure existing router did not update the version to the new version i.e. the version still unchanged at 1")
+	router, err := getRouter(
+		globalTestContext.httpClient,
+		globalTestContext.APIBasePath,
+		globalTestContext.ProjectID,
+		int(existingRouter.ID),
+	)
+	require.NoError(t, err)
+	require.NotNil(t, router.CurrRouterVersion)
+	assert.Equal(t, 1, int(router.CurrRouterVersion.Version))
+
+	downstream, err := getRouterDownstream(globalTestContext.clusterClients,
+		globalTestContext.ProjectName,
+		fmt.Sprintf("%s-turing-router", router.Name))
+	assert.NoError(t, err)
+	assert.Equal(t, downstream, fmt.Sprintf("%s-turing-router-%d.%s.%s",
+		router.Name, 1, globalTestContext.ProjectName, globalTestContext.KServiceDomain))
+
+	// Check that previous enricher, router, ensembler deployments exist
+	t.Log("Checking cluster state")
+	assert.True(t, isDeploymentExists(
+		globalTestContext.clusterClients,
+		globalTestContext.ProjectName,
+		fmt.Sprintf("%s-turing-router-%d-0-deployment", router.Name, 1)))
+	assert.True(t, isDeploymentExists(
+		globalTestContext.clusterClients,
+		globalTestContext.ProjectName,
+		fmt.Sprintf("%s-turing-enricher-%d-0-deployment", router.Name, 1)))
+	assert.True(t, isDeploymentExists(
+		globalTestContext.clusterClients,
+		globalTestContext.ProjectName,
+		fmt.Sprintf("%s-turing-ensembler-%d-0-deployment", router.Name, 1)))
+
+	// Make request to router
+	t.Log("Testing router endpoint")
+	router, err = getRouter(
+		globalTestContext.httpClient,
+		globalTestContext.APIBasePath,
+		globalTestContext.ProjectID,
+		int(router.ID),
+	)
+	require.NoError(t, err)
+	assert.Equal(t,
+		fmt.Sprintf(
+			"http://%s-turing-router.%s.%s/v1/predict",
+			router.Name,
+			globalTestContext.ProjectName,
+			globalTestContext.KServiceDomain,
+		),
+		router.Endpoint,
+	)
+	req, err = http.NewRequestWithContext(
+		context.Background(),
+		http.MethodPost,
+		router.Endpoint,
+		ioutil.NopCloser(bytes.NewReader([]byte(`{}`))),
+	)
+	require.NoError(t, err)
+	resp, err = globalTestContext.httpClient.Do(req)
+	require.NoError(t, err)
+	responseBytes, err := ioutil.ReadAll(resp.Body)
+	defer resp.Body.Close()
+	require.NoError(t, err)
+	actualResponse := gjson.GetBytes(responseBytes, "json.response").String()
+	expectedResponse := `{
+	  "experiment": {},
+	  "route_responses": [
+		{
+		  "data": {
+			"version": "control"
+		  },
+		  "is_default": true,
+		  "route": "control"
+		}
+	  ]
+	}`
+	assert.JSONEq(t, expectedResponse, actualResponse)
+}