[pull] master from MarketSquare:master

.github/workflows/common_tests.yml

@@ -0,0 +1,177 @@
+name: Common DB Tests
+
+on: [push, pull_request]
+
+env:
+  DB_NAME: db
+  DB_USER: db_user
+  DB_PASS: pass
+  DB_HOST: 127.0.0.1
+  # port is set in the job
+
+  # options for pyodbc only
+  DB_CHARSET: utf8mb4
+  DB_DRIVER: "{MySQL ODBC 9.2 ANSI Driver}"
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - job_name: PostgreSQL
+            module_mode: standard
+            py_db_module: psycopg2
+            pip_install: psycopg2
+            db_port: 5432
+          - job_name: oracledb
+            module_mode: standard
+            py_db_module: oracledb
+            pip_install: oracledb
+            db_port: 1521
+          - job_name: SQLite
+            module_mode: custom
+            py_db_module: sqlite3
+            pip_install: none
+            db_port: 0000
+          - job_name: MySQL_pymysql
+            module_mode: standard            
+            py_db_module: pymysql
+            pip_install: pymysql[rsa]
+            db_port: 3306
+          - job_name: MySQL_pyodbc
+            module_mode: standard            
+            py_db_module: pyodbc
+            pip_install: pyodbc
+            db_port: 3306
+
+    services:
+      postgres:
+        image: postgres:11
+        env:
+          POSTGRES_DB: ${{ env.DB_NAME }}
+          POSTGRES_USER: ${{ env.DB_USER }}
+          POSTGRES_PASSWORD: ${{ env.DB_PASS }}
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+      oracle:
+        image: gvenzl/oracle-free:latest
+        env:
+          ORACLE_PASSWORD: ${{ env.DB_PASS }}
+          ORACLE_DATABASE: ${{ env.DB_NAME }}
+          APP_USER: ${{ env.DB_USER }}
+          APP_USER_PASSWORD: ${{ env.DB_PASS }}
+        ports:
+          - 1521:1521
+          # Provide healthcheck script options for startup
+        options: --health-cmd healthcheck.sh --health-interval 10s --health-timeout 5s --health-retries 10
+
+      mysql:
+        image: mysql
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.DB_PASS }}
+          MYSQL_DATABASE: ${{ env.DB_NAME }}
+          MYSQL_USER: ${{ env.DB_USER }}
+          MYSQL_PASSWORD: ${{ env.DB_PASS }}
+        ports:
+          - 3306:3306
+
+    steps:
+
+      - name: Install unixodbc
+        if: matrix.py_db_module == 'pyodbc'
+        run: sudo apt-get update && sudo apt-get install -y unixodbc
+
+      - name: Install ODBC driver for PostgreSQL
+        if: matrix.py_db_module == 'pyodbc'
+        run: |
+          echo "*** apt-get install the driver"
+          sudo apt-get install --yes odbc-postgresql
+          echo '*** ls -l /usr/lib/x86_64-linux-gnu/odbc'
+          ls -l /usr/lib/x86_64-linux-gnu/odbc || true
+          echo '*** add full paths to Postgres .so files in /etc/odbcinst.ini'
+          sudo sed -i 's|Driver=psqlodbca.so|Driver=/usr/lib/x86_64-linux-gnu/odbc/psqlodbca.so|g' /etc/odbcinst.ini
+          sudo sed -i 's|Driver=psqlodbcw.so|Driver=/usr/lib/x86_64-linux-gnu/odbc/psqlodbcw.so|g' /etc/odbcinst.ini
+          sudo sed -i 's|Setup=libodbcpsqlS.so|Setup=/usr/lib/x86_64-linux-gnu/odbc/libodbcpsqlS.so|g' /etc/odbcinst.ini
+
+      - name: Install ODBC driver for MySQL
+        if: matrix.py_db_module == 'pyodbc'
+        run: |
+          cd "$RUNNER_TEMP"
+          echo "*** download driver"
+          curl --silent --show-error --write-out "$CURL_OUTPUT_FORMAT" -O -L "https://dev.mysql.com/get/Downloads/Connector-ODBC/9.2/${MYSQL_DRIVER}"
+          ls -l "${MYSQL_DRIVER}"
+          echo "*** install the driver"
+          sudo dpkg -i "./${MYSQL_DRIVER}"
+          sudo apt-get install -f
+        env:
+            CURL_OUTPUT_FORMAT: '%{http_code} %{filename_effective} %{size_download} %{time_total}\n'
+            MYSQL_DRIVER: mysql-connector-odbc_9.2.0-1ubuntu24.04_amd64.deb
+
+      - name: Check ODBC setup
+        if: matrix.py_db_module == 'pyodbc'
+        run: |
+          echo "*** odbcinst -j"
+          odbcinst -j
+          echo "*** cat /etc/odbcinst.ini"
+          cat /etc/odbcinst.ini
+          echo "*** cat /etc/odbc.ini"
+          cat /etc/odbc.ini
+          echo '*** ls -l /opt/microsoft/msodbcsql17/lib64'
+          ls -l /opt/microsoft/msodbcsql17/lib64 || true
+          echo '*** ls -l /usr/lib/x86_64-linux-gnu/odbc'
+          ls -l /usr/lib/x86_64-linux-gnu/odbc || true
+
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.8.14'
+
+      - name: Setup Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Install Development/Checked out version of DatabaseLibrary
+        run: |
+          pip install -e ${{ github.workspace }}
+
+      - name: Setup Python DB module
+        if: matrix.pip_install != 'none'
+
+        run: |
+          pip install ${{ matrix.pip_install }}
+
+      - name: Tests for ${{ matrix.job_name }}
+        working-directory: ./test
+        run: >-
+            robot
+            -d results
+            --xunit result.xml
+            --loglevel DEBUG:INFO
+            --output output_${{ matrix.job_name }}.xml
+            --log log_${{ matrix.job_name }}.html
+            --report report_${{ matrix.job_name }}.html
+            -v DB_MODULE_MODE:${{ matrix.module_mode }}
+            -v DB_MODULE:${{ matrix.py_db_module }}
+            -v DB_NAME:${{ env.DB_NAME }}
+            -v DB_USER:${{ env.DB_USER }}
+            -v DB_PASS:${{ env.DB_PASS }}
+            -v DB_HOST:${{ env.DB_HOST }}
+            -v DB_PORT:${{ matrix.db_port }}
+            -v DB_CHARSET:${{env.DB_CHARSET}}
+            -v DB_DRIVER:"${{env.DB_DRIVER}}"
+            tests/common_tests            
+
+      - name: Upload Robot Logs
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: log-files-${{ matrix.job_name }}
+          path: ./test/results/

