Refactoring/588 update ptb and remove doc links tasks (#589)

ArBridgeman · web-flow · commit 00765c23f80f · 2025-07-02T09:39:36.000+02:00
* Update to exasol-toolbox 1.6.0

* Fix broken links

* Remove duplicated link code, as using from PTB in CI

* Update changelog &amp; dependencies
diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml
@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Build Artifacts
         run: poetry build
diff --git a/.github/workflows/check-release-tag.yml b/.github/workflows/check-release-tag.yml
@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Check Tag Version
         # make sure the pushed/created tag matched the project version
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -16,7 +16,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Check Version(s)
         run: poetry run -- nox -s version:check
@@ -32,12 +32,16 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Build Documentation
         run: |
           poetry run -- nox -s docs:build
 
+      - name: Link Check
+        run: |
+          poetry run -- nox -s links:check
+
   build-matrix:
     name: Generate Build Matrix
     uses: ./.github/workflows/matrix-python.yml
@@ -55,7 +59,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Run changelog update check
         run: poetry run -- nox -s changelog:updated
@@ -74,7 +78,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -105,7 +109,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -127,7 +131,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -151,7 +155,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Run format check
         run: poetry run -- nox -s project:format
@@ -173,7 +177,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
         with:
           python-version: ${{ matrix.python-version }}
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,14 +1,10 @@
 name: CI
 
 on:
-  push:
-    branches-ignore:
-      - "github-pages/*"
-      - "gh-pages/*"
-      - "main"
-      - "master"
+  pull_request:
+      types: [opened, synchronize, reopened]
   schedule:
-    # "At 00:00 on every 7th day-of-month from 1 through 31." (https://crontab.guru)
+    # At 00:00 on every 7th day-of-month from 1 through 31. (https://crontab.guru)
     - cron: "0 0 1/7 * *"
 
 jobs:
@@ -22,5 +18,6 @@ jobs:
   Metrics:
     needs: [ CI ]
     uses: ./.github/workflows/report.yml
+    secrets: inherit
     permissions:
       contents: read
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -17,7 +17,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Build Documentation
         run: |
diff --git a/.github/workflows/matrix-all.yml b/.github/workflows/matrix-all.yml
@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Generate matrix
         run: poetry run -- nox -s matrix:all
diff --git a/.github/workflows/matrix-exasol.yml b/.github/workflows/matrix-exasol.yml
@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Generate matrix
         run: poetry run -- nox -s matrix:exasol
diff --git a/.github/workflows/matrix-python.yml b/.github/workflows/matrix-python.yml
@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Generate matrix
         run: poetry run -- nox -s matrix:python
diff --git a/.github/workflows/pr-merge.yml b/.github/workflows/pr-merge.yml
@@ -28,5 +28,6 @@ jobs:
   metrics:
     needs: [ ci-job ]
     uses: ./.github/workflows/report.yml
+    secrets: inherit
     permissions:
       contents: read
diff --git a/.github/workflows/report.yml b/.github/workflows/report.yml
@@ -19,26 +19,24 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
 
       - name: Download Artifacts
         uses: actions/download-artifact@v4.2.1
         with:
           path: ./artifacts
 
       - name: Copy Artifacts into Root Folder
-        working-directory: ./artifacts
-        run: |
-          poetry run -- coverage combine --keep coverage-python3.9*/.coverage
-          # Errors during copying are ignored because they are checked in the next step
-          cp .coverage ../ || true
-          cp lint-python3.9/.lint.txt ../ || true
-          cp lint-python3.9/.lint.json ../ || true
-          cp security-python3.9/.security.json ../ || true
+        run: poetry run -- nox -s artifacts:copy -- artifacts
 
       - name: Validate Artifacts
         run: poetry run -- nox -s artifacts:validate
 
+      - name: Upload to sonar
+        env:
+          SONAR_TOKEN: "${{ secrets.SONAR_TOKEN }}"
+        run: poetry run -- nox -s sonar:check
+
       - name: Generate Report
         run: poetry run -- nox -s project:report -- --format json | tee metrics.json
 
diff --git a/.github/workflows/slow-checks.yml b/.github/workflows/slow-checks.yml
@@ -32,7 +32,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.3.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
         with:
           python-version: ${{ matrix.python-version }}
 
diff --git a/README.rst b/README.rst
@@ -2,16 +2,16 @@ SQLAlchemy Dialect for EXASOL DB
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-.. image:: https://github.com/exasol/sqlalchemy-exasol/actions/workflows/ci-cd.yml/badge.svg?branch=master&event=push
-    :target: https://github.com/exasol/sqlalchemy-exasol/actions/workflows/ci-cd.yml
+.. image:: https://github.com/exasol/sqlalchemy-exasol/actions/workflows/pr-merge.yml/badge.svg?branch=master&event=push
+    :target: https://github.com/exasol/sqlalchemy-exasol/actions/workflows/pr-merge.yml
      :alt: CI Status
 
 .. image:: https://img.shields.io/pypi/v/sqlalchemy_exasol
-     :target: https://pypi.org/project/sqlalchemy-exasol/
+     :target: https://pypi.org/project/sqlalchemy_exasol/
      :alt: PyPI Version
 
 .. image:: https://img.shields.io/pypi/pyversions/sqlalchemy-exasol
-    :target: https://pypi.org/project/sqlalchemy-exasol
+    :target: https://pypi.org/project/sqlalchemy_exasol
     :alt: PyPI - Python Version
 
 .. image:: https://img.shields.io/badge/exasol-7.1.9%20%7C%207.0.18-green
@@ -27,19 +27,19 @@ SQLAlchemy Dialect for EXASOL DB
     :alt: Formatter - Isort
 
 .. image:: https://img.shields.io/badge/pylint-5.9-yellow
-    :target: https://github.com/PyCQA/pylint
+    :target: https://github.com/pylint-dev/pylint
     :alt: Pylint
 
 .. image:: https://img.shields.io/pypi/l/sqlalchemy-exasol
-     :target: https://opensource.org/licenses/BSD-2-Clause
+     :target: https://opensource.org/license/BSD-2-Clause
      :alt: License
 
 .. image:: https://img.shields.io/github/last-commit/exasol/sqlalchemy-exasol
-     :target: https://pypi.org/project/sqlalchemy-exasol/
+     :target: https://pypi.org/project/sqlalchemy_exasol/
      :alt: Last Commit
 
 .. image:: https://img.shields.io/pypi/dm/sqlalchemy-exasol
-    :target: https://pypi.org/project/sqlalchemy-exasol
+    :target: https://pypi.org/project/sqlalchemy_exasol
     :alt: PyPI - Downloads
 
 
diff --git a/doc/changes/changes_2.2.0.md b/doc/changes/changes_2.2.0.md
@@ -6,6 +6,6 @@
 
 ## 🐞 Fixed
 
-- Fixed performance problems for large tables/databases. For more details see [PR](https://github.com/blue-yonder/sqlalchemy_exasol/pull/101)
+- Fixed performance problems for large tables/databases. For more details see [PR](https://github.com/exasol/sqlalchemy-exasol/pull/101)
 
 
diff --git a/doc/changes/changes_4.0.0.md b/doc/changes/changes_4.0.0.md
@@ -9,7 +9,7 @@
     This upgrade is not backwards compatible with SQLA < 1.4
 
     This version may impact the performance (see also [SQLAlchemy docs](https://docs.sqlalchemy.org/en/14/faq/performance.html#why-is-my-application-slow-after-upgrading-to-1-4-and-or-2-x)).
-    If you are not willing or able to pay those potential performance hits, you should wait until the [tracking-issue #190](https://github.com/exasol/sqlalchemy-exasol/issues/190>) is resolved.
+    If you are not willing or able to pay those potential performance hits, you should wait until the [tracking-issue #190](https://github.com/exasol/sqlalchemy-exasol/issues/190) is resolved.
 
 
 ## 🗑️ Removed
@@ -28,7 +28,7 @@
         Checked dependencies:
 
         * Nox (Code search)
-        * Pytest (Code search + [tracking-issue #10392](https://github.com/pytest-dev/pytest/issues/10392>))
+        * Pytest (Code search + [tracking-issue #10392](https://github.com/pytest-dev/pytest/issues/10392))
 
 ## 🔧 Changed
 
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -7,3 +7,4 @@
 - - Relocked dependencies to resolve CVE-2025-43859
 - #564: Replaced nox test:unit with that from exasol-toolbox
 - Reformatted files to meet project specifications
+- #588: Updated to exasol-toolbox 1.6.0 and relocked dependencies to resolve CVE-2025-50182, CVE-2025-50181, & CVE-2024-47081
diff --git a/doc/conf.py b/doc/conf.py
@@ -76,3 +76,15 @@
     "github_url": "https://github.com/exasol/sqlalchemy-exasol",
     "accent_color": "grass",
 }
+# -- Configure link checking behavior  ----------------------------------------
+linkcheck_rate_limit_timeout = 60
+linkcheck_timeout = 15
+linkcheck_delay = 30
+linkcheck_retries = 2
+linkcheck_anchors = False
+linkcheck_ignore: list[str] = []
+linkcheck_allowed_redirects = {
+    # All HTTP redirections from the source URI to
+    # the canonical URI will be treated as "working".
+    r"https://github\.com/.*": r"https://github\.com/login*"
+}
diff --git a/doc/developer_guide/developer_guide.rst b/doc/developer_guide/developer_guide.rst
@@ -217,7 +217,7 @@ For more general information on, why and for whom to create a changelog, have a
 look at keepachangelog_.
 
 .. _keepachangelog: https://keepachangelog.com/en/1.1.0/
-.. _action: https://github.com/exasol/sqlalchemy_exasol/actions
+.. _action: https://github.com/exasol/sqlalchemy-exasol/actions
 .. _python: https://www.python.org/
 .. _poetry: https://python-poetry.org/
 .. _git: https://git-scm.com/
diff --git a/doc/developer_guide/integration_tests.rst b/doc/developer_guide/integration_tests.rst
@@ -60,7 +60,7 @@ This workflow will be executed anytime there's a commit pushed to any branch tha
 
 To run it just commit and push to any non-master branch and watch the workflow run in:
 
-`<https://github.com/exasol/sqlalchemy_exasol/actions>`_
+`<https://github.com/exasol/sqlalchemy-exasol/actions>`_
 
 CI-CD
 -----
@@ -75,6 +75,6 @@ This workflow will be executed anytime there's a commit pushed to **master**, or
 
 To run it just commit and push to master (*Optional:* push a tag in case you want PyPI upload) and watch the workflow run in:
 
-`<https://github.com/exasol/sqlalchemy_exasol/actions>`_
+`<https://github.com/exasol/sqlalchemy-exasol/actions>`_
 
 The status of the CI-CD workflow will always be reflected in the badge called "build" in the README.rst and Home Page of this repository
diff --git a/doc/user_guide.rst b/doc/user_guide.rst
@@ -8,7 +8,7 @@ SQLAlchemy-Exasol is a dialect extension for SQLAlchemy, implementing support fo
 Getting Started
 ~~~~~~~~~~~~~~~
 
-#. Install the `SQLAlchemy-Exasol extension <https://pypi.org/project/sqlalchemy-exasol/>`_
+#. Install the `SQLAlchemy-Exasol extension <https://pypi.org/project/sqlalchemy_exasol/>`_
 
     .. code-block:: shell
 
diff --git a/noxconfig.py b/noxconfig.py
@@ -42,6 +42,7 @@ def post_integration_tests_hook(self, session, config, context):
 class Config:
     root: Path = Path(__file__).parent
     doc: Path = Path(__file__).parent / "doc"
+    source: Path = Path("sqlalchemy_exasol")
     version_file: Path = Path(__file__).parent / "sqlalchemy_exasol" / "version.py"
     path_filters: Iterable[str] = (
         "dist",
diff --git a/noxfile.py b/noxfile.py
@@ -28,14 +28,10 @@
 
 # imports all nox task provided by the toolbox
 from exasol.toolbox.nox.tasks import *  # type: ignore
-from scripts.links import check as _check
-from scripts.links import documentation as _documentation
-from scripts.links import urls as _urls
 
 # default actions to be run if nothing is explicitly specified with the -s option
 nox.options.sessions = ["project:fix"]
 
-
 from noxconfig import (
     PROJECT_CONFIG,
     Config,
@@ -274,29 +270,6 @@ def report_skipped(session: Session) -> None:
                 )
 
 
-@nox.session(name="docs:links", python=False)
-def list_links(session: Session) -> None:
-    """List all the links within the documentation."""
-    for path, url in _urls(_documentation(PROJECT_ROOT)):
-        session.log(f"Url: {url}, File: {path}")
-
-
-@nox.session(name="docs:links:check", python=False)
-def check_links(session: Session) -> None:
-    """Checks whether all links in the documentation are accessible."""
-    errors = []
-    for path, url in _urls(_documentation(PROJECT_ROOT)):
-        status, details = _check(url)
-        if status != 200:
-            errors.append((path, url, status, details))
-
-    if errors:
-        session.error(
-            "\n"
-            + "\n".join(f"Url: {e[1]}, File: {e[0]}, Error: {e[3]}" for e in errors)
-        )
-
-
 def _connector_matrix(config: Config):
     CONNECTORS = ["websocket"]
     attr = "connectors"
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/scripts/links.py b/scripts/links.py
diff --git a/scripts/version_check.py b/scripts/version_check.py
