120 update openapi python client, fix vulnerabilities, update PTB to version 5 by ckunki · Pull Request #139 · exasol/saas-api-python

ckunki · 2026-02-16T07:30:35Z

This PR closes the following issues

Fix vulerabilities by updating dependencies #140
- This required updating dependency openapi-python-client
Update /openapi-python-client to version 0.26 or higher #120
- This required re-generating the SaaS API Python Client Code
- Also required adapting file api_access.py to process ApiErrors
SAPIPY: Update PTB to version 5 and regenerate workflows #141
- This required regenerating the GitHub workflows and fixing a number of lint errors
- Also, file noxconfig.py needed to be updated

Closes #120
Closes #141
Closes #140

ckunki · 2026-02-16T08:46:03Z

.github/workflows/slow-checks.yml

+        env:
+          SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
+          SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
+          SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
+          PROJECT_SHORT_TAG: SAPIPY


Manually added

ckunki · 2026-02-16T08:56:40Z

.github/workflows/build-and-publish.yml

@@ -4,21 +4,24 @@ on:
  workflow_call:


The workflows are mainly generated by PTB, but updated in a few places, which are commented.

Manual updated were required mainly for

Add secrets for accessing SaaS instances

Re- integrate the slow tests, which were marked with pytest.mark.slow before

ckunki · 2026-02-16T09:00:18Z

.github/workflows/slow-checks.yml

+        env:
+          SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
+          SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
+          SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
+          PROJECT_SHORT_TAG: SAPIPY


Manually added

ckunki · 2026-02-16T09:03:53Z

exasol/saas/client/api_access.py

@@ -1,16 +1,13 @@
 from __future__ import annotations



Main changes in this file are for handling results of type ApiError, which are new in version 0.26
of openapi-python-client.

Our updated implementation now raises an exception of type OpenApiError.

ckunki · 2026-02-16T09:04:58Z

exasol/saas/client/api_access.py

    wait_fixed,
 )

+import exasol.saas.client.openapi.models as openapi_models


The linter coming with PTB version 5 does no longer accept

from exasol.saas.client import openapi openapi.models.CreateDatabaseInitialCluster(...)

I think, we saw something similar in another project; the linter requires explicit exports if you want to import things. The explicit export can be happen by definition or by __all__

tkilias · 2026-02-17T14:28:55Z

exasol/saas/client/api_access.py

+        try:
+            return still_exists()
+        except (TryAgain, RetryError) as ex:
+            raise DatabaseDeleteTimeout from ex


I guess the main reason for this change is that you can chain the original exception

Yes, correct. Actually, I am not 100% happy with the overall result.

I wanted to distinguish the following scenarios

The operation terminated successfully

An unexpected error happend: Should be detected and signaled ASAP without retry

If specific conditions are met: retry!

In rare use cases: ignore potential errors, in particular when deleting a database instance

Additionally I wanted to wrap unexpected errors and exceptions as well as too
many retries in an exception of a common type.

All this felt hard to me and often interfered with

tenacity API

the partially unknown behavior of the SaaS API

the wrapping code generated by open-api-client

I often encountered the question

Can a particular operation raise an exception?

In general probably: yes

Will it return a HTTP response?

How to map the response attributes to the scenarios described above, then?

Is the result of an API call of type ApiError?

Needs to be mapped to the scenarios described above, too.

test/unit/test_api_access.py

tkilias · 2026-02-17T15:06:14Z

test/integration/test_connection.py

hm, the file name is a bit weird. I know it is possible with pytest, but all other places use test_*

Yes, pytest supports prefix test_ as well as suffix _test.py.
Bucketfs-python is inconsistent, as well, for example.
I don't have a clear opinion here.

If working on an implementation, then it makes sense to separate production code from tests using the prefix.

If opening a specific test, then the common prefix test_ feels redundant, as the test files are in directory test/ anyway.

In notebook-connector, I tried prefixes itest_ and utest_ which I found helpful.

test/unit/slc/utest_slc.py

test/integration/gpu/itest_slct_manager_with_gpu.py

I renamed the files in SAPIPY now.

tkilias · 2026-02-17T15:06:35Z

test/integration/test_databases.py

hm, the file name is a bit weird. I know it is possible with pytest, but all other places use test_*

I renamed the files in SAPIPY now.

sonarqubecloud · 2026-02-18T14:23:53Z

Quality Gate failed

Failed conditions
77.5% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

tkilias · 2026-02-19T11:01:36Z

exasol/saas/client/api_access.py

-        if still_exists():
-            raise DatabaseDeleteTimeout
+        try:
+            return still_exists()


