Get endpoint JSON tests

prebid · Jan 7, 2025 · d1fc525 · d1fc525
1 parent bae814f
commit d1fc525
Show file tree

Hide file tree

Showing 31 changed files with 165 additions and 58 deletions.
diff --git a/endpoints/get_test.go b/endpoints/get_test.go
@@ -34,12 +34,21 @@ func TestGetJsonTests(t *testing.T) {
 
 		router := httprouter.New()
 		router.GET("/cache", NewGetHandler(backend, m, tc.HostConfig.AllowSettingKeys, tc.HostConfig.RefererLogRate))
-		request, err := http.NewRequest("GET", "/cache?"+tc.Query, nil)
+		request, err := http.NewRequest("GET", "/cache?"+tc.Request.Query, nil)
 		if !assert.NoError(t, err, "Failed to create a GET request: %v", err) {
 			hook.Reset()
 			assert.Nil(t, hook.LastEntry())
 			continue
 		}
+
+		if len(tc.Request.Headers) > 0 {
+			for header, values := range tc.Request.Headers {
+				for _, v := range values {
+					request.Header.Set(header, v)
+				}
+			}
+		}
+
 		rr := httptest.NewRecorder()
 
 		// Run test

diff --git a/endpoints/put.go b/endpoints/put.go
@@ -189,7 +189,7 @@ func (e *PutHandler) handle(w http.ResponseWriter, r *http.Request, ps httproute
 	// If incoming request comes with a referer header, there's a e.cfg.refererLogRate percent chance
 	// getting it logged
 	if referer := r.Referer(); referer != "" && utils.RandomPick(e.cfg.refererLogRate) {
-		logrus.Info("PUT request Referer header: " + referer)
+		logrus.Info("POST request Referer header: " + referer)
 	}
 
 	start := time.Now()

diff --git a/endpoints/put_test.go b/endpoints/put_test.go
@@ -51,11 +51,20 @@ func TestPutJsonTests(t *testing.T) {
 
 		router := httprouter.New()
 		router.POST("/cache", NewPutHandler(backend, m, tc.HostConfig.MaxNumValues, tc.HostConfig.AllowSettingKeys, tc.HostConfig.RefererLogRate))
-		request, err := http.NewRequest("POST", "/cache", strings.NewReader(string(tc.PutRequest.Body)))
+		request, err := http.NewRequest("POST", "/cache", strings.NewReader(string(tc.Request.Body)))
 		if !assert.NoError(t, err, "Failed to create a POST request. Test file: %s Error: %v", testFile, err) {
 			hook.Reset()
 			continue
 		}
+
+		if len(tc.Request.Headers) > 0 {
+			for header, values := range tc.Request.Headers {
+				for _, v := range values {
+					request.Header.Set(header, v)
+				}
+			}
+		}
+
 		rr := httptest.NewRecorder()
 
 		// RUN TEST
@@ -96,17 +105,17 @@ func TestPutJsonTests(t *testing.T) {
 }
 
 type testData struct {
-	HostConfig         hostConfig     `json:"config"`
-	PutRequest         testPutRequest `json:"put_request"`
-	ExpectedOutput     expectedOut    `json:"expected_output"`
-	ExpectedLogEntries []logEntry     `json:"expected_log_entries"`
-	ExpectedMetrics    []string       `json:"expected_metrics"`
-	Query              string         `json:"get_request_query"`
+	HostConfig         hostConfig  `json:"config"`
+	Request            testRequest `json:"request"`
+	ExpectedOutput     expectedOut `json:"expected_output"`
+	ExpectedLogEntries []logEntry  `json:"expected_log_entries"`
+	ExpectedMetrics    []string    `json:"expected_metrics"`
 }
 
-type testPutRequest struct {
+type testRequest struct {
 	Body    json.RawMessage     `json:"body"`
 	Headers map[string][]string `json:"headers"`
+	Query   string              `json:"query"`
 }
 
 type expectedOut struct {

diff --git a/endpoints/sample-requests/get-endpoint/invalid/data-corrupted.json b/endpoints/sample-requests/get-endpoint/invalid/data-corrupted.json
@@ -10,7 +10,9 @@
       ]
     }
   },
-  "get_request_query": "uuid=36-char-uid-maps-to-actual-xml-value",
+  "request": {
+    "query": "uuid=36-char-uid-maps-to-actual-xml-value"
+  },
   "expected_log_entries": [
     {
       "message": "GET /cache uuid=36-char-uid-maps-to-actual-xml-value: Cache data was corrupted. Cannot determine type.",

diff --git a/endpoints/sample-requests/get-endpoint/invalid/key-not-found.json b/endpoints/sample-requests/get-endpoint/invalid/key-not-found.json
@@ -10,7 +10,9 @@
       ]
     }
   },
-  "get_request_query": "uuid=36-char-uuid-is-not-found-in-backend",
+  "request": {
+    "query": "uuid=36-char-uuid-is-not-found-in-backend"
+  },
   "expected_metrics": [
     "RecordGetTotal",
     "RecordGetBackendError",

diff --git a/endpoints/sample-requests/get-endpoint/invalid/missing-uuid.json b/endpoints/sample-requests/get-endpoint/invalid/missing-uuid.json
@@ -10,7 +10,9 @@
       ]
     }
   },
