From 0e157950dce2e519681f13104f87c449ee3d28c4 Mon Sep 17 00:00:00 2001
From: Oliver <oliver.henry.walters@gmail.com>
Date: Fri, 15 Jul 2022 08:19:49 +1000
Subject: [PATCH] Update unit tests for API plugin mixin class (#3328)
* Update unit tests for API plugin mixin class
- API at previous target URL has changed
- Simplier to use the github API as a test case
* Revert test database name
* Override default URL behaviour for unit test
---
InvenTree/InvenTree/settings.py | 2 +-
InvenTree/plugin/base/integration/mixins.py | 5 +++
.../plugin/base/integration/test_mixins.py | 34 +++++++++++++------
3 files changed, 29 insertions(+), 12 deletions(-)
diff --git a/InvenTree/InvenTree/settings.py b/InvenTree/InvenTree/settings.py
index 6d62f1302d..e19896a7a6 100644
--- a/InvenTree/InvenTree/settings.py
+++ b/InvenTree/InvenTree/settings.py
@@ -551,7 +551,7 @@ if "mysql" in db_engine: # pragma: no cover
# https://docs.djangoproject.com/en/3.2/ref/databases/#mysql-isolation-level
if "isolation_level" not in db_options:
serializable = _is_true(
- os.getenv("INVENTREE_DB_ISOLATION_SERIALIZABLE", "true")
+ os.getenv("INVENTREE_DB_ISOLATION_SERIALIZABLE", "false")
)
db_options["isolation_level"] = (
"serializable" if serializable else "read committed"
diff --git a/InvenTree/plugin/base/integration/mixins.py b/InvenTree/plugin/base/integration/mixins.py
index b4565e0dbc..7a14a9a890 100644
--- a/InvenTree/plugin/base/integration/mixins.py
+++ b/InvenTree/plugin/base/integration/mixins.py
@@ -443,6 +443,10 @@ class APICallMixin:
if endpoint_is_url:
url = endpoint
else:
+
+ if endpoint.startswith('/'):
+ endpoint = endpoint[1:]
+
url = f'{self.api_url}/{endpoint}'
# build kwargs for call
@@ -450,6 +454,7 @@ class APICallMixin:
'url': url,
'headers': headers,
}
+
if data:
kwargs['data'] = json.dumps(data)
diff --git a/InvenTree/plugin/base/integration/test_mixins.py b/InvenTree/plugin/base/integration/test_mixins.py
index 40cb1591b8..13cfb47d79 100644
--- a/InvenTree/plugin/base/integration/test_mixins.py
+++ b/InvenTree/plugin/base/integration/test_mixins.py
@@ -173,6 +173,7 @@ class APICallMixinTest(BaseMixinDefinition, TestCase):
def setUp(self):
"""Setup for all tests."""
+
class MixinCls(APICallMixin, SettingsMixin, InvenTreePlugin):
NAME = "Sample API Caller"
@@ -184,23 +185,32 @@ class APICallMixinTest(BaseMixinDefinition, TestCase):
'API_URL': {
'name': 'External URL',
'description': 'Where is your API located?',
- 'default': 'reqres.in',
+ 'default': 'https://api.github.com',
},
}
+
API_URL_SETTING = 'API_URL'
API_TOKEN_SETTING = 'API_TOKEN'
+ @property
+ def api_url(self):
+ """Override API URL for this test"""
+ return "https://api.github.com"
+
def get_external_url(self, simple: bool = True):
"""Returns data from the sample endpoint."""
- return self.api_call('api/users/2', simple_response=simple)
+ return self.api_call('orgs/inventree', simple_response=simple)
+
self.mixin = MixinCls()
class WrongCLS(APICallMixin, InvenTreePlugin):
pass
+
self.mixin_wrong = WrongCLS()
class WrongCLS2(APICallMixin, InvenTreePlugin):
API_URL_SETTING = 'test'
+
self.mixin_wrong2 = WrongCLS2()
def test_base_setup(self):
@@ -208,7 +218,7 @@ class APICallMixinTest(BaseMixinDefinition, TestCase):
# check init
self.assertTrue(self.mixin.has_api_call)
# api_url
- self.assertEqual('https://reqres.in', self.mixin.api_url)
+ self.assertEqual('https://api.github.com', self.mixin.api_url)
# api_headers
headers = self.mixin.api_headers
@@ -232,7 +242,9 @@ class APICallMixinTest(BaseMixinDefinition, TestCase):
# api_call
result = self.mixin.get_external_url()
self.assertTrue(result)
- self.assertIn('data', result,)
+
+ for key in ['login', 'email', 'name', 'twitter_username']:
+ self.assertIn(key, result)
# api_call without json conversion
result = self.mixin.get_external_url(False)
@@ -240,22 +252,22 @@ class APICallMixinTest(BaseMixinDefinition, TestCase):
self.assertEqual(result.reason, 'OK')
# api_call with full url
- result = self.mixin.api_call('https://reqres.in/api/users/2', endpoint_is_url=True)
+ result = self.mixin.api_call('https://api.github.com/orgs/inventree', endpoint_is_url=True)
self.assertTrue(result)
# api_call with post and data
result = self.mixin.api_call(
- 'api/users/',
- data={"name": "morpheus", "job": "leader"},
- method='POST'
+ 'repos/inventree/InvenTree',
+ method='GET'
)
+
self.assertTrue(result)
- self.assertEqual(result['name'], 'morpheus')
+ self.assertEqual(result['name'], 'InvenTree')
+ self.assertEqual(result['html_url'], 'https://github.com/inventree/InvenTree')
# api_call with filter
- result = self.mixin.api_call('api/users', url_args={'page': '2'})
+ result = self.mixin.api_call('repos/inventree/InvenTree/stargazers', url_args={'page': '2'})
self.assertTrue(result)
- self.assertEqual(result['page'], 2)
def test_function_errors(self):
"""Test function errors."""