Add unit tests for heralding option

tests/test_iqm_client.py

@@ -13,7 +13,8 @@
 # limitations under the License.
 """Tests for the IQM client.
 """
-from mockito import ANY, verify, when
+import json
+from mockito import ANY, kwargs, verify, unstub, when
 
 # pylint: disable=unused-argument
 import pytest
@@ -28,6 +29,7 @@
     ClientConfigurationError,
     IQMClient,
     QuantumArchitectureSpecification,
+    RunRequest,
     SingleQubitMapping,
     Status,
     __version__,
@@ -189,6 +191,38 @@ def test_submit_circuits_with_duration_check_disabled_returns_id(
     assert job_id == existing_run
 
 
+def test_submit_circuits_does_not_activate_heralding_by_default(base_url, sample_circuit):
+    client = IQMClient(base_url)
+    circuits = [Circuit.parse_obj(sample_circuit)]
+    expected_request_str = json.loads(RunRequest(circuits=circuits, shots=10, heralding='none').json(exclude_none=True))
+    when(requests).post(f'{base_url}/jobs', json=expected_request_str, **kwargs).thenReturn(
+        MockJsonResponse(201, {'id': str(existing_run)})
+    )
+    client.submit_circuits(circuits=circuits, shots=10)
+    unstub()
+
+
+def test_submit_circuits_sets_heralding_mode_in_run_request(base_url, sample_circuit):
+    client = IQMClient(base_url)
+    circuits = [Circuit.parse_obj(sample_circuit)]
+    expected_request_str = json.loads(RunRequest(circuits=circuits, shots=1, heralding='zeros').json(exclude_none=True))
+    when(requests).post(f'{base_url}/jobs', json=expected_request_str, **kwargs).thenReturn(
+        MockJsonResponse(201, {'id': str(existing_run)})
+    )
+    client.submit_circuits(circuits=circuits, heralding='zeros')
+
+
+def test_submit_circuits_raises_with_invalid_heralding_mode(base_url, sample_circuit):
+    client = IQMClient(base_url)
+    with pytest.raises(ValueError, match='value is not a valid enumeration member'):
+        client.submit_circuits(
+            qubit_mapping={'Qubit A': 'QB1', 'Qubit B': 'QB2'},
+            circuits=[Circuit.parse_obj(sample_circuit)],
+            heralding='bamboleo',
+            shots=1000,
+        )
+
+
 def test_get_run_adds_user_agent(mock_server, base_url, calibration_set_id, sample_circuit):
     """
     Tests that get_run without client signature adds the correct User-Agent header