Move datetime.datetime.utcnow usage to consolidated function (aws#9636)

Author: nateprewitt

awscli/compat.py

@@ -13,6 +13,7 @@
 
 import collections.abc as collections_abc
 import contextlib
+import datetime
 import io
 import locale
 import os
@@ -502,3 +503,13 @@ def _linux_distribution(
         if _id:
             id = _id
         return distname, version, id
+
+
+def get_current_datetime(remove_tzinfo=True):
+    # TODO: Consolidate to botocore.compat.get_current_datetime
+    # after it's had time to bake to avoid import errors with
+    # mismatched versions.
+    datetime_now = datetime.datetime.now(datetime.timezone.utc)
+    if remove_tzinfo:
+        datetime_now = datetime_now.replace(tzinfo=None)
+    return datetime_now

awscli/customizations/cloudformation/deployer.py

@@ -17,10 +17,10 @@
 import botocore
 import collections
 
+from awscli.compat import get_current_datetime
 from awscli.customizations.cloudformation import exceptions
 from awscli.customizations.cloudformation.artifact_exporter import mktempfile, parse_s3_url
 
-from datetime import datetime
 
 LOG = logging.getLogger(__name__)
 
@@ -85,7 +85,7 @@ def create_changeset(self, stack_name, cfn_template,
         :return:
         """
 
-        now = datetime.utcnow().isoformat()
+        now = get_current_datetime().isoformat()
         description = "Created by AWS CLI at {0} UTC".format(now)
 
         # Each changeset will get a unique name based on time

awscli/customizations/cloudtrail/validation.py

@@ -19,7 +19,7 @@
 import sys
 import zlib
 from zlib import error as ZLibError
-from datetime import datetime, timedelta
+from datetime import timedelta
 from dateutil import tz, parser
 
 from pyasn1.error import PyAsn1Error
@@ -29,6 +29,7 @@
     get_account_id_from_arn
 from awscli.customizations.commands import BasicCommand
 from botocore.exceptions import ClientError
+from awscli.compat import get_current_datetime
 from awscli.schema import ParameterRequiredError
 from awscli.utils import create_nested_client
 
@@ -432,7 +433,7 @@ def traverse(self, start_date, end_date=None):
         :param end_date: Date to stop validating at (inclusive).
         """
         if end_date is None:
-            end_date = datetime.utcnow()
+            end_date = get_current_datetime()
         end_date = normalize_date(end_date)
         start_date = normalize_date(start_date)
         bucket = self.starting_bucket
@@ -735,7 +736,7 @@ def handle_args(self, args):
         if args.end_time:
             self.end_time = normalize_date(parse_date(args.end_time))
         else:
-            self.end_time = normalize_date(datetime.utcnow())
+            self.end_time = normalize_date(get_current_datetime())
         if self.start_time > self.end_time:
             raise ValueError(('Invalid time range specified: start-time must '
                               'occur before end-time'))

awscli/customizations/codecommit.py

@@ -16,13 +16,12 @@
 import sys
 import logging
 import fileinput
-import datetime
 
 from botocore.auth import SigV4Auth
 from botocore.awsrequest import AWSRequest
 from botocore.compat import urlsplit
 from awscli.customizations.commands import BasicCommand
-from awscli.compat import NonTranslatedStdout
+from awscli.compat import NonTranslatedStdout, get_current_datetime
 
 logger = logging.getLogger('botocore.credentials')
 
@@ -150,7 +149,7 @@ def sign_request(self, region, url_to_sign):
         request = AWSRequest()
         request.url = url_to_sign
         request.method = 'GIT'
-        now = datetime.datetime.utcnow()
+        now = get_current_datetime()
         request.context['timestamp'] = now.strftime('%Y%m%dT%H%M%S')
         split = urlsplit(request.url)
         # we don't want to include the port number in the signature

awscli/customizations/codedeploy/push.py

@@ -16,13 +16,12 @@
 import zipfile
 import tempfile
 import contextlib
-from datetime import datetime
 
 from botocore.exceptions import ClientError
 
 from awscli.customizations.codedeploy.utils import validate_s3_location
 from awscli.customizations.commands import BasicCommand
-from awscli.compat import BytesIO, ZIP_COMPRESSION_MODE
+from awscli.compat import BytesIO, ZIP_COMPRESSION_MODE, get_current_datetime
 from awscli.utils import create_nested_client
 
 ONE_MB = 1 << 20
@@ -132,7 +131,7 @@ def _validate_args(self, parsed_args):
         if not parsed_args.description:
             parsed_args.description = (
                 'Uploaded by AWS CLI {0} UTC'.format(
-                    datetime.utcnow().isoformat()
+                    get_current_datetime().isoformat()
                 )
             )
 

awscli/customizations/datapipeline/__init__.py

@@ -12,10 +12,11 @@
 # language governing permissions and limitations under the License.
 
 import json
-from datetime import datetime, timedelta
+from datetime import timedelta
 
 from awscli.formatter import get_formatter
 from awscli.arguments import CustomArgument
+from awscli.compat import get_current_datetime
 from awscli.customizations.commands import BasicCommand
 from awscli.customizations.datapipeline import translator
 from awscli.customizations.datapipeline.createdefaultroles \
@@ -184,7 +185,7 @@ class QueryArgBuilder(object):
     """
     def __init__(self, current_time=None):
         if current_time is None:
-            current_time = datetime.utcnow()
+            current_time = get_current_datetime()
         self.current_time = current_time
 
     def build_query(self, parsed_args):

awscli/customizations/ec2/bundleinstance.py

@@ -18,6 +18,7 @@
 import datetime
 
 from awscli.arguments import CustomArgument
+from awscli.compat import get_current_datetime
 
 logger = logging.getLogger('ec2bundleinstance')
 
@@ -117,7 +118,7 @@ def _generate_policy(params):
     # Called if there is no policy supplied by the user.
     # Creates a policy that provides access for 24 hours.
     delta = datetime.timedelta(hours=24)
-    expires = datetime.datetime.utcnow() + delta
+    expires = get_current_datetime() + delta
     expires_iso = expires.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
     policy = POLICY.format(expires=expires_iso,
                            bucket=params['Bucket'],

awscli/customizations/eks/get_token.py

@@ -16,12 +16,13 @@
 import os
 import sys
 
-from datetime import datetime, timedelta
+from datetime import timedelta
 from botocore.signers import RequestSigner
 from botocore.model import ServiceId
 
 from awscli.formatter import get_formatter
 from awscli.utils import create_nested_client
+from awscli.compat import get_current_datetime
 from awscli.customizations.commands import BasicCommand
 from awscli.customizations.utils import uni_print
 from awscli.customizations.utils import validate_mutually_exclusive
@@ -107,7 +108,7 @@ class GetTokenCommand(BasicCommand):
     ]
 
     def get_expiration_time(self):
-        token_expiration = datetime.utcnow() + timedelta(
+        token_expiration = get_current_datetime() + timedelta(
             minutes=TOKEN_EXPIRATION_MINS
         )
         return token_expiration.strftime('%Y-%m-%dT%H:%M:%SZ')

awscli/customizations/opsworks.py

@@ -24,7 +24,7 @@
 
 from botocore.exceptions import ClientError
 
-from awscli.compat import urlopen, ensure_text_type
+from awscli.compat import get_current_datetime, urlopen, ensure_text_type
 from awscli.customizations.commands import BasicCommand
 from awscli.customizations.utils import create_client_from_parsed_globals
 
@@ -505,7 +505,7 @@ def _iam_policy_document(arn, timeout=None):
             "Resource": arn,
         }
         if timeout is not None:
-            valid_until = datetime.datetime.utcnow() + timeout
+            valid_until = get_current_datetime() + timeout
             statement["Condition"] = {
                 "DateLessThan": {
                     "aws:CurrentTime":

tests/functional/ec2/test_bundle_instance.py

@@ -31,7 +31,7 @@ class TestBundleInstance(BaseAWSCommandParamsTest):
 
     def setUp(self):
         super(TestBundleInstance, self).setUp()
-        # This mocks out datetime.datetime.utcnow() so that it always
+        # This mocks out datetime.datetime.now() so that it always
         # returns the same datetime object.  This is because this value
         # is embedded into the policy file that is generated and we
         # don't what the policy or its signature to change each time
@@ -41,7 +41,7 @@ def setUp(self):
             mock.Mock(wraps=datetime.datetime)
         )
         mocked_datetime = self.datetime_patcher.start()
-        mocked_datetime.utcnow.return_value = datetime.datetime(2013, 8, 9)
+        mocked_datetime.now.return_value = datetime.datetime(2013, 8, 9)
 
     def tearDown(self):
         super(TestBundleInstance, self).tearDown()