Merge pull request #1 from scmacdon/master

Updating with latest commits

Author: beckandros

cpp/example_code/general/CMakeLists-minimal.txt

@@ -1,5 +1,5 @@
 # Minimal CMakeLists.txt for the AWS SDK for C++.
-cmake_minimum_required(VERSION 3.2)
+cmake_minimum_required(VERSION 3.8)
 
 # Use shared libraries, which is the default for the AWS C++ SDK build.
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)

cpp/example_code/s3/include/awsdoc/s3/s3-demo.h

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX - License - Identifier: Apache - 2.0 
+
+// Enables test_s3-demo.pp to test the functionality in s3-demo.cpp.
+
+#pragma once
+
+#include <aws/core/Aws.h>
+#include <aws/s3/S3Client.h>
+#include <awsdoc/s3/S3_EXPORTS.h>
+
+AWSDOC_S3_API bool FindTheBucket(const Aws::S3::S3Client& s3Client,
+    const Aws::String& bucketName);
+AWSDOC_S3_API bool CreateTheBucket(const Aws::S3::S3Client& s3Client,
+    const Aws::String& bucketName);
+AWSDOC_S3_API bool DeleteTheBucket(const Aws::S3::S3Client& s3Client,
+    const Aws::String& bucketName);

cpp/example_code/s3/include/awsdoc/s3/s3_list_objects_with_aws_global_region.h

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX - License - Identifier: Apache - 2.0 
+
+// Enables test_list_objects_with_aws_global_region.cpp to test the 
+// functionality in list_objects_with_aws_global_region.cpp.
+
+#pragma once
+
+#include <aws/core/Aws.h>
+#include <aws/s3/S3Client.h>
+#include <awsdoc/s3/S3_EXPORTS.h>
+
+AWSDOC_S3_API bool CreateABucket(const Aws::S3::S3Client& s3Client);
+AWSDOC_S3_API bool ListTheObjects(const Aws::S3::S3Client& s3Client);
+AWSDOC_S3_API bool DeleteABucket(const Aws::S3::S3Client& s3Client);

cpp/example_code/s3/list_objects_with_aws_global_region.cpp

@@ -1,17 +1,15 @@
-//snippet-sourcedescription:[Upgrade AWS SDK for C++ to version 1.8 to build list_objects_with_aws_global_region.cpp. This example demonstrates how to use aws-global region in client configuration to make cross-region requests.]
+//snippet-sourcedescription:[This example demonstrates how to use the AWS SDK for C++, starting with SDK version 1.8, to specify aws-global as the AWS Region during Amazon S3 API client configuration to make requests to S3 across AWS Regions.]
 //snippet-keyword:[C++]
 //snippet-sourcesyntax:[cpp]
 //snippet-keyword:[Code Sample]
 //snippet-keyword:[Amazon S3]
 //snippet-service:[s3]
 //snippet-sourcetype:[full-example]
-//snippet-sourcedate:[]
+//snippet-sourcedate:[2020-08-10]
 //snippet-sourceauthor:[AWS]
 
-/**
- * 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
 
 #include <aws/core/Aws.h>
 #include <aws/core/utils/logging/LogLevel.h>
@@ -22,6 +20,7 @@
 #include <aws/s3/model/ListObjectsRequest.h>
 #include <aws/s3/model/DeleteBucketRequest.h>
 #include <iostream>
+#include <awsdoc/s3/s3_list_objects_with_aws_global_region.h>
 
 using namespace Aws;
 using namespace Aws::S3;
@@ -30,78 +29,135 @@ using namespace Aws::S3::Model;
 static const char BUCKET_NAME[] = "aws-sdk-cpp-list-objects-with-aws-global-region";
 
 /**
- * With AWS SDK for C++ version 1.8, you are able to make cross region requests by specifying aws-global as region in client configuration.
- * In this example, an S3 client in aws-global region is able to list objects in the S3 bucket in us-west-2.
+ * Starting with the AWS SDK for C++ version 1.8, you can make requests to 
+ * Amazon S3 across AWS Regions by specifying aws-global as the AWS Region 
+ * during S3 API client configuration. In this example, an S3 API client 
+ * set to the aws-global AWS Region is able to list objects in an S3 bucket 
+ * that is located in the us-west-2 AWS Region.
+ */
+
+/** 
+ * Following are helper methods for creating the bucket, listing the objects 
+ * in the new bucket, and then deleting the bucket. These methods are later 
+ * called from this example's main method.
  */
