Merge pull request #34 from melexis/error-handling

Support Python 3.13

Author: JasperCraeghs

.github/workflows/python-package.yml

@@ -9,11 +9,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -23,16 +23,16 @@ jobs:
     - name: Run test
       run: tox -e py
     - name: Upload coverage to Codecov
-      if: matrix.python-version == 3.9
-      uses: codecov/codecov-action@v3
+      if: matrix.python-version == 3.13
+      uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./coverage.xml
         fail_ci_if_error: true
         flags: unittests
         verbose: true
     - name: Static checks
-      if: matrix.python-version == 3.9
+      if: matrix.python-version == 3.13
       run: tox -e check
 
   deploy:
@@ -41,11 +41,11 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.7'
+        python-version: '3.13'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -55,5 +55,5 @@ jobs:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build --wheel
         twine upload dist/*

.gitignore

@@ -96,4 +96,4 @@ pip-selfcheck.json
 *.swp
 
 # Offline version file
-src/mlx/__version__.py
+src/mlx/jira_juggler/_version.py

MANIFEST.in

@@ -12,7 +12,7 @@ global-exclude *.py[cod] __pycache__ *.so *.dylib
 include NOTICE
 include .env.example
 
-exclude src/mlx/__version__.py
+exclude src/mlx/jira_juggler/_version.py
 
 # added by check_manifest.py
 include *.tjp

pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=77", "wheel", "setuptools_scm>=7.1.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src/"]
+include = ["mlx.jira_juggler"]
+
+[tool.setuptools_scm]
+write_to = "src/mlx/jira_juggler/_version.py"
+
+[project]
+name = "mlx.jira_juggler"
+description = "A Python script for extracting data from Jira, and converting to TaskJuggler (tj3) output"
+authors = [
+    {name = "Jasper Craeghs", email = "jce@melexis.com"}
+]
+readme = "README.rst"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dynamic = ["version"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: Unix",
+    "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+keywords = [
+    "Jira",
+    "taskjuggler",
+    "gantt",
+    "project planning",
+    "planning",
+    "software engineering",
+]
+dependencies = [
+    "jira>=3.8",
+    "python-dateutil>=2.8.0,<3.0",
+    "natsort>=8.3.1",
+    "python-decouple",
+]
+
+[project.urls]
+Homepage = "https://github.com/melexis/jira-juggler"
+Repository = "https://github.com/melexis/jira-juggler"
+
+[project.scripts]
+jira-juggler = "mlx.jira_juggler.jira_juggler:entrypoint"
+
+[tool.setuptools.package-data]
+"*" = ["*"]

setup.py

@@ -594,16 +594,35 @@ def load_issues_from_jira(self, depend_on_preceding=False, sprint_field_name='',
             try:
                 issues = jirahandle.search_issues(self.query, maxResults=JIRA_PAGE_SIZE, startAt=self.issue_count,
                                                   expand='changelog')
-            except JIRAError:
-                logging.error('Invalid Jira query "%s"', self.query)
+            except JIRAError as err:
+                logging.error(f'Failed to query JIRA: {err}')
+                if err.status_code == 401:
+                    logging.error('Please check your JIRA credentials in the .env file or environment variables.')
+                elif err.status_code == 403:
+                    logging.error('You do not have permission to access this JIRA project or query.')
+                elif err.status_code == 404:
+                    logging.error('The JIRA endpoint is not found. Please check the endpoint URL.')
+                elif err.status_code == 400:
+                    # Parse and display the specific JQL errors more clearly
+                    try:
+                        error_data = err.response.json()
+                        if 'errorMessages' in error_data:
+                            for error_msg in error_data['errorMessages']:
+                                logging.error(f'JIRA query error: {error_msg}')
+                    except Exception:
+                        pass  # Fall back to generic error if JSON parsing fails
+
+                    logging.error('Invalid JQL query syntax. Please check your query.')
+                else:
+                    logging.error(f'An unexpected error occurred: {err}')
                 return None
 
             if len(issues) <= 0:
                 busy = False
 
             self.issue_count += len(issues)
             for issue in issues:
-                logging.debug('Retrieved %s: %s', issue.key, issue.fields.summary)
+                logging.debug(f'Retrieved {issue.key}: {issue.fields.summary}')
                 tasks.append(JugglerTask(issue))
 
         self.validate_tasks(tasks)

src/mlx/__init__.py

@@ -23,7 +23,7 @@
         pip.main(['install', 'mock'])
         from mock import MagicMock, patch, call
 
-import mlx.jira_juggler as dut
+import mlx.jira_juggler.jira_juggler as dut
 
 try:
     from jira import JIRA
@@ -167,7 +167,7 @@ class TestJiraJuggler(unittest.TestCase):
     def SetUp(self):
         '''SetUp is run before each test to provide clean working environment'''
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_empty_query_result(self, jira_mock):
         '''Test for Jira not returning any task on the given query'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -179,7 +179,7 @@ def test_empty_query_result(self, jira_mock):
         juggler.juggle()
         jira_mock_object.search_issues.assert_called_once_with(self.QUERY, maxResults=dut.JIRA_PAGE_SIZE, startAt=0, expand='changelog')
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_single_task_happy(self, jira_mock):
         '''Test for simple happy flow: single task is returned by Jira Server'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -203,7 +203,7 @@ def test_single_task_happy(self, jira_mock):
         self.assertEqual(self.ESTIMATE1 / self.SECS_PER_DAY, issues[0].properties['effort'].value)
         self.assertEqual(self.DEPENDS1, issues[0].properties['depends'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_single_task_email_happy(self, jira_mock):
         '''Test for simple happy flow: single task is returned by Jira Cloud'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -228,7 +228,7 @@ def test_single_task_email_happy(self, jira_mock):
         self.assertEqual(self.ESTIMATE1 / self.SECS_PER_DAY, issues[0].properties['effort'].value)
         self.assertEqual(self.DEPENDS1, issues[0].properties['depends'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_single_task_email_hidden(self, jira_mock):
         '''Test for error logging when user has restricted email visibility in Jira Cloud'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -254,7 +254,7 @@ def test_single_task_email_hidden(self, jira_mock):
         self.assertEqual(self.ESTIMATE1 / self.SECS_PER_DAY, issues[0].properties['effort'].value)
         self.assertEqual(self.DEPENDS1, issues[0].properties['depends'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_single_task_minimal(self, jira_mock):
         '''Test for minimal happy flow: single task with minimal content is returned by Jira
 
@@ -276,7 +276,7 @@ def test_single_task_minimal(self, jira_mock):
         self.assertEqual(self.SUMMARY1, issues[0].summary)
         self.assertEqual(dut.JugglerTaskEffort.DEFAULT_VALUE, issues[0].properties['effort'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_estimate_too_low(self, jira_mock):
         '''Test for correcting an estimate which is too low'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -296,7 +296,7 @@ def test_estimate_too_low(self, jira_mock):
         self.assertEqual(self.SUMMARY1, issues[0].summary)
         self.assertEqual(dut.JugglerTaskEffort.MINIMAL_VALUE, issues[0].properties['effort'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_broken_depends(self, jira_mock):
         '''Test for removing a broken link to a dependant task'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -317,7 +317,7 @@ def test_broken_depends(self, jira_mock):
         self.assertEqual(self.SUMMARY1, issues[0].summary)
         self.assertEqual([], issues[0].properties['depends'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_task_depends(self, jira_mock):
         '''Test for dual happy flow: one task depends on the other'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -352,7 +352,7 @@ def test_task_depends(self, jira_mock):
         self.assertEqual(self.ESTIMATE2 / self.SECS_PER_DAY, issues[1].properties['effort'].value)
         self.assertEqual(self.DEPENDS2, issues[1].properties['depends'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_task_double_depends(self, jira_mock):
         '''Test for extended happy flow: one task depends on two others'''
         jira_mock_object = MagicMock(spec=JIRA)
@@ -397,7 +397,7 @@ def test_task_double_depends(self, jira_mock):
         self.assertEqual(self.ESTIMATE3 / self.SECS_PER_DAY, issues[2].properties['effort'].value)
         self.assertEqual(self.DEPENDS3, issues[2].properties['depends'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_resolved_task(self, jira_mock):
         '''Test that the last assignee in the Analyzed state is used and the Time Spent is used as effort
         Test that the most recent transition to the Approved/Resolved state is used to mark the end'''
@@ -465,7 +465,7 @@ def test_resolved_task(self, jira_mock):
         self.assertEqual(self.ESTIMATE2 / self.SECS_PER_DAY, issues[0].properties['effort'].value)
         self.assertEqual('2022-05-25 14:07:11.974000+02:00', str(issues[0].resolved_at_date))
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_closed_task(self, jira_mock):
         '''
         Test that a change of assignee after Resolved status has no effect and that the original time estimate is
@@ -506,7 +506,7 @@ def test_closed_task(self, jira_mock):
         self.assertEqual(self.ASSIGNEE1, issues[0].properties['allocate'].value)
         self.assertEqual(self.ESTIMATE1 / self.SECS_PER_DAY, issues[0].properties['effort'].value)
 
-    @patch('mlx.jira_juggler.JIRA', autospec=True)
+    @patch('mlx.jira_juggler.jira_juggler.JIRA', autospec=True)
     def test_depend_on_preceding(self, jira_mock):
         '''Test --depends-on-preceding, --weeklymax and --current-date options'''
         jira_mock_object = MagicMock(spec=JIRA)

src/mlx/jira_juggler/__init__.py

@@ -1,26 +1,26 @@
 [tox]
 envlist =
-    py37, py38, py39, py310, py3.11
+    py39, py310, py311, py312, py313
     clean,
     check,
 
 [gh-actions]
 python =
-    3.7: py37
-    3.8: py38
     3.9: py39
     3.10: py310
     3.11: py311
+    3.12: py312
+    3.13: py313
 
 [testenv]
 basepython =
     py: python3
     pypy: {env:TOXPYTHON:pypy}
-    py37: {env:TOXPYTHON:python3.7}
-    py38: {env:TOXPYTHON:python3.8}
     py39: {env:TOXPYTHON:python3.9}
     py310: {env:TOXPYTHON:python3.10}
     py311: {env:TOXPYTHON:python3.11}
+    py312: {env:TOXPYTHON:python3.12}
+    py313: {env:TOXPYTHON:python3.13}
     {clean,check,report,coveralls}: python3
 setenv =
     PYTHONPATH={toxinidir}/tests
@@ -39,16 +39,14 @@ commands =
 
 [testenv:check]
 deps =
-    docutils
     check-manifest
     flake8
-    readme-renderer
     twine
 commands =
-    python setup.py sdist
+    python -m build --wheel
     twine check dist/*
     check-manifest {toxinidir} -u
-    flake8 src tests setup.py
+    flake8 src tests
     jira-juggler -h
 
 [testenv:coveralls]