Use FilterContext to allow filters to access URLRequestJob data...

net/base/sdch_filter_unittest.cc

 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include <limits.h>
 
 #include <algorithm>
 #include <string>
 #include <vector>
 
 #include "base/logging.h"
 #include "base/scoped_ptr.h"
 #include "net/base/filter.h"
+#include "net/base/filter_unittest.h"
 #include "net/base/sdch_filter.h"
 #include "net/url_request/url_request_http_job.cc"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/zlib/zlib.h"
 
 //------------------------------------------------------------------------------
 // Provide sample data and compression results with a sample VCDIFF dictionary.
 // Note an SDCH dictionary has extra meta-data before the VCDIFF dictionary.
 static const char kTestVcdiffDictionary[] = "DictionaryFor"
     "SdchCompression1SdchCompression2SdchCompression3SdchCompression\n";
@@ skipping 120 matching lines @@
   return dictionary;
 }
 
 //------------------------------------------------------------------------------
 
 TEST_F(SdchFilterTest, BasicBadDictionary) {
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
   const int kInputBufferSize(30);
   char output_buffer[20];
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
   std::string url_string("http://ignore.com");
-  filter->SetURL(GURL(url_string));
+  filter_context.SetURL(GURL(url_string));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
 
 
   // With no input data, try to read output.
   int output_bytes_or_buffer_size = sizeof(output_buffer);
   Filter::FilterStatus status = filter->ReadData(output_buffer,
                                                  &output_bytes_or_buffer_size);
 
   EXPECT_EQ(0, output_bytes_or_buffer_size);
   EXPECT_EQ(Filter::FILTER_NEED_MORE_DATA, status);
 
@@ skipping 72 matching lines @@
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   // Decode with a large buffer (larger than test input, or compressed data).
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
-  filter->SetURL(url);
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(url);
+
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
 
   size_t feed_block_size = 100;
   size_t output_block_size = 100;
   std::string output;
   EXPECT_TRUE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Decode with really small buffers (size 1) to check for edge effects.
-  filter.reset((Filter::Factory(filter_types, kInputBufferSize)));
-  filter->SetURL(url);
+  filter.reset((Filter::Factory(filter_types, filter_context)));
 
   feed_block_size = 1;
   output_block_size = 1;
   output.clear();
   EXPECT_TRUE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 }
 
 TEST_F(SdchFilterTest, NoDecodeHttps) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL("https://" + kSampleDomain));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
   const size_t feed_block_size(100);
   const size_t output_block_size(100);
   std::string output;
 
-  filter->SetURL(GURL("https://" + kSampleDomain));
   EXPECT_FALSE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
 }
 
 // Current failsafe TODO/hack refuses to decode any content that doesn't use
 // http as the scheme (see use of DICTIONARY_SELECTED_FOR_NON_HTTP).
 // The following tests this blockage.  Note that blacklisting results, so we
 // we need separate tests for each of these.
 TEST_F(SdchFilterTest, NoDecodeFtp) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL("ftp://" + kSampleDomain));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
   const size_t feed_block_size(100);
   const size_t output_block_size(100);
   std::string output;
 
-  filter->SetURL(GURL("ftp://" + kSampleDomain));
   EXPECT_FALSE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
 }
 
 TEST_F(SdchFilterTest, NoDecodeFileColon) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL("file://" + kSampleDomain));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
   const size_t feed_block_size(100);
   const size_t output_block_size(100);
   std::string output;
 
-  filter->SetURL(GURL("file://" + kSampleDomain));
   EXPECT_FALSE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
 }
 
 TEST_F(SdchFilterTest, NoDecodeAboutColon) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL("about://" + kSampleDomain));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
   const size_t feed_block_size(100);
   const size_t output_block_size(100);
   std::string output;
 
-  filter->SetURL(GURL("about://" + kSampleDomain));
   EXPECT_FALSE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
 }
 
 TEST_F(SdchFilterTest, NoDecodeJavaScript) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL("javascript://" + kSampleDomain));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
   const size_t feed_block_size(100);
   const size_t output_block_size(100);
   std::string output;
 
-  filter->SetURL(GURL("javascript://" + kSampleDomain));
   EXPECT_FALSE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
 }
 
 TEST_F(SdchFilterTest, CanStillDecodeHttp) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
 
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL("http://" + kSampleDomain));
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
   const size_t feed_block_size(100);
   const size_t output_block_size(100);
   std::string output;
 
-  filter->SetURL(GURL("http://" + kSampleDomain));
   EXPECT_TRUE(FilterTestData(compressed, feed_block_size, output_block_size,
                              filter.get(), &output));
 }
 
 TEST_F(SdchFilterTest, CrossDomainDictionaryUse) {
   // Construct a valid SDCH dictionary from a VCDIFF dictionary.
   const std::string kSampleDomain = "sdchtest.com";
   std::string dictionary(NewSdchDictionary(kSampleDomain));
 
   std::string url_string = "http://" + kSampleDomain;
 
   GURL url(url_string);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary, url));
 
   std::string compressed(NewSdchCompressedData(dictionary));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
   const int kInputBufferSize(100);
 
   // Decode with content arriving from the "wrong" domain.
