Added LocalTestTrait.

Author: Takashi Matsuo

appengine/standard/modules/tests/LocalTest.php

@@ -16,59 +16,11 @@
  */
 namespace Google\Cloud\Test;
 
-use GuzzleHttp\Client;
-use Google\Cloud\TestUtils\GaeApp;
+use Google\Cloud\TestUtils\LocalTestTrait;
 
 class LocalTest extends \PHPUnit_Framework_TestCase
 {
-    private static $gaeApp;
-
-    private $client;
-
-    const PROJECT_ENV = 'GOOGLE_PROJECT_ID';
-    const VERSION_ENV = 'GOOGLE_VERSION_ID';
-
-    private static function getVersion()
-    {
-        return "modules-" . getenv(self::VERSION_ENV);
-    }
-
-    private static function getTargetDir()
-    {
-        return realpath(__DIR__ . '/../');
-    }
-
-    public static function setUpBeforeClass()
-    {
-        self::markTestIncomplete(
-            'dev_appserver.py is not working for us now');
-        $project_id = getenv(self::PROJECT_ENV);
-        $e2e_test_version = getenv(self::VERSION_ENV);
-        if ($project_id === false) {
-            self::fail('Please set ' . self::PROJECT_ENV . ' env var.');
-        }
-        if ($e2e_test_version === false) {
-            self::fail('Please set ' . self::VERSION_ENV . ' env var.');
-        }
-        self::$gaeApp = new GaeApp(
-            $project_id,
-            $e2e_test_version,
-            self::getTargetDir());
-        if (self::$gaeApp->run() === false) {
-            self::fail('dev_appserver failed.');
-        }
-    }
-
-    public static function tearDownAfterClass()
-    {
-        self::$gaeApp->stop();
-    }
-
-    public function setUp()
-    {
-        $url = self::$gaeApp->getLocalBaseUrl();
-        $this->client = new Client(['base_uri' => $url]);
-    }
+    use LocalTestTrait;
 
     public function testIndex()
     {

appengine/standard/modules/tests/bootstrap.php

@@ -17,3 +17,4 @@
 require __DIR__ . '/../vendor/autoload.php';
 require_once __DIR__ . '/../../../../testing/E2EDeploymentTrait.php';
 require_once __DIR__ . '/../../../../testing/GaeApp.php';
+require_once __DIR__ . '/../../../../testing/LocalTestTrait.php';

testing/E2EDeploymentTrait.php

@@ -33,7 +33,10 @@ trait E2EDeploymentTrait
     public static $projectEnv = 'GOOGLE_PROJECT_ID';
     public static $versionEnv = 'GOOGLE_VERSION_ID';
 
-    public static function setUpBeforeClass()
+    /**
+     * @beforeClass
+     */
+    public static function deployApp()
     {
         $project_id = getenv(self::$projectEnv);
         $e2e_test_version = getenv(self::$versionEnv);
@@ -52,7 +55,10 @@ public static function setUpBeforeClass()
         }
     }
 
-    public static function tearDownAfterClass()
+    /**
+     * @afterClass
+     */
+    public static function deleteApp()
     {
         self::$gaeApp->delete();
     }

testing/GaeApp.php

@@ -17,6 +17,8 @@
 
 namespace Google\Cloud\TestUtils;
 
+use Symfony\Component\Process\Process;
+
 /**
  * Class GaeApp
  * @package Google\Cloud\TestUtils
@@ -29,6 +31,7 @@ class GaeApp
     private $version;
     private $port;
     private $deployed;
+    private $isRunning;
     private $process;
     private $dir;
 
@@ -47,7 +50,7 @@ private function execWithRetry($cmd, $retry = self::DEFAULT_RETRY)
             exec($cmd, $output, $ret);
             if ($ret === 0) {
                 return true;
-            } else if ($i <= $retry) {
+            } elseif ($i <= $retry) {
                 $this->errorLog('Retrying the command: ' . $cmd);
             }
         }
@@ -77,6 +80,7 @@ public function __construct(
         }
         $this->version = $version;
         $this->deployed = false;
+        $this->isRunning = false;
         $this->dir = $dir;
         $this->port = $port;
     }
@@ -117,6 +121,41 @@ public function deploy(
         return $ret;
     }
 
+    /**
+     * Runs the app with dev_appserver.
+     *
+     * @return bool true if the app is running, otherwise false
+     */
+    public function run()
+    {
+        $options = '--port ' . $this->port
+            . ' --php_executable_path ' . PHP_BINARY;
+        $cmd = 'dev_appserver.py --port ' . $this->port
+            . ' --php_executable_path ' . PHP_BINARY
+            . ' ' . $this->dir;
+        $this->process = new Process($cmd);
+        $this->process->start();
+        sleep(3);
+        if (! $this->process->isRunning()) {
+            $this->errorLog('dev_appserver failed to run.');
+            $this->errorLog($this->process->getErrorOutput());
+            return false;
+        }
+        $this->isRunning = true;
+        return true;
+    }
+
+    /**
+     * Stops the dev_appserver.
+     */
+    public function stop()
+    {
+        if ($this->process->isRunning()) {
+            $this->process->stop();
+        }
+        $this->isRunning = false;
+    }
+
     /**
      * Deletes the deployed app.
      *
@@ -135,9 +174,25 @@ public function delete(
         return $ret;
     }
 
+    /**
+     * Returns the base URL of the local dev_appserver.
+     *
+     * @return mixed returns the base URL of the running app, or false when
+     *     the app is not running
+     */
+    public function getLocalBaseUrl()
+    {
+        if (! $this->isRunning) {
+            $this->errorLog('The app is not running.');
+            return false;
+        }
+        return 'http://localhost:' . $this->port;
+    }
+
     /**
      * Returns the base URL of the deployed app.
      *
+     * @param string $module optional
      * @return mixed returns the base URL of the deployed app, or false when
      *     the app is not deployed.
      */

testing/LocalTestTrait.php

@@ -0,0 +1,64 @@
+
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Cloud\TestUtils;
+
+use GuzzleHttp\Client;
+
+/**
+ * Class LocalTestTrait
+ * @package Google\Cloud\TestUtils
+ *
+ * Use this trait to use dev_appserver for testing.
+ */
+trait LocalTestTrait
+{
+    private static $gaeApp;
+    private $client;
+
+    /**
+     * @beforeClass
+     */
+    public static function startServer()
+    {
+        self::markTestIncomplete(
+            'dev_appserver.py is not working for us now.'
+            . ' TODO: Make this work with specifying --php_gae_extension_path'
+        );
+        self::$gaeApp = new GaeApp('', '');
+        if (self::$gaeApp->run() === false) {
+            self::fail('dev_appserver failed');
+        }
+    }
+
+    /**
+     * @afterClass
+     */
+    public static function stopServer()
+    {
+        self::$gaeApp->stop();
+    }
+
+    /**
+     * @before
+     */
+    public function setUpClient()
+    {
+        $url = self::$gaeApp->getLocalBaseUrl();
+        $this->client = new Client(['base_uri' => $url]);
+    }
+}