test: Add unit tests and CI/CD workflow to meet open-source standards

Author: shlok926

.github/workflows/python-app.yml

@@ -0,0 +1,30 @@
+name: Python Application CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with pytest
+      run: |
+        pytest tests/

README.md

@@ -11,6 +11,7 @@
     <img src="https://img.shields.io/badge/UI-Streamlit-red.svg" alt="Streamlit" />
     <img src="https://img.shields.io/badge/Status-Active-brightgreen.svg" alt="Status" />
     <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License" />
+    <img src="https://github.com/shlok926/q-refine/actions/workflows/python-app.yml/badge.svg" alt="Build Status" />
   </p>
 
   <p>

requirements.txt

@@ -3,3 +3,4 @@ qiskit-aer>=0.14.0
 streamlit>=1.30.0
 numpy
 matplotlib
+pytest>=7.0.0

tests/test_circuits.py

@@ -0,0 +1,36 @@
+import pytest
+from qiskit import QuantumCircuit
+from q_refine.circuits.bv import bernstein_vazirani
+from q_refine.circuits.simon import simon_algorithm
+from q_refine.circuits.grover import grover_algorithm
+from q_refine.circuits.qft import qft_benchmark_circuit
+from q_refine.circuits.qnn import generate_trained_qnn
+
+def test_bernstein_vazirani():
+    qc = bernstein_vazirani("101")
+    assert isinstance(qc, QuantumCircuit)
+    assert qc.name == "BV_Circuit"
+    assert qc.num_qubits == 4
+
+def test_simon_algorithm():
+    qc = simon_algorithm("11")
+    assert isinstance(qc, QuantumCircuit)
+    assert qc.name == "Simon"
+    assert qc.num_qubits == 4
+
+def test_grover_algorithm():
+    qc = grover_algorithm()
+    assert isinstance(qc, QuantumCircuit)
+    assert qc.num_qubits == 2
+
+def test_qft_circuit():
+    qc = qft_benchmark_circuit(3)
+    assert isinstance(qc, QuantumCircuit)
+    assert qc.name == "QFT"
+    assert qc.num_qubits == 3
+
+def test_generate_trained_qnn():
+    qc = generate_trained_qnn(num_qubits=3, num_layers=1)
+    assert isinstance(qc, QuantumCircuit)
+    assert qc.name == "Optimized_QNN"
+    assert qc.num_qubits == 3

tests/test_q_sanitizer.py

@@ -0,0 +1,40 @@
+import pytest
+from qiskit import QuantumCircuit
+from q_refine.mitigation_engine.q_sanitizer import QSanitizer
+
+def test_q_sanitizer_init():
+    sanitizer = QSanitizer(mitigation_method="ZNE")
+    assert sanitizer.mitigation_method == "ZNE"
+    assert sanitizer.scale_factors == [1, 3, 5]
+
+def test_circuit_folding():
+    sanitizer = QSanitizer(mitigation_method="ZNE")
+    qc = QuantumCircuit(2)
+    qc.h(0)
+    qc.cx(0, 1)
+    
+    folded_circuits = sanitizer.refine(qc)
+    
+    assert 1 in folded_circuits
+    assert 3 in folded_circuits
+    assert 5 in folded_circuits
+    
+    assert isinstance(folded_circuits[1], QuantumCircuit)
+    assert isinstance(folded_circuits[3], QuantumCircuit)
+    assert isinstance(folded_circuits[5], QuantumCircuit)
+    
+    # Scale 3 circuit depth should be significantly larger
+    assert folded_circuits[3].depth() > folded_circuits[1].depth()
+
+def test_richardson_extrapolate():
+    sanitizer = QSanitizer(mitigation_method="ZNE")
+    
+    # Mock data showing degraded probability as scale increases
+    noisy_probs = [0.90, 0.80, 0.70]
+    scales = [1, 3, 5]
+    
+    zero_noise_prob = sanitizer.richardson_extrapolate(noisy_probs, scales)
+    
+    # Expect the zero noise prob to be higher than the scale 1 prob
+    assert zero_noise_prob > 0.90
+    assert zero_noise_prob <= 1.05  # Sanity check