Merge pull request #17 from MagaluCloud/refactor-repo-structure

refactor: updating package manager, pipeline and run_cli util

Author: chrystianrcampos

.github/workflows/test-on-pr.yml

@@ -0,0 +1,64 @@
+name: CI Tests with MGC
+
+on:
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 9 * * *'
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Run Pytest via Make
+    runs-on: ubuntu-latest
+    
+    env:
+      MGC_API_KEY: ${{ secrets.MGC_API_KEY }}
+      MGC_PATH: ${{ vars.MGC_PATH }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Install Magalu Cloud CLI (via APT)
+        run: |
+          sudo mkdir -p /etc/apt/keyrings
+          sudo gpg --yes --keyserver keyserver.ubuntu.com --recv-keys 0C59E21A5CB00594
+          sudo gpg --export --armor 0C59E21A5CB00594 | sudo gpg --dearmor -o /etc/apt/keyrings/magalu-archive-keyring.gpg
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/magalu-archive-keyring.gpg] https://packages.magalu.cloud/apt stable main" | sudo tee /etc/apt/sources.list.d/magalu.list
+          sudo apt update
+          sudo apt install -y mgccli
+
+      - name: Verify MGC_API_KEY and MGC_PATH and CLI
+        run: |
+          if [ -z "$MGC_API_KEY" ]; then
+            echo "Error: MGC_API_KEY is not set in GitHub Secrets."
+            exit 1
+          fi
+          if [ -z "$MGC_PATH" ]; then
+            echo "Error: MGC_PATH is not set in GitHub Variables."
+            exit 1
+          fi
+          mgc --version
+
+      - name: Run tests
+        run: make test
+
+      - name: Upload Test Report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: pytest-html-report
+          path: report.html
+          retention-days: 7

.gitignore

@@ -169,3 +169,5 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+report.html
+.secrets

.python-version

@@ -0,0 +1 @@
+3.10

Makefile

@@ -1,29 +1,48 @@
-test-all:
-	@MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest --tb=short -v
+.PHONY: ensure-deps test test-auth test-block test-dbaas test-lbaas test-network test-object test-profile test-regression test-vm test-workspace
 
-test-lbaas:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_lbaas.py --tb=short -v
+ensure-deps:
+	@command -v python3 >/dev/null 2>&1 || { echo "python3 not found. Please install python3 and re-run."; exit 1; }
+	@command -v curl >/dev/null 2>&1 || { echo "curl not found. Install curl to allow automatic installation of 'uv'."; exit 1; }
+	@command -v uv >/dev/null 2>&1 || ( \
+		echo "uv not found — installing via curl..."; \
+		mkdir -p ~/.local/bin; \
+		UV_URL=$${UV_URL:-https://github.com/uv/uv/releases/latest/download/uv}; \
+		if curl -fL "$$UV_URL" -o ~/.local/bin/uv; then \
+			chmod +x ~/.local/bin/uv; \
+			echo "uv installed at ~/.local/bin/uv"; \
+		else \
+			echo "Failed to download 'uv' via curl. Please install 'uv' manually."; exit 1; \
+		fi )
 
-test-dbaas:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_dbaas.py --tb=short -v
+test: ensure-deps
+	@MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest --html=report.html --self-contained-html
 
-test-network:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_network.py --tb=short -v
+test-auth: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_auth.py
 
-test-object:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_object.py --tb=short -v
+test-block: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_block.py
 
-test-profile:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_profile.py --tb=short -v
+test-dbaas: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_dbaas.py
 
-test-vm:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_vm.py --tb=short -v
+test-lbaas: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_lbaas.py
 
-test-workspace:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_workspace.py --tb=short -v
+test-network: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_network.py
 
-test-regression:
-	@MGC_PRINT_COMMAND=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest tests/test_regression.py --tb=short -v
+test-object: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_object.py
 
-test-ci: 
-	@MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) poetry run pytest --ignore=tests/test_auth.py --tb=short -v
+test-profile: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_profile.py
+
+test-regression: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_regression.py
+
+test-vm: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_vm.py
+
+test-workspace: ensure-deps
+	@MGC_VERBOSE=True MGC_API_KEY=$(MGC_API_KEY) MGC_PATH=$(MGC_PATH) uv run pytest tests/test_workspace.py

README.md

@@ -1,15 +1,67 @@
 # mgc-cli-tests
-funcional tests on Magalu Cloud CLI
+
+Functional tests for Magalu Cloud CLI.
 
 ## Requirements
