Merge branch 'main' into k8s_fix_import

Author: Mia-Cross

.github/workflows/ansible-test-integration.yml

@@ -24,40 +24,40 @@ jobs:
           - stable-2.18
           - stable-2.19
     env:
-     ansible-collections-path: "./ansible_collections/scaleway/scaleway"
+      ansible-collections-path: "./ansible_collections/scaleway/scaleway"
 
     steps:
-        - name: Create directory
-          run: |
-            mkdir -p ${{ env.ansible-collections-path }}
-
-        - name: Checkout the repo
-          uses: actions/checkout@v4
-          with:
-            path: ${{ env.ansible-collections-path }}
-
-        - name: Setup Python and install ansible
-          uses: actions/setup-python@v5
-          with:
-            python-version: 3.11
-
-        - name: Install ansible
-          run: |
-            python -m pip install \
-              https://github.com/ansible/ansible/archive/${{ matrix.ansible-version }}.tar.gz \
-              --disable-pip-version-check
-
-        - name: Create scw config
-          run: |
-            mkdir -p $HOME/.config/scw
-            cat << EOF > $HOME/.config/scw/config.yaml
-            access_key: ${{ secrets.SCW_ACCESS_KEY }}
-            secret_key: ${{ secrets.SCW_SECRET_KEY }}
-            default_region: ${{ secrets.SCW_DEFAULT_REGION }}
-            default_project_id: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
-            EOF
-
-        - name: Run integration tests with ansible ${{ matrix.ansible-version }}
-          working-directory: ${{ env.ansible-collections-path }}
-          run: |
-            ansible-test integration -v --requirements ${{ matrix.module }}
+      - name: Create directory
+        run: |
+          mkdir -p ${{ env.ansible-collections-path }}
+
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+        with:
+          path: ${{ env.ansible-collections-path }}
+
+      - name: Setup Python and install ansible
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install ansible
+        run: |
+          python -m pip install \
+            https://github.com/ansible/ansible/archive/${{ matrix.ansible-version }}.tar.gz \
+            --disable-pip-version-check
+
+      - name: Create scw config
+        run: |
+          mkdir -p $HOME/.config/scw
+          cat << EOF > $HOME/.config/scw/config.yaml
+          access_key: ${{ secrets.SCW_ACCESS_KEY }}
+          secret_key: ${{ secrets.SCW_SECRET_KEY }}
+          default_region: ${{ secrets.SCW_DEFAULT_REGION }}
+          default_project_id: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+          EOF
+
+      - name: Run integration tests with ansible ${{ matrix.ansible-version }}
+        working-directory: ${{ env.ansible-collections-path }}
+        run: |
+          ansible-test integration -v --requirements ${{ matrix.module }}

.github/workflows/ansible-test-units.yml

@@ -22,7 +22,7 @@ jobs:
           - stable-2.17
           - stable-2.18
     env:
-     ansible-collections-path: "./ansible_collections/scaleway/scaleway"
+      ansible-collections-path: "./ansible_collections/scaleway/scaleway"
 
     runs-on: ubuntu-latest
     steps:
@@ -49,4 +49,4 @@ jobs:
       - name: Run unit tests with ansible ${{ matrix.ansible-version }}
         working-directory: ${{ env.ansible-collections-path }}
         run: |
-          ansible-test units -v --requirements
+          ansible-test units -v --requirements

.github/workflows/format.yml

@@ -0,0 +1,17 @@
+name: Format
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+
+jobs:
+  ruff:
+    name: Format
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v2
+        with:
+          args: "format --check"

.github/workflows/integration-nightly.yml

@@ -7,4 +7,4 @@ on:
 jobs:
   integration:
     uses: ./.github/workflows/ansible-test-integration.yml
-    secrets: inherit
+    secrets: inherit

.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+name: Check linters
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+
+jobs:
+  ruff:
+    name: Ruff
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v2

.github/workflows/typing.yml

@@ -0,0 +1,44 @@
+name: Check type hinting
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+
+jobs:
+  ty:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "poetry"
+      - name: Install dependencies and library
+        run: poetry install
+      - name: Check typing
+        run: poetry run ty check
+
+  pyrefly:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "poetry"
+      - name: Install dependencies and library
+        run: poetry install
+      - name: Check typing with pyrefly
+        run: poetry run pyrefly check

.gitignore

@@ -133,3 +133,5 @@ dmypy.json
 
 # Archive files
 *.tar.gz
+
+tests/.../inventory

CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# Contributing to Scaleway Ansible Collection
+
+Thank you for contributing to the Scaleway Ansible Collection! This guide will help you set up your development environment and run tests properly.
+
+## Repository Structure
+
+The repository must be placed in the correct path for Ansible to recognize it:
+```
+ansible_collections/scaleway/scaleway/
+```
+
+## Environment Setup
+
+### Virtual Environment
+Always use a virtual environment when working on this project:
+```bash
+python -m venv .venv
+source .venv/bin/activate  # On macOS/Linux
+```
+
+### Dependencies
+Install the required dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+## Testing
+
+### Integration Tests
+Run integration tests with:
+```bash
+ansible-test integration scaleway_secret --requirements
+```
+
+**Note**: `ansible-test` does not read environment variables. For local testing with specific profiles, use `ansible-playbook` directly:
+```bash
+SCW_PROFILE=owner SCW_DEFAULT_REGION=fr-par SCW_CONFIG_PATH="/path/to/config.yml" ansible-playbook playbook.yaml
+```
+
+### Unit Tests
+Run unit tests with:
+```bash
+ansible-test units --python-interpreter .venv/bin/python
+```
+
+**MacOS Users**: You may need to set this environment variable:
+```bash
+export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
+```
+
+**Important**: `ansible-test sanity` ignores the Python path argument, which is why you'll see import checks like:
+```python
+try:
+    import scaleway
+except ImportError:
+    # handle import error
+```
+
+To test quickly your changes without writing a test you can export the collection path `export ANSIBLE_COLLECTIONS_PATH=/Users/gnoale/git/scaleway/ansible_collections`
+
+## Development Guidelines
+
+### Python Compatibility
+- Be mindful of Python versions and dependencies
+- The target system receives module code and is subject to your declared dependencies
+
+### Type Hints
+When using types from the Scaleway SDK in function signatures, wrap them in quotes to avoid import issues during validation:
+```python
+def example_function(client: "Client") -> str:
+    pass
+```
+
+
+## Running Playbooks
+
+Example playbook execution:
+```yaml
+---
+- hosts: localhost
+  tasks:
+    - name: Create a secret
+      scaleway.scaleway.scaleway_secret:
+        name: "test-secret"
+        protected: false
+        state: present
+      vars:
+        ansible_python_interpreter: .venv/bin/python
+```
+
+Execute with:
+```bash
+SCW_PROFILE=owner SCW_DEFAULT_REGION=fr-par SCW_CONFIG_PATH="/path/to/config.yml" ansible-playbook playbook.yaml
+```