Merge pull request #2484 from kylekatarnls/feature/mock-with-timezone

Implement setTestNowAndTimezone()
briannesbitt · Nov 1, 2021 · eed8393 · eed8393
2 parents 2cf868e + a4ecf41
commit eed8393
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 43 deletions.
diff --git a/src/Carbon/Traits/Test.php b/src/Carbon/Traits/Test.php
@@ -11,8 +11,10 @@
 
 namespace Carbon\Traits;
 
+use Carbon\CarbonInterface;
 use Closure;
 use DateTimeImmutable;
+use DateTimeInterface;
 
 trait Test
 {
@@ -55,6 +57,21 @@ public static function setTestNow($testNow = null)
         static::$testNow = \is_string($testNow) ? static::parse($testNow) : $testNow;
     }
 
+    public static function setTestNowAndTimezone($testNow = null, $tz = null)
+    {
+        $useDateInstanceTimezone = $testNow instanceof DateTimeInterface;
+
+        if ($useDateInstanceTimezone) {
+            date_default_timezone_set($testNow->getTimezone()->getName());
+        }
+
+        static::setTestNow($testNow);
+
+        if (!$useDateInstanceTimezone) {
+            date_default_timezone_set(static::getMockedTestNow(\func_num_args() === 1 ? null : $tz)->timezone);
+        }
+    }
+
     /**
      * Temporarily sets a static date to be used within the callback.
      * Using setTestNow to set the date, executing the callback, then
@@ -98,27 +115,6 @@ public static function hasTestNow()
         return static::getTestNow() !== null;
     }
 
-    /**
-     * Return the given timezone and set it to the test instance if not null.
-     * If null, get the timezone from the test instance and return it.
-     *
-     * @param string|\DateTimeZone    $tz
-     * @param \Carbon\CarbonInterface $testInstance
-     *
-     * @return string|\DateTimeZone
-     */
-    protected static function handleMockTimezone($tz, &$testInstance)
-    {
-        //shift the time according to the given time zone
-        if ($tz !== null && $tz !== static::getMockedTestNow($tz)->getTimezone()) {
-            $testInstance = $testInstance->setTimezone($tz);
-
-            return $tz;
-        }
-
-        return $testInstance->getTimezone();
-    }
-
     /**
      * Get the mocked date passed in setTestNow() and if it's a Closure, execute it.
      *
@@ -139,20 +135,22 @@ protected static function getMockedTestNow($tz)
         }
         /* @var \Carbon\CarbonImmutable|\Carbon\Carbon|null $testNow */
 
-        return $testNow;
+        return $testNow instanceof CarbonInterface
+            ? $testNow->avoidMutation()->tz($tz)
+            : $testNow;
     }
 
-    protected static function mockConstructorParameters(&$time, &$tz)
+    protected static function mockConstructorParameters(&$time, $tz)
     {
         /** @var \Carbon\CarbonImmutable|\Carbon\Carbon $testInstance */
         $testInstance = clone static::getMockedTestNow($tz);
 
-        $tz = static::handleMockTimezone($tz, $testInstance);
-
         if (static::hasRelativeKeywords($time)) {
             $testInstance = $testInstance->modify($time);
         }
 
-        $time = $testInstance instanceof self ? $testInstance->rawFormat(static::MOCK_DATETIME_FORMAT) : $testInstance->format(static::MOCK_DATETIME_FORMAT);
+        $time = $testInstance instanceof self
+            ? $testInstance->rawFormat(static::MOCK_DATETIME_FORMAT)
+            : $testInstance->format(static::MOCK_DATETIME_FORMAT);
     }
 }
diff --git a/tests/AbstractTestCase.php b/tests/AbstractTestCase.php
@@ -73,8 +73,8 @@ protected function setUp(): void
             ? CarbonImmutable::create(2017, 6, 27, 13, 14, 15, 'UTC')
             : CarbonImmutable::now();
 
-        Carbon::setTestNow($this->now = $now);
-        CarbonImmutable::setTestNow($this->immutableNow = $immutableNow);
+        Carbon::setTestNowAndTimezone($this->now = $now);
+        CarbonImmutable::setTestNowAndTimezone($this->immutableNow = $immutableNow);
 
         Carbon::useStrictMode(true);
         CarbonImmutable::useStrictMode(true);
@@ -227,11 +227,11 @@ public function wrapWithTestNow(Closure $func, CarbonInterface $dt = null)
         $test = Carbon::getTestNow();
         $immutableTest = CarbonImmutable::getTestNow();
         $dt = $dt ?: Carbon::now();
-        Carbon::setTestNow($dt);
-        CarbonImmutable::setTestNow($dt);
+        Carbon::setTestNowAndTimezone($dt);
+        CarbonImmutable::setTestNowAndTimezone($dt);
         $func();
-        Carbon::setTestNow($test);
-        CarbonImmutable::setTestNow($immutableTest);
+        Carbon::setTestNowAndTimezone($test);
+        CarbonImmutable::setTestNowAndTimezone($immutableTest);
     }
 
     public function wrapWithNonDstDate(Closure $func)

diff --git a/tests/Carbon/ComparisonTest.php b/tests/Carbon/ComparisonTest.php
@@ -263,7 +263,7 @@ public function testIsBirthday()
 
         // Birthday test can't work on February 29th
         if ($dt->format('m-d') === '02-29') {
-            Carbon::setTestNow($dt->subDay());
+            Carbon::setTestNowAndTimezone($dt->subDay());
             $dt = Carbon::now();
         }
 

