feat(appengine): add custom extension sample (GoogleCloudPlatform#1372)

Author: bshaffer

appengine/standard/extensions/.gcloudignore

@@ -0,0 +1,49 @@
+# This file specifies files that are *not* uploaded to Google Cloud Platform
+# using gcloud. It follows the same syntax as .gitignore, with the addition of
+# "#!include" directives (which insert the entries of the given .gitignore-style
+# file at that point).
+#
+# For more information, run:
+#   $ gcloud topic gcloudignore
+#
+.gcloudignore
+# If you would like to upload your .git directory, .gitignore file or files
+# from your .gitignore file, remove the corresponding line
+# below:
+.git
+.gitignore
+
+# PHP Composer dependencies:
+/vendor/
+
+# Files from phpize
+ext/Makefile.global
+ext/acinclude.m4
+ext/aclocal.m4
+ext/autom4te.cache/
+ext/config.guess
+ext/config.h.in
+ext/config.sub
+ext/configure
+ext/configure.ac
+ext/install-sh
+ext/ltmain.sh
+ext/missing
+ext/mkinstalldirs
+ext/run-tests.php
+
+# Files from ./configure
+ext/Makefile
+ext/Makefile.fragments
+ext/Makefile.objects
+ext/config.h
+ext/config.log
+ext/config.nice
+ext/config.status
+ext/libtool
+
+# Files from make
+ext/.libs/
+ext/modules/
+ext/*.la
+ext/*.lo

appengine/standard/extensions/.gitignore

@@ -0,0 +1,31 @@
+# Files from phpize
+ext/Makefile.global
+ext/acinclude.m4
+ext/aclocal.m4
+ext/autom4te.cache/
+ext/config.guess
+ext/config.h.in
+ext/config.sub
+ext/configure
+ext/configure.ac
+ext/install-sh
+ext/ltmain.sh
+ext/missing
+ext/mkinstalldirs
+ext/run-tests.php
+
+# Files from ./configure
+ext/Makefile
+ext/Makefile.fragments
+ext/Makefile.objects
+ext/config.h
+ext/config.log
+ext/config.nice
+ext/config.status
+ext/libtool
+
+# Files from make
+ext/.libs/
+ext/modules/
+ext/*.la
+ext/*.lo

appengine/standard/extensions/app.yaml

@@ -0,0 +1 @@
+runtime: php74

appengine/standard/extensions/composer.json

@@ -0,0 +1,8 @@
+{
+    "scripts": {
+        "post-autoload-dump": [
+            "cd ext && phpize --clean && phpize && ./configure && make",
+            "cp ext/modules/my_custom_extension.so vendor/"
+        ]
+    }
+}

appengine/standard/extensions/ext/config.m4

@@ -0,0 +1,5 @@
+PHP_ARG_ENABLE(my_custom_extension, Whether to enable the MyCustomExtension extension, [ --enable-my-custom-extension Enable MyCustomExtension])
+
+if test "$MY_CUSTOM_EXTENSION" != "no"; then
+    PHP_NEW_EXTENSION(my_custom_extension, my_custom_extension.c, $ext_shared)
+fi

appengine/standard/extensions/ext/my_custom_extension.c

@@ -0,0 +1,34 @@
+// include the PHP API itself
+#include 
+// include the extension header
+#include "my_custom_extension.h"
+
+// register the "helloworld_from_extension" function to the PHP API
+zend_function_entry my_custom_extension_functions[] = {
+    PHP_FE(helloworld_from_extension, NULL)
+    {NULL, NULL, NULL}
+};
+
+// some information about our module
+zend_module_entry my_custom_extension_module_entry = {
+    STANDARD_MODULE_HEADER,
+    PHP_MY_CUSTOM_EXTENSION_EXTNAME,
+    my_custom_extension_functions,
+    NULL,
+    NULL,
+    NULL,
+    NULL,
+    NULL,
+    PHP_MY_CUSTOM_EXTENSION_VERSION,
+    STANDARD_MODULE_PROPERTIES
+};
+
+// use a macro to output additional C code, to make ext dynamically loadable
+ZEND_GET_MODULE(my_custom_extension)
+
+// Implement our "Hello World" function, which returns a string
+PHP_FUNCTION(helloworld_from_extension) {
+    zval val;
+    ZVAL_STRING(&val, "Hello World! (from my_custom_extension.so)\n");
+    RETURN_STR(Z_STR(val));
+}

appengine/standard/extensions/ext/my_custom_extension.h

@@ -0,0 +1,6 @@
+// module constants
+#define PHP_MY_CUSTOM_EXTENSION_EXTNAME "my_custom_extension"
+#define PHP_MY_CUSTOM_EXTENSION_VERSION "0.0.1"
+
+// the function to be exported
+PHP_FUNCTION(helloworld_from_extension);

appengine/standard/extensions/index.php

@@ -0,0 +1,3 @@
+
+
+echo helloworld_from_extension();

appengine/standard/extensions/php.ini

@@ -0,0 +1 @@
+extension=/workspace/vendor/my_custom_extension.so

appengine/standard/extensions/test/DeployTest.php

@@ -0,0 +1,44 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * 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\Samples\AppEngine\HelloWorld;
+
+use Google\Cloud\TestUtils\AppEngineDeploymentTrait;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @group deploy
+ */
+class DeployTest extends TestCase
+{
+    use AppEngineDeploymentTrait;
+
+    public function testIndex()
+    {
+        $resp = $this->client->get('/');
+
+        $this->assertEquals(
+            '200',
+            $resp->getStatusCode(),
+            'Top page status code should be 200'
+        );
+
+        $this->assertStringContainsString(
+            'Hello World! (from my_custom_extension.so)',
+            (string) $resp->getBody()
+        );
+    }
+}