-  // This tests CanSet() in the sdch_manager_->
-  scoped_ptr<Filter> filter((Filter::Factory(filter_types,  kInputBufferSize)));
+  // This tests SdchManager::CanSet().
+  MockFilterContext filter_context(kInputBufferSize);
   GURL wrong_domain_url("http://www.wrongdomain.com");
-  filter->SetURL(wrong_domain_url);
+  filter_context.SetURL(wrong_domain_url);
+  scoped_ptr<Filter> filter((Filter::Factory(filter_types,  filter_context)));
 
   size_t feed_block_size = 100;
   size_t output_block_size = 100;
   std::string output;
   EXPECT_FALSE(FilterTestData(compressed, feed_block_size, output_block_size,
                               filter.get(), &output));
   EXPECT_EQ(output.size(), 0u);  // No output written.
 
   EXPECT_TRUE(SdchManager::Global()->IsInSupportedDomain(GURL(url_string)));
   EXPECT_FALSE(SdchManager::Global()->IsInSupportedDomain(wrong_domain_url));
@@ skipping 17 matching lines @@
   dictionary_with_path.append(dictionary);
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary_with_path, url));
 
   std::string compressed_for_path(NewSdchCompressedData(dictionary_with_path));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
   const int kInputBufferSize(100);
 
   // Test decode the path data, arriving from a valid path.