diff --git a/tests/Carbon/ConstructTest.php b/tests/Carbon/ConstructTest.php
@@ -69,14 +69,14 @@ public function testParseCreatesAnInstanceDefaultToNow()
 
     public function testWithFancyString()
     {
-        Carbon::setTestNow(Carbon::today());
+        Carbon::setTestNowAndTimezone(Carbon::today());
         $c = new Carbon('first day of January 2008');
         $this->assertCarbon($c, 2008, 1, 1, 0, 0, 0);
     }
 
     public function testParseWithFancyString()
     {
-        Carbon::setTestNow(Carbon::today());
+        Carbon::setTestNowAndTimezone(Carbon::today());
         $c = Carbon::parse('first day of January 2008');
         $this->assertCarbon($c, 2008, 1, 1, 0, 0, 0);
     }

diff --git a/tests/Carbon/TestingAidsTest.php b/tests/Carbon/TestingAidsTest.php
@@ -201,7 +201,7 @@ public function testTimeZoneWithTestValueSet()
 
     public function testCreateFromPartialFormat()
     {
-        Carbon::setTestNow($now = Carbon::parse('2013-09-01 05:10:15', 'America/Vancouver'));
+        Carbon::setTestNowAndTimezone('2013-09-01 05:10:15 America/Vancouver', 'America/Vancouver');
 
         // Simple partial time.
         $this->assertSame('2018-05-06T05:10:15-07:00', Carbon::createFromFormat('Y-m-d', '2018-05-06')->toIso8601String());
@@ -244,7 +244,7 @@ public function testCreateFromPartialFormat()
 
     public function testCreateFromPartialFormatWithMicroseconds()
     {
-        Carbon::setTestNow($now = Carbon::parse('2013-09-01 05:10:15.123456', 'America/Vancouver'));
+        Carbon::setTestNowAndTimezone(Carbon::parse('2013-09-01 05:10:15.123456', 'America/Vancouver'));
 
         // Set microseconds to zero to match behavior of DateTime::createFromFormat()
         // See https://bugs.php.net/bug.php?id=74332

diff --git a/tests/CarbonImmutable/TestingAidsTest.php b/tests/CarbonImmutable/TestingAidsTest.php
@@ -210,7 +210,7 @@ public function testTimeZoneWithTestValueSet()
 
     public function testCreateFromPartialFormat()
     {
-        Carbon::setTestNow($now = Carbon::parse('2013-09-01 05:10:15', 'America/Vancouver'));
+        Carbon::setTestNowAndTimezone(Carbon::parse('2013-09-01 05:10:15', 'America/Vancouver'));
 
         // Simple partial time.
         $this->assertSame('2018-05-06T05:10:15-07:00', Carbon::createFromFormat('Y-m-d', '2018-05-06')->toIso8601String());
@@ -253,7 +253,7 @@ public function testCreateFromPartialFormat()
 
     public function testCreateFromPartialFormatWithMicroseconds()
     {
-        Carbon::setTestNow($now = Carbon::parse('2013-09-01 05:10:15.123456', 'America/Vancouver'));
+        Carbon::setTestNowAndTimezone(Carbon::parse('2013-09-01 05:10:15.123456', 'America/Vancouver'));
 
         // Set microseconds to zero to match behavior of DateTime::createFromFormat()
         // See https://bugs.php.net/bug.php?id=74332

diff --git a/tests/CarbonPeriod/SettersTest.php b/tests/CarbonPeriod/SettersTest.php
@@ -337,7 +337,7 @@ public function testSetRelativeDates()
 
     public function testFluentSetters()
     {
-        Carbon::setTestNow(Carbon::now('UTC'));
+        Carbon::setTestNowAndTimezone(Carbon::now('UTC'));
 
         $period = CarbonInterval::days(3)->toPeriod()->since('2018-04-21')->until('2018-04-27');
         $dates = [];

diff --git a/tests/CarbonPeriod/ToStringTest.php b/tests/CarbonPeriod/ToStringTest.php
@@ -35,7 +35,7 @@ public function testToString($period, $expected)
 
     public function provideToString(): Generator
     {
-        Carbon::setTestNow(new Carbon('2015-09-01', 'America/Toronto'));
+        Carbon::setTestNowAndTimezone(new Carbon('2015-09-01', 'America/Toronto'));
 
         yield [
                 CarbonPeriod::create('R4/2012-07-01T12:00:00/P7D'),
@@ -101,7 +101,7 @@ public function testToIso8601String($period, $expected)
 
     public function provideToIso8601String(): Generator
     {
-        Carbon::setTestNow(new Carbon('2015-09-01', 'America/Toronto'));
+        Carbon::setTestNowAndTimezone(new Carbon('2015-09-01', 'America/Toronto'));
 
         yield [
                 CarbonPeriod::create('R4/2012-07-01T00:00:00-04:00/P7D'),

diff --git a/tests/Factory/FactoryTest.php b/tests/Factory/FactoryTest.php
@@ -84,7 +84,7 @@ public function testFactoryModification()
 
     public function testFactoryTimezone()
     {
-        Carbon::setTestNow(Carbon::parse('2020-09-04 03:39:04.123456', 'UTC'));
+        Carbon::setTestNowAndTimezone(Carbon::parse('2020-09-04 03:39:04.123456', 'UTC'));
 
         $factory = new Factory();