chore: update pubsub samples to new test runner (GoogleCloudPlatform#1356)

Author: jdpedrie

pubsub/api/README.md

@@ -7,35 +7,80 @@ This simple command-line application demonstrates how to invoke
 
 [pubsub]: https://cloud.google.com/pubsub/docs/quickstart-client-libraries
 
-## Build and Run
-1.  **Enable APIs** - [Enable the Pub\Sub API](https://console.cloud.google.com/flows/enableapi?apiid=pubsub)
-    and create a new project or select an existing project.
-2.  **Download The Credentials** - Click "Go to credentials" after enabling the APIs. Click "New Credentials"
-    and select "Service Account Key". Create a new service account, use the JSON key type, and
-    select "Create". Once downloaded, set the environment variable `GOOGLE_APPLICATION_CREDENTIALS`
-    to the path of the JSON key that was downloaded.
-3.  **Clone the repo** and cd into this directory
-
-    ```sh
-    $ git clone https://github.com/GoogleCloudPlatform/php-docs-samples
-    $ cd php-docs-samples/pubsub/api
-```
-4.  **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md).
+## Setup
+
+### Authentication
+
+Authentication is typically done through [Application Default Credentials][adc]
+which means you do not have to change the code to authenticate as long as
+your environment has credentials. You have a few options for setting up
+authentication:
+
+1. When running locally, use the [Google Cloud SDK][google-cloud-sdk]
+
+        gcloud auth application-default login
+
+1. When running on App Engine or Compute Engine, credentials are already
+   set-up. However, you may need to configure your Compute Engine instance
+   with [additional scopes][additional_scopes].
+
+1. You can create a [Service Account key file][service_account_key_file]. This file can be used to
+   authenticate to Google Cloud Platform services from any environment. To use
+   the file, set the ``GOOGLE_APPLICATION_CREDENTIALS`` environment variable to
+   the path to the key file, for example:
+
+        export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
+
+[adc]: https://cloud.google.com/docs/authentication#getting_credentials_for_server-centric_flow
+[additional_scopes]: https://cloud.google.com/compute/docs/authentication#using
+[service_account_key_file]: https://developers.google.com/identity/protocols/OAuth2ServiceAccount#creatinganaccount
+
+## Install Dependencies
+
+1. Ensure the [gRPC PHP Extension][php_grpc] is installed and enabled on your machine.
+1. [Enable the Cloud Pub/Sub API](https://console.cloud.google.com/flows/enableapi?apiid=pubsub.googleapis.com).
+
+1. **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md).
     Run `php composer.phar install` (if composer is installed locally) or `composer install`
     (if composer is installed globally).
-5.  Run `php pubsub.php`. The following commands are available:
 
-    ```sh
-    iam           Manage IAM for Pub\Sub
-    subscription  Manage subscriptions for Pub\Sub
-    topic         Manage topics for Pub\Sub
+1. Create a service account at the
+[Service account section in the Cloud Console](https://console.cloud.google.com/iam-admin/serviceaccounts/)
+
+1. Download the json key file of the service account.
+
+1. Set `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to that file.
+
+## Samples
+
+To run the Pub/Sub Samples, run any of the files in `src/` on the CLI:
+
+```
+$ php src/create-topic.php
+
+Usage: create_topic.php $projectId $topicName
+
+	@param string $projectId  The Google project ID.
+	@param string $topicName  The Pub/Sub topic name.
 ```
-6. Run `php pubsub.php COMMAND --help` to print information about the usage of each command.
 
-## Contributing changes
+## Troubleshooting
+
+If you get the following error, set the environment variable `GCLOUD_PROJECT` to your project ID:
+
+```
+[Google\Cloud\Core\Exception\GoogleException]
+No project ID was provided, and we were unable to detect a default project ID.
+```
 
-* See [CONTRIBUTING.md](../../CONTRIBUTING.md)
+## The client library
 
-## Licensing
+This sample uses the [Google Cloud Client Library for PHP][google-cloud-php].
+You can read the documentation for more details on API usage and use GitHub
+to [browse the source][google-cloud-php-source] and  [report issues][google-cloud-php-issues].
 
-* See [LICENSE](../../LICENSE)
+[php_grpc]: http://cloud.google.com/php/grpc
+[google-cloud-php]: https://googlecloudplatform.github.io/google-cloud-php
+[google-cloud-php-source]: https://github.com/GoogleCloudPlatform/google-cloud-php
+[google-cloud-php-issues]: https://github.com/GoogleCloudPlatform/google-cloud-php/issues
+[google-cloud-sdk]: https://cloud.google.com/sdk/

pubsub/api/composer.json

@@ -3,30 +3,5 @@
         "php": ">=5.4",
         "google/cloud-pubsub": "^1.29",
         "symfony/console": " ^3.0"
-    },
-    "autoload": {
-        "files": [
-            "src/create_subscription.php",
-            "src/create_topic.php",
-            "src/dead_letter_create_subscription.php",
-            "src/dead_letter_delivery_attempt.php",
-            "src/dead_letter_remove.php",
-            "src/dead_letter_update_subscription.php",
-            "src/create_push_subscription.php",
-            "src/delete_subscription.php",
-            "src/delete_topic.php",
-            "src/detach_subscription.php",
-            "src/get_subscription_policy.php",
-            "src/get_topic_policy.php",
-            "src/list_subscriptions.php",
-            "src/list_topics.php",
-            "src/publish_message_batch.php",
-            "src/publish_message.php",
-            "src/pull_messages.php",
-            "src/set_subscription_policy.php",
-            "src/set_topic_policy.php",
-            "src/test_subscription_permissions.php",
-            "src/test_topic_permissions.php"
-        ]
     }
 }

pubsub/api/pubsub.php

@@ -48,3 +48,5 @@ function create_push_subscription($projectId, $topicName, $subscriptionName, $en
     printf('Subscription created: %s' . PHP_EOL, $subscription->name());
 }
 # [END pubsub_create_push_subscription]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

pubsub/api/src/create_push_subscription.php

@@ -45,3 +45,5 @@ function create_subscription($projectId, $topicName, $subscriptionName)
     printf('Subscription created: %s' . PHP_EOL, $subscription->name());
 }
 # [END pubsub_create_pull_subscription]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);