Merge branch 'main' into fix/timeout-usage-in-rest-client

Author: cgoetz-inovex

.github/workflows/ci.yaml

@@ -101,29 +101,22 @@ jobs:
         uses: ./.github/actions/build/python
       - name: Generate SDK
         uses: ./.github/actions/generate-sdk/python
-      - name: Install Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}          
+          python-version: ${{ matrix.python-version }}
+      - name: install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.10.4"
+          python-version: ${{ matrix.python-version }}
       - name: Install sdk
         working-directory: ./sdk-repo-updated
-        run: |
-          pip install poetry
-          poetry config virtualenvs.create false
-          python -m venv .venv          
-          . .venv/bin/activate
-          python -m pip install --upgrade pip
-          make install-dev
+        run: make install-dev
       - name: Lint
         working-directory: ./sdk-repo-updated
-        run: |
-          . .venv/bin/activate
-          make lint
+        run: make lint
       - name: Test
         working-directory: ./sdk-repo-updated
-        run: |
-          . .venv/bin/activate
-          make test
+        run: make test
 
   main-java:
     name: CI [Java]

.github/workflows/sdk-pr.yaml

@@ -65,17 +65,15 @@ jobs:
         uses: ./.github/actions/build/python
       - name: Generate SDK
         uses: ./.github/actions/generate-sdk/python
+      - name: install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.10.4"
       - name: Push SDK
         env:
           GH_REPO: "stackitcloud/stackit-sdk-python"
           GH_TOKEN: ${{ secrets.SDK_PR_TOKEN }}
         run: |
-          set -e
-          python -m venv .venv
-          . .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install poetry
-          poetry config virtualenvs.create false
           (cd ./sdk-repo-updated && make install-dev)
           scripts/sdk-create-pr.sh "generator-bot-${{ github.run_id }}" "Generated from GitHub run [${{ github.run_id }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})" "git@github.com:stackitcloud/stackit-sdk-python.git" "python"
 

languages/golang/.openapi-generator-ignore

@@ -1,15 +1,5 @@
+README.md
 git_push.sh
 .travis.yml
 .gitignore
-#utils.go
-README.md
-response.go
 api/openapi.yaml
-.openapi-generator/*
-.gitlab-ci.yml
-setup.cfg
-setup.py
-test-requirements.txt
-requirements.txt
-tox.ini
-*/.github/*

languages/golang/README.md

@@ -0,0 +1,27 @@
+# STACKIT Golang SDK Generator
+
+## Template adjustments
+
+The following templates were customized but don't need to be adjusted when updating the Go SDK generator to a new a newer upstream version:
+
+- `configuration.mustache`: This template was entirely overwritten so we can use our custom [configuration struct](https://github.com/stackitcloud/stackit-sdk-go/blob/c3b04bc3cb8bf93de351fd7b1b04ac11de78ff89/core/config/config.go#L78) from our Go SDK core module. By default the OpenAPI generator would generate a new configuration struct for each service API version.
+
+The following templates were customized and need to be checked for adjustments when updating the Go SDK generator to a newer upstream version:
+
+- `client.mustache`: 
+  - Removed the generation of the `GenericOpenAPIError` struct which would be generated for each service API version by default. Instead use the `GenericOpenAPIError` struct from the [Go SDK core module](https://github.com/stackitcloud/stackit-sdk-go/blob/c3b04bc3cb8bf93de351fd7b1b04ac11de78ff89/core/oapierror/oapierror.go#L15).
+    - Our custom `GenericOpenAPIError` struct from the core module has additional fields like the http status code, ... which the default one doesn't have.
+  - Customized the `NewAPIClient` func to use the configuration struct and the authentication from the core SDK module.
+- `api.mustache`
+  - Added customization to capture the HTTP request and response in the context (like it was done before the multi API version support was implemented in the Go SDK generator).
+  - Use the `GenericOpenAPIError` struct from the core module instead of the default one (see previous section of `client.mustache`).
+  - Don't return the `http.Response` param which the OpenAPI generator returns by default.
+    - It was done like that before the multi API version support was implemented in the Go SDK generator.
+    - Furthermore, it would when using the STACKIT Go SDK require a lot of boilerplate code after each SDK API call to do a nil check, close the http response body and handle the potential error.
+
+## Custom templates
+
+The custom templates don't need to be adjusted when updating the Go SDK generator to a new a newer upstream version.
+
+- `custom/api_mock.mustache`: This template was added to allow easy mocking of SDK API calls in unit test implementations.
+

languages/golang/blacklist.txt languages/golang/blocklist.txtlanguages/golang/blacklist.txt renamed to languages/golang/blocklist.txt

@@ -0,0 +1,14 @@
+git_push.sh
+.travis.yml
+.gitignore
+README.md
+response.go
+api/openapi.yaml
+.openapi-generator/*
+.gitlab-ci.yml
+setup.cfg
+setup.py
+test-requirements.txt
+requirements.txt
+tox.ini
+*/.github/*

languages/golang/compat-layer/.openapi-generator-ignore

@@ -0,0 +1,36 @@
+# Transitional file to enable compatibility layer generation for selected services. 
+# Note: It shouldn't be needed to add any services here!
+alb
+auditlog
+authorization
+cdn
+certificates
+dns
+edge
+git
+iaas
+intake
+kms
+loadbalancer
+logme
+logs
+mariadb
+modelserving
+mongodbflex
+objectstorage
+observability
+opensearch
+postgresflex
+rabbitmq
+redis
+resourcemanager
+runcommand
+scf
+secretsmanager
+serverbackup
+serverupdate
+serviceaccount
+serviceenablement
+sfs
+ske
+sqlserverflex

languages/golang/compat-layer/allow-list.txt

@@ -0,0 +1,8 @@
+useOneOfDiscriminatorLookup: true
+templateDir: languages/golang/compat-layer/templates
+files:
+  custom/model_test.mustache:
+    # TODO: this should be 'ModelTests' instead of 'Model'
+    # 'Model' was used because 'ModelTests' didn't stick to golangs file naming conventions
+    templateType: Model
+    destinationFilename: _test.go