-  scoped_ptr<Filter> filter((Filter::Factory(filter_types, kInputBufferSize)));
-  filter->SetURL(GURL(url_string + path));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL(url_string + path));
+  scoped_ptr<Filter> filter((Filter::Factory(filter_types, filter_context)));
 
   size_t feed_block_size = 100;
   size_t output_block_size = 100;
   std::string output;
 
   EXPECT_TRUE(FilterTestData(compressed_for_path, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Test decode the path data, arriving from a invalid path.
-  filter.reset((Filter::Factory(filter_types, kInputBufferSize)));
-  filter->SetURL(GURL(url_string));
+  filter_context.SetURL(GURL(url_string));
+  filter.reset((Filter::Factory(filter_types, filter_context)));
 
   feed_block_size = 100;
   output_block_size = 100;
   output.clear();
   EXPECT_FALSE(FilterTestData(compressed_for_path, feed_block_size,
                               output_block_size, filter.get(), &output));
   EXPECT_EQ(output.size(), 0u);  // No output written.
 
   EXPECT_FALSE(SdchManager::Global()->IsInSupportedDomain(GURL(url_string)));
   SdchManager::ClearBlacklistings();
@@ skipping 19 matching lines @@
   EXPECT_TRUE(sdch_manager_->AddSdchDictionary(dictionary_with_port,
                                             GURL(url_string + ":" + port)));
 
   std::string compressed_for_port(NewSdchCompressedData(dictionary_with_port));
 
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
   const int kInputBufferSize(100);
 
   // Test decode the port data, arriving from a valid port.
-  scoped_ptr<Filter> filter((Filter::Factory(filter_types, kInputBufferSize)));
-  filter->SetURL(GURL(url_string + ":" + port));
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(GURL(url_string + ":" + port));
+  scoped_ptr<Filter> filter((Filter::Factory(filter_types, filter_context)));
 
   size_t feed_block_size = 100;
   size_t output_block_size = 100;
   std::string output;
   EXPECT_TRUE(FilterTestData(compressed_for_port, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Test decode the port data, arriving from a valid (default) port.
-  filter.reset((Filter::Factory(filter_types, kInputBufferSize)));
-  filter->SetURL(GURL(url_string));  // Default port.
+  filter_context.SetURL(GURL(url_string));  // Default port.
+  filter.reset((Filter::Factory(filter_types, filter_context)));
 
   feed_block_size = 100;
   output_block_size = 100;
   output.clear();
   EXPECT_TRUE(FilterTestData(compressed_for_port, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Test decode the port data, arriving from a invalid port.
-  filter.reset((Filter::Factory(filter_types, kInputBufferSize)));
-  filter->SetURL(GURL(url_string + ":" + port + "1"));
+  filter_context.SetURL(GURL(url_string + ":" + port + "1"));
+  filter.reset((Filter::Factory(filter_types, filter_context)));
 
   feed_block_size = 100;
   output_block_size = 100;
   output.clear();
   EXPECT_FALSE(FilterTestData(compressed_for_port, feed_block_size,
                               output_block_size, filter.get(), &output));
   EXPECT_EQ(output.size(), 0u);  // No output written.
 
   EXPECT_FALSE(SdchManager::Global()->IsInSupportedDomain(GURL(url_string)));
   SdchManager::ClearBlacklistings();
@@ skipping 78 matching lines @@
   // Construct a chained filter.
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
   filter_types.push_back(Filter::FILTER_TYPE_GZIP);
 
   // First try with a large buffer (larger than test input, or compressed data).
   const size_t kLargeInputBufferSize(1000);  // Used internally in filters.
   CHECK(kLargeInputBufferSize > gzip_compressed_sdch.size());
   CHECK(kLargeInputBufferSize > sdch_compressed.size());
   CHECK(kLargeInputBufferSize > expanded_.size());
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types,
-                            kLargeInputBufferSize));
-  filter->SetURL(url);
+  MockFilterContext filter_context(kLargeInputBufferSize);
+  filter_context.SetURL(url);
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
 
   // Verify that chained filter is waiting for data.
   char tiny_output_buffer[10];
   int tiny_output_size = sizeof(tiny_output_buffer);
   EXPECT_EQ(Filter::FILTER_NEED_MORE_DATA,
             filter->ReadData(tiny_output_buffer, &tiny_output_size));
 
   // Make chain process all data.
   size_t feed_block_size = kLargeInputBufferSize;
   size_t output_block_size = kLargeInputBufferSize;
   std::string output;
   EXPECT_TRUE(FilterTestData(gzip_compressed_sdch, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Next try with a mid-sized internal buffer size.
   const size_t kMidSizedInputBufferSize(100);
   // Buffer should be big enough to swallow whole gzip content.
   CHECK(kMidSizedInputBufferSize > gzip_compressed_sdch.size());
   // Buffer should be small enough that entire SDCH content can't fit.
   // We'll go even further, and force the chain to flush the buffer between the
   // two filters more than once (that is why we multiply by 2).
   CHECK(kMidSizedInputBufferSize * 2 < sdch_compressed.size());
-  filter.reset(Filter::Factory(filter_types, kMidSizedInputBufferSize));
-  filter->SetURL(url);
+  filter_context.SetBufferSize(kMidSizedInputBufferSize);
+  filter_context.SetURL(url);
+  filter.reset(Filter::Factory(filter_types, filter_context));
 
   feed_block_size = kMidSizedInputBufferSize;
   output_block_size = kMidSizedInputBufferSize;
   output.clear();
   EXPECT_TRUE(FilterTestData(gzip_compressed_sdch, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Next try with a tiny input and output buffer to cover edge effects.
-  filter.reset(Filter::Factory(filter_types, kLargeInputBufferSize));
-  filter->SetURL(url);
+  filter_context.SetBufferSize(kLargeInputBufferSize);
+  filter.reset(Filter::Factory(filter_types, filter_context));
 
   feed_block_size = 1;
   output_block_size = 1;
   output.clear();
   EXPECT_TRUE(FilterTestData(gzip_compressed_sdch, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 }
 
 TEST_F(SdchFilterTest, DefaultGzipIfSdch) {
@@ skipping 12 matching lines @@
   std::string gzip_compressed_sdch = gzip_compress(sdch_compressed);
 
   // Only claim to have sdch content, but really use the gzipped sdch content.
   // System should automatically add the missing (optional) gzip.
   std::vector<Filter::FilterType> filter_types;
   filter_types.push_back(Filter::FILTER_TYPE_SDCH);
   Filter::FixupEncodingTypes(true, "anything/mime", &filter_types);
 
   // First try with a large buffer (larger than test input, or compressed data).
   const int kInputBufferSize(100);
-  scoped_ptr<Filter> filter(Filter::Factory(filter_types, kInputBufferSize));
-  filter->SetURL(url);
+  MockFilterContext filter_context(kInputBufferSize);
+  filter_context.SetURL(url);
+  scoped_ptr<Filter> filter(Filter::Factory(filter_types, filter_context));
+
 
   // Verify that chained filter is waiting for data.
   char tiny_output_buffer[10];
   int tiny_output_size = sizeof(tiny_output_buffer);
   EXPECT_EQ(Filter::FILTER_NEED_MORE_DATA,
             filter->ReadData(tiny_output_buffer, &tiny_output_size));
 
   size_t feed_block_size = 100;
   size_t output_block_size = 100;
   std::string output;
   EXPECT_TRUE(FilterTestData(gzip_compressed_sdch, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 
   // Next try with a tiny buffer to cover edge effects.
-  filter.reset(Filter::Factory(filter_types, kInputBufferSize));
-  filter->SetURL(url);
+  filter.reset(Filter::Factory(filter_types, filter_context));
 
   feed_block_size = 1;
   output_block_size = 1;
   output.clear();
   EXPECT_TRUE(FilterTestData(gzip_compressed_sdch, feed_block_size,
                              output_block_size, filter.get(), &output));
   EXPECT_EQ(output, expanded_);
 }
 
 TEST_F(SdchFilterTest, DomainSupported) {
@@ skipping 172 matching lines @@
 TEST_F(SdchFilterTest, DictionaryTooLarge) {
   std::string dictionary_domain(".google.com");
   std::string dictionary_text(NewSdchDictionary(dictionary_domain));
 
   dictionary_text.append(
       SdchManager::kMaxDictionarySize + 1 - dictionary_text.size(), ' ');
   EXPECT_FALSE(sdch_manager_->AddSdchDictionary(dictionary_text,
               GURL("http://" + dictionary_domain)));
 }