From b1c959d6de4d698c239e7be052f7384852039e43 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sat, 9 Apr 2022 08:21:27 +0200
Subject: [PATCH] Tests: new `Cookie\FormatTest` class

... with dedicated tests for the `Cookie::__toString()`, `Cookie::format_for_header()` and the `Cookie::format_for_set_cookie()` methods.

Includes removing some test code from the `CookieTest` class which is now covered by the tests in this class.

Also take note that, IMO, some of these tests highlight potential bugs. I'd like a second opinion on this though before addressing this.
---
 tests/Cookie/CookieTest.php |  15 ----
 tests/Cookie/FormatTest.php | 144 ++++++++++++++++++++++++++++++++++++
 2 files changed, 144 insertions(+), 15 deletions(-)
 create mode 100644 tests/Cookie/FormatTest.php

diff --git a/tests/Cookie/CookieTest.php b/tests/Cookie/CookieTest.php
index f00e81794..be5d36e6c 100644
--- a/tests/Cookie/CookieTest.php
+++ b/tests/Cookie/CookieTest.php
@@ -12,21 +12,6 @@ public function testBasicCookie() {
 
 		$this->assertSame('requests-testcookie', $cookie->name);
 		$this->assertSame('testvalue', $cookie->value);
-		$this->assertSame('testvalue', (string) $cookie);
-
-		$this->assertSame('requests-testcookie=testvalue', $cookie->format_for_header());
-		$this->assertSame('requests-testcookie=testvalue', $cookie->format_for_set_cookie());
-	}
-
-	public function testCookieWithAttributes() {
-		$attributes = [
-			'httponly',
-			'path' => '/',
-		];
-		$cookie     = new Cookie('requests-testcookie', 'testvalue', $attributes);
-
-		$this->assertSame('requests-testcookie=testvalue', $cookie->format_for_header());
-		$this->assertSame('requests-testcookie=testvalue; httponly; path=/', $cookie->format_for_set_cookie());
 	}
 
 	public function testEmptyCookieName() {
diff --git a/tests/Cookie/FormatTest.php b/tests/Cookie/FormatTest.php
new file mode 100644
index 000000000..6920b5502
--- /dev/null
+++ b/tests/Cookie/FormatTest.php
@@ -0,0 +1,144 @@
+<?php
+
+namespace WpOrg\Requests\Tests\Cookie;
+
+use WpOrg\Requests\Cookie;
+use WpOrg\Requests\Tests\TestCase;
+
+/**
+ * @coversDefaultClass \WpOrg\Requests\Cookie
+ */
+final class FormatTest extends TestCase {
+
+	/**
+	 * Verify a Cookie is stringable.
+	 *
+	 * @covers ::__toString
+	 *
+	 * @return void
+	 */
+	public function testStringable() {
+		$cookie = new Cookie('requests-testcookie', 'testvalue');
+
+		$this->assertSame('testvalue', (string) $cookie);
+	}
+
+	/**
+	 * Test formatting a cookie for a Cookie header.
+	 *
+	 * @covers ::format_for_header
+	 *
+	 * @dataProvider dataFormat
+	 *
+	 * @param string $name     Cookie name.
+	 * @param string $value    Cookie value.
+	 * @param array  $expected Expected function return values.
+	 *
+	 * @return void
+	 */
+	public function testFormatForHeader($name, $value, $expected) {
+		$cookie = new Cookie($name, $value);
+
+		$this->assertSame($expected, $cookie->format_for_header());
+	}
+
+	/**
+	 * Test formatting a cookie for a Set-Cookie header.
+	 *
+	 * @covers ::format_for_set_cookie
+	 *
+	 * @dataProvider dataFormat
+	 *
+	 * @param string $name       Cookie name.
+	 * @param string $value      Cookie value.
+	 * @param array  $expected   Expected function return values.
+	 *
+	 * @return void
+	 */
+	public function testFormatForSetCookie($name, $value, $expected) {
+		$cookie = new Cookie($name, $value);
+
+		$this->assertSame($expected, $cookie->format_for_set_cookie());
+	}
+
+	/**
+	 * Data provider.
+	 *
+	 * @return array
+	 */
+	public static function dataFormat() {
+		return [
+			'Empty key, empty value' => [
+				'name'     => '',
+				'value'    => '',
+				'expected' => '=',
+			],
+			'Empty key, has value' => [
+				'name'     => '',
+				'value'    => 'testvalue',
+				'expected' => '=testvalue',
+			],
+			'Has key and value' => [
+				'name'     => 'requests-testcookie',
+				'value'    => 'testvalue',
+				'expected' => 'requests-testcookie=testvalue',
+			],
+		];
+	}
+
+	/**
+	 * Test formatting a cookie with attributes for a Set-Cookie header.
+	 *
+	 * @covers ::format_for_set_cookie
+	 *
+	 * @dataProvider dataFormatWithAttributes
+	 *
+	 * @param array  $attributes Cookie attributes.
+	 * @param array  $expected   Expected function return values.
+	 *
+	 * @return void
+	 */
+	public function testFormatWithAttributes($attributes, $expected) {
+		// Set the reference time to 2022-01-01 00:00:00.
+		$reference_time = gmmktime(0, 0, 0, 1, 1, 2022);
+
+		$cookie = new Cookie('requests-testcookie', 'testvalue', $attributes, [], $reference_time);
+
+		$this->assertSame($expected, $cookie->format_for_set_cookie());
+	}
+
+	/**
+	 * Data provider.
+	 *
+	 * @return array
+	 */
+	public static function dataFormatWithAttributes() {
+		return [
+			'Empty attributes array' => [
+				'attributes' => [],
+				'expected'   => 'requests-testcookie=testvalue',
+			],
+			'Single attribute with key' => [
+				'attributes' => [
+					'domain'  => 'example.org',
+				],
+				'expected'   => 'requests-testcookie=testvalue; domain=example.org',
+			],
+			'Single attribute without key' => [
+				'attributes' => [
+					'httponly',
+				],
+				'expected'   => 'requests-testcookie=testvalue; httponly',
+			],
+			'Attributes with and without key' => [
+				'attributes' => [
+					'domain'  => 'example.org',
+					'httponly',
+					'path'    => '/',
+					'max-age' => '3600',
+				],
+				'expected'   => 'requests-testcookie=testvalue; domain=example.org; httponly; path=/; max-age=1640998800',
+			],
+		];
+	}
+}