Php: Cleans up the S3 directory (first pass) and fixes some failing tests in IAM, DynamoDB, and Glue. (#5960)

Cleans up the S3 directory (first pass) and fixes some failing tests in IAM, DynamoDB, and Glue.

Author: beqqrry-aws

.doc_gen/metadata/cross_metadata.yaml

@@ -55,6 +55,7 @@ cross_PAM:
     PHP:
       versions:
         - sdk_version: 3
+          github: php/applications/photo_asset_manager
           block_content: cross_PAM_PHP_block.xml
     Rust:
       versions:

.doc_gen/metadata/s3_metadata.yaml

@@ -51,6 +51,15 @@ s3_Hello:
             - description:
               snippet_tags:
                 - javascript.v3.s3.hello
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/s3
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.s3.basics.helloService
   services:
     s3: {ListBuckets}
 s3_CreateBucket:
@@ -116,7 +125,7 @@ s3_CreateBucket:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: Create a bucket.
               snippet_tags:
@@ -248,7 +257,7 @@ s3_CopyObject:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: Simple copy of an object.
               snippet_tags:
@@ -518,7 +527,7 @@ s3_DeleteObjects:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: Delete a set of objects from a list of keys.
               snippet_tags:
@@ -828,7 +837,7 @@ s3_GetObject:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: Get an object.
               snippet_tags:
@@ -1150,7 +1159,7 @@ s3_ListObjects:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: List objects in a bucket.
               snippet_tags:
@@ -1318,7 +1327,7 @@ s3_PutObject:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: Upload an object to a bucket.
               snippet_tags:
@@ -1466,7 +1475,7 @@ s3_DeleteBucket:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           excerpts:
             - description: Delete an empty bucket.
               snippet_tags:
@@ -2579,7 +2588,7 @@ s3_Scenario_GettingStarted:
     PHP:
       versions:
         - sdk_version: 3
-          github: php/example_code/s3/s3_basics
+          github: php/example_code/s3
           sdkguide:
           excerpts:
             - description:

php/example_code/auto-scaling/GettingStartedWithAutoScaling.php

@@ -1,6 +1,6 @@
 <?php
-# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-# SPDX-License-Identifier: Apache-2.0
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
 /**
  * Purpose
@@ -16,7 +16,7 @@
 * 5. Delete all resources created by the example.
  **/
 
-# snippet-start:[php.example_code.auto-scaling.basics.scenario]
+// snippet-start:[php.example_code.auto-scaling.basics.scenario]
 namespace AutoScaling;
 
 use Aws\AutoScaling\AutoScalingClient;
@@ -63,13 +63,15 @@ public function runExample()
         $this->templateName = "example_launch_template_$uniqid";
         $instanceType = "t1.micro";
         $amiId = "ami-0ca285d4c2cda3300";
-        $launchTemplate = $this->ec2Client->createLaunchTemplate([
+        $launchTemplate = $this->ec2Client->createLaunchTemplate(
+            [
             'LaunchTemplateName' => $this->templateName,
             'LaunchTemplateData' => [
                 'InstanceType' => $instanceType,
                 'ImageId' => $amiId,
             ]
-        ]);
+            ]
+        );
 
         /**
          * Step 1: CreateAutoScalingGroup: pass it the launch template you created in step 0.
@@ -187,25 +189,29 @@ public function runExample()
                 'Value' => $autoScalingGroup['AutoScalingGroupName'],
             ],
         ];
-        $metrics = $this->cloudWatchClient->listMetrics([
+        $metrics = $this->cloudWatchClient->listMetrics(
+            [
             'Dimensions' => $metricsDimensions,
             'Namespace' => $metricsNamespace,
-        ]);
+            ]
+        );
         foreach ($metrics['Metrics'] as $metric) {
             $timespan = 5;
             if ($metric['MetricName'] != 'GroupTotalCapacity' && $metric['MetricName'] != 'GroupMaxSize') {
                 continue;
             }
             echo "Over the last $timespan minutes, {$metric['MetricName']} recorded:\n";
-            $stats = $this->cloudWatchClient->getMetricStatistics([
+            $stats = $this->cloudWatchClient->getMetricStatistics(
+                [
                 'Dimensions' => $metricsDimensions,
                 'EndTime' => time(),
                 'StartTime' => time() - (5 * 60),
                 'MetricName' => $metric['MetricName'],
                 'Namespace' => $metricsNamespace,
                 'Period' => 60,
                 'Statistics' => ['Sum'],
-            ]);
+                ]
+            );
             foreach ($stats['Datapoints'] as $stat) {
                 echo "{$stat['Timestamp']}: {$stat['Sum']}\n";
             }
@@ -236,12 +242,14 @@ public function cleanUp()
         /**
          * Step 13: Delete launch template.
          */
-        $this->ec2Client->deleteLaunchTemplate([
+        $this->ec2Client->deleteLaunchTemplate(
+            [
             'LaunchTemplateName' => $this->templateName,
-        ]);
+            ]
+        );
     }
 
