From 441ff2003e60f9c2fa1a0e69d4ddfa3a67824c6a Mon Sep 17 00:00:00 2001
From: David Barratt <dbarratt@wikimedia.org>
Date: Tue, 29 Oct 2019 21:13:03 -0400
Subject: [PATCH] Add tests to OutputPage::sendCacheControl()

Before making improvements to OutputPage::sendCacheControl() the test coverage
should be increased.

Bug: T236862
Change-Id: I4a76b0894e2d574688e1cbd30f32ee7504801082
---
 includes/FauxResponse.php                 |  7 ++
 tests/phpunit/includes/OutputPageTest.php | 99 +++++++++++++++++++++++
 2 files changed, 106 insertions(+)

diff --git a/includes/FauxResponse.php b/includes/FauxResponse.php
index 24c396ec633..7b4ffde3ca0 100644
--- a/includes/FauxResponse.php
+++ b/includes/FauxResponse.php
@@ -147,4 +147,11 @@ class FauxResponse extends WebResponse {
 	public function getCookies() {
 		return $this->cookies;
 	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function hasCookies() {
+		return count( $this->cookies ) > 0;
+	}
 }
diff --git a/tests/phpunit/includes/OutputPageTest.php b/tests/phpunit/includes/OutputPageTest.php
index 98e3559c289..22b34739271 100644
--- a/tests/phpunit/includes/OutputPageTest.php
+++ b/tests/phpunit/includes/OutputPageTest.php
@@ -3073,6 +3073,105 @@ class OutputPageTest extends MediaWikiTestCase {
 		];
 	}
 
+	/**
+	 * @param array $options
+	 * @param array $expectations
+	 * @covers OutputPage::sendCacheControl
+	 * @dataProvider provideSendCacheControl
+	 */
+	public function testSendCacheControl( array $options = [], array $expecations = [] ) {
+		$output = $this->newInstance( [
+			'LoggedOutMaxAge' => $options['loggedOutMaxAge'] ?? 0,
+			'UseCdn' => $options['useCdn'] ?? false,
+		] );
+
+		$output->enableClientCache( $options['enableClientCache'] ?? true );
+		$output->setCdnMaxAge( $options['cdnMaxAge'] ?? 0 );
+
+		if ( isset( $options['lastModified'] ) ) {
+			$output->setLastModified( $options['lastModified'] );
+		}
+
+		$response = $output->getRequest()->response();
+		if ( isset( $options['cookie'] ) ) {
+			$response->setCookie( 'test', 1234 );
+		}
+
+		$output->sendCacheControl();
+
+		$headers = [
+			'Vary' => 'Accept-Encoding, Cookie',
+			'Cache-Control' => 'private, must-revalidate, max-age=0',
+			'Pragma' => false,
+			'Expires' => true,
+			'Last-Modified' => false,
+		];
+
+		foreach ( $headers as $header => $default ) {
+			$value = $expecations[$header] ?? $default;
+			if ( $value === true ) {
+				$this->assertNotEmpty( $response->getHeader( $header ) );
+			} elseif ( $value === false ) {
+				$this->assertNull( $response->getHeader( $header ) );
+			} else {
+				$this->assertEquals( $value, $response->getHeader( $header ) );
+			}
+		}
+	}
+
+	public function provideSendCacheControl() {
+		return [
+			'Default' => [],
+			'Logged out max-age' => [
+				[
+					'loggedOutMaxAge' => 300,
+				],
+				[
+					'Cache-Control' => 'private, must-revalidate, max-age=300',
+				],
+			],
+			'Cookies' => [
+				[
+					'cookie' => true,
+				],
+			],
+			'Cookies with logged out max-age' => [
+				[
+					'loggedOutMaxAge' => 300,
+					'cookie' => true,
+				],
+			],
+			'Disable client cache' => [
+				[
+					'enableClientCache' => false,
+				],
+				[
+					'Cache-Control' => 'no-cache, no-store, max-age=0, must-revalidate',
+					'Pragma' => 'no-cache'
+				],
+			],
+			'Set last modified' => [
+				[
+					// 0 is the current time, so we'll use 1 instead.
+					'lastModified' => 1,
+				],
+				[
+					'Last-Modified' => 'Thu, 01 Jan 1970 00:00:01 GMT',
+				]
+			],
+			'Public' => [
+				[
+					'useCdn' => true,
+					'cdnMaxAge' => 300,
+				],
+				[
+					'Cache-Control' => 's-maxage=300, must-revalidate, max-age=0',
+					'Expires' => false,
+				],
+			],
+		];
+	}
+
 	private function newInstance(
 		array $config = [],
 		WebRequest $request = null,