Restructure testing (#929)

* Add system test credentials CLI * Update Snippet testing for restructure * Fix unit tests for restructure * Fix system test runner * Fix conformance bootstrap * fix credentials CLIts * Fix docs * exclude dev folder from snippet parsing * install latest composer * Credentials CLI should not throw exception * Test component integration * Don't fail if extension is missing * skip tests if debugger ext is missing * Allow setting the search location paths for the SourceLocationResolver (#6)
googleapis · Mar 22, 2018 · 06f02c5 · 06f02c5
1 parent d72266f
commit 06f02c5
Show file tree

Hide file tree

Showing 181 changed files with 1,005 additions and 1,709 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ vendor/
 
 # do not delete
 keys/
+.testing
diff --git a/.travis.yml b/.travis.yml
@@ -18,7 +18,7 @@ before_script:
   - if [[ $TRAVIS_PHP_VERSION =~ ^7 ]]; then pecl install stackdriver_debugger-alpha || echo 'Failed to install stackdriver_debugger'; fi
   - composer install
   - if [[ $TRAVIS_PHP_VERSION =~ ^hhvm ]]; then composer --no-interaction --dev remove google/protobuf google/gax google/proto-client; fi
-  - ./dev/sh/system-test-credentials
+  - dev/google-cloud credentials
 
 env:
   global:
@@ -34,7 +34,3 @@ after_success:
   - if [[ $TRAVIS_PHP_VERSION =~ ^hhvm ]]; then bash <(curl -s https://codecov.io/bash); fi
   - ./dev/sh/push-docs
   - ./dev/sh/trigger-split
-  - cat ./build/snippets-uncovered.json
-
-after_failure:
-  - echo "SNIPPET COVERAGE REPORT" && cat ./build/snippets-uncovered.json
diff --git a/BigQuery/phpunit-snippets.xml.dist b/BigQuery/phpunit-snippets.xml.dist
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Snippet/bootstrap.php" colors="true">
+<phpunit
+  bootstrap="./vendor/google/cloud-core/snippet-bootstrap.php"
+  colors="true"
+  printerClass="Google\Cloud\Core\Testing\Snippet\Coverage\ResultPrinter">
   <testsuites>
     <testsuite>
       <directory>tests/Snippet</directory>

diff --git a/BigQuery/phpunit-system.xml.dist b/BigQuery/phpunit-system.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/System/bootstrap.php" colors="true">
+<phpunit bootstrap="./vendor/google-cloud/cloud-core/system-bootstrap.php" colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/System</directory>

diff --git a/BigQuery/phpunit.xml.dist b/BigQuery/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Unit/bootstrap.php" colors="true">
+<phpunit colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/Unit</directory>

diff --git a/BigQuery/tests/Snippet/bootstrap.php b/BigQuery/tests/Snippet/bootstrap.php
diff --git a/BigQuery/tests/System/bootstrap.php b/BigQuery/tests/System/bootstrap.php
@@ -1,24 +1,5 @@
 <?php
 
-require __DIR__ . '/../../vendor/autoload.php';
+use Google\Cloud\Core\Testing\TestHelpers;
 
-use Google\Cloud\Core\Testing\System\SystemTestCase;
-
-if (!getenv('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH')) {
-    throw new \Exception(
-        'Please set the \'GOOGLE_CLOUD_PHP_TESTS_KEY_PATH\' env var to run the system tests'
-    );
-}
-
-SystemTestCase::setupQueue();
-
-$pid = getmypid();
-register_shutdown_function(function () use ($pid) {
-    // Skip flushing deletion queue if exiting a forked process.
-    if ($pid !== getmypid()) {
-        return;
-    }
-
-    // This should always be last.
-    SystemTestCase::processQueue();
-});
+TestHelpers::requireKeyfile('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH');
diff --git a/BigQuery/tests/Unit/bootstrap.php b/BigQuery/tests/Unit/bootstrap.php
diff --git a/Bigtable/composer.json b/Bigtable/composer.json
@@ -8,7 +8,9 @@
         "google/gax": "^0.30"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8|^5.0"
+        "phpunit/phpunit": "^4.8|^5.0",
+        "google/cloud-core": "^1.14",
+        "phpdocumentor/reflection": "^3.0"
     },
     "suggest": {
         "ext-protobuf": "Provides a significant increase in throughput over the pure PHP protobuf implementation. See https://cloud.google.com/php/grpc for installation instructions."

diff --git a/Bigtable/phpunit-snippets.xml.dist b/Bigtable/phpunit-snippets.xml.dist
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Snippet/bootstrap.php" colors="true">
+<phpunit
+  bootstrap="./vendor/google/cloud-core/snippet-bootstrap.php"
+  colors="true"
+  printerClass="Google\Cloud\Core\Testing\Snippet\Coverage\ResultPrinter">
   <testsuites>
     <testsuite>
       <directory>tests/Snippet</directory>

diff --git a/Bigtable/phpunit-system.xml.dist b/Bigtable/phpunit-system.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/System/bootstrap.php" colors="true">
+<phpunit bootstrap="./vendor/google-cloud/cloud-core/system-bootstrap.php" colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/System</directory>

diff --git a/Bigtable/phpunit.xml.dist b/Bigtable/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Unit/bootstrap.php" colors="true">
+<phpunit colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/Unit</directory>

diff --git a/Bigtable/tests/Snippet/bootstrap.php b/Bigtable/tests/Snippet/bootstrap.php
diff --git a/Bigtable/tests/System/bootstrap.php b/Bigtable/tests/System/bootstrap.php
@@ -1,9 +1,5 @@
 <?php
 
-require __DIR__ . '/../../vendor/autoload.php';
+use Google\Cloud\Core\Testing\TestHelpers;
 
-if (!getenv('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH')) {
-    throw new \Exception(
-        'Please set the \'GOOGLE_CLOUD_PHP_TESTS_KEY_PATH\' env var to run the system tests'
-    );
-}
+TestHelpers::requireKeyfile('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH');
diff --git a/Bigtable/tests/Unit/bootstrap.php b/Bigtable/tests/Unit/bootstrap.php
diff --git a/Container/composer.json b/Container/composer.json
@@ -21,6 +21,8 @@
         "google/gax": "^0.30"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8|^5.0"
+        "phpunit/phpunit": "^4.8|^5.0",
+        "google/cloud-core": "^1.14",
+        "phpdocumentor/reflection": "^3.0"
     }
 }
