feat: new rules for php-cs-fixer (GoogleCloudPlatform#1533)

Author: saranshdhingra

.kokoro/secrets-example.sh

@@ -60,6 +60,11 @@ export POSTGRES_DSN=
 export POSTGRES_DATABASE=
 export POSTGRES_USER=
 export POSTGRES_PASSWORD=
+export SQLSERVER_DSN=
+export SQLSERVER_DATABASE=
+export SQLSERVER_USER=
+export SQLSERVER_PASSWORD=
+export DB_SOCKET_DIR=
 
 # Datastore
 export CLOUD_DATASTORE_NAMESPACE=

.php-cs-fixer.dist.php

@@ -16,6 +16,22 @@
         'return_type_declaration' => [
             'space_before' => 'none'
         ],
+        // only converts simple strings in double quotes to single quotes
+        // ignores strings using variables, escape characters or single quotes inside
+        'single_quote' => true,
+        // there should be a single space b/w the cast and it's operand
+        'cast_spaces' => ['space' => 'single'],
+        // there shouldn't be any trailing whitespace at the end of a non-blank line
+        'no_trailing_whitespace' => true,
+        // there shouldn't be any trailing whitespace at the end of a blank line
+        'no_whitespace_in_blank_line' => true,
+        // there should be a space around binary operators like (=, => etc)
+        'binary_operator_spaces' => ['default' => 'single_space'],
+        // deals with rogue empty blank lines
+        'no_extra_blank_lines' => ['tokens' => ['extra']],
+        // reduces multi blank lines b/w phpdoc description and @param to a single line
+        // NOTE: Doesn't add a blank line if none exist
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
     ])
     ->setFinder(
         PhpCsFixer\Finder::create()

analyticsdata/quickstart_json_credentials.php

@@ -43,7 +43,6 @@
  */
 $property_id = 'YOUR-GA4-PROPERTY-ID';
 
-
 // [START analyticsdata_json_credentials_initialize]
 /* TODO(developer): Replace this variable with a valid path to the
  *  credentials.json file for your service account downloaded from the

appengine/flexible/datastore/app.php

@@ -72,7 +72,7 @@
             $entity['user_ip']);
     }
     # [END gae_flex_datastore_query]
-    array_unshift($visits, "Last 10 visits:");
+    array_unshift($visits, 'Last 10 visits:');
     $response->getBody()->write(implode("\n", $visits));
 
     return $response

appengine/flexible/datastore/test/DeployTest.php

@@ -30,6 +30,6 @@ public function testIndex()
         $this->assertEquals('200', $resp->getStatusCode(),
             'top page status code');
 
-        $this->assertStringContainsString("Last 10 visits:", (string) $resp->getBody());
+        $this->assertStringContainsString('Last 10 visits:', (string) $resp->getBody());
     }
 }

appengine/flexible/datastore/test/LocalTest.php

@@ -33,6 +33,6 @@ public function testIndex()
         $response = $app->handle($request);
         $this->assertEquals(200, $response->getStatusCode());
         $text = (string) $response->getBody();
-        $this->assertStringContainsString("Last 10 visits:", $text);
+        $this->assertStringContainsString('Last 10 visits:', $text);
     }
 }

appengine/flexible/logging/test/DeployTest.php

@@ -41,7 +41,7 @@ public function testIndex()
         $this->assertEquals('200', $resp->getStatusCode(),
             'top page status code');
 
-        $this->assertStringContainsString("Logs:", (string) $resp->getBody());
+        $this->assertStringContainsString('Logs:', (string) $resp->getBody());
     }
     public function testAsyncLog()
     {

appengine/flexible/logging/test/LocalTest.php

@@ -33,7 +33,7 @@ public function testSomeLogs()
 
         $this->assertEquals(200, $response->getStatusCode());
         $text = (string) $response->getBody();
-        $this->assertStringContainsString("Logs:", $text);
+        $this->assertStringContainsString('Logs:', $text);
     }
 
     public function testAsyncLog()

appengine/flexible/memcache/test/DeployTest.php

@@ -50,10 +50,10 @@ public function testIndex()
         $key = rand(0, 1000);
 
         // Test the /memcached REST API.
-        $this->put("/memcached/test$key", "sour");
-        $this->assertEquals("sour", $this->get("/memcached/test$key"));
-        $this->put("/memcached/test$key", "sweet");
-        $this->assertEquals("sweet", $this->get("/memcached/test$key"));
+        $this->put("/memcached/test$key", 'sour');
+        $this->assertEquals('sour', $this->get("/memcached/test$key"));
+        $this->put("/memcached/test$key", 'sweet');
+        $this->assertEquals('sweet', $this->get("/memcached/test$key"));
 
         // Make sure it handles a POST request too, which will increment the
         // counter.

appengine/flexible/memcache/test/LocalTest.php

@@ -62,26 +62,26 @@ public function testGetAndPut()
         // Use a random key to avoid colliding with simultaneous tests.
 
         // Test the /memcached REST API.
-        $request1 = (new RequestFactory)->createRequest('PUT', "/memcached/testkey1");
+        $request1 = (new RequestFactory)->createRequest('PUT', '/memcached/testkey1');
         $request1->getBody()->write('sour');
         $response1 = $app->handle($request1);
         $this->assertEquals(200, (string) $response1->getStatusCode());
 
         // Check that the key was written as expected
-        $request2 = (new RequestFactory)->createRequest('GET', "/memcached/testkey1");
+        $request2 = (new RequestFactory)->createRequest('GET', '/memcached/testkey1');
         $response2 = $app->handle($request2);
-        $this->assertEquals("sour", (string) $response2->getBody());
+        $this->assertEquals('sour', (string) $response2->getBody());
 
         // Test the /memcached REST API with a new value.
-        $request3 = (new RequestFactory)->createRequest('PUT', "/memcached/testkey2");
+        $request3 = (new RequestFactory)->createRequest('PUT', '/memcached/testkey2');
         $request3->getBody()->write('sweet');
         $response3 = $app->handle($request3);
         $this->assertEquals(200, (string) $response3->getStatusCode());
 
         // Check that the key was written as expected
-        $request4 = (new RequestFactory)->createRequest('GET', "/memcached/testkey2");
+        $request4 = (new RequestFactory)->createRequest('GET', '/memcached/testkey2');
         $response4 = $app->handle($request4);
-        $this->assertEquals("sweet", (string) $response4->getBody());
+        $this->assertEquals('sweet', (string) $response4->getBody());
     }
 }
 

appengine/flexible/twilio/app.php

@@ -28,7 +28,7 @@
 $app->addErrorMiddleware(true, true, true);
 
 $twilioAccountSid = getenv('TWILIO_ACCOUNT_SID');
-$twilioAuthToken  = getenv('TWILIO_AUTH_TOKEN');
+$twilioAuthToken = getenv('TWILIO_AUTH_TOKEN');
 $twilioNumber = getenv('TWILIO_FROM_NUMBER');
 
 # [START gae_flex_twilio_receive_call]

appengine/flexible/websockets/socket-demo.php

@@ -42,7 +42,7 @@ public function onOpen(ConnectionInterface $conn)
 
     public function onMessage(ConnectionInterface $from, $msg)
     {
-        $output = "Message received: " . $msg . "\n";
+        $output = 'Message received: ' . $msg . "\n";
         echo $output;
         foreach ($this->clients as $client) {
             $client->send($output);
@@ -59,7 +59,7 @@ public function onClose(ConnectionInterface $conn)
     public function onError(ConnectionInterface $conn, \Exception $e)
     {
         $conn->close();
-        echo "Connection closed due to error: " . $e->getMessage() . "\n";
+        echo 'Connection closed due to error: ' . $e->getMessage() . "\n";
         echo "\t" . $this->clients->count() . " connection(s) active.\n";
     }
 }

appengine/flexible/websockets/test/LocalTest.php

@@ -54,14 +54,14 @@ public function testIndex()
                 return $endPromise;
             })
             ->otherwise(function ($e) {
-                echo "Error: " . $e->getMessage() . "\n";
+                echo 'Error: ' . $e->getMessage() . "\n";
                 throw $e;
             });
 
         $this->loop->run();
         $resolvedMsg = Block\await($basePromise, $this->loop);
         $this->assertStringContainsString(
-            "Message received: Hello World!",
+            'Message received: Hello World!',
             strval($resolvedMsg)
         );
     }

appengine/flexible/wordpress/files/wp-config.php

@@ -97,7 +97,7 @@
  * You can have multiple installations in one database if you give each
  * a unique prefix. Only numbers, letters, and underscores please!
  */
-$table_prefix  = 'wp_';
+$table_prefix = 'wp_';
 
 /**
  * For developers: WordPress debugging mode.

appengine/standard/errorreporting/index.php

@@ -43,7 +43,7 @@ function throwException()
             print('Triggering a PHP Fatal Error by including a file with a syntax error.');
             print($linkText);
             $filename = tempnam(sys_get_temp_dir(), 'php_syntax_error');
-            file_put_contents($filename, "");
+            file_put_contents($filename, '');
             require($filename);
             break;
         default:

appengine/standard/getting-started/test/CloudSqlTest.php

@@ -20,22 +20,36 @@
 use Google\Cloud\Samples\AppEngine\GettingStarted\CloudSqlDataModel;
 use PHPUnit\Framework\TestCase;
 use PDO;
+use Symfony\Component\Process\Process;
 
 class CloudSqlTest extends TestCase
 {
     use TestTrait;
+    private static $process;
 
     public function setUp(): void
     {
         $connection = $this->requireEnv('CLOUDSQL_CONNECTION_NAME');
         $dbUser = $this->requireEnv('CLOUDSQL_USER');
         $dbPass = $this->requireEnv('CLOUDSQL_PASSWORD');
         $dbName = getenv('CLOUDSQL_DATABASE_NAME') ?: 'bookshelf';
-        $socket = "/tmp/cloudsql/${connection}";
+        $socketDir = $this->requireEnv('DB_SOCKET_DIR');
+        $socket = "${socketDir}/${connection}";
+
+        // create the directory to store the unix socket for cloud_sql_proxy
+        if (!is_dir($socketDir)) {
+            mkdir($socketDir, 0755, true);
+        }
+
+        self::$process = new Process(['cloud_sql_proxy', '-instances=' . $connection, '-dir', $socketDir]);
+        self::$process->start();
+        self::$process->waitUntil(function ($type, $buffer) {
+            return str_contains($buffer, 'Ready for new connections');
+        });
 
         if (!file_exists($socket)) {
             $this->markTestSkipped(
-                "You must run 'cloud_sql_proxy -instances=${connection} -dir=/cloudsql'"
+                "You must run 'cloud_sql_proxy -instances=${connection} -dir=${socketDir}'"
             );
         }
         $dsn = "mysql:unix_socket=${socket};dbname=${dbName}";
@@ -46,6 +60,11 @@ public function setUp(): void
         $this->model = new CloudSqlDataModel($pdo);
     }
 
+    public static function tearDownAfterClass(): void
+    {
+        self::$process->stop();
+    }
+
     public function testDataModel()
     {
         $model = $this->model;
@@ -144,11 +163,11 @@ public function testDataModel()
 
         // Clean up.
         $result = $model->delete($breakfastId);
-        $this->assertTrue((bool)$result);
+        $this->assertTrue((bool) $result);
         $this->assertFalse($model->read($breakfastId));
-        $this->assertTrue((bool)$model->read($bellId));
+        $this->assertTrue((bool) $model->read($bellId));
         $result = $model->delete($bellId);
-        $this->assertTrue((bool)$result);
+        $this->assertTrue((bool) $result);
         $this->assertFalse($model->read($bellId));
     }
 }

appengine/standard/grpc/monitoring.php

@@ -41,7 +41,7 @@
 $r = new MonitoredResource();
 $r->setType('gce_instance');
 $r->setLabels([
-    'instance_id' =>$instanceId,
+    'instance_id' => $instanceId,
     'zone' => 'us-central1-f',
 ]);
 

appengine/standard/grpc/speech.php

@@ -47,7 +47,7 @@
 $strm->write($strmReq);
 
 $strmReq = new StreamingRecognizeRequest();
-$f = fopen($audioFile, "rb");
+$f = fopen($audioFile, 'rb');
 $fsize = filesize($audioFile);
 $bytes = fread($f, $fsize);
 $strmReq->setAudioContent($bytes);

appengine/standard/helloworld/index.php

@@ -1,3 +1,3 @@
 
 
-echo "hello world!";
+echo 'hello world!';

bigquery/api/src/browse_table.php

@@ -30,7 +30,6 @@
 list($_, $projectId, $datasetId, $tableId) = $argv;
 $startIndex = isset($argv[4]) ? $argv[4] : 0;
 
-
 # [START bigquery_browse_table]
 use Google\Cloud\BigQuery\BigQueryClient;
 

bigquery/api/src/stream_row.php

@@ -30,7 +30,7 @@
     return printf("Usage: php %s PROJECT_ID DATASET_ID TABLE_ID [DATA]\n", __FILE__);
 }
 list($_, $projectId, $datasetId, $tableId) = $argv;
-$data = isset($argv[4]) ? json_decode($argv[4], true) : ["field1" => "value1"];
+$data = isset($argv[4]) ? json_decode($argv[4], true) : ['field1' => 'value1'];
 
 # [START bigquery_table_insert_rows]
 use Google\Cloud\BigQuery\BigQueryClient;

bigtable/src/create_cluster.php

@@ -48,18 +48,18 @@ function create_cluster(
     $instanceName = $instanceAdminClient->instanceName($projectId, $instanceId);
     $clusterName = $instanceAdminClient->clusterName($projectId, $instanceId, $clusterId);
 
-    printf("Adding Cluster to Instance %s" . PHP_EOL, $instanceId);
+    printf('Adding Cluster to Instance %s' . PHP_EOL, $instanceId);
     try {
         $instanceAdminClient->getInstance($instanceName);
     } catch (ApiException $e) {
         if ($e->getStatus() === 'NOT_FOUND') {
-            printf("Instance %s does not exists." . PHP_EOL, $instanceId);
+            printf('Instance %s does not exists.' . PHP_EOL, $instanceId);
             return;
         } else {
             throw $e;
         }
     }
-    printf("Listing Clusters:" . PHP_EOL);
+    printf('Listing Clusters:' . PHP_EOL);
 
     $storage_type = StorageType::SSD;
     $serve_nodes = 3;
@@ -81,18 +81,18 @@ function create_cluster(
     );
     try {
         $instanceAdminClient->getCluster($clusterName);
-        printf("Cluster %s already exists, aborting...", $clusterId);
+        printf('Cluster %s already exists, aborting...', $clusterId);
     } catch (ApiException $e) {
         if ($e->getStatus() === 'NOT_FOUND') {
             $operationResponse = $instanceAdminClient->createCluster($instanceName, $clusterId, $cluster);
 
             $operationResponse->pollUntilComplete();
             if ($operationResponse->operationSucceeded()) {
                 $result = $operationResponse->getResult();
-                printf("Cluster created: %s", $clusterId);
+                printf('Cluster created: %s', $clusterId);
             } else {
                 $error = $operationResponse->getError();
-                printf("Cluster not created: %s", $error);
+                printf('Cluster not created: %s', $error);
             }
         } else {
             throw $e;

bigtable/src/create_dev_instance.php

@@ -50,7 +50,7 @@ function create_dev_instance(
     $projectName = $instanceAdminClient->projectName($projectId);
     $instanceName = $instanceAdminClient->instanceName($projectId, $instanceId);
 
-    printf("Creating a DEVELOPMENT Instance" . PHP_EOL);
+    printf('Creating a DEVELOPMENT Instance' . PHP_EOL);
     // Set options to create an Instance
 
     $storageType = StorageType::HDD;
@@ -78,10 +78,10 @@ function create_dev_instance(
     // Create development instance with given options
     try {
         $instanceAdminClient->getInstance($instanceName);
-        printf("Instance %s already exists." . PHP_EOL, $instanceId);
+        printf('Instance %s already exists.' . PHP_EOL, $instanceId);
     } catch (ApiException $e) {
         if ($e->getStatus() === 'NOT_FOUND') {
-            printf("Creating a development Instance: %s" . PHP_EOL, $instanceId);
+            printf('Creating a development Instance: %s' . PHP_EOL, $instanceId);
             $operationResponse = $instanceAdminClient->createInstance(
                 $projectName,
                 $instanceId,
@@ -92,7 +92,7 @@ function create_dev_instance(
             if (!$operationResponse->operationSucceeded()) {
                 print('Error: ' . $operationResponse->getError()->getMessage());
             } else {
-                printf("Instance %s created." . PHP_EOL, $instanceId);
+                printf('Instance %s created.' . PHP_EOL, $instanceId);
             }
         } else {
             throw $e;