ci: add coverage report on PRs (#837)

Author: radu-mocanu

.github/workflows/ci.yml

@@ -23,4 +23,5 @@ jobs:
     secrets:
       UIPATH_URL: ${{ secrets.UIPATH_URL }}
       UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
-      UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
+      UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/test.yml

@@ -3,12 +3,14 @@ name: Test
 on:
   workflow_call:
     secrets:
-        UIPATH_URL:
-          required: true
-        UIPATH_CLIENT_ID:
-          required: true
-        UIPATH_CLIENT_SECRET:
-          required: true
+      UIPATH_URL:
+        required: true
+      UIPATH_CLIENT_ID:
+        required: true
+      UIPATH_CLIENT_SECRET:
+        required: true
+      SONAR_TOKEN:
+        required: false
 
 jobs:
   test:
@@ -41,19 +43,66 @@ jobs:
         if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version')"
         uses: actions/setup-python@v5
         with:
-          python-version-file: ".python-version"
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version')"
-        run: uv sync --all-extras
+        run: uv sync --all-extras --python ${{ matrix.python-version }}
 
       - name: Run tests
-        if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version')"
-        run: uv run pytest
+        if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version') && !(matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13')"
+        run: uv run --python ${{ matrix.python-version }} pytest
+        env:
+          UIPATH_URL: ${{ secrets.UIPATH_URL }}
+          UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
+          UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
+
+      - name: Run tests with coverage
+        if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version') && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'"
+        run: uv run --python ${{ matrix.python-version }} pytest --cov-report=xml --cov-report=html --tb=short
         env:
           UIPATH_URL: ${{ secrets.UIPATH_URL }}
           UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
           UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
 
+      - name: Upload coverage HTML report
+        if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version') && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' && always()"
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-html-report
+          path: htmlcov/
+          retention-days: 30
+
+      - name: Upload coverage XML report
+        if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version') && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' && always()"
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-xml-report
+          path: coverage.xml
+          retention-days: 30
+
     continue-on-error: true
 
+  sonarcloud:
+    name: SonarCloud
+    needs: test
+    runs-on: ubuntu-latest
+    if: always() && needs.test.result != 'failure'
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download coverage
+        uses: actions/download-artifact@v4
+        continue-on-error: true
+        with:
+          name: coverage-xml-report
+
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarqube-scan-action@2f77a1ec69fb1d595b06f35ab27e97605bdef703 # v5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

pyproject.toml

@@ -127,10 +127,31 @@ disallow_untyped_defs = false
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = "test_*.py"
-addopts = "-ra -q"
+addopts = "-ra -q --cov=src/uipath_langchain --cov-report=term-missing"
 asyncio_default_fixture_loop_scope = "function"
 asyncio_mode = "auto"
 
+[tool.coverage.run]
+source = ["src/uipath_langchain"]
+relative_files = true
+omit = [
+  "*/tests/*",
+  "*/__pycache__/*",
+  "*/site-packages/*",
+  "*/conftest.py",
+]
+
+[tool.coverage.report]
+show_missing = true
+precision = 2
+exclude_lines = [
+  "pragma: no cover",
+  "def __repr__",
+  "raise NotImplementedError",
+  "if TYPE_CHECKING:",
+  "@(abc\\.)?abstractmethod",
+]
+
 [[tool.uv.index]]
 name = "testpypi"
 url = "https://test.pypi.org/simple/"

sonar-project.properties

@@ -0,0 +1,13 @@
+sonar.projectKey=UiPath_uipath-langchain-python
+sonar.organization=ui
+sonar.host.url=https://sonarcloud.io
+
+sonar.sources=src/uipath_langchain
+sonar.tests=tests
+
+sonar.python.version=3.11,3.12,3.13
+sonar.python.coverage.reportPaths=coverage.xml
+
+sonar.exclusions=**/samples/**,**/testcases/**,**/template/**
+
+sonar.sourceEncoding=UTF-8