feat: [Gax] Add script to download and generate the showcase client and download the showcase server by Hectorhammett · Pull Request #9347 · googleapis/google-cloud-php

Hectorhammett · 2026-07-16T21:46:36Z

Created a script for downloading and generating the showcase client for the conformance tests. This client was generated a long time ago and we need a consistent way to generate and update the showcase client and server, specially with PQC around the corner.

Closes: #9229

Depends on: googleapis/gapic-generator-php#838

…the showcase server

cy-yun

LGTM!

Thanks for adding this!

bshaffer

Looks great! Most of what I have is nits - I think we have a lot of opportunities to simplify this.

bshaffer · 2026-07-22T00:53:51Z

+    private string $rootDirectory;
+    private Filesystem $fs;
+
+    public function __construct(string $rootDirectory)


nit but everywhere else this is $rootPath

bshaffer · 2026-07-22T00:54:44Z

+            )
+            ->addOption(
+                'showcase-path',
+                'p',


nit but, I'd say just make all of the aliases null (except for out-dir), as p and a aren't exactly intuitive

bshaffer · 2026-07-22T00:54:56Z

+                'Gax'
+            )
+            ->addOption(
+                'generator-path',


nit, can we call this gapic-generator-path?

bshaffer · 2026-07-22T00:57:15Z

+        $outDir = $input->getOption('out-dir');
+        $targetDir = $this->rootDirectory . trim($outDir, '/');
+        $conformanceDir = $targetDir . '/tests/Conformance';
+        $tmpOutputDir = $conformanceDir . '/tmp_out';


I'd say make this a temporary file in the filesystem, e.g.

Suggested change

$tmpOutputDir = $conformanceDir . '/tmp_out';

$tmpOutputDir = tempnam(sys_get_temp_dir(), 'showcase_out');

bshaffer · 2026-07-22T00:57:31Z

+
+        $outDir = $input->getOption('out-dir');
+        $targetDir = $this->rootDirectory . trim($outDir, '/');
+        $conformanceDir = $targetDir . '/tests/Conformance';


This should not be hardcoded, but rather part of the out-dir by default

Suggested change

$conformanceDir = $targetDir . '/tests/Conformance';

bshaffer · 2026-07-22T01:41:36Z

+        $allProtoFiles = glob($schemaDir . '/*.proto');
+        $generatorProtoFiles = array_values(array_filter(
+            $allProtoFiles,
+            fn ($file) => !str_ends_with($file, 'messaging.proto')


why are we explicitly excluding the messaging client? Please leave a comment explaining it

bshaffer · 2026-07-22T01:42:11Z

+            '--descriptor_set_out=' . $descFile,
+        ], $generatorProtoFiles, [
+            $googleapisPath . '/google/cloud/common_resources.proto',
+        ]);


nit but, can we just do this?

Suggested change

'--descriptor_set_out=' . $descFile,

], $generatorProtoFiles, [

$googleapisPath . '/google/cloud/common_resources.proto',

]);

'--descriptor_set_out=' . $descFile,

$googleapisPath . '/google/cloud/common_resources.proto'

], $generatorProtoFiles);

bshaffer · 2026-07-22T01:43:04Z

+
+        $serviceYaml = file_exists($schemaDir . '/showcase_v1beta1.yaml') ? file_get_contents($schemaDir . '/showcase_v1beta1.yaml') : null;


we can assume it exists... and if we use the filesystem component, it will throw an Exception if it doesn't exist, which would be even better (since we expect it to exist)

Suggested change

$serviceYaml = file_exists($schemaDir . '/showcase_v1beta1.yaml') ? file_get_contents($schemaDir . '/showcase_v1beta1.yaml') : null;

$serviceYaml = $this->fs->readFile($schemaDir . '/showcase_v1beta1.yaml');

bshaffer · 2026-07-22T01:45:23Z

+            $this->fs->mkdir(dirname($fullPath));
+            file_put_contents($fullPath, $content);


Should we stick with using the filesystem component? That will make calling mkdir redundant:

Suggested change

$this->fs->mkdir(dirname($fullPath));

file_put_contents($fullPath, $content);

$this->fs->dumpFile($fullPath, $content);

bshaffer · 2026-07-22T01:45:43Z

