Added unit tests for isCacheableRequest in CacheFilterUtils

Signed-off-by: Yosry Ahmed <yosryahmed@google.com>
yosrym93 · Jun 15, 2020 · 83b8b5f · 83b8b5f
1 parent c47f8b4
commit 83b8b5f
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 4 deletions.
diff --git a/source/extensions/filters/http/cache/cache_filter_utils.cc b/source/extensions/filters/http/cache/cache_filter_utils.cc
@@ -6,7 +6,7 @@ namespace Extensions {
 namespace HttpFilters {
 namespace Cache {
 
-bool CacheFilterUtils::isCacheableRequest(Http::RequestHeaderMap& headers) {
+bool CacheFilterUtils::isCacheableRequest(const Http::RequestHeaderMap& headers) {
   const Http::HeaderEntry* method = headers.Method();
   const Http::HeaderEntry* forwarded_proto = headers.ForwardedProto();
   const Http::HeaderValues& header_values = Http::Headers::get();
@@ -18,7 +18,7 @@ bool CacheFilterUtils::isCacheableRequest(Http::RequestHeaderMap& headers) {
           forwarded_proto->value() == header_values.SchemeValues.Https);
 }
 
-bool CacheFilterUtils::isCacheableResponse(Http::ResponseHeaderMap& headers) {
+bool CacheFilterUtils::isCacheableResponse(const Http::ResponseHeaderMap& headers) {
   const absl::string_view cache_control = headers.getCacheControlValue();
   // TODO(toddmgreer): fully check for cacheability. See for example
   // https://github.com/apache/incubator-pagespeed-mod/blob/master/pagespeed/kernel/http/caching_headers.h.

diff --git a/source/extensions/filters/http/cache/cache_filter_utils.h b/source/extensions/filters/http/cache/cache_filter_utils.h
@@ -10,10 +10,10 @@ namespace Cache {
 class CacheFilterUtils {
 public:
   // Checks if a request can be served from cache
-  static bool isCacheableRequest(Http::RequestHeaderMap& headers);
+  static bool isCacheableRequest(const Http::RequestHeaderMap& headers);
 
   // Checks if a response can be stored in cache
-  static bool isCacheableResponse(Http::ResponseHeaderMap& headers);
+  static bool isCacheableResponse(const Http::ResponseHeaderMap& headers);
 };
 } // namespace Cache
 } // namespace HttpFilters

diff --git a/test/extensions/filters/http/cache/BUILD b/test/extensions/filters/http/cache/BUILD
@@ -46,6 +46,16 @@ envoy_extension_cc_test(
     ],
 )
 
+envoy_extension_cc_test(
+    name = "cache_filter_utils_test",
+    srcs = ["cache_filter_utils_test.cc"],
+    extension_name = "envoy.filters.http.cache",
+    deps = [
+        "//source/extensions/filters/http/cache:cache_filter_utils_lib",
+        "//test/test_common:utility_lib",
+    ],
+)
+
 envoy_extension_cc_test(
     name = "config_test",
     srcs = ["config_test.cc"],

diff --git a/test/extensions/filters/http/cache/cache_filter_utils_test.cc b/test/extensions/filters/http/cache/cache_filter_utils_test.cc
@@ -0,0 +1,70 @@
+#include "extensions/filters/http/cache/cache_filter_utils.h"
+
+#include "test/test_common/utility.h"
+
+#include "gtest/gtest.h"
+
+namespace Envoy {
+namespace Extensions {
+namespace HttpFilters {
+namespace Cache {
+namespace {
+
+struct IsCacheableRequestParams {
+  Http::TestRequestHeaderMapImpl request_headers;
+  bool is_cacheable;
+};
+
+IsCacheableRequestParams params[] = {
+    {
+        {},
+        false
+    },
+    {
+        {{":path", "/"}},
+        false
+    },
+    {
+        {{":path", "/"}, {":method", "GET"}},
+        false
+    },
+    {
+        {{":path", "/"}, {":method", "GET"}, {"x-forwarded-proto", "https"}},
+        false
+    },
+    {
+        {{":path", "/"}, {":method", "GET"}, {"x-forwarded-proto", "https"}, {":authority", "test"}},
+        true
+    },
+    {
+        {{":path", "/"}, {":method", "POST"}, {"x-forwarded-proto", "https"}, {":authority", "test"}},
+        false
+    },
+    {
+        {{":path", "/"}, {":method", "GET"}, {"x-forwarded-proto", "http"}, {":authority", "test"}},
+        true
+    },
+    {
+        {{":path", "/"}, {":method", "GET"}, {"x-forwarded-proto", "http"}, {":authority", "test"}},
+        true
+    },
+    {
+        {{":path", "/"}, {":method", "GET"}, {"x-forwarded-proto", "ftp"}, {":authority", "test"}},
+        false
+    },
+};
+
+class IsCacheableRequestTest : public testing::TestWithParam<IsCacheableRequestParams> {};
+
+INSTANTIATE_TEST_SUITE_P(IsCacheableRequestTest, IsCacheableRequestTest, testing::ValuesIn(params));
+
+TEST_P(IsCacheableRequestTest, IsCacheableRequestTest) { 
+    EXPECT_EQ(CacheFilterUtils::isCacheableRequest(GetParam().request_headers), GetParam().is_cacheable);
+}
+
+
+} // namespace
+} // namespace Cache
+} // namespace HttpFilters
+} // namespace Extensions
+} // namespace Envoy