chore: replace cs and staticanalysis with reusable workflows

.github/sync-repo-settings.yaml

@@ -13,8 +13,8 @@ branchProtectionRules:
     - 'PHP 8.3 Unit Test'
     - 'PHP 8.3 Unit Test protobuf,grpc'
     - 'Run google-cloud-php tests'
-    - 'PHP Style Check'
-    - 'PHPStan Static Analysis'
+    - 'PHP Style Check / PHP Code Standards'
+    - 'PHPStan Static Analysis / PHPStan Static Analysis'
     - 'cla/google'
   requiredApprovingReviewCount: 1
   requiresCodeOwnerReviews: true

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Generate Documentation
+name: Documentation
 
 on:
     push:
@@ -15,7 +15,7 @@ permissions:
 
 jobs:
     docs:
-        name: "Generate and Deploy Documentation"
+        name: "Generate Documentation"
         uses: GoogleCloudPlatform/php-tools/.github/workflows/doctum.yml@main
         with:
           title: "Google API Core (GAX) Reference Documentation"

.github/workflows/tests.yml

@@ -43,39 +43,11 @@ jobs:
               run: vendor/bin/phpunit
 
     style:
-        runs-on: ubuntu-latest
         name: PHP Style Check
-        steps:
-            - uses: actions/checkout@v4
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                php-version: "8.2"
-            - name: Install Dependencies
-              uses: nick-invision/retry@v3
-              with:
-                timeout_minutes: 10
-                max_attempts: 3
-                command: composer install
-            - name: Run Script
-              run: vendor/bin/phpcs -s --standard=./ruleset.xml
-
-    staticanalysis:
-      runs-on: ubuntu-latest
-      name: PHPStan Static Analysis
-      steps:
-      - uses: actions/checkout@v4
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '8.2'
-      - name: Install Dependencies
-        uses: nick-invision/retry@v3
+        uses: GoogleCloudPlatform/php-tools/.github/workflows/code-standards.yml@main
         with:
-          timeout_minutes: 10
-          max_attempts: 3
-          command: composer install
-      - name: Run Script
-        run: |
-          vendor/bin/phpstan analyse
+          path: src
 
+    static-analysis:
+        name: PHPStan Static Analysis
+        uses: GoogleCloudPlatform/php-tools/.github/workflows/static-analysis.yml@main

src/AgentHeader.php

@@ -101,9 +101,9 @@ public static function buildAgentHeader(array $headerInfo)
 
         $metricsList = [];
         foreach ($metricsHeaders as $key => $value) {
-            $metricsList[] = $key . "/" . $value;
+            $metricsList[] = $key . '/' . $value;
         }
-        return [self::AGENT_HEADER_KEY => [implode(" ", $metricsList)]];
+        return [self::AGENT_HEADER_KEY => [implode(' ', $metricsList)]];
     }
 
     /**

src/ApiException.php

@@ -35,7 +35,6 @@
 use Google\Protobuf\Internal\RepeatedField;
 use Google\Rpc\Status;
 use GuzzleHttp\Exception\RequestException;
-use Google\ApiCore\Testing\MockStatus;
 use stdClass;
 
 /**

src/BidiStream.php

@@ -68,10 +68,10 @@ public function __construct(BidiStreamingCall $bidiStreamingCall, array $streami
     public function write($request)
     {
         if ($this->isComplete) {
-            throw new ValidationException("Cannot call write() after streaming call is complete.");
+            throw new ValidationException('Cannot call write() after streaming call is complete.');
         }
         if ($this->writesClosed) {
-            throw new ValidationException("Cannot call write() after calling closeWrite().");
+            throw new ValidationException('Cannot call write() after calling closeWrite().');
         }
         $this->call->write($request);
     }
@@ -99,7 +99,7 @@ public function closeWrite()
     {
         if ($this->isComplete) {
             throw new ValidationException(
-                "Cannot call closeWrite() after streaming call is complete."
+                'Cannot call closeWrite() after streaming call is complete.'
             );
         }
         if (!$this->writesClosed) {
@@ -119,7 +119,7 @@ public function closeWrite()
     public function read()
     {
         if ($this->isComplete) {
-            throw new ValidationException("Cannot call read() after streaming call is complete.");
+            throw new ValidationException('Cannot call read() after streaming call is complete.');
         }
         $resourcesGetMethod = $this->resourcesGetMethod;
         if (!is_null($resourcesGetMethod)) {

src/ClientStream.php

@@ -47,7 +47,7 @@ class ClientStream
      * @param ClientStreamingCall $clientStreamingCall The gRPC client streaming call object
      * @param array $streamingDescriptor
      */
