net/instaweb/http/headers_cookie_util_test.cc

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */


// Unit tests for remove cookie operations.

#include "pagespeed/kernel/base/gtest.h"
#include "pagespeed/kernel/base/string.h"
#include "pagespeed/kernel/base/string_util.h"
#include "pagespeed/kernel/http/http_names.h"
#include "pagespeed/kernel/http/request_headers.h"

namespace net_instaweb {

class HeadersCookieUtilTest : public ::testing::Test {
};

TEST_F(HeadersCookieUtilTest, OnlyOne) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "PageSpeedExperiment=1");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, OnlyUnrelatedCookies_1) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "A=1");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=1\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, OnlyUnrelatedCookies_2) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "A=1;  B=2;  C; D  ; E = ; F");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=1;  B=2;  C; D  ; E = ; F\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, OnlyOneWithUnrelatedCookie) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "PageSpeedExperiment=1; B=2");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: B=2\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, OnlyOneAtEndWithUnrelatedCookie) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "A=1; PageSpeedExperiment=1");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=1\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, MultipleInOneLine) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie,
              "PageSpeedExperiment=1; PageSpeedExperiment=1; "
              "PageSpeedExperiment=1");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, MultipleInOneLineWithUnrelatedCookie) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie,
              "A=1; PageSpeedExperiment=1; B=2; PageSpeedExperiment=1; C=3; "
              "PageSpeedExperiment=1");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=1; B=2; C=3\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, RemovePreviewCookie) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "PageSpeedExperiment=1; B=2; C=3");
  headers.Add(HttpAttributes::kCookie, "A=x; PageSpeedExperiment=1; B=2; C=3");
  headers.Add(HttpAttributes::kCookie,
              "A=x; B=2; C=3;     PageSpeedExperiment=2");
  headers.Add(HttpAttributes::kCookie, "PageSpeedExperiment=1");
  headers.Add(HttpAttributes::kCookie, "    PageSpeedExperiment=1    ");
  headers.Add(HttpAttributes::kCookie, "A=b");
  headers.Add(HttpAttributes::kCookie, "    A=b; PageSpeedExperiment=");
  headers.Add(HttpAttributes::kCookie,
              "PageSpeedExperiment=1; PageSpeedExperiment=2; "
              "PageSpeedExperiment=3; A=1; PageSpeedExperiment=4;");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: B=2; C=3\r\n"
      "Cookie: A=x; B=2; C=3\r\n"
      "Cookie: A=x; B=2; C=3\r\n"
      "Cookie: A=b\r\n"
      "Cookie: A=b\r\n"
      "Cookie: A=1\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, InvalidCase_1) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie,
              "A; PageSpeedExperiment=1;");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, InvalidCase_2) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie,
              "A=1; B PageSpeedExperiment=1;");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=1; B PageSpeedExperiment=1;\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, InvalidCase_3) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie,
              "A=1; PageSpeedExperiment=xyz 1;");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=1\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, QuotedValues) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "A=\"12;23;\"");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: A=\"12;23;\"\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

// This test case illustrates a flaw in our implementation. Quoted cookie values
// are not treated as one token because of which we end up with broken cookie
// values.
// TODO(nforman): Fix this.
TEST_F(HeadersCookieUtilTest, QuotedValues_BrokenCase) {
  RequestHeaders headers;
  headers.Add(HttpAttributes::kCookie, "PageSpeedExperiment=\"12;23;\"");

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeaders[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: 23;\"\r\n"
      "\r\n";
  EXPECT_EQ(kExpectedHeaders, headers.ToString());
}

TEST_F(HeadersCookieUtilTest, QuotedValues_BrokenCase_2) {
  RequestHeaders headers;
  GoogleString header_string =
      "XPageSpeedExperiment=1; A=\"_BPageSpeedExperiment\"";
  headers.Add(HttpAttributes::kCookie, header_string);

  headers.RemoveCookie("PageSpeedExperiment");

  const char kExpectedHeadersFormat[] =
      "GET  HTTP/1.0\r\n"
      "Cookie: %s"
      "\r\n\r\n";
  GoogleString expected_headers = StringPrintf(kExpectedHeadersFormat,
                                               header_string.c_str());
  EXPECT_EQ(expected_headers, headers.ToString());
}

}  // namespace net_instaweb