Merge pull request #126 from mathieutu/master

Allow using env var to manage snapshot creation and update

Author: freekmurze

README.md

@@ -156,7 +156,7 @@ FAILURES!
 Tests: 1, Assertions: 1, Failures: 1.
 ```
 
-When we expect a changed value, we need to tell the test runner to update the existing snapshots instead of failing the test. This is possible by adding  a`-d --update-snapshots` flag to the `phpunit` command.
+When we expect a changed value, we need to tell the test runner to update the existing snapshots instead of failing the test. This is possible by adding  a`-d --update-snapshots` flag to the `phpunit` command, or setting the `UPDATE_SNAPSHOTS` env var to `true`.
 
 ```
 > ./vendor/bin/phpunit -d --update-snapshots
@@ -278,14 +278,27 @@ $this->assertMatchesSnapshot($something->toYaml(), new MyYamlDriver());
 
 When running your tests in Continuous Integration you would possibly want to disable the creation of snapshots.
 
-By using the `--without-creating-snapshots` parameter, PHPUnit will fail if the snapshots don't exist.
+By using the `--without-creating-snapshots` parameter or by setting the `CREATE_SNAPSHOTS` env var to `false`, PHPUnit will fail if the snapshots don't exist.
 
 ```bash
 > ./vendor/bin/phpunit -d --without-creating-snapshots
 
 1) ExampleTest::test_it_matches_a_string
 Snapshot "ExampleTest__test_it_matches_a_string__1.txt" does not exist.
-You can automatically create it by removing `-d --no-create-snapshots` of PHPUnit's CLI arguments.
+You can automatically create it by removing the `CREATE_SNAPSHOT=false` env var, or `-d --no-create-snapshots` of PHPUnit's CLI arguments.
+```
+
+### Usage with parallel testing
+
+If you want to run your test in parallel with a tool like [Paratest](https://github.com/paratestphp/paratest), ou with the `php artisan test --parallel` command of Laravel, you will have to use the environment variables.
+
+
+```bash
+> CREATE_SNAPSHOTS=false php artisan test --parallel
+
+1) ExampleTest::test_it_matches_a_string
+Snapshot "ExampleTest__test_it_matches_a_string__1.txt" does not exist.
+You can automatically create it by removing the `CREATE_SNAPSHOT=false` env var, or `-d --no-create-snapshots` of PHPUnit's CLI arguments.
 ```
 
 ### A note for Windows users

src/MatchesSnapshots.php

@@ -130,23 +130,28 @@ protected function getFileSnapshotDirectory(): string
      * matched.
      *
      * Override this method it you want to use a different flag or mechanism
-     * than `-d --update-snapshots`.
+     * than `-d --update-snapshots` or `UPDATE_SNAPSHOTS=true` env var.
      */
     protected function shouldUpdateSnapshots(): bool
     {
-        return in_array('--update-snapshots', $_SERVER['argv'], true);
+        if(in_array('--update-snapshots', $_SERVER['argv'], true)) {
+            return true;
+        }
+
+        return getenv('UPDATE_SNAPSHOTS') === 'true';
     }
 
     /*
      * Determines whether or not the snapshot should be created instead of
      * matched.
      *
      * Override this method if you want to use a different flag or mechanism
-     * than `-d --without-creating-snapshots`.
+     * than `-d --without-creating-snapshots` or `CREATE_SNAPSHOTS=false` env var.
      */
     protected function shouldCreateSnapshots(): bool
     {
-        return ! in_array('--without-creating-snapshots', $_SERVER['argv'], true);
+        return ! in_array('--without-creating-snapshots', $_SERVER['argv'], true)
+            && getenv('CREATE_SNAPSHOTS') !== 'false';
     }
 
     protected function doSnapshotAssertion($actual, Driver $driver)
@@ -299,6 +304,7 @@ protected function assertSnapshotShouldBeCreated(string $snapshotFileName): void
         $this->fail(
             "Snapshot \"$snapshotFileName\" does not exist.\n".
             'You can automatically create it by removing '.
+            'the `CREATE_SNAPSHOT=false` env var, or '.
             '`-d --without-creating-snapshots` of PHPUnit\'s CLI arguments.'
         );
     }

