chore(functions): Revise test coverage for CI utility updates (GoogleCloudPlatform#1215)

grayside · web-flow · commit 41c441625533 · 2020-11-09T13:46:50.000-08:00
diff --git a/functions/concepts_filesystem/test/DeployTest.php b/functions/concepts_filesystem/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'listFiles';
+    private static $entryPoint = 'listFiles';
 
     /**
       * @dataProvider cases
diff --git a/functions/concepts_filesystem/test/SystemTest.php b/functions/concepts_filesystem/test/SystemTest.php
@@ -31,7 +31,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'listFiles';
+    private static $entryPoint = 'listFiles';
 
     /**
       * @dataProvider cases
diff --git a/functions/concepts_filesystem/test/UnitTest.php b/functions/concepts_filesystem/test/UnitTest.php
@@ -30,7 +30,7 @@ class UnitTest extends TestCase
 {
     use TestCasesTrait;
     
-    private static $name = 'listFiles';
+    private static $entryPoint = 'listFiles';
 
     public static function setUpBeforeClass(): void
     {
@@ -43,7 +43,7 @@ public static function setUpBeforeClass(): void
     public function testFunction($file): void
     {
         $request = new ServerRequest('GET', '/');
-        $response = $this->runFunction(self::$name, [$request]);
+        $response = $this->runFunction(self::$entryPoint, [$request]);
         $this->assertContains($file, $response);
     }
 
diff --git a/functions/concepts_requests/test/DeployTest.php b/functions/concepts_requests/test/DeployTest.php
@@ -37,7 +37,18 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'makeRequest';
+    private static $entryPoint = 'makeRequest';
+
+    /**
+     * Deploy the Function.
+     *
+     * Overrides CloudFunctionLocalTestTrait::doDeploy().
+     */
+    private static function doDeploy()
+    {
+        $case = reset(self::cases());
+        self::$fn->run([$case['varName'] => $case['varValue']]);
+    }
 
     /**
       * @dataProvider cases
diff --git a/functions/concepts_requests/test/SystemTest.php b/functions/concepts_requests/test/SystemTest.php
@@ -31,7 +31,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'makeRequest';
+    private static $entryPoint = 'makeRequest';
 
     /**
       * @dataProvider cases
diff --git a/functions/concepts_requests/test/UnitTest.php b/functions/concepts_requests/test/UnitTest.php
@@ -31,7 +31,7 @@ class UnitTest extends TestCase
 {
     use TestCasesTrait;
 
-    private static $name = 'makeRequest';
+    private static $entryPoint = 'makeRequest';
 
     public static function setUpBeforeClass(): void
     {
@@ -44,7 +44,7 @@ public static function setUpBeforeClass(): void
     public function testFunction($statusCode): void
     {
         $request = new ServerRequest('GET', '');
-        $output = $this->runFunction(self::$name, [$request]);
+        $output = $this->runFunction(self::$entryPoint, [$request]);
         $this->assertEquals(
             $statusCode,
             $output->getStatusCode()
diff --git a/functions/env_vars/test/DeployTest.php b/functions/env_vars/test/DeployTest.php
@@ -37,7 +37,20 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'envVar';
+    private static $entryPoint = 'envVar';
+
+    /**
+     * Deploy the Function.
+     *
+     * Overrides CloudFunctionDeploymentTrait::doDeploy().
+     */
+    private static function doDeploy()
+    {
+        // Use the first test case as the source of the deployed environment variable.
+        $cases = self::cases();
+        $env = sprintf("%s=%s", $cases[0]['varName'], $cases[0]['varValue']);
+        self::$fn->deploy(['--update-env-vars' => $env]);
+    }
 
     /**
       * @dataProvider cases
diff --git a/functions/env_vars/test/SystemTest.php b/functions/env_vars/test/SystemTest.php
@@ -31,7 +31,20 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'envVar';
+    private static $entryPoint = 'envVar';
+
+    /**
+     * Run the PHP server locally for the defined function.
+     *
+     * Overrides CloudFunctionLocalTestTrait::doRun().
+     */
+    private static function doRun()
+    {
+        // Use the first test case as the source of the deployed environment variable.
+        $cases = self::cases();
+        $case = reset($cases);
+        self::$fn->run([$case['varName'] => $case['varValue']]);
+    }
 
     /**
       * @dataProvider cases
@@ -41,9 +54,6 @@ public function testFunction(
         $varName,
         $varValue
     ): void {
-        // Check the target env variable
-        $this->requireEnv($varName);
-
         // Send a request to the function.
         $resp = $this->client->get('/');
 
diff --git a/functions/env_vars/test/TestCasesTrait.php b/functions/env_vars/test/TestCasesTrait.php
@@ -22,6 +22,7 @@ trait TestCasesTrait
 {
     public static function cases(): array
     {
+        // WARNING: DeployTest and SystemTest are only deployed with the first test case.
         return [
             [
                 'statusCode' => 200,
diff --git a/functions/env_vars/test/UnitTest.php b/functions/env_vars/test/UnitTest.php
@@ -30,13 +30,11 @@ class UnitTest extends TestCase
 {
     use TestCasesTrait;
 
-    private static $name = 'envVar';
+    private static $entryPoint = 'envVar';
 
     public static function setUpBeforeClass(): void
     {
         require_once __DIR__ . '/../index.php';
-
-        putenv("FOO=bar");
     }
 
     /**
@@ -47,8 +45,9 @@ public function testFunction(
         $varName,
         $varValue
     ): void {
+        putenv("$varName=$varValue");
         $request = new ServerRequest('GET', '/');
-        $output = $this->runFunction(self::$name, [$request]);
+        $output = $this->runFunction(self::$entryPoint, [$request]);
         $this->assertContains($varValue, $output);
     }
 
diff --git a/functions/helloworld_get/test/DeployTest.php b/functions/helloworld_get/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloGet';
+    private static $entryPoint = 'helloGet';
 
     /**
       * @dataProvider cases
diff --git a/functions/helloworld_get/test/SystemTest.php b/functions/helloworld_get/test/SystemTest.php
@@ -31,7 +31,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloGet';
+    private static $entryPoint = 'helloGet';
 
     /**
       * @dataProvider cases
diff --git a/functions/helloworld_get/test/UnitTest.php b/functions/helloworld_get/test/UnitTest.php
@@ -28,7 +28,7 @@
  */
 class UnitTest extends TestCase
 {
-    private static $name = 'helloGet';
+    private static $entryPoint = 'helloGet';
 
     use TestCasesTrait;
 
@@ -43,7 +43,7 @@ public static function setUpBeforeClass(): void
     public function testFunction($statusCode, $expected): void
     {
         $request = new ServerRequest('GET', '');
-        $output = $this->runFunction(self::$name, [$request]);
+        $output = $this->runFunction(self::$entryPoint, [$request]);
         $this->assertContains($expected, $output);
     }
 
diff --git a/functions/helloworld_http/test/DeployTest.php b/functions/helloworld_http/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloHttp';
+    private static $entryPoint = 'helloHttp';
 
     /**
       * @dataProvider cases
diff --git a/functions/helloworld_http/test/SystemTest.php b/functions/helloworld_http/test/SystemTest.php
@@ -32,7 +32,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloHttp';
+    private static $entryPoint = 'helloHttp';
 
     /**
       * @dataProvider cases
diff --git a/functions/helloworld_http/test/UnitTest.php b/functions/helloworld_http/test/UnitTest.php
@@ -29,7 +29,7 @@ class UnitTest extends TestCase
 {
     use TestCasesTrait;
 
-    private static $name = 'helloHttp';
+    private static $entryPoint = 'helloHttp';
 
     public static function setUpBeforeClass(): void
     {
@@ -49,7 +49,7 @@ public function testFunction(
         $body = json_encode($body);
         $request = (new ServerRequest('POST', '/', [], $body))
           ->withQueryParams($query);
-        $actual = $this->runFunction(self::$name, [$request]);
+        $actual = $this->runFunction(self::$entryPoint, [$request]);
         $this->assertContains($expected, $actual, $label . ':');
     }
 
diff --git a/functions/http_content_type/test/DeployTest.php b/functions/http_content_type/test/DeployTest.php
@@ -35,7 +35,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloContent';
+    private static $entryPoint = 'helloContent';
 
     public function testFunction(): void
     {
diff --git a/functions/http_content_type/test/SystemTest.php b/functions/http_content_type/test/SystemTest.php
@@ -32,7 +32,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloContent';
+    private static $entryPoint = 'helloContent';
 
     public function testFunction(): void
     {
diff --git a/functions/http_content_type/test/UnitTest.php b/functions/http_content_type/test/UnitTest.php
@@ -31,7 +31,7 @@ class UnitTest extends TestCase
 {
     use TestCasesTrait;
 
-    private static $name = 'helloContent';
+    private static $entryPoint = 'helloContent';
 
     public static function setUpBeforeClass()
     {
@@ -42,7 +42,7 @@ public function testFunction(): void
     {
         foreach (self::cases() as $test) {
             $request = new ServerRequest('POST', '/', ['content-type' => $test['content-type']], $test['body']);
-            $actual = $this->runFunction(self::$name, [$request]);
+            $actual = $this->runFunction(self::$entryPoint, [$request]);
             $this->assertContains($test['expected'], $actual, $test['content-type'] . ':');
         }
     }
diff --git a/functions/http_cors/test/DeployTest.php b/functions/http_cors/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'corsEnabledFunction';
+    private static $entryPoint = 'corsEnabledFunction';
 
     /**
       * @dataProvider cases
diff --git a/functions/http_cors/test/SystemTest.php b/functions/http_cors/test/SystemTest.php
@@ -31,7 +31,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'corsEnabledFunction';
+    private static $entryPoint = 'corsEnabledFunction';
 
     /**
       * @dataProvider cases
diff --git a/functions/http_cors/test/UnitTest.php b/functions/http_cors/test/UnitTest.php
@@ -29,7 +29,7 @@
  */
 class UnitTest extends TestCase
 {
-    private static $name = 'corsEnabledFunction';
+    private static $entryPoint = 'corsEnabledFunction';
 
     use TestCasesTrait;
 
@@ -50,7 +50,7 @@ public function testFunction(
         $notContainsContent
     ): void {
         $request = new ServerRequest($method, '/');
-        $response = $this->runFunction(self::$name, [$request]);
+        $response = $this->runFunction(self::$entryPoint, [$request]);
 
         // Assert status code.
         $this->assertEquals(
diff --git a/functions/http_form_data/test/DeployTest.php b/functions/http_form_data/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'uploadFile';
+    private static $entryPoint = 'uploadFile';
 
     /**
      * @dataProvider cases
diff --git a/functions/http_form_data/test/SystemTest.php b/functions/http_form_data/test/SystemTest.php
@@ -32,7 +32,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'uploadFile';
+    private static $entryPoint = 'uploadFile';
 
     /**
      * @dataProvider cases
diff --git a/functions/http_method/test/DeployTest.php b/functions/http_method/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'httpMethod';
+    private static $entryPoint = 'httpMethod';
 
     /**
       * @dataProvider cases
diff --git a/functions/http_method/test/SystemTest.php b/functions/http_method/test/SystemTest.php
@@ -31,7 +31,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'httpMethod';
+    private static $entryPoint = 'httpMethod';
 
     /**
       * @dataProvider cases
diff --git a/functions/http_method/test/UnitTest.php b/functions/http_method/test/UnitTest.php
@@ -31,7 +31,7 @@ class UnitTest extends TestCase
 {
     use TestCasesTrait;
 
-    private static $name = 'httpMethod';
+    private static $entryPoint = 'httpMethod';
 
     public static function setUpBeforeClass(): void
     {
@@ -47,7 +47,7 @@ public function testFunction(
         $content
     ): void {
         $request = new ServerRequest($method, '/');
-        $output = $this->runFunction(self::$name, [$request]);
+        $output = $this->runFunction(self::$entryPoint, [$request]);
         $this->assertEquals(
             $statusCode,
             $output->getStatusCode()
diff --git a/functions/log_helloworld/test/DeployTest.php b/functions/log_helloworld/test/DeployTest.php
@@ -37,7 +37,7 @@ class DeployTest extends TestCase
     use CloudFunctionDeploymentTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloLogging';
+    private static $entryPoint = 'helloLogging';
 
     public function testFunction(): void
     {
diff --git a/functions/log_helloworld/test/SystemTest.php b/functions/log_helloworld/test/SystemTest.php
@@ -31,7 +31,7 @@ class SystemTest extends TestCase
     use CloudFunctionLocalTestTrait;
     use TestCasesTrait;
 
-    private static $name = 'helloLogging';
+    private static $entryPoint = 'helloLogging';
 
     public function testFunction(): void
     {
diff --git a/functions/log_helloworld/test/UnitTest.php b/functions/log_helloworld/test/UnitTest.php

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class UnitTest extends TestCase`
`30`	`30`	`{`
`31`	`31`	`use TestCasesTrait;`
`32`	`32`
`33`		`- private static $name = 'listFiles';`
	`33`	`+ private static $entryPoint = 'listFiles';`
`34`	`34`
`35`	`35`	`public static function setUpBeforeClass(): void`
`36`	`36`	`{`
`@@ -43,7 +43,7 @@ public static function setUpBeforeClass(): void`
`43`	`43`	`public function testFunction($file): void`
`44`	`44`	`{`
`45`	`45`	`$request = new ServerRequest('GET', '/');`
`46`		`- $response = $this->runFunction(self::$name, [$request]);`
	`46`	`+ $response = $this->runFunction(self::$entryPoint, [$request]);`
`47`	`47`	`$this->assertContains($file, $response);`
`48`	`48`	`}`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class UnitTest extends TestCase`
`31`	`31`	`{`
`32`	`32`	`use TestCasesTrait;`
`33`	`33`
`34`		`- private static $name = 'makeRequest';`
	`34`	`+ private static $entryPoint = 'makeRequest';`
`35`	`35`
`36`	`36`	`public static function setUpBeforeClass(): void`
`37`	`37`	`{`
`@@ -44,7 +44,7 @@ public static function setUpBeforeClass(): void`
`44`	`44`	`public function testFunction($statusCode): void`
`45`	`45`	`{`
`46`	`46`	`$request = new ServerRequest('GET', '');`
`47`		`- $output = $this->runFunction(self::$name, [$request]);`
	`47`	`+ $output = $this->runFunction(self::$entryPoint, [$request]);`
`48`	`48`	`$this->assertEquals(`
`49`	`49`	`$statusCode,`
`50`	`50`	`$output->getStatusCode()`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ trait TestCasesTrait`
`22`	`22`	`{`
`23`	`23`	`public static function cases(): array`
`24`	`24`	`{`
	`25`	`+ // WARNING: DeployTest and SystemTest are only deployed with the first test case.`
`25`	`26`	`return [`
`26`	`27`	`[`
`27`	`28`	`'statusCode' => 200,`
Original file line number	Diff line number	Diff line change
`@@ -30,13 +30,11 @@ class UnitTest extends TestCase`
`30`	`30`	`{`
`31`	`31`	`use TestCasesTrait;`
`32`	`32`
`33`		`- private static $name = 'envVar';`
	`33`	`+ private static $entryPoint = 'envVar';`
`34`	`34`
`35`	`35`	`public static function setUpBeforeClass(): void`
`36`	`36`	`{`
`37`	`37`	`require_once __DIR__ . '/../index.php';`
`38`		`-`
`39`		`- putenv("FOO=bar");`
`40`	`38`	`}`
`41`	`39`
`42`	`40`	`/**`
`@@ -47,8 +45,9 @@ public function testFunction(`
`47`	`45`	`$varName,`
`48`	`46`	`$varValue`
`49`	`47`	`): void {`
	`48`	`+ putenv("$varName=$varValue");`
`50`	`49`	`$request = new ServerRequest('GET', '/');`
`51`		`- $output = $this->runFunction(self::$name, [$request]);`
	`50`	`+ $output = $this->runFunction(self::$entryPoint, [$request]);`
`52`	`51`	`$this->assertContains($varValue, $output);`
`53`	`52`	`}`
`54`	`53`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`*/`
`29`	`29`	`class UnitTest extends TestCase`
`30`	`30`	`{`
`31`		`- private static $name = 'helloGet';`
	`31`	`+ private static $entryPoint = 'helloGet';`
`32`	`32`
`33`	`33`	`use TestCasesTrait;`
`34`	`34`
`@@ -43,7 +43,7 @@ public static function setUpBeforeClass(): void`
`43`	`43`	`public function testFunction($statusCode, $expected): void`
`44`	`44`	`{`
`45`	`45`	`$request = new ServerRequest('GET', '');`
`46`		`- $output = $this->runFunction(self::$name, [$request]);`
	`46`	`+ $output = $this->runFunction(self::$entryPoint, [$request]);`
`47`	`47`	`$this->assertContains($expected, $output);`
`48`	`48`	`}`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class UnitTest extends TestCase`
`29`	`29`	`{`
`30`	`30`	`use TestCasesTrait;`
`31`	`31`
`32`		`- private static $name = 'helloHttp';`
	`32`	`+ private static $entryPoint = 'helloHttp';`
`33`	`33`
`34`	`34`	`public static function setUpBeforeClass(): void`
`35`	`35`	`{`
`@@ -49,7 +49,7 @@ public function testFunction(`
`49`	`49`	`$body = json_encode($body);`
`50`	`50`	`$request = (new ServerRequest('POST', '/', [], $body))`
`51`	`51`	`->withQueryParams($query);`
`52`		`- $actual = $this->runFunction(self::$name, [$request]);`
	`52`	`+ $actual = $this->runFunction(self::$entryPoint, [$request]);`
`53`	`53`	`$this->assertContains($expected, $actual, $label . ':');`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class DeployTest extends TestCase`
`35`	`35`	`use CloudFunctionDeploymentTrait;`
`36`	`36`	`use TestCasesTrait;`
`37`	`37`
`38`		`- private static $name = 'helloContent';`
	`38`	`+ private static $entryPoint = 'helloContent';`
`39`	`39`
`40`	`40`	`public function testFunction(): void`
`41`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class SystemTest extends TestCase`
`32`	`32`	`use CloudFunctionLocalTestTrait;`
`33`	`33`	`use TestCasesTrait;`
`34`	`34`
`35`		`- private static $name = 'helloContent';`
	`35`	`+ private static $entryPoint = 'helloContent';`
`36`	`36`
`37`	`37`	`public function testFunction(): void`
`38`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class DeployTest extends TestCase`
`37`	`37`	`use CloudFunctionDeploymentTrait;`
`38`	`38`	`use TestCasesTrait;`
`39`	`39`
`40`		`- private static $name = 'helloLogging';`
	`40`	`+ private static $entryPoint = 'helloLogging';`
`41`	`41`
`42`	`42`	`public function testFunction(): void`
`43`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class SystemTest extends TestCase`
`31`	`31`	`use CloudFunctionLocalTestTrait;`
`32`	`32`	`use TestCasesTrait;`
`33`	`33`
`34`		`- private static $name = 'helloLogging';`
	`34`	`+ private static $entryPoint = 'helloLogging';`
`35`	`35`
`36`	`36`	`public function testFunction(): void`
`37`	`37`	`{`