diff --git a/Container/phpunit-snippets.xml.dist b/Container/phpunit-snippets.xml.dist
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Snippet/bootstrap.php" colors="true">
+<phpunit
+  bootstrap="./vendor/google/cloud-core/snippet-bootstrap.php"
+  colors="true"
+  printerClass="Google\Cloud\Core\Testing\Snippet\Coverage\ResultPrinter">
   <testsuites>
     <testsuite>
       <directory>tests/Snippet</directory>

diff --git a/Container/phpunit-system.xml.dist b/Container/phpunit-system.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/System/bootstrap.php" colors="true">
+<phpunit bootstrap="./vendor/google-cloud/cloud-core/system-bootstrap.php" colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/System</directory>

diff --git a/Container/phpunit.xml.dist b/Container/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Unit/bootstrap.php" colors="true">
+<phpunit colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/Unit</directory>

diff --git a/Container/tests/Snippet/bootstrap.php b/Container/tests/Snippet/bootstrap.php
diff --git a/Container/tests/System/bootstrap.php b/Container/tests/System/bootstrap.php
@@ -1,9 +1,5 @@
 <?php
 
-require __DIR__ . '/../../vendor/autoload.php';
+use Google\Cloud\Core\Testing\TestHelpers;
 
-if (!getenv('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH')) {
-    throw new \Exception(
-        'Please set the \'GOOGLE_CLOUD_PHP_TESTS_KEY_PATH\' env var to run the system tests'
-    );
-}
+TestHelpers::requireKeyfile('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH');
diff --git a/Container/tests/Unit/bootstrap.php b/Container/tests/Unit/bootstrap.php
diff --git a/Core/phpunit-snippets.xml.dist b/Core/phpunit-snippets.xml.dist
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Snippet/bootstrap.php" colors="true">
+<phpunit
+  bootstrap="./snippet-bootstrap.php"
+  colors="true"
+  printerClass="Google\Cloud\Core\Testing\Snippet\Coverage\ResultPrinter">
   <testsuites>
     <testsuite>
       <directory>tests/Snippet</directory>

diff --git a/Core/phpunit-system.xml.dist b/Core/phpunit-system.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/System/bootstrap.php" colors="true">
+<phpunit bootstrap="./vendor/google-cloud/cloud-core/system-bootstrap.php" colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/System</directory>

diff --git a/Core/phpunit.xml.dist b/Core/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/Unit/bootstrap.php" colors="true">
+<phpunit colors="true">
   <testsuites>
     <testsuite>
       <directory>tests/Unit</directory>

diff --git a/Core/snippet-bootstrap.php b/Core/snippet-bootstrap.php
@@ -0,0 +1,5 @@
+<?php
+
+use Google\Cloud\Core\Testing\TestHelpers;
+
+TestHelpers::snippetBootstrap();
diff --git a/...c/DocGenerator/FileListFilterIterator.php → Core/src/Testing/FileListFilterIterator.php b/...c/DocGenerator/FileListFilterIterator.php → Core/src/Testing/FileListFilterIterator.php
@@ -15,10 +15,13 @@
  * limitations under the License.
  */
 
-namespace Google\Cloud\Dev\DocGenerator;
+namespace Google\Cloud\Core\Testing;
 
 /**
  * Filter to create a list of only required files
+ *
+ * @experimental
+ * @internal
  */
 class FileListFilterIterator extends \FilterIterator
 {
@@ -27,6 +30,15 @@ class FileListFilterIterator extends \FilterIterator
     private $testPaths = [];
     private $excludes = [];
 
+    /**
+     * @param string $projectRootPath The path to the root of the project.
+     * @param \Iterator $iterator The iterator to find files.
+     * @param array $fileTypes A list of file types to include
+     * @param array $testPaths A list of known patterns for test files.
+     * @param array $excludes A list of patterns to exclude from the result.
+     * @experimental
+     * @internal
+     */
     public function __construct(
         $projectRootPath,
         \Iterator $iterator,
@@ -42,6 +54,14 @@ public function __construct(
         parent::__construct($iterator);
     }
 
+    /**
+     * Decides whether to include the file or exclude it.
+     *
+     * @return bool
+     *
+     * @experimental
+     * @internal
+     */
     public function accept()
     {
         /** @var \SplFileInfo */
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@ vendor/

		# do not delete
		keys/
		.testing