Turn ON AWS_EC2_METADATA_DISABLED for unit tests by default.

Disable client configuration reading region from EC2 metadata in unit tests expect when we want to test it explicitly. This is to avoid the requests retrieving EC2 metadata so that we won't slow down the testing process as well as build process when AUTORUN_UNIT_TESTS is ON.

Author: wps132230

aws-cpp-sdk-core-tests/RunTests.cpp

@@ -23,15 +23,19 @@ int main(int argc, char** argv)
 
     Aws::Testing::RedirectHomeToTempIfAppropriate();
 
-    Aws::SDKOptions options;	
+    Aws::SDKOptions options;
     options.loggingOptions.logLevel = Aws::Utils::Logging::LogLevel::Trace;
     options.httpOptions.installSigPipeHandler = true;
     AWS_BEGIN_MEMORY_TEST_EX(options, 1024, 128);
 
     Aws::Testing::InitPlatformTest(options);
     Aws::InitAPI(options);
+    // Disable EC2 metadata in client configuration to avoid requests retrieving EC2 metadata in unit tests.
+    Aws::Testing::SaveEnvironmentVariable("AWS_EC2_METADATA_DISABLED");
+    Aws::Environment::SetEnv("AWS_EC2_METADATA_DISABLED", "true", 1/*override*/);
     ::testing::InitGoogleTest(&argc, argv);
     int retVal = RUN_ALL_TESTS();
+    Aws::Testing::RestoreEnvironmentVariables();
     Aws::ShutdownAPI(options);
     AWS_END_MEMORY_TEST_EX;
 

aws-cpp-sdk-core-tests/aws/client/AWSClientTest.cpp

@@ -143,7 +143,6 @@ class AWSConfigTestSuite : public ::testing::Test
         SaveEnvironmentVariable("AWS_PROFILE");
         SaveEnvironmentVariable("AWS_DEFAULT_REGION");
         SaveEnvironmentVariable("AWS_REGION");
-        SaveEnvironmentVariable("AWS_EC2_METADATA_DISABLED");
 
         Aws::StringStream ss;
         ss << Aws::Auth::GetConfigProfileFilename() + "_blah" << std::this_thread::get_id();
@@ -516,8 +515,6 @@ TEST(AWSClientTest, TestOverflowContainer)
 TEST_F(AWSConfigTestSuite, TestClientConfigurationWithNonExistentProfile)
 {
     // create a config file with profile named Dijkstra
-    Aws::Environment::SetEnv("AWS_EC2_METADATA_DISABLED", "true", 1);
-
     Aws::OFStream configFileNew(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
     configFileNew << "[Dijkstra]" << std::endl;
     configFileNew << "region = " << Aws::Region::US_WEST_2 << std::endl;
@@ -537,7 +534,6 @@ TEST_F(AWSConfigTestSuite, TestClientConfigurationWithNonExistentProfile)
 TEST_F(AWSConfigTestSuite, TestClientConfigurationWithNonExistentConfigFile)
 {
     Aws::Environment::SetEnv("AWS_CONFIG_FILE", "WhatAreTheChances", 1/*overwrite*/);
-    Aws::Environment::SetEnv("AWS_EC2_METADATA_DISABLED", "true", 1);
     Aws::Config::ReloadCachedConfigFile();
 
     Aws::Client::ClientConfiguration config("default");
@@ -675,6 +671,8 @@ TEST_F(AWSRegionTest, TestResolveRegionFromEC2InstanceMetadata)
 
     Aws::Environment::UnSetEnv("AWS_DEFAULT_REGION");
     Aws::Environment::UnSetEnv("AWS_REGION");
+    // We set AWS_EC2_METADATA_DISABLED=true Aws::Testing::InitPlatformTest, we need to set it to false explicitly for this test.
+    Aws::Environment::UnSetEnv("AWS_EC2_METADATA_DISABLED");
     Aws::OFStream configFile(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
     configFile << "[default]" << std::endl;
     configFile.close();
@@ -708,7 +706,6 @@ TEST_F(AWSRegionTest, TestResolveDefaultRegion)
 {
     Aws::Environment::UnSetEnv("AWS_DEFAULT_REGION");
     Aws::Environment::UnSetEnv("AWS_REGION");
-    Aws::Environment::SetEnv("AWS_EC2_METADATA_DISABLED", "true", 1);
     Aws::OFStream configFile(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
     configFile << "[default]" << std::endl;
     configFile.close();

testing-resources/include/aws/testing/TestingEnvironment.h

@@ -19,6 +19,8 @@ namespace Testing
     AWS_TESTING_API void SetAwsResourcePrefix(const char* resourcePrefix);
     AWS_TESTING_API const Aws::String GetAwsResourcePrefix();
     AWS_TESTING_API void ParseArgs(int argc, char** argv);
+    AWS_TESTING_API void SaveEnvironmentVariable(const char* variableName);
+    AWS_TESTING_API void RestoreEnvironmentVariables();
 
 } // namespace Testing
 } // namespace Aws

testing-resources/source/TestingEnvironment.cpp

@@ -7,6 +7,7 @@
 #include <aws/testing/TestingEnvironment.h>
 
 #include <aws/core/platform/FileSystem.h>
+#include <aws/core/platform/Environment.h>
 #include <aws/testing/platform/PlatformTesting.h>
 
 #include <sstream>
@@ -18,7 +19,7 @@ namespace Testing
 
 void RedirectHomeToTempIfAppropriate()
 {
-    #if !defined(DISABLE_HOME_DIR_REDIRECT) 
+    #if !defined(DISABLE_HOME_DIR_REDIRECT)
         //Set $HOME to tmp on unix systems
         std::stringstream tempDir; //( P_tmpdir );
         tempDir << P_tmpdir;
@@ -66,5 +67,27 @@ void ParseArgs(int argc, char** argv)
     }
 }
 
+static std::vector<std::pair<const char*, std::string>> s_environments;
+
+void SaveEnvironmentVariable(const char* variableName)
+{
+    s_environments.emplace_back(variableName, Aws::Environment::GetEnv(variableName).c_str());
+}
+
+void RestoreEnvironmentVariables()
+{
+    for(const auto& iter : s_environments)
+    {
+        if(iter.second.empty())
+        {
+            Aws::Environment::UnSetEnv(iter.first);
+        }
+        else
+        {
+            Aws::Environment::SetEnv(iter.first, iter.second.c_str(), 1/*override*/);
+        }
+    }
+}
+
 } // namespace Testing
 } // namespace Aws