.github/workflows/static.yml

@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/unit_tests.yml

@@ -0,0 +1,56 @@
+---
+# This workflow will install Python dependencies
+# and run unit tests for given OSes
+
+name: Unit tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: 'ubuntu-latest'
+            python-version: '3.8'
+            rf-version: '5.0.1'
+          - os: 'ubuntu-latest'
+            python-version: '3.9'
+            rf-version: '5.0.1'
+          - os: 'ubuntu-latest'
+            python-version: '3.10'
+            rf-version: '6.1.1'
+          - os: 'ubuntu-latest'
+            python-version: '3.11'
+            rf-version: '6.1.1'
+          - os: 'ubuntu-latest'
+            python-version: '3.12'
+            rf-version: '7.0.1'
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install robotframework==${{ matrix.rf-version }} coverage pytest
+          pip install .
+
+      - name: Run unit tests with coverage
+        run:
+          coverage run -m pytest
+
+      - name: Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          name: ${{ matrix.python-version }}-${{ matrix.os }}-${{ matrix.rf-version }}

.gitignore

@@ -1,10 +1,16 @@
+dist/
 build/
+*.egg-info/
 *.pyc
 .idea
 .py*/
-*.egg-info/
-test/log.html
-test/my_db_test.db
-test/output.xml
-test/report.html
-test/logs/
+**/my_db_test.db
+logs
+interactive_console_output.xml
+log.html
+output.xml
+report.html
+venv
+.runNumber
+.DS_Store
+test/resources/ojdbc17.jar

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+    - id: isort
+      name: isort (python)
+
+- repo: https://github.com/psf/black
+  rev: 23.1.0
+  hooks:
+  - id: black

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+        "recommendations": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-python.pylint",
+        "robocorp.robotframework-lsp",
+        "techer.open-in-browser",
+        "eamodio.gitlens"
+    ]
+}