-int main(int argc, char *argv[])
+
+bool CreateABucket(const S3Client& s3Client)
+{
+    // Create an S3 bucket within the us-west-2 AWS Region.
+    CreateBucketRequest createBucketRequest;
+    createBucketRequest.SetBucket(BUCKET_NAME);
+    CreateBucketConfiguration createBucketConfiguration;
+    createBucketConfiguration.SetLocationConstraint(BucketLocationConstraint::us_west_2);
+    createBucketRequest.SetCreateBucketConfiguration(createBucketConfiguration);
+    auto createBucketOutcome = s3Client.CreateBucket(createBucketRequest);
+
+    if (createBucketOutcome.IsSuccess()) {
+        std::cout << "Success. Created the bucket named '" << BUCKET_NAME << 
+            "'." << std::endl;
+    }
+    else {
+        std::cout << "Error. Could not create the bucket: " << 
+            createBucketOutcome.GetError() << std::endl;
+
+        return false;
+    }
+
+    // Wait for the bucket to propagate before continuing.
+    unsigned timeoutCount = 0;
+    while (timeoutCount++ < 20)
+    {
+        HeadBucketRequest headBucketRequest;
+        headBucketRequest.SetBucket(BUCKET_NAME);
+        HeadBucketOutcome headBucketOutcome = s3Client.HeadBucket(headBucketRequest);
+        if (headBucketOutcome.IsSuccess())
+        {
+            break;
+        }
+
+        std::this_thread::sleep_for(std::chrono::seconds(10));
+    }
+
+    return true;
+}
+
+bool ListTheObjects(const S3Client& s3Client)
+{
+    // An S3 API client set to the aws-global AWS Region should be able to get 
+    // access to a bucket in any AWS Region.
+    ListObjectsRequest listObjectsRequest;
+    listObjectsRequest.SetBucket(BUCKET_NAME);
+    auto listObjectOutcome = s3Client.ListObjects(listObjectsRequest);
+    
+    if (listObjectOutcome.IsSuccess()) {
+        std::cout << "Success. Number of objects in the bucket named '" << 
+            BUCKET_NAME << "' is " << 
+            listObjectOutcome.GetResult().GetContents().size() << "." << 
+            std::endl;
+
+        return true;
+    }
+    else
+    {
+        std::cout << "Error. Could not count the objects in the bucket: " << 
+            listObjectOutcome.GetError() << std::endl;
+
+        return false;
+    }
+}
+
+bool DeleteABucket(const S3Client& s3Client)
+{
+    DeleteBucketRequest deleteBucketRequest;
+    deleteBucketRequest.SetBucket(BUCKET_NAME);
+    auto deleteBucketOutcome = s3Client.DeleteBucket(deleteBucketRequest);
+
+    if (deleteBucketOutcome.IsSuccess())
+    {
+        std::cout << "Success. Deleted the bucket named '" << BUCKET_NAME << 
+            "'." << std::endl;
+
+        return true;
+    }
+    else
+    {
+        std::cout << "Error. Could not delete the bucket: " << 
+            deleteBucketOutcome.GetError() << std::endl;
+        std::cout << "To clean up, you must delete the bucket named '" <<
+            BUCKET_NAME << "' yourself." << std::endl;
+
+        return false;
+    }
+}
+
+int main()
 {
     SDKOptions options;
     options.loggingOptions.logLevel = Utils::Logging::LogLevel::Trace;
+
     InitAPI(options);
     {
         Aws::Client::ClientConfiguration config;
         config.region = Aws::Region::AWS_GLOBAL;
-        S3Client s3Client(config);
 
-        // Create a bucket in us-west-2.
-        CreateBucketRequest createBucketRequest;
-        createBucketRequest.SetBucket(BUCKET_NAME);
-        CreateBucketConfiguration createBucketConfiguration;
-        createBucketConfiguration.SetLocationConstraint(BucketLocationConstraint::us_west_2);
-        createBucketRequest.SetCreateBucketConfiguration(createBucketConfiguration);
-        auto createBucketOutcome = s3Client.CreateBucket(createBucketRequest);
-
-        if (createBucketOutcome.IsSuccess()) {
-            std::cout << "Succeeded to create bucket: " << BUCKET_NAME << std::endl;
-        } else {
-            std::cout << "Failed to create bucket. Details of the error:" << std::endl;
-            std::cout << createBucketOutcome.GetError() << std::endl;
-        }
+        S3Client s3Client(config);
 
-        // Wait for bucket to propagate.
-        unsigned timeoutCount = 0;
-        while (timeoutCount++ < 20)
+        if (!CreateABucket(s3Client))
         {
-            HeadBucketRequest headBucketRequest;
-            headBucketRequest.SetBucket(BUCKET_NAME);
-            HeadBucketOutcome headBucketOutcome = s3Client.HeadBucket(headBucketRequest);
-            if (headBucketOutcome.IsSuccess())
-            {
-                break;
-            }
-
-            std::this_thread::sleep_for(std::chrono::seconds(10));
+            return 1;
         }
-
-        // S3 client with aws-global region should be able to get access to bucket in any region.
-        ListObjectsRequest listObjectsRequest;
-        listObjectsRequest.SetBucket(BUCKET_NAME);
-        auto listObjectOutcome = s3Client.ListObjects(listObjectsRequest);
-
-        if (listObjectOutcome.IsSuccess()) {
-            std::cout << "Found objects in bucket: " << BUCKET_NAME << std::endl;
-            std::cout << "Number of objects in this bucket: " << listObjectOutcome.GetResult().GetContents().size() << std::endl;
-        }
-        else
+        
+        if (!ListTheObjects(s3Client))
         {
-            std::cout << "Failed to list objects. Details of the error:" << std::endl;
-            std::cout << listObjectOutcome.GetError() << std::endl;
+            return 1;
         }
 
-        DeleteBucketRequest deleteBucketRequest;
-        deleteBucketRequest.SetBucket(BUCKET_NAME);
-        auto deleteBucketOutcome = s3Client.DeleteBucket(deleteBucketRequest);
-        if (deleteBucketOutcome.IsSuccess())
+        if (!DeleteABucket(s3Client))
         {
-            std::cout << "Succeeded to delete bucket" << std::endl;
-        }
-        else
-        {
-            std::cout << "Failed to delete bucket. Details of the error:" << std::endl;
-            std::cout << deleteBucketOutcome.GetError() << std::endl;
+            return 1;
         }
     }
-
     ShutdownAPI(options);
+    
     return 0;
 }