tests/Integration/MatchesSnapshotTest.php

@@ -400,6 +400,23 @@ public function it_can_update_a_file_snapshot_with_a_different_extension()
         $this->assertFileDoesNotExist($oldSnapshot);
     }
 
+    /** @test */
+    public function it_can_update_a_snapshot_with_env_var()
+    {
+        putenv('UPDATE_SNAPSHOTS=true');
+
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectIncompleteMatchesSnapshotTest($mockTrait, function ($mockTrait) {
+            $mockTrait->assertMatchesSnapshot('Foo');
+        });
+
+        $this->assertSnapshotMatchesExample(
+            'MatchesSnapshotTest__it_can_update_a_snapshot_with_env_var__1.txt',
+            'string_snapshot.txt'
+        );
+    }
+
     private function expectIncompleteMatchesSnapshotTest(MockObject $matchesSnapshotMock, callable $assertions)
     {
         $matchesSnapshotMock
@@ -479,7 +496,7 @@ public function it_doesnt_create_a_regular_snapshot_and_mismatches_if_asked()
         $this->expectFail(
             $mockTrait,
             "Snapshot \"MatchesSnapshotTest__it_doesnt_create_a_regular_snapshot_and_mismatches_if_asked__1.txt\" does not exist.\n".
-            'You can automatically create it by removing `-d --without-creating-snapshots` of PHPUnit\'s CLI arguments.'
+            "You can automatically create it by removing the `CREATE_SNAPSHOT=false` env var, or `-d --without-creating-snapshots` of PHPUnit's CLI arguments."
         );
 
         $mockTrait->assertMatchesSnapshot('Bar');
@@ -495,7 +512,39 @@ public function it_doesnt_create_a_file_snapshot_and_mismatches_if_asked()
         $this->expectFail(
             $mockTrait,
             "Snapshot \"MatchesSnapshotTest__it_doesnt_create_a_file_snapshot_and_mismatches_if_asked__1.jpg_failed.jpg\" does not exist.\n".
-            'You can automatically create it by removing `-d --without-creating-snapshots` of PHPUnit\'s CLI arguments.'
+            "You can automatically create it by removing the `CREATE_SNAPSHOT=false` env var, or `-d --without-creating-snapshots` of PHPUnit's CLI arguments."
+        );
+
+        $mockTrait->assertMatchesFileSnapshot(__DIR__.'/stubs/test_files/friendly_man.jpg');
+    }
+
+    /** @test */
+    public function it_doesnt_create_a_regular_snapshot_and_mismatches_if_asked_with_env_var()
+    {
+        putenv('CREATE_SNAPSHOTS=false');
+
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectFail(
+            $mockTrait,
+            "Snapshot \"MatchesSnapshotTest__it_doesnt_create_a_regular_snapshot_and_mismatches_if_asked_with_env_var__1.txt\" does not exist.\n".
+            "You can automatically create it by removing the `CREATE_SNAPSHOT=false` env var, or `-d --without-creating-snapshots` of PHPUnit's CLI arguments."
+        );
+
+        $mockTrait->assertMatchesSnapshot('Bar');
+    }
+
+    /** @test */
+    public function it_doesnt_create_a_file_snapshot_and_mismatches_if_asked_with_env_var()
+    {
+        putenv('CREATE_SNAPSHOT=false');
+
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectFail(
+            $mockTrait,
+            "Snapshot \"MatchesSnapshotTest__it_doesnt_create_a_file_snapshot_and_mismatches_if_asked_with_env_var__1.jpg_failed.jpg\" does not exist.\n".
+            "You can automatically create it by removing the `CREATE_SNAPSHOT=false` env var, or `-d --without-creating-snapshots` of PHPUnit's CLI arguments."
         );
 
         $mockTrait->assertMatchesFileSnapshot(__DIR__.'/stubs/test_files/friendly_man.jpg');

tests/Integration/stubs/__snapshots__/MatchesSnapshotTest__it_can_update_a_snapshot_with_env_var__1.txt

@@ -0,0 +1 @@
+Bar