-    public function __construct(  // @phpstan-ignore-line
+    public function __construct(// @phpstan-ignore-line
         ClientStreamingCall $clientStreamingCall,
         array $streamingDescriptor = []
     ) {

src/CredentialsWrapper.php

@@ -34,18 +34,15 @@
 use DomainException;
 use Exception;
 use Google\Auth\ApplicationDefaultCredentials;
-use Google\Auth\ProjectIdProviderInterface;
 use Google\Auth\Cache\MemoryCacheItemPool;
+use Google\Auth\Credentials\GCECredentials;
 use Google\Auth\Credentials\ServiceAccountCredentials;
 use Google\Auth\CredentialsLoader;
 use Google\Auth\FetchAuthTokenCache;
 use Google\Auth\FetchAuthTokenInterface;
 use Google\Auth\GetQuotaProjectInterface;
 use Google\Auth\GetUniverseDomainInterface;
-use Google\Auth\Credentials\GCECredentials;
-use Google\Auth\HttpHandler\Guzzle6HttpHandler;
-use Google\Auth\HttpHandler\Guzzle7HttpHandler;
-use Google\Auth\HttpHandler\HttpHandlerFactory;
+use Google\Auth\ProjectIdProviderInterface;
 use Google\Auth\UpdateMetadataInterface;
 use Psr\Cache\CacheItemPoolInterface;
 
@@ -335,7 +332,7 @@ private static function buildApplicationDefaultCredentials(
                 $defaultScopes
             );
         } catch (DomainException $ex) {
-            throw new ValidationException("Could not construct ApplicationDefaultCredentials", $ex->getCode(), $ex);
+            throw new ValidationException('Could not construct ApplicationDefaultCredentials', $ex->getCode(), $ex);
         }
     }
 

src/FixedSizeCollection.php