Suggested change

return still_exists()

still_exists()

ckunki added 4 commits February 15, 2026 12:56

updated dependencies, adapted to PTB version 5

3561b84

Updated changelog

74a9a45

Re-generated workflows and fixed typing errors

0302f93

updated changelog

d00b507

ckunki temporarily deployed to manual-approval February 16, 2026 07:30 — with GitHub Actions Inactive

Moved file version.py

7a9560f

ckunki temporarily deployed to manual-approval February 16, 2026 07:32 — with GitHub Actions Inactive

re-generated API using updated openapi-python-client

cb72387

ckunki requested a deployment to manual-approval February 16, 2026 07:36 — with GitHub Actions Waiting

Wrapped calls to inner API to raise OpenApiError

fa69368

ckunki requested a deployment to manual-approval February 16, 2026 07:51 — with GitHub Actions Waiting

reformatted generated code

ceea86c

ckunki temporarily deployed to manual-approval February 16, 2026 07:55 — with GitHub Actions Inactive

Added missing import

06cfb73

ckunki temporarily deployed to manual-approval February 16, 2026 07:59 — with GitHub Actions Inactive

ckunki commented Feb 16, 2026

View reviewed changes

updated changelog

26e881d

ckunki changed the title ~~120 update openapi python client~~ 120 update openapi python client, fix vulnerabilities, update PTB to version 5 Feb 16, 2026

ckunki commented Feb 16, 2026

View reviewed changes

increased timeout in tests

3b29d66

ckunki temporarily deployed to manual-approval February 16, 2026 09:12 — with GitHub Actions Inactive

poetry lock

fbd8087

ckunki temporarily deployed to manual-approval February 16, 2026 09:17 — with GitHub Actions Inactive

Modified API

4b7f579

ckunki temporarily deployed to manual-approval February 16, 2026 10:41 — with GitHub Actions Inactive

Added instrumentation for failing test

6ec206d

ckunki temporarily deployed to manual-approval February 16, 2026 11:15 — with GitHub Actions Inactive

Cleaned up log messages and unit test

1eaa7ff

ckunki temporarily deployed to manual-approval February 16, 2026 16:42 — with GitHub Actions Inactive

ckunki added 2 commits February 17, 2026 09:03

nox -s format:fix

514a882

Refactored error messages and unit tests

9a391f6

ckunki requested a deployment to manual-approval February 17, 2026 08:18 — with GitHub Actions Waiting

nox -s format:fix

a663b62

ckunki requested a deployment to manual-approval February 17, 2026 08:18 — with GitHub Actions Waiting

Removed output

8ff9f55

ckunki temporarily deployed to manual-approval February 17, 2026 08:20 — with GitHub Actions Inactive

tkilias reviewed Feb 17, 2026

View reviewed changes

test/unit/test_api_access.py Outdated Show resolved Hide resolved

tkilias reviewed Feb 17, 2026

View reviewed changes

Renamed integration test files

66c4ed3

ckunki requested a deployment to manual-approval February 18, 2026 07:33 — with GitHub Actions Waiting

replaced json parsing by access to response.parsed

8881bff

ckunki requested a deployment to manual-approval February 18, 2026 08:13 — with GitHub Actions Waiting

nox -s format:fix

ae8b220

ckunki requested a deployment to manual-approval February 18, 2026 08:16 — with GitHub Actions Waiting

fixed type errors

2b72eb9

ckunki requested a deployment to manual-approval February 18, 2026 08:19 — with GitHub Actions Waiting

Fixed unit tests

13e3e43

ckunki requested a deployment to manual-approval February 18, 2026 10:20 — with GitHub Actions Waiting

nox -s format:fix

ec64947

ckunki temporarily deployed to manual-approval February 18, 2026 10:23 — with GitHub Actions Inactive

tkilias reviewed Feb 19, 2026

View reviewed changes

ckunki added 2 commits February 19, 2026 14:36

Replace ApiRunner by separate mocks

5406aae

Used common function for reporting ApiErrors

45f536d

ckunki deployed to manual-approval February 19, 2026 14:09 — with GitHub Actions Active

Conversation

ckunki commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ckunki Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ckunki Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tkilias Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ckunki Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 18, 2026

Quality Gate failed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

ckunki commented Feb 16, 2026 •

edited

Loading

ckunki Feb 16, 2026 •

edited

Loading

ckunki Feb 16, 2026 •

edited

Loading

tkilias Feb 17, 2026 •

edited

Loading

ckunki Feb 18, 2026 •

edited

Loading