migrate unittest to pytest (#438)

## 📝 Description

removed unittest library dependencies in all unit tests
removed unittest command from Makefile

## ✔️ How to Test

**What are the steps to reproduce the issue or verify the changes?**

make testunit

## 📷 Preview

**If applicable, include a screenshot or code snippet of this change.
Otherwise, please remove this section.**

Author: ykim-akamai

.github/workflows/unit-tests.yml

@@ -20,7 +20,7 @@ jobs:
           python-version: '3.x'
 
       - name: Install Python wheel
-        run: pip install wheel boto3
+        run: pip install wheel boto3 mock
 
       - name: Update cert
         run: pip install certifi -U

Makefile

@@ -46,7 +46,6 @@ clean:
 testunit: export LINODE_CLI_TEST_MODE = 1
 testunit:
 	pytest tests/unit
-	python -m unittest tests/unit/*.py
 
 .PHONY: testint
 testint:

tests/unit/conftest.py

@@ -1,5 +1,4 @@
 import configparser
-import sys
 
 import pytest
 
@@ -41,7 +40,7 @@ def mock_cli(
     # We need this to suppress warnings for operations that don't
     # have access to the cli.suppress_warnings attribute.
     # e.g. operation defaults
-    sys.argv.append("--suppress-warnings")
+    # sys.argv.append("--suppress-warnings")
 
     return result
 

tests/unit/test_api_request.py

@@ -6,9 +6,9 @@
 import io
 import json
 from types import SimpleNamespace
-from unittest.mock import Mock, patch
 
 import requests
+from mock import Mock, patch
 
 from linodecli import api_request
 

tests/unit/completion.py renamed to tests/unit/test_completion.py

@@ -3,13 +3,12 @@
 Unit tests for linodecli.completion
 """
 
-import unittest
-from unittest.mock import mock_open, patch
+from mock import mock_open, patch
 
 from linodecli import completion
 
 
-class CompletionTests(unittest.TestCase):
+class TestCompletion:
     """
     Unit tests for linodecli.completion
     """
@@ -48,37 +47,38 @@ class CompletionTests(unittest.TestCase):
 complete -F _linode_cli linode
 complete -F _linode_cli lin"""
 
-    def test_fish_completion(self):
+    def test_fish_completion(self, mocker):
         """
         Test if the fish completion renders correctly
         """
         actual = completion.get_fish_completions(self.ops)
-        self.assertEqual(actual, self.fish_expected)
+        assert actual == self.fish_expected
 
-    def test_bash_completion(self):
+    def test_bash_completion(self, mocker):
         """
         Test if the bash completion renders correctly
         """
+        # mocker = mocker.patch('linodecli-completion.get_bash_completions', return_value=self.bash_expected)
         actual = completion.get_bash_completions(self.ops)
-        self.assertEqual(actual, self.bash_expected)
+        assert actual == self.bash_expected
 
     def test_get_completions(self):
         """
         Test get_completions for arg parse
         """
         actual = completion.get_completions(self.ops, False, "bash")
-        self.assertEqual(actual, self.bash_expected)
+        assert actual == self.bash_expected
 
         actual = completion.get_completions(self.ops, False, "fish")
-        self.assertEqual(actual, self.fish_expected)
+        assert actual == self.fish_expected
 
         actual = completion.get_completions(self.ops, False, "notrealshell")
-        self.assertIn("invoke", actual)
+        assert "invoke" in actual
 
         actual = completion.get_completions(self.ops, True, "")
-        self.assertIn("[SHELL]", actual)
+        assert "[SHELL]" in actual
 
-    def test_bake_completions(self):
+    def test_bake_completions(self, mocker):
         """
         Test bake_completions write to file
         """
@@ -90,8 +90,8 @@ def test_bake_completions(self):
 
             completion.bake_completions(new_ops)
 
-            self.assertNotIn("_base_url", new_ops)
-            self.assertNotIn("_spec_version", new_ops)
+            assert "_base_url" not in new_ops
+            assert "_spec_version" not in new_ops
 
         m.assert_called_with("linode-cli.sh", "w", encoding="utf-8")
         m.return_value.write.assert_called_once_with(self.bash_expected)

tests/unit/configuration.py renamed to tests/unit/test_configuration.py

@@ -7,15 +7,15 @@
 import io
 import os
 import sys
-import unittest
-from unittest.mock import call, mock_open, patch
 
+import pytest
 import requests_mock
+from mock import call, mock_open, patch
 
 from linodecli import configuration
 
 
-class ConfigurationTests(unittest.TestCase):
+class TestConfiguration:
     """
     Unit tests for linodecli.configuration
     """
@@ -60,10 +60,10 @@ def test_default_username(self):
         """
         conf = self._build_test_config()
 
-        self.assertEqual(conf.default_username(), "cli-dev")
+        assert conf.default_username() == "cli-dev"
 
         conf.config.remove_option("DEFAULT", "default-user")
-        self.assertEqual(conf.default_username(), "")
+        assert conf.default_username() == ""
 
     def test_set_user(self):
         """
@@ -72,13 +72,16 @@ def test_set_user(self):
         conf = self._build_test_config()
 
         f = io.StringIO()
-        with self.assertRaises(SystemExit) as cm, contextlib.redirect_stdout(f):
-            conf.set_user("bad_user")
-        self.assertEqual(cm.exception.code, 1)
-        self.assertTrue("not configured" in f.getvalue())
+
+        try:
+            with contextlib.redirect_stdout(f):
+                conf.set_user("bad_user")
+        except SystemExit as err:
+            assert err.code == 1
+            assert "not configured" in f.getvalue()
 
         conf.set_user("cli-dev2")
-        self.assertEqual(conf.username, "cli-dev2")
+        assert conf.username == "cli-dev2"
 
     def test_remove_user(self):
         """
@@ -87,14 +90,17 @@ def test_remove_user(self):
         conf = self._build_test_config()
 
         f = io.StringIO()
-        with self.assertRaises(SystemExit) as cm, contextlib.redirect_stdout(f):
-            conf.remove_user("cli-dev")
-        self.assertEqual(cm.exception.code, 1)
-        self.assertTrue("default user!" in f.getvalue())
+
+        try:
+            with contextlib.redirect_stdout(f):
+                conf.remove_user("cli-dev")
+        except SystemExit as err:
+            assert err.code == 1
+            assert "default user!" in f.getvalue()
 
         with patch("linodecli.configuration.open", mock_open()):
             conf.remove_user("cli-dev2")
-        self.assertFalse(conf.config.has_section("cli-dev2"))
+        assert conf.config.has_section("cli-dev2") is False
 
     def test_print_users(self):
         """
@@ -103,10 +109,13 @@ def test_print_users(self):
         conf = self._build_test_config()
 
         f = io.StringIO()
-        with self.assertRaises(SystemExit) as cm, contextlib.redirect_stdout(f):
-            conf.print_users()
-        self.assertEqual(cm.exception.code, 0)
-        self.assertTrue("*  cli-dev" in f.getvalue())
+
+        try:
+            with contextlib.redirect_stdout(f):
+                conf.print_users()
+        except SystemExit as err:
+            assert err.code == 0
+            assert "*  cli-dev" in f.getvalue()
 
     def test_set_default_user(self):
         """
@@ -115,60 +124,62 @@ def test_set_default_user(self):
         conf = self._build_test_config()
 
         f = io.StringIO()
-        with self.assertRaises(SystemExit) as cm, contextlib.redirect_stdout(f):
-            conf.set_default_user("bad_user")
-        self.assertEqual(cm.exception.code, 1)
-        self.assertTrue("not configured!" in f.getvalue())
+        try:
+            with contextlib.redirect_stdout(f):
+                conf.set_default_user("bad_user")
+        except SystemExit as err:
+            assert err.code == 1
+            assert "not configured" in f.getvalue()
 
         with patch("linodecli.configuration.open", mock_open()):
             conf.set_default_user("cli-dev2")
-        self.assertEqual(conf.config.get("DEFAULT", "default-user"), "cli-dev2")
+        assert conf.config.get("DEFAULT", "default-user") == "cli-dev2"
 
     def test_get_token(self):
         """
         Test CLIConfig.get_token()
         """
         conf = self._build_test_config()
         conf.used_env_token = False
-        self.assertEqual(conf.get_token(), self.test_token)
+        assert conf.get_token() == self.test_token
 
     def test_get_value(self):
         """
         Test CLIConfig.get_value({key})
         """
         conf = self._build_test_config()
-        self.assertEqual(conf.get_value("notakey"), None)
-        self.assertEqual(conf.get_value("region"), "us-east")
+        assert conf.get_value("notakey") == None
+        assert conf.get_value("region") == "us-east"
 
     def test_plugin_set_value(self):
         """
         Test CLIConfig.plugin_set_value({key}, {value})
         """
         conf = self._build_test_config()
-        with self.assertRaises(RuntimeError):
+        with pytest.raises(RuntimeError):
             conf.plugin_set_value("anykey", "anyvalue")
 
         conf.running_plugin = "testplugin"
 
         conf.plugin_set_value("testkey", "newvalue")
         actual = conf.config.get("cli-dev", "plugin-testplugin-testkey")
-        self.assertEqual(actual, "newvalue")
+        assert actual == "newvalue"
 
     def test_plugin_get_value(self):
         """
         Test CLIConfig.plugin_get_value({key})
         """
         conf = self._build_test_config()
-        with self.assertRaises(RuntimeError):
+        with pytest.raises(RuntimeError):
             conf.plugin_get_value("anykey")
 
         conf.running_plugin = "testplugin"
 
         actual = conf.plugin_get_value("badkey")
-        self.assertEqual(actual, None)
+        assert actual == None
 
         actual = conf.plugin_get_value("testkey")
-        self.assertEqual(actual, "plugin-test-value")
+        assert actual == "plugin-test-value"
 
     def test_update(self):
         """
@@ -204,26 +215,26 @@ def test_update(self):
         with contextlib.redirect_stdout(f):
             result = vars(conf.update(ns, allowed_defaults))
 
-        self.assertTrue("--no-defaults" in f.getvalue())
-        self.assertEqual(result.get("newkey"), "newvalue")
-        self.assertEqual(result.get("testkey"), "testvalue")
-        self.assertTrue(isinstance(result.get("authorized_users"), list))
-        self.assertFalse(result.get("plugin-testplugin-testkey"))
+        assert "--no-defaults" in f.getvalue()
+        assert result.get("newkey") == "newvalue"
+        assert result.get("testkey") == "testvalue"
+        assert isinstance(result.get("authorized_users"), list)
+        assert result.get("plugin-testplugin-testkey") is None
 
         f = io.StringIO()
         sys.argv.append("--suppress-warnings")
         with contextlib.redirect_stdout(f):
             result = vars(conf.update(ns, None))
         sys.argv.remove("--suppress-warnings")
 
-        self.assertFalse("--no-defaults" in f.getvalue())
+        assert "--no-defaults" not in f.getvalue()
 
         # test that update default engine value correctly when creating database
         create_db_action = "mysql-create"
         f = io.StringIO()
         with contextlib.redirect_stdout(f):
             result = vars(conf.update(ns, allowed_defaults, create_db_action))
-        self.assertEqual(result.get("engine"), "mysql/new-test-engine")
+        assert result.get("engine") == "mysql/new-test-engine"
 
     def test_write_config(self):
         """
@@ -235,7 +246,7 @@ def test_write_config(self):
         m = mock_open()
         with patch("builtins.open", m):
             conf.write_config()
-        self.assertIn(call("type = newvalue\n"), m().write.call_args_list)
+        assert call("type = newvalue\n") in m().write.call_args_list
 
     def test_configure_no_default_terminal(self):
         """
@@ -290,16 +301,14 @@ def mock_input(prompt):
             )
             conf.configure()
 
-        self.assertEqual(conf.get_value("type"), "test-type")
-        self.assertEqual(conf.get_value("token"), "test-token")
-        self.assertEqual(conf.get_value("image"), "test-image")
-        self.assertEqual(conf.get_value("region"), "test-region")
-        self.assertEqual(conf.get_value("authorized_users"), "cli-dev")
+        assert conf.get_value("type") == "test-type"
+        assert conf.get_value("token") == "test-token"
+        assert conf.get_value("image") == "test-image"
+        assert conf.get_value("region") == "test-region"
+        assert conf.get_value("authorized_users") == "cli-dev"
         # make sure that we set the default engine value according to type of database
-        self.assertEqual(conf.get_value("mysql_engine"), "mysql/test-engine")
-        self.assertEqual(
-            conf.get_value("postgresql_engine"), "postgresql/test-engine"
-        )
+        assert conf.get_value("mysql_engine") == "mysql/test-engine"
+        assert conf.get_value("postgresql_engine") == "postgresql/test-engine"
 
     def test_configure_default_terminal(self):
         """
@@ -354,13 +363,11 @@ def mock_input(prompt):
             )
             conf.configure()
 
-        self.assertEqual(conf.get_value("type"), "test-type")
-        self.assertEqual(conf.get_value("image"), "test-image")
-        self.assertEqual(conf.get_value("region"), "test-region")
-        self.assertEqual(conf.get_value("authorized_users"), "cli-dev")
-        self.assertEqual(conf.config.get("DEFAULT", "default-user"), "DEFAULT")
+        assert conf.get_value("type") == "test-type"
+        assert conf.get_value("image") == "test-image"
+        assert conf.get_value("region") == "test-region"
+        assert conf.get_value("authorized_users") == "cli-dev"
+        assert conf.config.get("DEFAULT", "default-user") == "DEFAULT"
         # make sure that we set the default engine value according to type of database
-        self.assertEqual(conf.get_value("mysql_engine"), "mysql/test-engine")
-        self.assertEqual(
-            conf.get_value("postgresql_engine"), "postgresql/test-engine"
-        )
+        assert conf.get_value("mysql_engine") == "mysql/test-engine"
+        assert conf.get_value("postgresql_engine") == "postgresql/test-engine"