@@ -62,7 +62,7 @@ public function __construct(Page $initialPage, int $collectionSize)
         if ($collectionSize < $initialPage->getPageElementCount()) {
             $ipc = $initialPage->getPageElementCount();
             throw new InvalidArgumentException(
-                "collectionSize must be greater than or equal to the number of " .
+                'collectionSize must be greater than or equal to the number of ' .
                 "elements in initialPage. collectionSize: $collectionSize, " .
                 "initialPage size: $ipc"
             );
@@ -178,8 +178,8 @@ private static function createPageArray(Page $initialPage, int $collectionSize)
             $currentPage = $currentPage->getNextPage($remainingCount);
             $rxElementCount = $currentPage->getPageElementCount();
             if ($rxElementCount > $remainingCount) {
-                throw new LengthException("API returned a number of elements " .
-                    "exceeding the specified page size limit. page size: " .
+                throw new LengthException('API returned a number of elements ' .
+                    'exceeding the specified page size limit. page size: ' .
                     "$remainingCount, elements received: $rxElementCount");
             }
             array_push($pageList, $currentPage);

src/Middleware/CredentialsWrapperMiddleware.php

@@ -33,7 +33,6 @@
 
 use Google\ApiCore\Call;
 use Google\ApiCore\CredentialsWrapper;
-use GuzzleHttp\Promise\PromiseInterface;
 
 /**
 * Middleware which adds a CredentialsWrapper object to the call options.

src/Middleware/FixedHeaderMiddleware.php

@@ -33,7 +33,6 @@
 namespace Google\ApiCore\Middleware;
 
 use Google\ApiCore\Call;
-use GuzzleHttp\Promise\PromiseInterface;
 
 /**
  * Middleware to add fixed headers to an API call.

src/Middleware/MiddlewareInterface.php

@@ -32,11 +32,11 @@
 
 namespace Google\ApiCore\Middleware;
 
+use Google\ApiCore\BidiStream;
 use Google\ApiCore\Call;
-use GuzzleHttp\Promise\PromiseInterface;
 use Google\ApiCore\ClientStream;
 use Google\ApiCore\ServerStream;
-use Google\ApiCore\BidiStream;
+use GuzzleHttp\Promise\PromiseInterface;
 
 /**
  * Middlewares must take a MiddlewareInterface as their first constructor

src/Middleware/OperationsMiddleware.php

@@ -34,7 +34,6 @@
 use Google\ApiCore\Call;
 use Google\ApiCore\OperationResponse;
 use Google\Protobuf\Internal\Message;
-use GuzzleHttp\Promise\PromiseInterface;
 
 /**
  * Middleware which wraps the response in an OperationResponse object.

src/Middleware/OptionsFilterMiddleware.php

@@ -33,7 +33,6 @@
 
 use Google\ApiCore\ArrayTrait;
 use Google\ApiCore\Call;
-use GuzzleHttp\Promise\PromiseInterface;
 
 /**
 * Middleware which filters the $options array.

src/Middleware/PagedMiddleware.php

@@ -36,7 +36,6 @@
 use Google\ApiCore\PagedListResponse;
 use Google\ApiCore\PageStreamingDescriptor;
 use Google\Protobuf\Internal\Message;
-use GuzzleHttp\Promise\PromiseInterface;
 
 /**
 * Middleware which wraps the response in an PagedListResponses object.

src/Middleware/RequestAutoPopulationMiddleware.php

@@ -87,7 +87,7 @@ public function __invoke(Call $call, array $options)
                         break;
                     default:
                         throw new \UnexpectedValueException(sprintf(
-                            "Value type %s::%s not supported for auto population of the field %s",
+                            'Value type %s::%s not supported for auto population of the field %s',
                             Format::class,
                             Format::name($valueType),
                             $fieldName

src/OperationResponse.php

@@ -32,12 +32,12 @@
 
 namespace Google\ApiCore;
 
-use Google\LongRunning\Client\OperationsClient;
-use Google\LongRunning\OperationsClient as LegacyOperationsClient;
 use Google\LongRunning\CancelOperationRequest;
+use Google\LongRunning\Client\OperationsClient;
 use Google\LongRunning\DeleteOperationRequest;
 use Google\LongRunning\GetOperationRequest;
 use Google\LongRunning\Operation;
+use Google\LongRunning\OperationsClient as LegacyOperationsClient;
 use Google\Protobuf\Any;
 use Google\Protobuf\Internal\Message;
 use Google\Rpc\Status;
@@ -272,7 +272,7 @@ public function pollUntilComplete(array $options = [])
     public function reload()
     {
         if ($this->deleted) {
-            throw new ValidationException("Cannot call reload() on a deleted operation");
+            throw new ValidationException('Cannot call reload() on a deleted operation');
         }
 
         $requestClass = $this->isNewSurfaceOperationsClient() ? $this->getOperationRequest : null;

src/Options/ClientOptions.php

@@ -34,10 +34,10 @@
 
 use ArrayAccess;
 use Closure;
-use InvalidArgumentException;
 use Google\ApiCore\CredentialsWrapper;
 use Google\ApiCore\Transport\TransportInterface;
 use Google\Auth\FetchAuthTokenInterface;
+use InvalidArgumentException;
 
 /**
  * The ClientOptions class adds typing to the associative array of options

src/Options/OptionsTrait.php

@@ -32,8 +32,8 @@
 
 namespace Google\ApiCore\Options;
 
-use Google\ApiCore\ValidationException;
 use BadMethodCallException;
+use Google\ApiCore\ValidationException;
 
 /**
  * Trait implemented by any class representing an associative array of PHP options.

src/Options/TransportOptions.php

@@ -32,10 +32,10 @@
 
 namespace Google\ApiCore\Options;
 
-use Google\ApiCore\Options\TransportOptions\GrpcTransportOptions;
+use ArrayAccess;
 use Google\ApiCore\Options\TransportOptions\GrpcFallbackTransportOptions;
+use Google\ApiCore\Options\TransportOptions\GrpcTransportOptions;
 use Google\ApiCore\Options\TransportOptions\RestTransportOptions;
-use ArrayAccess;
 
 class TransportOptions implements ArrayAccess
 {

src/Options/TransportOptions/GrpcTransportOptions.php

@@ -35,9 +35,9 @@
 use ArrayAccess;
 use Closure;
 use Google\ApiCore\Options\OptionsTrait;
+use Google\ApiCore\Transport\Grpc\UnaryInterceptorInterface;
 use Grpc\Channel;
 use Grpc\Interceptor;
-use Google\ApiCore\Transport\Grpc\UnaryInterceptorInterface;
 
 /**
  * The GrpcTransportOptions class provides typing to the associative array of options used to

src/Page.php

@@ -42,7 +42,7 @@
  */
 class Page implements IteratorAggregate
 {
-    const FINAL_PAGE_TOKEN = "";
+    const FINAL_PAGE_TOKEN = '';
 
     private $call;
     private $callable;
@@ -243,26 +243,26 @@ public function expandToFixedSizeCollection($collectionSize)
     {
         if (!$this->pageStreamingDescriptor->requestHasPageSizeField()) {
             throw new ValidationException(
-                "FixedSizeCollection is not supported for this method, because " .
-                "the method does not support an optional argument to set the " .
-                "page size."
+                'FixedSizeCollection is not supported for this method, because ' .
+                'the method does not support an optional argument to set the ' .
+                'page size.'
             );
         }
         $request = $this->getRequestObject();
         $pageSizeGetMethod = $this->pageStreamingDescriptor->getRequestPageSizeGetMethod();
         $pageSize = $request->$pageSizeGetMethod();
         if (is_null($pageSize)) {
             throw new ValidationException(
-                "Error while expanding Page to FixedSizeCollection: No page size " .
-                "parameter found. The page size parameter must be set in the API " .
-                "optional arguments array, and must be less than the collectionSize " .
-                "parameter, in order to create a FixedSizeCollection object."
+                'Error while expanding Page to FixedSizeCollection: No page size ' .
+                'parameter found. The page size parameter must be set in the API ' .
+                'optional arguments array, and must be less than the collectionSize ' .
+                'parameter, in order to create a FixedSizeCollection object.'
             );
         }
         if ($pageSize > $collectionSize) {
             throw new ValidationException(
-                "Error while expanding Page to FixedSizeCollection: collectionSize " .
-                "parameter is less than the page size optional argument specified in " .
+                'Error while expanding Page to FixedSizeCollection: collectionSize ' .
+                'parameter is less than the page size optional argument specified in ' .
                 "the API call. collectionSize: $collectionSize, page size: $pageSize"
             );
         }

src/RequestBuilder.php

@@ -111,7 +111,7 @@ public function build(string $path, Message $message, array $headers = [])
 
                 // Request enum fields will be encoded as numbers rather than strings  (in the response).
                 if ($numericEnums) {
-                    $queryParams['$alt'] = "json;enum-encoding=int";
+                    $queryParams['$alt'] = 'json;enum-encoding=int';
                 }
 
                 $uri = $this->buildUri($pathTemplate, $queryParams);
@@ -132,8 +132,8 @@ public function build(string $path, Message $message, array $headers = [])
         }
 
         throw new ValidationException("Could not map bindings for $path to any Uri template.\n" .
-            "Bindings: " . print_r($bindings, true) .
-            "UriTemplates: " . print_r($uriTemplates, true));
+            'Bindings: ' . print_r($bindings, true) .
+            'UriTemplates: ' . print_r($uriTemplates, true));
     }
 
     /**