-- python 3.12
-- poetry
-- [MGC CLI](https://github.com/MagaluCloud/mgccli/) on path (or configured via `MGC_PATH` env var)
 
-## How to run
+- Python 3.10 or higher
+- uv (Astral's package manager)
+- Make
+- [MGC CLI](https://github.com/MagaluCloud/mgccli/) in PATH (or configure via the `MGC_PATH` environment variable)
+
+## Installation and setup
+
+Option A — Manual:
+1. Install uv following the official instructions: https://github.com/astral-sh/uv
+   - Example (Linux/Mac):
+     ```
+     curl -LsSf https://astral.sh/uv/install.sh | sh
+     ```
+   - Restart your terminal after installation.
+2. In the project directory, run:
+   ```
+   uv sync
+   uv run pytest --html=report.html --self-contained-html
+   ```
+3. To run individual test targets:
+   ```
+   uv run pytest tests/test_auth.py
+   uv run pytest tests/test_block.py
+   ...
+   ```
+
+Option B — Automatic (using the Makefile):
+1. Run:
+   ```
+   make test
+   ```
+   - The Makefile checks for python3 and curl and attempts to install `uv` via curl into `~/.local/bin/uv` if not present.
+   - If the Makefile installs `uv` to `~/.local/bin`, ensure `~/.local/bin` is in your PATH, e.g.:
+     ```
+     export PATH=$HOME/.local/bin:$PATH
+     ```
+2. To run individual test targets:
+   ```
+   make test-auth
+   make test-block
+   ...
+   ```
+
+## HTML report
+
+- The `make test` target generates a self-contained HTML report named `report.html`.
+- Open `report.html` in your browser after the run to review results.
 
-```bash
-poetry run pytest
+## How to run without the Makefile
+
+To run all tests:
+```
+uv run pytest
+```
+
+To run a specific test file:
+```
+uv run pytest tests/test_lbaas.py
 ```
 
 ## Modules tested

action.yml

@@ -1,5 +1,5 @@
 name: 'MGCCLI Tests'
-description: 'Executa testes para mgccli usando Poetry e Pytest'
+description: 'Executa testes para mgccli usando Astral UV e Pytest'
 author: 'MagaluCloud'
 
 inputs:
@@ -67,33 +67,34 @@ runs:
       with:
         python-version: ${{ inputs.python-version }}
 
-    - name: Install Poetry
-      uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a
-      with:
-        version: 1.8.4
+    - name: Install Astral UV
+      shell: bash
+      run: |
+        curl -LsSf https://astral.sh/uv/install.sh | sh
         
     - name: Install dependencies
       shell: bash
       working-directory: ./tmp/mgccli-source
       run: |
-        poetry install --no-interaction
-        
+        uv sync
+
     - name: Run tests
       id: run-tests
       shell: bash
       working-directory: ./tmp/mgccli-source
       env:
         MGC_PATH: ${{ env.MGC_PATH_RESOLVED }}
       run: |
-        echo "Executando testes com MGC_PATH: $MGC_PATH"
-        poetry run pytest ${{ inputs.pytest-args }} --tb=short -v --ignore=tests/test_auth.py 2>&1 | tee pytest_output.txt
+        echo "Running tests with MGC_PATH: $MGC_PATH"
+        uv run pytest ${{ inputs.pytest-args }} --tb=short -v --html=report.html --self-contained-html 2>&1 | tee pytest_output.txt
         echo "exit_code=${PIPESTATUS[0]}" >> $GITHUB_OUTPUT
-        
+
     - name: Upload test results
       if: always()
       uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
       with:
         name: pytest-results
-        path: ./tmp/mgccli-source/pytest_output.txt
+        path: |
+          ./tmp/mgccli-source/pytest_output.txt
+          ./tmp/mgccli-source/report.html
         retention-days: 2
-        

main.py

@@ -0,0 +1,6 @@
+def main():
+    print("Run the tests with: uv run pytest")
+
+
+if __name__ == "__main__":
+    main()

poetry.lock

@@ -1,18 +1,14 @@
-[tool.poetry]
-name = "mgc-cli-tests"
+[project]
+name = "mgccli-tests"
 version = "0.1.0"
-description = ""
-authors = ["Luiz Cavalcanti <luiz.cavalcanti@luizalabs.com>"]
+description = "Add your description here"
 readme = "README.md"
-package-mode = false
-
-[tool.poetry.dependencies]
-python = "^3.12"
-
-
-[tool.poetry.group.dev.dependencies]
-pytest = "^8.3.4"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires-python = ">=3.10"
+dependencies = [
+    "pytest>=9.0.2",
+    "pytest-html>=4.1.1",
+]
+authors = [
+    { name = "Luiz Cavalcanti", email = "<luiz.cavalcanti@luizalabs.com>" },
+    { name = "Chrystian R. Campos", email = "<chrystian1.camp@luizalabs.com>" }
+]