Add unit tests to client

.github/workflows/deploy.yml

@@ -0,0 +1,24 @@
+# A single CI script with github workflow
+name: Build wheels and deploy
+
+on:
+  workflow_dispatch:
+  push:
+  merge_group:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.9, '3.10', '3.11']
+    uses: qiboteam/workflows/.github/workflows/deploy-pip-poetry.yml@main
+    with:
+      os: ${{ matrix.os }}
+      python-version: ${{ matrix.python-version }}
+      publish: ${{ github.event_name == 'release' && github.event.action == 'published' && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10' }}
+      poetry-extras: "--with dev"
+    secrets: inherit

.github/workflows/unit_test.yml

@@ -0,0 +1,22 @@
+name: Tests
+
+on:
+  workflow_dispatch:
+  push:
+  merge_group:
+  pull_request:
+    types: [labeled]
+
+jobs:
+  build:
+    if: contains(github.event.pull_request.labels.*.name, 'run-workflow') || github.event_name == 'push'
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.9, '3.10', '3.11']
+    uses: qiboteam/workflows/.github/workflows/rules-poetry.yml@main
+    with:
+      os: ${{ matrix.os }}
+      python-version: ${{ matrix.python-version }}
+      poetry-extras: "--with dev"
+    secrets: inherit

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+ci:
+  autofix_prs: true
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: debug-statements
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v2.4.0
+    hooks:
+      - id: pycln
+        args: [--config=pyproject.toml]

examples/run_error_job.py

@@ -1,11 +1,12 @@
 import qibo
+
 from qibo_tii_provider import TiiProvider
 
 # create the circuit you want to run
 circuit = qibo.models.QFT(11)
 
 # read the token from file
-with open("token.txt", "r") as f:
+with open("token.txt") as f:
     token = f.read()
 
 # authenticate to server through the client instance

examples/run_successful_job.py

@@ -1,11 +1,12 @@
 import qibo
+
 from qibo_tii_provider import TIIProvider
 
 # create the circuit you want to run
 circuit = qibo.models.QFT(5)
 
 # read the token from file
-with open("token.txt", "r") as f:
+with open("token.txt") as f:
     token = f.read()
 
 # authenticate to server through the client instance

pyproject.toml

@@ -23,3 +23,25 @@ packages = [{ include = "qibo_tii_provider", from = "src" }]
 python = ">=3.8,<3.12"
 qibo = ">=0.2.2"
 requests = "^2.31.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.3"
+pytest-cov = "^4.1.0"
+pylint = "^3.0.3"
+
+[tool.poe.tasks]
+test = "pytest"
+lint = "pylint --errors-only src"
+lint-warnings = "pylint --exit-zero src"
+
+[tool.pylint.reports]
+output-format = "colorized"
+
+[tool.pytest.ini_options]
+testpaths = ['tests/']
+filterwarnings = ['ignore::RuntimeWarning']
+addopts = [
+  '--cov=src/qibo_tii_provider',
+  '--cov-report=xml',
+  '--cov-report=html',
+]

src/qibo_tii_provider/__init__.py

@@ -1 +1,2 @@
+"""The `qibo_tii_provider` package"""
 from qibo_tii_provider.tiiprovider import TIIProvider

src/qibo_tii_provider/config.py

@@ -0,0 +1,23 @@
+"""This module implements some constants and custom exceptions"""
+
+
+class MalformedResponseError(Exception):
+    """Exception raised when server responsed body does not contain expected keys"""
+
+    def __init__(
+        self, message="Server response body does not contain all the expected keys"
+    ):
+        self.message = message
+        super().__init__(self.message)
+
+
+class JobPostServerError(Exception):
+    """Exception raised when server fails to post the job to the queue.
+
+    The client should handle such error to aknowledge that job submission was
+    not successful without crashing.
+    """
+
+    def __init__(self, message="Server failed to post job to queue"):
+        self.message = message
+        super().__init__(self.message)