Merge branch 'main' into corepyle/react-sqs

Author: beqqrry-aws

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,37 +1,29 @@
 # aws-doc-sdk-examples Pull Request
 
-Thank you for making a submission to the *aws-doc-sdk-examples* repository. For more information about submitting pull requests to this repository, see [Guidelines for contributing](/CONTRIBUTING.md).
+Thank you for making a submission to the *aws-doc-sdk-examples* repository. For more information about submitting pull requests to this repository, see [Guidelines for contributing](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/CONTRIBUTING.md).
 
-*NOTE:* This PR template contains three sections. Depending on the reason for your pull request, please fill out the section that applies to you and then remove the other two sections.
+*NOTE:* This pull request (PR) template contains two sections. Use the section that applies to your submission, and remove the section which doesn't apply.
+***
+## I'm submitting a new SDK code example
 
-## New SDK Code Example
+Confirm you have met the following minimum requirements:
 
-The submitter has:
+- [ ] Add the following copyright notice to the top of each file. See the [LICENSE agreement](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/LICENSE) for the terms of the copyright. 
+>Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\
+>SPDX-License-Identifier: Apache-2.0
+- [ ] Create unit tests for all paths through the code, and confirm that the all the tests pass. For recommendations, see [How we test code examples](https://github.com/awsdocs/aws-doc-sdk-examples/wiki/Code-quality-guidelines---testing-and-linting#how-we-test-code-examples).
+- [ ] Run a linter against all code and implement the resulting suggestions. For recommendations, see [Linters run on check in](https://github.com/awsdocs/aws-doc-sdk-examples/wiki/Code-quality-guidelines---testing-and-linting#linters-run-on-check-in).
+- [ ] Add minimum usage documentation as comments in the code. For recommendations, see [Code comment guidelines](https://github.com/awsdocs/aws-doc-sdk-examples/wiki/Code-comment-guidelines).
+***
+## I'm resolving an issue with an existing code example
 
-- [ ] Added the default copyright notice to all files.
-- [ ] Created unit tests for all paths through the code and they all pass.
-- [ ] Run a linter against all code and implemented the resulting suggestions.
-- [ ] Added minimum usage documentation as comments in the code.
-- [ ] Had comments and strings reviewed and incorporated suggested changes.
-- [ ] Had the code reviewed and implemented the reviewer's suggested changes.
+Describe the changes you have made here, including any issue numbers.
 
-## Existing Example Update
+Confirm you have met the following minimum requirements:
 
-The submitter has:
-
-- [ ] Confirmed that the correct copyright is included in all files.
-- [ ] Major code changes have been reviewed, and the submitter has incorporated review comments.
-- [ ] Changed or added comments and strings have been reviewed, and the submitter has incorporated any and all suggested edits.
-
-## Resolve Issue
-
-Issue #
-
-### Description of Changes
-
-Please describe the changes you have made here.
-
-- [ ] I have tested my changes and created unit tests for new code paths.
-- [ ] Changes have been reviewed, and all reviewer comments have been incorporated.
+- [ ] Test the changed code. For recommendations, see [How we test code examples](https://github.com/awsdocs/aws-doc-sdk-examples/wiki/Code-quality-guidelines---testing-and-linting#how-we-test-code-examples).
+- [ ] Run a linter against the changed code and implement the resulting suggestions. For recommendations, see [Linters run on check in](https://github.com/awsdocs/aws-doc-sdk-examples/wiki/Code-quality-guidelines---testing-and-linting#linters-run-on-check-in).
+***
+## Open source license adherence
 
 _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license._

.github/workflows/cpp-lint.yml

@@ -1,11 +1,6 @@
-name: cpp lint check
+name: "cpp lint check"
 on:
-  push:
-    paths:
-      - 'cpp/**'
-    branches:
-      - main
-  pull_request:
+  pull_request_target:
     paths:
       - 'cpp/**'
   workflow_dispatch:
@@ -19,7 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Run clang-tidy check
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: "Run clang-tidy check"
         uses: ./.github/cpp-linter
         with:
           config_file: ./.github/cpp-linter/clang-tidy-config.txt

cpp/.gitignore

@@ -1,2 +1,3 @@
 build/
 cmake-build*/
+.vs/

cpp/example_code/s3/CMakeLists.txt

@@ -27,14 +27,14 @@ if(NOT BUILD_SHARED_LIBS)
 endif()
 
 # Find the AWS SDK for C++ package.
-find_package(AWSSDK REQUIRED COMPONENTS s3 sts)
+find_package(AWSSDK REQUIRED COMPONENTS s3 sts iam)
 
 # If the compiler is some version of Microsoft Visual C++, or another compiler simulating C++,
 # and building as shared libraries, then dynamically link to those shared libraries.
 if(MSVC AND BUILD_SHARED_LIBS)
     add_definitions(-DUSE_IMPORT_EXPORT)
     # Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
-    list(APPEND SERVICE_LIST s3 sts)
+    list(APPEND SERVICE_LIST s3 sts iam)
     #For IDE's like Xcode and Visual Studio, this line is ignored. This is because Release/Debug
     #  is switched internally, but this is necessary for non-IDE builds.
     set(CMAKE_BUILD_TYPE Debug) #TODO: Set to your build type.
@@ -114,7 +114,7 @@ foreach(file ${AWSDOC_S3_SOURCE})
         set(EXAMPLE_TEST_FILE ${CMAKE_CURRENT_SOURCE_DIR}/tests/test_${EXAMPLE}.cpp)
 
         if(EXISTS ${EXAMPLE_TEST_FILE})
-            add_executable(${EXAMPLE_TEST} ${EXAMPLE_TEST_FILE} )
+            add_executable(${EXAMPLE_TEST} ${EXAMPLE_TEST_FILE} tests/test_utils.cpp)
 
             target_include_directories(${EXAMPLE_TEST} PUBLIC
                 $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>

cpp/example_code/s3/gtests/CMakeLists.txt

@@ -4,8 +4,12 @@
 # Set the minimum required version of CMake for this project.
 cmake_minimum_required(VERSION 3.14)
 
+set(EXAMPLE_SERVICE_NAME "s3")
+set(CURRENT_TARGET "${EXAMPLE_SERVICE_NAME}_gtest")
+set(CURRENT_TARGET_AWS_DEPENDENCIES s3 sts)
+
 # Set this project's name.
-project("s3-examples-gtests")
+project("${EXAMPLE_SERVICE_NAME}-examples-gtests" )
 
 # Set the C++ standard to use to build this target.
 set(CMAKE_CXX_STANDARD 14)
@@ -31,36 +35,42 @@ if(NOT BUILD_SHARED_LIBS)
     set(BUILD_SHARED_LIBS ON)
 endif()
 
+set(CMAKE_BUILD_TYPE Debug)
+
 # Find the AWS SDK for C++ package.
-find_package(AWSSDK REQUIRED COMPONENTS s3 sts)
+find_package(AWSSDK REQUIRED COMPONENTS ${CURRENT_TARGET_AWS_DEPENDENCIES})
 
 add_executable(
-        s3_gtest
+        ${CURRENT_TARGET}
 )
 
-
 # If the compiler is some version of Microsoft Visual C++, or another compiler simulating C++,
 # and building as shared libraries, then dynamically link to those shared libraries.
 if(MSVC AND BUILD_SHARED_LIBS)
     add_definitions(-DUSE_IMPORT_EXPORT)
     # Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
-    list(APPEND SERVICE_LIST s3 sts)
+    list(APPEND SERVICE_LIST ${CURRENT_TARGET_AWS_DEPENDENCIES})
     #For IDE's like Xcode and Visual Studio this line will be ignored because Release/Debug 
     #  is switched internally, but this is necessary for non-IDE builds.
-    set(CMAKE_BUILD_TYPE Debug) #TODO: Set to your build type.
+
 
     #TODO:Choose which of the following two lines to use to copy to the same folder where your executables are.
-    AWSSDK_CPY_DYN_LIBS(SERVICE_LIST "" ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})  #Choose this line if your executables are in /build/Debug
-    #AWSSDK_CPY_DYN_LIBS(SERVICE_LIST "" ${CMAKE_CURRENT_BINARY_DIR})  #Choose this line for Visual Studio and possibly other IDEs.
+    AWSSDK_CPY_DYN_LIBS(
+        SERVICE_LIST
+        ""
+        ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}
+    )  #Choose this line if your executables are in /build/Debug
+
     add_custom_command(
-        TARGET s3_gtest  POST_BUILD
+        TARGET
+        ${CURRENT_TARGET}
+        POST_BUILD
         COMMAND ${CMAKE_COMMAND} -E copy
-                ${CMAKE_BINARY_DIR}/${CMAKE_BUILD_TYPE}/gtest_main.dll
-                ${CMAKE_BINARY_DIR}/${CMAKE_BUILD_TYPE}/gtest.dll
-                ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+                ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}/${CMAKE_BUILD_TYPE}/gtest.dll
+                ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}
+    )
  endif()
 
-
 # Check whether the target system is Windows, including Win64.
 if(WIN32)
     # Check whether the compiler is some version of Microsoft Visual C++, or another compiler simulating C++.
@@ -72,8 +82,10 @@ endif()
 
 enable_testing()
 
-file(GLOB GTEST_SOURCE_FILES
-        "gtest_*.cpp"
+file(
+     GLOB
+     GTEST_SOURCE_FILES
+    "gtest_*.cpp"
 )
 
 foreach(TEST_FILE ${GTEST_SOURCE_FILES})
@@ -83,29 +95,37 @@ foreach(TEST_FILE ${GTEST_SOURCE_FILES})
     else()
         message("Error: no associated source file found for ${TEST_FILE}")
     endif()
-
 endforeach()
 
-
 target_sources(
-        s3_gtest
+        ${CURRENT_TARGET}
         PUBLIC
         ${GTEST_SOURCE}
+        test_main.cpp
 )
 
-target_include_directories(s3_gtest PUBLIC
+target_include_directories(
+        ${CURRENT_TARGET}
+        PUBLIC
         $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../include>
-        $<INSTALL_INTERFACE:../include>)
+        $<INSTALL_INTERFACE:../include>
+)
 
-target_compile_definitions(s3_gtest PUBLIC
-        TESTING_BUILD)
+target_compile_definitions(
+        ${CURRENT_TARGET}
+        PUBLIC
+        TESTING_BUILD
+)
 
 target_link_libraries(
-        s3_gtest
-        GTest::gtest_main
+        ${CURRENT_TARGET}
+        GTest::gtest
         ${AWSSDK_LINK_LIBRARIES}
         ${AWSSDK_PLATFORM_DEPS}
 )
 
 include(GoogleTest)
-gtest_discover_tests(s3_gtest)
+gtest_add_tests(
+        TARGET
+        ${CURRENT_TARGET}
+)

cpp/example_code/s3/gtests/test_main.cpp

@@ -0,0 +1,11 @@
+/*
+   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   SPDX-License-Identifier: Apache-2.0
+*/
+
+#include "gtest/gtest.h"
+
+int main(int argc, char **argv) {
+    ::testing::InitGoogleTest(&argc, argv);
+    return RUN_ALL_TESTS();
+}

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

@@ -36,14 +36,15 @@ namespace AwsDoc
         AWSDOC_S3_API bool GetWebsiteConfig(const Aws::String& bucketName,
             const Aws::String& region = "");
         AWSDOC_S3_API bool ListBuckets();
+        AWSDOC_S3_API bool ListBucketDisablingDnsCache( const Aws::String& region = "");
         AWSDOC_S3_API bool ListObjects(const Aws::String& bucketName, 
             const Aws::String& region = "");
-        AWSDOC_S3_API bool PutBucketAcl(const Aws::String& bucketName, 
-            const Aws::String& ownerID, 
-            const Aws::String& granteePermission, 
+        AWSDOC_S3_API bool PutBucketAcl(const Aws::String& bucketName,
+            const Aws::String& ownerID,
+            const Aws::String& granteePermission,
             const Aws::String& granteeType,
-            const Aws::String& region, 
-            const Aws::String& granteeID = "", 
+            const Aws::String& granteeID,
+            const Aws::String& region,
             const Aws::String& granteeDisplayName = "",
             const Aws::String& granteeEmailAddress = "",
             const Aws::String& granteeURI = "");

cpp/example_code/s3/list_buckets_disabling_dns_cache.cpp

@@ -23,6 +23,7 @@
 #include <aws/core/client/ClientConfiguration.h>
 #include <aws/core/http/curl/CurlHttpClient.h>  //This example is for Linux only. See top.
 #include <aws/s3/S3Client.h>
+#include "awsdoc/s3/s3_examples.h"
 
 using namespace Aws;
 using namespace Aws::Http;
@@ -83,6 +84,38 @@ class MyHttpClientFactory : public Aws::Http::HttpClientFactory
     }
 };
 
+bool AwsDoc::S3::ListBucketDisablingDnsCache( const Aws::String& region)
+{
+    SetHttpClientFactory(Aws::MakeShared<MyHttpClientFactory>(ALLOCATION_TAG));
+    Aws::Client::ClientConfiguration config;
+    if (!region.empty())
+    {
+        config.region = region;
+    }
+
+    Aws::S3::S3Client s3Client(config);
+    auto listBucketsOutcome = s3Client.ListBuckets();
+    if (listBucketsOutcome.IsSuccess())
+    {
+        std::cout << "Found " << listBucketsOutcome.GetResult().GetBuckets().size() << " buckets" << std::endl;
+        for (auto&& bucket : listBucketsOutcome.GetResult().GetBuckets())
+        {
+            std::cout << "  " << bucket.GetName() << std::endl;
+        }
+    }
+    else
+    {
+        std::cout << "Failed to list buckets. Error details:" << std::endl;
+        std::cout << listBucketsOutcome.GetError() << std::endl;
+    }
+
+    // reset the http client factory
+    CleanupHttp();
+    InitHttp();
+
+    return listBucketsOutcome.IsSuccess();
+}
+
 /**
  * With AWS SDK for C++ version 1.8, it's much easier to override the default HTTP client configuration with the virtual functions: OverrideOptionsOn*Handle()
  * In this example, we override the default HTTP client and disable DNS caching with some low level Curl APIs.
@@ -92,26 +125,13 @@ int main(int argc, char *argv[])
     SDKOptions options;
     options.loggingOptions.logLevel = Utils::Logging::LogLevel::Trace;
     InitAPI(options);
-    {
-        SetHttpClientFactory(Aws::MakeShared<MyHttpClientFactory>(ALLOCATION_TAG));
 
-        Aws::S3::S3Client s3Client;
-        auto listBucketsOutcome = s3Client.ListBuckets();
-        if (listBucketsOutcome.IsSuccess())
-        {
-            std::cout << "Found " << listBucketsOutcome.GetResult().GetBuckets().size() << " buckets" << std::endl;
-            for (auto&& bucket : listBucketsOutcome.GetResult().GetBuckets())
-            {
-                std::cout << "  " << bucket.GetName() << std::endl;
-            }
-        }
-        else
-        {
-            std::cout << "Failed to list buckets. Error details:" << std::endl;
-            std::cout << listBucketsOutcome.GetError() << std::endl;
-        }
+    int result = 0;
+    if (!AwsDoc::S3::ListBucketDisablingDnsCache())
+    {
+        result = 1;
     }
 
     ShutdownAPI(options);
-    return 0;
+    return result;
 }

cpp/example_code/s3/tests/test_delete_bucket_policy.cpp

@@ -10,6 +10,7 @@
 #include <aws/s3/model/PutBucketPolicyRequest.h>
 #include <aws/s3/model/DeleteBucketRequest.h>
 #include <awsdoc/s3/s3_examples.h>
+#include "test_utils.h"
 
 int main()
 {
@@ -46,6 +47,12 @@ int main()
             return 1;
         }
 
+        Aws::String user_arn = AwsTest::TestUtils::getArnForUser(config);
+        if (user_arn.empty())
+        {
+            return 1;
+        }
+
         // 2/4. Create the bucket policy, and then add the bucket policy 
         // to the bucket.
         Aws::String policy_string =
@@ -55,7 +62,9 @@ int main()
             "   {\n"
             "     \"Sid\": \"1\",\n"
             "     \"Effect\": \"Allow\",\n"
-            "     \"Principal\": {\"AWS\":\"*\"},\n"
+            "     \"Principal\": {\n"
+            "          \"AWS\": \"" + user_arn + "\"\n"
+            "     },\n"
             "     \"Action\": [\"s3:GetObject\"],\n"
             "     \"Resource\": [\"arn:aws:s3:::" + bucket_name + "/*\"]\n"
             "   }]\n"
@@ -77,9 +86,9 @@ int main()
         {
             auto err = create_outcome.GetError();
             std::cout << "Error: DeleteBucketPolicy test setup: Add bucket policy '" <<
-                policy_string << "' to bucket '" << bucket_name << "': " << 
+                policy_string << "' to bucket '" << bucket_name << "': " <<
                 err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
-            std::cout << "To clean up, you must delete the bucket '" << 
+            std::cout << "To clean up, you must delete the bucket '" <<
                 bucket_name << "' yourself. " << std::endl;
 
             return 1;