-  "get_request_query": "uuid=",
+  "request": {
+    "query": "uuid="
+  },
   "expected_log_entries": [
     {
       "message": "GET /cache: Missing required parameter uuid",

diff --git a/endpoints/sample-requests/get-endpoint/invalid/uuid-length.json b/endpoints/sample-requests/get-endpoint/invalid/uuid-length.json
@@ -1,6 +1,8 @@
 {
   "description": "Gut request doesn't come with a UUID value in the URL query, expect MISSING_KEY error",
-  "get_request_query": "uuid=non-36-char-uuid",
+  "request": {
+    "query": "uuid=non-36-char-uuid"
+  },
   "expected_log_entries": [
     {
       "message": "GET /cache uuid=non-36-char-uuid: invalid uuid length",

diff --git a/endpoints/sample-requests/get-endpoint/valid/element-found.json b/endpoints/sample-requests/get-endpoint/valid/element-found.json
@@ -10,7 +10,9 @@
       ]
     }
   },
-  "get_request_query": "uuid=36-char-uid-maps-to-stored-xml-value",
+  "request": {
+    "query": "uuid=36-char-uid-maps-to-stored-xml-value"
+  },
   "expected_metrics": [
     "RecordGetBackendTotal",
     "RecordGetDuration",
@@ -21,4 +23,4 @@
     "code": 200,
     "get_response": "<description>stored xml value</description>"
   }
-}
+}
diff --git a/endpoints/sample-requests/get-endpoint/valid/log-referrer-header.json b/endpoints/sample-requests/get-endpoint/valid/log-referrer-header.json
@@ -0,0 +1,36 @@
+{
+  "description": "Prebid Cache configured to log the referer header of 100% of incoming requests. Referer successfully logged.",
+  "config": {
+    "fake_backend": {
+      "stored_data": [
+        {
+          "key": "36-char-uid-maps-to-stored-xml-value",
+          "value": "xml<description>stored xml value</description>"
+        }
+      ]
+    },
+    "referer_sampling_rate": 1.0
+  },
+  "request": {
+    "query": "uuid=36-char-uid-maps-to-stored-xml-value",
+    "headers": {
+      "Referer": [ "anyreferer" ]
+    }
+  },
+  "expected_log_entries": [
+    {
+      "message": "GET request Referer header: anyreferer",
+      "level": 4
+    }
+  ],
+  "expected_metrics": [
+    "RecordGetBackendTotal",
+    "RecordGetDuration",
+    "RecordGetBackendDuration",
+    "RecordGetTotal"
+  ],
+  "expected_output": {
+    "code": 200,
+    "get_response": "<description>stored xml value</description>"
+  }
+}
diff --git a/endpoints/sample-requests/put-endpoint/backends/ignite/record-exists-error.json b/endpoints/sample-requests/put-endpoint/backends/ignite/record-exists-error.json
@@ -6,7 +6,7 @@
       "server_response": "{\"successStatus\":0,\"error\":\"\",\"response\":false}"
     }
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -28,4 +28,4 @@
     "code": 200,
     "expected_error_message": "{\"responses\":[{\"uuid\":\"\"}]}"
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/backends/redis/invalid-redis-server-error.json b/endpoints/sample-requests/put-endpoint/backends/redis/invalid-redis-server-error.json
@@ -6,7 +6,7 @@
       "throw_error_message": "Redis server side error"
     }
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -38,4 +38,4 @@
     "code": 500,
     "expected_error_message": "Redis server side error\n"
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/backends/redis/valid-overwrite.json b/endpoints/sample-requests/put-endpoint/backends/redis/valid-overwrite.json
@@ -12,7 +12,7 @@
       ]
     }
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -42,4 +42,4 @@
       ]
     }
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/backends/redis/valid-success-true.json b/endpoints/sample-requests/put-endpoint/backends/redis/valid-success-true.json
@@ -7,7 +7,7 @@
       "throw_error_message": "redis: nil"
     }
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -35,4 +35,4 @@
       ]
     }
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/custom-keys/allowed/key-field-included.json b/endpoints/sample-requests/put-endpoint/custom-keys/allowed/key-field-included.json
@@ -3,7 +3,7 @@
   "config": {
     "allow_setting_keys": true
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -33,4 +33,4 @@
       ]
     }
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/custom-keys/allowed/key-field-missing.json b/endpoints/sample-requests/put-endpoint/custom-keys/allowed/key-field-missing.json
@@ -3,7 +3,7 @@
   "config": {
     "allow_setting_keys": true
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -31,4 +31,4 @@
       ]
     }
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/custom-keys/not-allowed/key-field-included.json b/endpoints/sample-requests/put-endpoint/custom-keys/not-allowed/key-field-included.json
@@ -1,6 +1,6 @@
 {
   "description": "Put request wants to store element under a custom key but custom keys are not allowed in Prebid Cache's config. Store under a random UUID",
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -29,4 +29,4 @@
       ]
     }
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/invalid-number-of-elements/puts-max-num-values.json b/endpoints/sample-requests/put-endpoint/invalid-number-of-elements/puts-max-num-values.json
@@ -3,7 +3,7 @@
   "config": {
     "max_num_values": 1
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -27,4 +27,4 @@
     "code": 400,
     "expected_error_message": "More keys than allowed: 1\n"
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/invalid-types/type-missing.json b/endpoints/sample-requests/put-endpoint/invalid-types/type-missing.json
@@ -1,6 +1,6 @@
 {
   "description": "Request is missing the 'type' field. Respond with error",
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -27,4 +27,4 @@
     "code": 400,
     "expected_error_message": "Type must be one of [\"json\", \"xml\"]. Found ''\n"
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/invalid-types/type-unknown.json b/endpoints/sample-requests/put-endpoint/invalid-types/type-unknown.json
@@ -1,6 +1,6 @@
 {
   "description": "Prebid Cache only allows to store JSON or XML types and the type 'unknown' is not supported. Respond with error",
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -28,4 +28,4 @@
     "code": 400,
     "expected_error_message": "Type must be one of [\"json\", \"xml\"]. Found 'unknown'\n"
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/invalid-value/value-greater-than-max.json b/endpoints/sample-requests/put-endpoint/invalid-value/value-greater-than-max.json
@@ -3,7 +3,7 @@
   "config": {
     "max_size_bytes": 1
   },
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -35,4 +35,4 @@
     "code": 400,
     "expected_error_message": "POST /cache element 0 exceeded max size: Payload size 73 exceeded max 1\n"
   }
-}
+}
diff --git a/endpoints/sample-requests/put-endpoint/invalid-value/value-missing.json b/endpoints/sample-requests/put-endpoint/invalid-value/value-missing.json
@@ -1,6 +1,6 @@
 {
   "description": "Prebid Cache returns an error if a request doesn't come with a 'value' field.",
-  "put_request": {
+  "request": {
     "body": {
       "puts": [
         {
@@ -27,4 +27,4 @@
     "code": 400,
     "expected_error_message": "Missing value.\n"
   }
-}
+}