-    #snippet-start:[php.example_code.auto-scaling.basics.helloService]
+    // snippet-start:[php.example_code.auto-scaling.basics.helloService]
     public function helloService()
     {
         $autoScalingClient = new AutoScalingClient([
@@ -253,6 +261,6 @@ public function helloService()
         $groups = $autoScalingClient->describeAutoScalingGroups([]);
         var_dump($groups);
     }
-    #snippet-end:[php.example_code.auto-scaling.basics.helloService]
+    // snippet-end:[php.example_code.auto-scaling.basics.helloService]
 }
-# snippet-end:[php.example_code.auto-scaling.basics.scenario]
+// snippet-end:[php.example_code.auto-scaling.basics.scenario]

php/example_code/aws_utilities/AWSServiceClass.php

@@ -31,6 +31,8 @@ public function customWaiter($function, $verbose = false)
             } catch (AwsException $exception) {
                 if ($verbose) {
                     echo "Attempt failed because of: {$exception->getMessage()}.\n";
+                    echo "Aws error type: {$exception->getAwsErrorType()}\n";
+                    echo "Aws error code: {$exception->getAwsErrorCode()}\n";
                     echo "Waiting " . static::$waitTime . " seconds before trying again.\n";
                     echo (static::$maxWaitAttempts - $attempts) . " attempts left.\n";
                 }

php/example_code/aws_utilities/LoadMovieData.php

@@ -2,9 +2,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-use GuzzleHttp\Client as GuzzleClient;
+namespace AwsUtilities;
 
-//use ZipArchive;
+use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\Psr7\Utils;
+use ZipArchive;
 
 function loadMovieData()
 {
@@ -13,8 +16,13 @@ function loadMovieData()
 
     $url = 'https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/samples/moviedata.zip';
     $guzzle = new GuzzleClient(['verify' => false]);
-    $file = \GuzzleHttp\Psr7\Utils::tryFopen($movieZipName, 'w');
-    $guzzle->request("get", $url, ['sink' => $file]);
+    $file = Utils::tryFopen($movieZipName, 'w');
+    try {
+        $guzzle->request("get", $url, ['sink' => $file]);
+    } catch (GuzzleException $e) {
+        echo "Could not retrieve remote file. {$e->getCode()}: {$e->getMessage()}\n";
+        return null;
+    }
 
     $zip = new ZipArchive();
     $extractPath = ".";

php/example_code/aws_utilities/TestableReadline.php

@@ -19,7 +19,7 @@
 function testable_readline($prompt)
 {
     global $LINES;
-    if (count($LINES) > 0) {
+    if ($LINES && count($LINES) > 0) {
         return array_shift($LINES);
     }
     return readline($prompt);

php/example_code/s3/CommandPool.php renamed to php/example_code/class_examples/CommandPool.php

@@ -2,48 +2,58 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-/*
- * ABOUT THIS PHP SAMPLE: This sample is part of the SDK for PHP Developer Guide topic at
- * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/s3-examples-creating-buckets.html
+/**
+ * This file shows how to use the CommandPool class provided with the AWS SDK for PHP.
+ * It uses the S3Client for this example, but the CommandPool class can be used with
+ * many SDK clients. See https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_commands.html
+ * for more information.
+ *
+ * This code expects that you have AWS credentials set up per:
+ * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html
  *
+ * It also assumes it will be run in a *nix environment.
  */
-// snippet-start:[s3.php.command_pool.complete]
-// snippet-start:[s3.php.command_pool.import]
-require 'vendor/autoload.php';
 
-use Aws\Exception\AwsException;
-use Aws\S3\S3Client;
-use Aws\CommandPool;
+namespace ClassExamples;
+
+# snippet-start:[php.class_examples.command_pool.complete]
+# snippet-start:[php.class_examples.command_pool.import]
+include __DIR__ . "/vendor/autoload.php";
+
 use Aws\CommandInterface;
+use Aws\CommandPool;
+use Aws\Exception\AwsException;
 use Aws\ResultInterface;
+use Aws\S3\S3Client;
+use DirectoryIterator;
 use GuzzleHttp\Promise\PromiseInterface;
-// snippet-end:[s3.php.command_pool.import]
-/**
- * Use Command Pool to upload a file to an Amazon S3 bucket.
- *
- * This code expects that you have AWS credentials set up per:
- * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html
- */
-// Create the client
-// snippet-start:[s3.php.command_pool.main] 
-$client = new S3Client([
-    'region'  => 'us-standard',
-    'version' => '2006-03-01'
-]);
+use Iterator;
+use S3\S3Service;
 
-$fromDir = '/path/to/dir';
-$toBucket = 'my-bucket';
+# snippet-end:[php.class_examples.command_pool.import]
+
+# snippet-start:[php.class_examples.command_pool.main]
+$client = new S3Client([]);
+
+$s3Service = new S3Service($client, true);
+
+$bucket = 'my-bucket-' . uniqid(); // This bucket will be deleted at the end of this example.
+
+$client->createBucket([
+    "Bucket" => $bucket,
+]);
 
 // Create an iterator that yields files from a directory
-$files = new DirectoryIterator($fromDir);
+$files = new DirectoryIterator(__DIR__);
 
 // Create a generator that converts the SplFileInfo objects into
 // Aws\CommandInterface objects. This generator accepts the iterator that
 // yields files and the name of the bucket to upload the files to.
-$commandGenerator = function (\Iterator $files, $bucket) use ($client) {
+$commandGenerator = function (Iterator $files, $bucket) use ($client) {
+    /** @var DirectoryIterator $file */
     foreach ($files as $file) {
-        // Skip "." and ".." files
-        if ($file->isDot()) {
+        // Skip "." and ".." files as well as directories
+        if ($file->isDot() || $file->isDir()) {
             continue;
         }
         $filename = $file->getPath() . '/' . $file->getFilename();
@@ -57,9 +67,9 @@
 };
 
 // Now create the generator using the files iterator
-$commands = $commandGenerator($files, $toBucket);
+$commands = $commandGenerator($files, $bucket);
 
-// Create a pool and provide an optional array of configuration
+// Create a pool and provide an optional configuration array
 $pool = new CommandPool($client, $commands, [
     // Only send 5 files at a time (this is set to 25 by default)
     'concurrency' => 5,
@@ -93,6 +103,11 @@
 $promise->wait();
 
 // Or you can chain the calls off of the pool
-$promise->then(function() { echo "Done\n"; });
-// snippet-end:[s3.php.command_pool.main]
-// snippet-end:[s3.php.command_pool.complete]
+$promise->then(function () {
+    echo "Done\n";
+});
+
+//Clean up the created bucket
+$s3Service->emptyAndDeleteBucket($bucket);
+# snippet-end:[php.class_examples.command_pool.main]
+# snippet-end:[php.class_examples.command_pool.complete]

php/example_code/class_examples/composer.json

@@ -0,0 +1,15 @@
+{
+  "require": {
+    "aws/aws-sdk-php": "^3.209",
+    "guzzlehttp/guzzle": "^7.0"
+  },
+  "autoload": {
+    "psr-0": {
+      "": "*"
+    },
+    "psr-4": {
+      "S3\\": "../s3/",
+      "AwsUtilities\\": "../aws_utilities/"
+    }
+  }
+}