Move to pytest (#6427)

Author: nateprewitt

awscli/customizations/ec2/bundleinstance.py

@@ -135,7 +135,7 @@ def _generate_signature(params):
         policy = base64.b64encode(six.b(policy)).decode('utf-8')
         new_hmac = hmac.new(sak.encode('utf-8'), digestmod=sha1)
         new_hmac.update(six.b(policy))
-        ps = base64.encodestring(new_hmac.digest()).strip().decode('utf-8')
+        ps = base64.encodebytes(new_hmac.digest()).strip().decode('utf-8')
         params['UploadPolicySignature'] = ps
         del params['_SAK']
 

awscli/customizations/opsworks.py

@@ -302,7 +302,7 @@ def determine_details(self, args):
                 if 'PublicIpAddress' in self._ec2_instance:
                     self._use_address = self._ec2_instance['PublicIpAddress']
                 elif 'PrivateIpAddress' in self._ec2_instance:
-                    LOG.warn(
+                    LOG.warning(
                         "Instance does not have a public IP address. Trying "
                         "to use the private address to connect.")
                     self._use_address = self._ec2_instance['PrivateIpAddress']

awscli/testutils.py

@@ -917,6 +917,7 @@ class TestEventHandler(object):
     def __init__(self, handler=None):
         self._handler = handler
         self._called = False
+        self.__test__ = False
 
     @property
     def called(self):

pyproject.toml

@@ -0,0 +1,4 @@
+[tool.pytest.ini_options]
+markers = [
+    "slow: marks tests as slow",
+]

requirements-check.txt

@@ -1 +1,4 @@
 check-manifest==0.37
+
+# We need setuptools>=43.0 to include pyproject.toml
+setuptools>=43.0

scripts/ci/run-tests

@@ -33,10 +33,7 @@ def process_args(args):
     runner = args.test_runner
     test_args = ""
     if args.with_cov:
-        test_args += (
-            f"--with-xunit --cover-erase --with-coverage "
-            f"--cover-package {PACKAGE} --cover-xml -v "
-        )
+        test_args += f"--cov={PACKAGE} --cov-report xml "
     dirs = " ".join(args.test_dirs)
 
     return runner, test_args, dirs
@@ -53,8 +50,8 @@ if __name__ == "__main__":
     parser.add_argument(
         "-r",
         "--test-runner",
-        default="nosetests",
-        help="Test runner to execute tests. Defaults to nose.",
+        default="pytest",
+        help="Test runner to execute tests. Defaults to pytest.",
     )
     parser.add_argument(
         "-c",

tests/functional/docs/test_examples.py

@@ -28,6 +28,8 @@
 import docutils.parsers.rst
 import docutils.utils
 
+import pytest
+
 from awscli.argparser import MainArgParser
 from awscli.argparser import ServiceArgParser
 from awscli.testutils import BaseAWSHelpOutputTest, create_clidriver
@@ -66,13 +68,45 @@ def noop_test(self):
         pass
 
 
-def test_examples():
+def _get_example_test_cases():
+    test_cases = []
     for command, subcommands in COMMAND_EXAMPLES.items():
         for subcommand in subcommands:
-            yield verify_has_examples, command, subcommand
+            test_cases.append((command, subcommand))
+    return test_cases
+
+
+def _get_all_doc_examples():
+    rst_doc_examples = []
+    other_doc_examples = []
+    # Iterate over all rst doc examples0
+    for root, _, filenames in os.walk(EXAMPLES_DIR):
+        for filename in filenames:
+            full_path = os.path.join(root, filename)
+            if not filename.endswith('.rst'):
+                other_doc_examples.append(full_path)
+                continue
+            rst_doc_examples.append(full_path)
+    return rst_doc_examples, other_doc_examples
+
+
+RST_DOC_EXAMPLES, OTHER_DOC_EXAMPLES = _get_all_doc_examples()
+EXAMPLE_COMMAND_TESTS = _get_example_test_cases()
+
+
+@pytest.fixture(scope="module")
+def command_validator():
+    # CLIDriver can take up a lot of resources so we'll just create one
+    # instance and use it for all the validation tests.
+    driver = create_clidriver()
+    return CommandValidator(driver)
 
 
-def verify_has_examples(command, subcommand):
+@pytest.mark.parametrize(
+    "command, subcommand",
+    EXAMPLE_COMMAND_TESTS
+)
+def test_examples(command, subcommand):
     t = _ExampleTests(methodName='noop_test')
     t.setUp()
     try:
@@ -82,27 +116,14 @@ def verify_has_examples(command, subcommand):
         t.tearDown()
 
 
-def test_all_doc_examples():
-    # CLIDriver can take up a lot of resources so we'll just create one
-    # instance and use it for all the validation tests.
-    driver = create_clidriver()
-    command_validator = CommandValidator(driver)
-
-    for example_file in iter_all_doc_examples():
-        yield verify_has_only_ascii_chars, example_file
-        yield verify_is_valid_rst, example_file
-        yield verify_cli_commands_valid, example_file, command_validator
-
-
-def iter_all_doc_examples():
-    # Iterate over all rst doc examples0
-    _dname = os.path.dirname
-    for rootdir, _, filenames in os.walk(EXAMPLES_DIR):
-        for filename in filenames:
-            if not filename.endswith('.rst'):
-                continue
-            full_path = os.path.join(rootdir, filename)
-            yield full_path
+@pytest.mark.parametrize(
+    "example_file",
+    RST_DOC_EXAMPLES
+)
+def test_rst_doc_examples(command_validator, example_file):
+    verify_has_only_ascii_chars(example_file)
+    verify_is_valid_rst(example_file)
+    verify_cli_commands_valid(example_file, command_validator)
 
 
 def verify_has_only_ascii_chars(filename):
@@ -263,12 +284,14 @@ def default_visit(self, node):
         pass
 
 
-def test_example_file_names():
-    for root, _, files in os.walk(EXAMPLES_DIR):
-        for filename in files:
-            filepath = os.path.join(root, filename)
-            yield (_assert_file_is_rst_or_txt, filepath)
-            yield (_assert_name_contains_only_allowed_characters, filename)
+@pytest.mark.parametrize(
+    "example_file",
+    RST_DOC_EXAMPLES + OTHER_DOC_EXAMPLES
+)
+def test_example_file_name(example_file):
+    filename = example_file.split(os.sep)[-1]
+    _assert_file_is_rst_or_txt(example_file)
+    _assert_name_contains_only_allowed_characters(filename)
 
 
 def _assert_file_is_rst_or_txt(filepath):

tests/functional/ec2/test_bundle_instance.py

@@ -69,7 +69,7 @@ def test_no_policy_provided(self):
 
     def test_policy_provided(self):
         policy = '{"notarealpolicy":true}'
-        base64policy = base64.encodestring(six.b(policy)).strip().decode('utf-8')
+        base64policy = base64.encodebytes(six.b(policy)).strip().decode('utf-8')
         policy_signature = 'a5SmoLOxoM0MHpOdC25nE7KIafg='
         args = ' --instance-id i-12345678 --owner-akid AKIAIOSFODNN7EXAMPLE'
         args += ' --owner-sak wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'

tests/functional/eks/test_util.py

@@ -14,17 +14,15 @@
 """This module contains some helpers for mocking eks clusters"""
 
 import os
-from nose.tools import nottest
 
 
 EXAMPLE_NAME = "ExampleCluster"
 
-@nottest
 def get_testdata(file_name):
     """Get the path of a specific fixture"""
-    return os.path.join(os.path.dirname(os.path.realpath(__file__)),
-                        "testdata",
-                        file_name)
+    return os.path.join(
+        os.path.dirname(os.path.realpath(__file__)), "testdata", file_name
+    )
 
 
 def list_cluster_response():

tests/functional/test_shadowing.py

@@ -10,25 +10,26 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
+import pytest
+
 from awscli.clidriver import create_clidriver
 
 
-def _assert_does_not_shadow(command_name, command_table, builtins):
-    errors = []
-    for sub_name, sub_command in command_table.items():
-        op_help = sub_command.create_help_command()
-        arg_table = op_help.arg_table
-        for arg_name in arg_table:
-            if any(p.startswith(arg_name) for p in builtins):
-                # Then we are shadowing or prefixing a top level argument
-                errors.append(
-                    'Shadowing/Prefixing a top level option: '
-                    '%s.%s.%s' % (command_name, sub_name, arg_name))
-    if errors:
-        raise AssertionError('\n' + '\n'.join(errors))
+def _generate_command_tests():
+    driver = create_clidriver()
+    help_command = driver.create_help_command()
+    top_level_params = set(driver.create_help_command().arg_table)
+    for command_name, command_obj in help_command.command_table.items():
+        sub_help = command_obj.create_help_command()
+        if hasattr(sub_help, 'command_table'):
+            yield command_name, sub_help.command_table, top_level_params
 
 
-def test_no_shadowed_builtins():
+@pytest.mark.parametrize(
+    "command_name, command_table, builtins",
+    _generate_command_tests()
+)
+def test_no_shadowed_builtins(command_name, command_table, builtins):
     """Verify no command params are shadowed or prefixed by the built in param.
 
     The CLI parses all command line options into a single namespace.
@@ -54,13 +55,15 @@ def test_no_shadowed_builtins():
     a single test failure.
 
     """
-    driver = create_clidriver()
-    help_command = driver.create_help_command()
-    top_level_params = set(driver.create_help_command().arg_table)
-    for command_name, command_obj in help_command.command_table.items():
-        sub_help = command_obj.create_help_command()
-        if hasattr(sub_help, 'command_table'):
-            yield (
-                _assert_does_not_shadow,
-                command_name, sub_help.command_table, top_level_params
-            )
+    errors = []
+    for sub_name, sub_command in command_table.items():
+        op_help = sub_command.create_help_command()
+        arg_table = op_help.arg_table
+        for arg_name in arg_table:
+            if any(p.startswith(arg_name) for p in builtins):
+                # Then we are shadowing or prefixing a top level argument
+                errors.append(
+                    'Shadowing/Prefixing a top level option: '
+                    '%s.%s.%s' % (command_name, sub_name, arg_name))
+    if errors:
+        raise AssertionError('\n' + '\n'.join(errors))