Run PHPCS on tests (#1192)

This change updates the PHPCS configuration to enforce coding standards on all test files (unit, snippet and system tests). It continues to exclude generated code.

It also includes a sweep of test cleanup to conform to standards and modernizes some very old test code. This change shouldn't include changes to actual client code.

tests/Snippet/BigQueryClientTest.php

@@ -19,19 +19,20 @@
 
 use Google\Cloud\BigQuery\BigQueryClient;
 use Google\Cloud\BigQuery\Bytes;
-use Google\Cloud\BigQuery\Date;
-use Google\Cloud\BigQuery\Numeric;
-use Google\Cloud\BigQuery\Time;
-use Google\Cloud\BigQuery\Timestamp;
 use Google\Cloud\BigQuery\Connection\ConnectionInterface;
 use Google\Cloud\BigQuery\Dataset;
+use Google\Cloud\BigQuery\Date;
 use Google\Cloud\BigQuery\Job;
+use Google\Cloud\BigQuery\Numeric;
 use Google\Cloud\BigQuery\QueryJobConfiguration;
 use Google\Cloud\BigQuery\QueryResults;
+use Google\Cloud\BigQuery\Time;
+use Google\Cloud\BigQuery\Timestamp;
 use Google\Cloud\BigQuery\ValueMapper;
 use Google\Cloud\Core\Int64;
 use Google\Cloud\Core\Iterator\ItemIterator;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
 use Prophecy\Argument;
 
 /**
@@ -71,7 +72,7 @@ class BigQueryClientTest extends SnippetTestCase
     public function setUp()
     {
         $this->connection = $this->prophesize(ConnectionInterface::class);
-        $this->client = \Google\Cloud\Core\Testing\TestHelpers::stub(BigQueryTestClient::class);
+        $this->client = TestHelpers::stub(BigQueryTestClient::class);
         $this->client->___setProperty('connection', $this->connection->reveal());
     }
 
@@ -132,7 +133,10 @@ public function testQueryWithLocation()
         $array = $config->toArray();
 
         $this->assertInstanceOf(QueryJobConfiguration::class, $config);
-        $this->assertEquals('SELECT name FROM `my_project.users_dataset.users` LIMIT 100', $array['configuration']['query']['query']);
+        $this->assertEquals(
+            'SELECT name FROM `my_project.users_dataset.users` LIMIT 100',
+            $array['configuration']['query']['query']
+        );
         $this->assertEquals('asia-northeast1', $array['jobReference']['location']);
     }
 
@@ -442,6 +446,7 @@ public function testGetServiceAccount()
     }
 }
 
+//@codingStandardsIgnoreStart
 class BigQueryTestClient extends BigQueryClient
 {
     public function query($query, array $options = [])
@@ -462,3 +467,4 @@ protected function generateJobId()
         return BigQueryClientTest::JOB_ID;
     }
 }
+//@codingStandardsIgnoreEnd

tests/Snippet/CopyJobConfigurationTest.php

@@ -20,6 +20,7 @@
 use Google\Cloud\BigQuery\BigQueryClient;
 use Google\Cloud\BigQuery\CopyJobConfiguration;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
 
 /**
  * @group bigquery
@@ -71,7 +72,7 @@ public function testSetters($method, $expected, $bq = null)
 
     public function setterDataProvider()
     {
-        $bq = \Google\Cloud\Core\Testing\TestHelpers::stub(BigQueryClient::class, [
+        $bq = TestHelpers::stub(BigQueryClient::class, [
             ['projectId' => self::PROJECT_ID]
         ]);
 

tests/Snippet/ExtractJobConfigurationTest.php

@@ -21,6 +21,7 @@
 use Google\Cloud\BigQuery\ExtractJobConfiguration;
 use Google\Cloud\BigQuery\Table;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
 
 /**
  * @group bigquery
@@ -72,7 +73,7 @@ public function testSetters($method, $expected, $bq = null)
 
     public function setterDataProvider()
     {
-        $bq = \Google\Cloud\Core\Testing\TestHelpers::stub(BigQueryClient::class, [
+        $bq = TestHelpers::stub(BigQueryClient::class, [
             ['projectId' => self::PROJECT_ID]
         ]);
 

tests/Snippet/LoadJobConfigurationTest.php

@@ -20,6 +20,7 @@
 use Google\Cloud\BigQuery\BigQueryClient;
 use Google\Cloud\BigQuery\LoadJobConfiguration;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
 
 /**
  * @group bigquery
@@ -82,7 +83,7 @@ public function testSetters($method, $expected, $bq = null)
 
     public function setterDataProvider()
     {
-        $bq = \Google\Cloud\Core\Testing\TestHelpers::stub(BigQueryClient::class, [
+        $bq = TestHelpers::stub(BigQueryClient::class, [
             ['projectId' => self::PROJECT_ID]
         ]);
 

tests/Snippet/QueryJobConfigurationTest.php

@@ -21,6 +21,7 @@
 use Google\Cloud\BigQuery\QueryJobConfiguration;
 use Google\Cloud\BigQuery\ValueMapper;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
 
 /**
  * @group bigquery
@@ -73,7 +74,7 @@ public function testSetters($method, $expected, $bq = null)
 
     public function setterDataProvider()
     {
-        $bq = \Google\Cloud\Core\Testing\TestHelpers::stub(BigQueryClient::class, [
+        $bq = TestHelpers::stub(BigQueryClient::class, [
             ['projectId' => self::PROJECT_ID]
         ]);
 

tests/Snippet/QueryResultsTest.php

@@ -22,6 +22,7 @@
 use Google\Cloud\BigQuery\QueryResults;
 use Google\Cloud\BigQuery\ValueMapper;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
 use Prophecy\Argument;
 
 /**
@@ -63,7 +64,7 @@ public function setUp()
         ];
 
         $this->connection = $this->prophesize(ConnectionInterface::class);
-        $this->qr = \Google\Cloud\Core\Testing\TestHelpers::stub(QueryResults::class, [
+        $this->qr = TestHelpers::stub(QueryResults::class, [
             $this->connection->reveal(),
             self::JOB_ID,
             self::PROJECT,

tests/Snippet/TableTest.php

@@ -28,8 +28,9 @@
 use Google\Cloud\BigQuery\Table;
 use Google\Cloud\BigQuery\ValueMapper;
 use Google\Cloud\Core\Iterator\ItemIterator;
-use Google\Cloud\Core\Upload\MultipartUploader;
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
+use Google\Cloud\Core\Testing\TestHelpers;
+use Google\Cloud\Core\Upload\MultipartUploader;
 use Google\Cloud\Storage\Connection\Rest as StorageConnection;
 use Google\Cloud\Storage\StorageClient;
 use Prophecy\Argument;
@@ -73,7 +74,7 @@ public function setUp()
 
         $this->mapper = new ValueMapper(false);
         $this->connection = $this->prophesize(ConnectionInterface::class);
-        $this->table = \Google\Cloud\Core\Testing\TestHelpers::stub(Table::class, [
+        $this->table = TestHelpers::stub(Table::class, [
             $this->connection->reveal(),
             self::ID,
             self::DSID,
@@ -202,7 +203,7 @@ public function testStartJob()
 
     public function testCopy()
     {
-        $bq = \Google\Cloud\Core\Testing\TestHelpers::stub(BigQueryClient::class);
+        $bq = TestHelpers::stub(BigQueryClient::class);
         $snippet = $this->snippetFromMethod(Table::class, 'copy');
         $snippet->addLocal('bigQuery', $bq);
         $bq->___setProperty('connection', $this->connection->reveal());
@@ -229,7 +230,7 @@ public function testCopy()
 
     public function testExtract()
     {
-        $storage = \Google\Cloud\Core\Testing\TestHelpers::stub(StorageClient::class);
+        $storage = TestHelpers::stub(StorageClient::class);
         $storage->___setProperty('connection', $this->prophesize(StorageConnection::class)->reveal());
         $snippet = $this->snippetFromMethod(Table::class, 'extract');
         $snippet->addLocal('storage', $storage);
@@ -274,7 +275,7 @@ public function testLoad()
 
     public function testLoadFromStorage()
     {
-        $storage = \Google\Cloud\Core\Testing\TestHelpers::stub(StorageClient::class);
+        $storage = TestHelpers::stub(StorageClient::class);
         $storage->___setProperty('connection', $this->prophesize(StorageConnection::class)->reveal());
         $snippet = $this->snippetFromMethod(Table::class, 'loadFromStorage');
         $snippet->addLocal('storage', $storage);
@@ -336,7 +337,10 @@ public function testInfo()
         $snippet->addLocal('table', $this->table);
 
         $res = $snippet->invoke();
-        $this->assertEquals('https://www.googleapis.com/bigquery/v2/projects/my-project/datasets/mynewdataset', $res->output());
+        $this->assertEquals(
+            'https://www.googleapis.com/bigquery/v2/projects/my-project/datasets/mynewdataset',
+            $res->output()
+        );
     }
 
     public function testReload()
@@ -353,7 +357,10 @@ public function testReload()
         $this->table->___setProperty('connection', $this->connection->reveal());
 
         $res = $snippet->invoke();
-        $this->assertEquals('https://www.googleapis.com/bigquery/v2/projects/my-project/datasets/myupdateddataset', $res->output());
+        $this->assertEquals(
+            'https://www.googleapis.com/bigquery/v2/projects/my-project/datasets/myupdateddataset',
+            $res->output()
+        );
     }
 
     public function testId()

tests/System/BigQueryTestCase.php

@@ -59,12 +59,8 @@ public static function setUpBeforeClass()
     protected static function createTable(Dataset $dataset, $name, array $options = [])
     {
         if (!isset($options['schema'])) {
-            $options['schema']['fields'] = json_decode(
-                file_get_contents(__DIR__ . '/data/table-schema.json'), true
-            );
+            $options['schema']['fields'] = json_decode(file_get_contents(__DIR__ . '/data/table-schema.json'), true);
         }
         return $dataset->createTable(uniqid(self::TESTING_PREFIX), $options);
     }
 }
-
-

tests/Unit/BigQueryClientTest.php

@@ -323,20 +323,16 @@ public function testGetsDatasetsWithToken()
     {
         $client = $this->getClient();
         $this->connection->listDatasets(Argument::any())
-            ->willReturn(
-                [
-                    'nextPageToken' => 'token',
-                    'datasets' => [
-                        ['datasetReference' => ['datasetId' => 'someOtherdatasetId']]
-                    ]
-                ],
-                    [
-                    'datasets' => [
-                        ['datasetReference' => ['datasetId' => self::DATASET_ID]]
-                    ]
+            ->willReturn([
+                'nextPageToken' => 'token',
+                'datasets' => [
+                    ['datasetReference' => ['datasetId' => 'someOtherdatasetId']]
+                ]
+            ], [
+                'datasets' => [
+                    ['datasetReference' => ['datasetId' => self::DATASET_ID]]
                 ]
-            )
-            ->shouldBeCalledTimes(2);
+            ])->shouldBeCalledTimes(2);
 
         $client->___setProperty('connection', $this->connection->reveal());
         $dataset = iterator_to_array($client->datasets());

tests/Unit/DatasetTest.php

@@ -146,20 +146,16 @@ public function testGetsTablesWithoutToken()
     public function testGetsTablesWithToken()
     {
         $this->connection->listTables(Argument::any())
-            ->willReturn(
-                [
-                    'nextPageToken' => 'token',
-                    'tables' => [
-                        ['tableReference' => ['tableId' => 'someOthertableId']]
-                    ]
-                ],
-                    [
-                    'tables' => [
-                        ['tableReference' => ['tableId' => $this->tableId]]
-                    ]
+            ->willReturn([
+                'nextPageToken' => 'token',
+                'tables' => [
+                    ['tableReference' => ['tableId' => 'someOthertableId']]
+                ]
+            ], [
+                'tables' => [
+                    ['tableReference' => ['tableId' => $this->tableId]]
                 ]
-            )
-            ->shouldBeCalledTimes(2);
+            ])->shouldBeCalledTimes(2);
 
         $dataset = $this->getDataset($this->connection);
         $tables = iterator_to_array($dataset->tables());

tests/Unit/JobConfigurationTraitTest.php

@@ -18,8 +18,9 @@
 namespace Google\Cloud\BigQuery\Tests\Unit;
 
 use Google\Cloud\BigQuery\JobConfigurationTrait;
-use Ramsey\Uuid\Uuid;
+use Google\Cloud\Core\Testing\TestHelpers;
 use PHPUnit\Framework\TestCase;
+use Ramsey\Uuid\Uuid;
 
 /**
  * @group bigquery
@@ -34,7 +35,7 @@ class JobConfigurationTraitTest extends TestCase
 
     public function setUp()
     {
-        $this->trait = \Google\Cloud\Core\Testing\TestHelpers::impl(JobConfigurationTrait::class);
+        $this->trait = TestHelpers::impl(JobConfigurationTrait::class);
     }
 
     public function testJobConfigurationProperties()

tests/Unit/JobWaitTraitTest.php

@@ -19,6 +19,7 @@
 
 use Google\Cloud\BigQuery\Job;
 use Google\Cloud\BigQuery\JobWaitTrait;
+use Google\Cloud\Core\Testing\TestHelpers;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -31,7 +32,7 @@ class JobWaitTraitTest extends TestCase
 
     public function setUp()
     {
-        $this->trait = \Google\Cloud\Core\Testing\TestHelpers::impl(JobWaitTrait::class);
+        $this->trait = TestHelpers::impl(JobWaitTrait::class);
         $this->job = $this->prophesize(Job::class)->reveal();
     }
 
@@ -41,11 +42,11 @@ public function testWaitSucceedsWhenAlreadyComplete()
         $isReloadCalled = false;
 
         $this->trait->call('wait', [
-            function() use (&$isCompleteCalled) {
+            function () use (&$isCompleteCalled) {
                 $isCompleteCalled = true;
                 return true;
             },
-            function() use (&$isReloadCalled) {
+            function () use (&$isReloadCalled) {
                 $isReloadCalled = true;
                 return ['complete' => true];
             },
@@ -63,11 +64,11 @@ public function testWaitCallsReloadThenSucceeds()
         $isReloadCalled = false;
 
         $this->trait->call('wait', [
-            function() use (&$isCompleteCallCount, &$isReloadCalled) {
+            function () use (&$isCompleteCallCount, &$isReloadCalled) {
                 $isCompleteCallCount++;
                 return $isReloadCalled ? true : false;
             },
-            function() use (&$isReloadCalled) {
+            function () use (&$isReloadCalled) {
                 $isReloadCalled = true;
                 return ['complete' => true];
             },
@@ -86,8 +87,12 @@ function() use (&$isReloadCalled) {
     public function testWaitThrowsExceptionWhenMaxAttemptsMet()
     {
         $this->trait->call('wait', [
-            function() { return false; },
-            function () { return ['complete' => false]; },
+            function () {
+                return false;
+            },
+            function () {
+                return ['complete' => false];
+            },
             $this->job,
             1
         ]);

tests/Unit/TableTest.php

@@ -678,10 +678,12 @@ public function testGetsIdentity()
     }
 }
 
+//@codingStandardsIgnoreStart
 class TableStub extends Table
 {
     protected function usleep($ms)
     {
         return;
     }
 }
+//@codingStandardsIgnoreEnd

tests/Unit/ValueMapperTest.php

@@ -45,7 +45,7 @@ public function testThrowsExceptionWithUnhandledClass()
      */
     public function testToParameterThrowsExceptionWithUnhandledType()
     {
-        $f = fopen('php://temp','r');
+        $f = fopen('php://temp', 'r');
         fclose($f);
         $mapper = new ValueMapper(false);
         $mapper->toParameter($f);