Merge pull request #1566 from dbungert/lp-2007554-async-parameterized

tests: patch parameterized to handle async

subiquity/common/filesystem/tests/test_gaps.py

@@ -17,7 +17,7 @@ from functools import partial
 import unittest
 from unittest import mock
 
-from parameterized import parameterized
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquity.models.filesystem import (
     Disk,

subiquity/common/filesystem/tests/test_manipulator.py

@@ -19,7 +19,7 @@ from unittest import mock
 
 import attr
 
-from parameterized import parameterized
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquity.common.filesystem.actions import (
     DeviceAction,

subiquity/models/tests/test_filesystem.py

@@ -17,7 +17,8 @@ import unittest
 from unittest import mock
 
 import attr
-from parameterized import parameterized
+
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquity.models.filesystem import (
     ActionRenderMode,

subiquity/models/tests/test_keyboard.py

@@ -13,7 +13,7 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from parameterized import parameterized
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquitycore.tests import SubiTestCase
 

subiquity/server/controllers/tests/test_filesystem.py

@@ -17,7 +17,7 @@ import copy
 from unittest import mock, TestCase, IsolatedAsyncioTestCase
 import uuid
 
-from parameterized import parameterized
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquitycore.snapd import AsyncSnapd, get_fake_connection
 from subiquitycore.tests.mocks import make_app

subiquity/server/controllers/tests/test_kernel.py

@@ -16,7 +16,7 @@
 import os
 import os.path
 
-from parameterized import parameterized
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquity.models.kernel import KernelModel
 from subiquity.server.controllers.kernel import KernelController

subiquity/server/controllers/tests/test_keyboard.py

@@ -17,10 +17,10 @@ import os
 import unittest
 
 from unittest.mock import Mock, patch
-from parameterized import parameterized
 
 from subiquitycore.tests import SubiTestCase
 from subiquitycore.tests.mocks import make_app
+from subiquitycore.tests.parameterized import parameterized
 
 from subiquity.models.keyboard import (
     KeyboardModel,

subiquitycore/tests/parameterized.py

@@ -0,0 +1,75 @@
+# Portions Copyright 2023 Canonical, Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# This is adapted from
+# https://github.com/wolever/parameterized/commit/0403e891d9a6ec5fa77c0e200f31e1298fcacbc9 # noqa
+#
+# Copyright 2010 David Wolever <david@wolever.net>. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#    1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#    2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY DAVID WOLEVER ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+# EVENT SHALL DAVID WOLEVER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# The views and conclusions contained in the software and documentation are
+# those of the authors and should not be interpreted as representing official
+# policies, either expressed or implied, of David Wolever.
+
+import inspect
+from functools import wraps
+
+from parameterized import parameterized as _parameterized
+
+
+# parameterized.expand uses param_as_standalone_func to create the expanded
+# test functions.  When the function being expanded is a coroutine function,
+# the expanded one should be as well.  LP: #2007554
+class parameterized(_parameterized):
+    @classmethod
+    def param_as_standalone_func(cls, p, func, name):
+        if inspect.iscoroutinefunction(func):
+            @wraps(func)
+            async def standalone_func(*a):
+                return await func(*(a + p.args), **p.kwargs)
+        else:
+            @wraps(func)
+            def standalone_func(*a):
+                return func(*(a + p.args), **p.kwargs)
+
+        standalone_func.__name__ = name
+
+        standalone_func.place_as = func
+
+        try:
+            del standalone_func.__wrapped__
+        except AttributeError:
+            pass
+        return standalone_func

subiquitycore/tests/test_async_helpers.py

@@ -17,13 +17,13 @@ import asyncio
 import unittest
 from unittest.mock import AsyncMock
 
-from parameterized import parameterized
-
 from subiquitycore.async_helpers import (
     SingleInstanceTask,
     TaskAlreadyRunningError,
 )
 
+from subiquitycore.tests.parameterized import parameterized
+
 
 class TestSingleInstanceTask(unittest.IsolatedAsyncioTestCase):
     @parameterized.expand([(True, 2), (False, 1)])