update error handling in JiraTestManager, remove default flaky

Author: adehad

tests/conftest.py

@@ -11,7 +11,6 @@
 from typing import Any, Dict
 
 import pytest
-from flaky import flaky
 
 from jira import JIRA
 
@@ -26,7 +25,6 @@
 broken_test = pytest.mark.xfail
 
 
-@flaky # all have default flaki-ness
 class JiraTestCase(unittest.TestCase):
  """Test case for all Jira tests.
 
@@ -53,7 +51,17 @@ def setUp(self) -> None:
  This is called before each test. If you want to add more for your tests,
  Run `JiraTestCase.setUp(self) in your custom setUp() to obtain these.
  """
- self.test_manager = JiraTestManager()
+
+ initialized = False
+ try:
+ self.test_manager = JiraTestManager()
+ initialized = self.test_manager.initialized
+ except Exception as e:
+ # pytest with flaky swallows any exceptions re-raised in a try, except
+ # so we log any exceptions for aiding debugging
+ LOGGER.exception(e)
+ self.assertTrue(initialized, "Test Manager setUp failed")
+
  self.jira = self.test_manager.jira_admin
  self.jira_normal = self.test_manager.jira_normal
  self.user_admin = self.test_manager.user_admin
@@ -105,6 +113,7 @@ class JiraTestManager(object):
  CI_JIRA_ADMIN (str): Admin user account name.
  CI_JIRA_USER (str): Limited user account name.
  max_retries (int): number of retries to perform for recoverable HTTP errors.
+ initialized (bool): if init was successful.
  """
 
  __shared_state: Dict[Any, Any] = {}
@@ -157,6 +166,7 @@ def set_jira_cloud_details(self):
  self.CI_JIRA_ADMIN_PASSWORD = os.environ["CI_JIRA_CLOUD_ADMIN_TOKEN"]
  self.CI_JIRA_USER = os.environ["CI_JIRA_CLOUD_USER"]
  self.CI_JIRA_USER_PASSWORD = os.environ["CI_JIRA_CLOUD_USER_TOKEN"]
+ self.CI_JIRA_ISSUE = os.environ.get("CI_JIRA_ISSUE", "Bug")
 
  def set_jira_server_details(self):
  self.CI_JIRA_URL = os.environ["CI_JIRA_URL"]
@@ -186,7 +196,15 @@ def set_basic_auth_logins(self, **jira_class_kwargs):
  self.jira_sysadmin = JIRA(self.CI_JIRA_URL, **jira_class_kwargs)
  self.jira_normal = JIRA(self.CI_JIRA_URL, **jira_class_kwargs)
 
- def __remove_project(self, project_key):
+ def _project_exists(self, project_key: str) -> bool:
+ try:
+ self.jira_admin.project(project_key)
+ except Exception as e: # If the project does not exist a warning is thrown
+ if "No project could be found" in str(e):
+ return False
+ return True
+
+ def _remove_project(self, project_key):
  """Ensure if the project exists we delete it first"""
 
  wait_between_checks_secs = 2
@@ -198,7 +216,8 @@ def __remove_project(self, project_key):
  try:
  self.jira_admin.project(project_key)
  except Exception as e: # If the project does not exist a warning is thrown
- LOGGER.warning(e)
+ if "No project could be found" not in str(e):
+ raise e
  else:
  # if no error is thrown that means the project exists, so we try to delete it
  try:
@@ -208,28 +227,34 @@ def __remove_project(self, project_key):
 
  # wait for the project to be deleted
  for _ in range(1, wait_attempts):
- try:
- self.jira_admin.project(project_key)
- except Exception:
+ if not self._project_exists(project_key):
  # If the project does not exist a warning is thrown
  # so once this is raised we know it is deleted successfully
  break
- print(f"Warning: Project '{project_key}' not deleted yet....")
  sleep(wait_between_checks_secs)
 
- def __create_project(self, project_key, project_name) -> int:
- """Create a project and return the id"""
+ if self._project_exists(project_key):
+ raise TimeoutError(
+ " Project '{project_key}' not deleted after {time_to_wait_for_delete_secs} seconds"
+ )
 
- self.__remove_project(project_key)
+ def _create_project(
+ self, project_key: str, project_name: str, allow_exist: bool = False
+ ) -> int:
+ """Create a project and return the id"""
 
- create_attempts = 6
- for _ in range(create_attempts):
- try:
- if self.jira_admin.create_project(project_key, project_name):
- break
- except Exception as e:
- if "A project with that name already exists" not in str(e):
- raise e
+ if allow_exist and self._project_exists(project_key):
+ pass
+ else:
+ self._remove_project(project_key)
+ create_attempts = 6
+ for _ in range(create_attempts):
+ try:
+ if self.jira_admin.create_project(project_key, project_name):
+ break
+ except Exception as e:
+ if "A project with that name already exists" not in str(e):
+ raise e
  return self.jira_admin.project(project_key).id
 
  def create_some_data(self):
@@ -266,8 +291,10 @@ def create_some_data(self):
  self.project_sd,
  )
 
- self.project_a_id = self.__create_project(self.project_a, self.project_a_name)
- self.project_b_id = self.__create_project(self.project_b, self.project_b_name)
+ self.project_a_id = self._create_project(self.project_a, self.project_a_name)
+ self.project_b_id = self._create_project(
+ self.project_b, self.project_b_name, allow_exist=True
+ )
 
  sleep(1) # keep it here as often Jira will report the
  # project as missing even after is created