+            -1,
+            false,
+            MigrationMode::NEW_SURFACE_ONLY
+        );


can we get some comments or some named parameters here?

Hectorhammett marked this pull request as ready for review July 16, 2026 22:03

Hectorhammett requested a review from a team as a code owner July 16, 2026 22:03

bshaffer reviewed Jul 17, 2026

View reviewed changes

Comment thread Gax/tests/Conformance/src/V1beta1/Client/TestingClient.php

Comment thread Gax/tests/Conformance/bin/gapic-showcase Outdated

Comment thread Gax/generate-showcase.sh Outdated

Hectorhammett added 3 commits July 20, 2026 20:36

Add script to download and generate the showcase client and download …

787b430

…the showcase server

Add instructions on how to run the script on the Readme file

75c704e

Remove the download and avoid versioning the showcase server

f5c0273

Hectorhammett force-pushed the generate-conformance-tests branch from 67b386e to f5c0273 Compare July 20, 2026 21:08

Hectorhammett added 2 commits July 20, 2026 21:16

Update readme for conformance tests

0101af0

Modify the generator script for PHP static analysis

f8cdd9a

cy-yun reviewed Jul 20, 2026

View reviewed changes

Comment thread Gax/tests/Conformance/README.md Outdated

Comment thread Gax/tests/Conformance/README.md

Comment thread dev/src/Command/ShowcaseGenerateCommand.php

bshaffer reviewed Jul 20, 2026

View reviewed changes

Comment thread Gax/tests/Conformance/src/V1beta1/Test_Blueprint.php Outdated

Comment thread dev/src/Command/GaxGenerateShowcaseCommand.php Outdated

Comment thread dev/src/Command/GaxGenerateShowcaseCommand.php Outdated

Comment thread dev/src/Command/ShowcaseGenerateCommand.php

bshaffer reviewed Jul 20, 2026

View reviewed changes

Comment thread dev/src/Command/GaxGenerateShowcaseCommand.php Outdated

Comment thread dev/src/Command/ShowcaseGenerateCommand.php Outdated

Hectorhammett added 4 commits July 20, 2026 23:39

Add the gapig generator as a dependency

20aed66

Rename the generation command

efe4ac3

Modify the generation command to exclude deprecated files

3583cb9

Add a out directory option for the generation command

b34aa29

cy-yun requested changes Jul 21, 2026

View reviewed changes

Comment thread dev/src/Command/ShowcaseGenerateCommand.php

Comment thread dev/src/Command/ShowcaseGenerateCommand.php Outdated

cy-yun reviewed Jul 21, 2026

View reviewed changes

Comment thread dev/src/Command/ShowcaseGenerateCommand.php

Hectorhammett added 2 commits July 21, 2026 18:57

Change the gapic generator dependency

76eb66e

Add the service yaml to the client generation

6720263

cy-yun approved these changes Jul 22, 2026

View reviewed changes

bshaffer reviewed Jul 22, 2026

View reviewed changes

	$tmpOutputDir = $conformanceDir . '/tmp_out';
	$tmpOutputDir = tempnam(sys_get_temp_dir(), 'showcase_out');


		$serviceYaml = file_exists($schemaDir . '/showcase_v1beta1.yaml') ? file_get_contents($schemaDir . '/showcase_v1beta1.yaml') : null;


	$serviceYaml = file_exists($schemaDir . '/showcase_v1beta1.yaml') ? file_get_contents($schemaDir . '/showcase_v1beta1.yaml') : null;
	$serviceYaml = $this->fs->readFile($schemaDir . '/showcase_v1beta1.yaml');

		$this->fs->mkdir(dirname($fullPath));
		file_put_contents($fullPath, $content);

	$this->fs->mkdir(dirname($fullPath));
	file_put_contents($fullPath, $content);
	$this->fs->dumpFile($fullPath, $content);

Uh oh!

Conversation

Hectorhammett commented Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cy-yun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bshaffer left a comment

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Hectorhammett commented Jul 16, 2026 •

edited

Loading

cy-yun left a comment •

edited

Loading

bshaffer Jul 22, 2026 •

edited

Loading

bshaffer Jul 22, 2026 •

edited

Loading

bshaffer Jul 22, 2026 •

edited

Loading