cpp/example_code/s3/metadata.yaml

@@ -84,6 +84,12 @@ files:
   - path: tests/test_list_objects.cpp
     services:
     - s3
+  - path: list_objects_with_aws_global_region.cpp
+    services:
+    - s3
+  - path: tests/test_list_objects_with_aws_global_region.cpp
+    services:
+    - s3
   - path: put_bucket_policy.cpp
     services:
     - s3
@@ -114,4 +120,10 @@ files:
   - path: tests/test_put_website_config.cpp
     services:
     - s3
+  - path: s3-demo.cpp
+    services:
+    - s3
+  - path: tests/test_s3-demo.cpp
+    services:
+    - s3
 ...

cpp/example_code/s3/tests/test_list_objects_with_aws_global_region.cpp

@@ -1,11 +1,38 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX - License - Identifier: Apache - 2.0 
 
-#include <iostream>
+#include <aws/core/Aws.h>
+#include <aws/s3/S3Client.h>
+#include <awsdoc/s3/s3_list_objects_with_aws_global_region.h>
 
 int main()
 {
-    std::cout << "Not yet implemented." << std::endl;
+    Aws::SDKOptions options;
+    options.loggingOptions.logLevel = Aws::Utils::Logging::LogLevel::Trace;
 
-    return 1;
+    Aws::InitAPI(options);
+    {
+        Aws::Client::ClientConfiguration config;
+        config.region = Aws::Region::AWS_GLOBAL;
+
+        Aws::S3::S3Client s3Client(config);
+
+        if (!CreateABucket(s3Client))
+        {
+            return 1;
+        }
+
+        if (!ListTheObjects(s3Client))
+        {
+            return 1;
+        }
+
+        if (!DeleteABucket(s3Client))
+        {
+            return 1;
+        }
+    }
+    ShutdownAPI(options);
+
+    return 0;
 }

cpp/example_code/s3/tests/test_s3-demo.cpp

@@ -2,10 +2,52 @@
 // SPDX - License - Identifier: Apache - 2.0 
 
 #include <iostream>
+#include <aws/core/Aws.h>
+#include <aws/s3/S3Client.h>
+#include <aws/core/utils/UUID.h>
+#include <awsdoc/s3/s3-demo.h>
 
 int main()
 {
-    std::cout << "Test for s3-demo not implemented." << std::endl;
+    Aws::SDKOptions options;
+    Aws::InitAPI(options);
+    {
+        // Create a unique bucket name to increase the chance of success 
+        // when trying to create the bucket.
+        // Format: "my-bucket-" + lowercase UUID.
+        Aws::String uuid = Aws::Utils::UUID::RandomUUID();
+        Aws::String bucket_name = "my-bucket-" +
+            Aws::Utils::StringUtils::ToLower(uuid.c_str());
 
-    return 1;
+        Aws::String region = "us-east-1";
+
+        Aws::Client::ClientConfiguration config;
+
+        config.region = region;
+
+        Aws::S3::S3Client s3_client(config);
+
+        if (!FindTheBucket(s3_client, bucket_name)) {
+            return 1;
+        }
+
+        if (!CreateTheBucket(s3_client, bucket_name)) {
+            return 1;
+        }
+
+        if (!FindTheBucket(s3_client, bucket_name)) {
+            return 1;
+        }
+
+        if (!DeleteTheBucket(s3_client, bucket_name)) {
+            return 1;
+        }
+
+        if (!FindTheBucket(s3_client, bucket_name)) {
+            return 1;
+        }
+    }
+    Aws::ShutdownAPI(options);
+
+    return 0;
 }