-
Notifications
You must be signed in to change notification settings - Fork 16
feat: pact contract for get job by id and post job #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
duvanmoionq
wants to merge
4
commits into
main
Choose a base branch
from
pact/contract
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| name: Pact — publish consumer contracts | ||
| on: | ||
| workflow_dispatch: {} | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
| paths: | ||
| - "ionq_core/**" | ||
| - "tests/pact/**" | ||
| - ".github/workflows/pact-publish.yml" | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| env: | ||
| UV_FROZEN: true | ||
|
|
||
| jobs: | ||
| publish-pacts: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: ./.github/actions/setup-uv | ||
| with: | ||
| enable-cache: ${{ github.event_name == 'push' }} | ||
| - run: uv sync | ||
| # --no-cov: the pact test alone cannot meet the repo's 100% coverage gate | ||
| # (addopts sets --cov-fail-under=100), same as ci.yml's non-3.11 matrix legs. | ||
| - name: Generate consumer pact | ||
| run: uv run pytest tests/pact --no-cov | ||
| - name: Publish pact to PactFlow | ||
| uses: pactflow/actions/publish-pact-files@3074b72c0df6af10087afccfa6f91e2308dc151c # v2.0.0 | ||
| with: | ||
| pactfiles: pacts | ||
| broker_url: ${{ vars.PACT_BROKER_BASE_URL }} | ||
| token: ${{ secrets.PACT_BROKER_TOKEN }} | ||
| # Explicit so a PR's detached-HEAD checkout doesn't misreport them. | ||
| branch: ${{ github.head_ref || github.ref_name }} | ||
| version: ${{ github.event.pull_request.head.sha || github.sha }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,3 +13,6 @@ docs/ | |
| .env | ||
| .idea/ | ||
| *.orig | ||
|
|
||
| # Pact contract files (generated by consumer tests; published to the broker) | ||
| pacts/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| """Pact HTTP contract: ionq-core-python -> cloud-job-manager-http. | ||
|
|
||
| Consumes POST /v0.4/jobs (create -> 201) and GET /v0.4/jobs/{id} (fetch a | ||
| completed job -> 200). Generated openapi-python-client: from_dict parse IS | ||
| consumption, so the GET asserts every required key. Use the bare | ||
| AuthenticatedClient (not the IonQClient factory) — its UA / non-HTTPS warnings | ||
| would trip this repo's filterwarnings=error. | ||
| """ | ||
|
|
||
| from pathlib import Path | ||
|
|
||
| from pact import Pact, match | ||
|
|
||
| from ionq_core.api.default import create_job, get_job | ||
| from ionq_core.client import AuthenticatedClient | ||
| from ionq_core.models import ( | ||
| CircuitJobCreationPayload, | ||
| JobCreationResponse, | ||
| SingleCircuitJob, | ||
| ) | ||
|
|
||
| PACT_DIR = Path(__file__).resolve().parents[3] / "pacts" | ||
|
|
||
| ISO_TIMESTAMP = r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$" | ||
|
|
||
| # Pinned with cloud-job-manager's provider state handler ('a completed circuit | ||
| # job with results exists' seeds this exact id from the state parameters). | ||
| JOB_ID = "0198097d-3888-72ad-a9dd-9ace842cf181" | ||
|
|
||
| # The real request model drives the pact request body (never hand-written, so | ||
| # it can't drift from what the SDK serializes). Enriched with the optional | ||
| # fields the SDK really sends: name, settings.error_mitigation and noise. | ||
| # attrs' to_dict() drops UNSET fields, but shots defaults to 100 (not UNSET) | ||
| # and is therefore always on the wire. | ||
| CREATE_PAYLOAD = CircuitJobCreationPayload.from_dict( | ||
| { | ||
| "type": "ionq.circuit.v1", | ||
| "backend": "simulator", | ||
| "name": "pact test job", | ||
| "shots": 100, | ||
| "input": { | ||
| "gateset": "qis", | ||
| "qubits": 2, | ||
| "circuit": [ | ||
| {"gate": "h", "target": 0}, | ||
| {"gate": "cnot", "target": 0, "control": 1}, | ||
| ], | ||
| }, | ||
| "settings": {"error_mitigation": {"debiasing": False}}, | ||
| "noise": {"model": "ideal"}, | ||
| } | ||
| ) | ||
|
|
||
| CREATE_RESPONSE_BODY = { | ||
| "id": match.uuid("0198097d-3888-72ad-a9dd-9ace842cf182"), | ||
| "status": "submitted", | ||
| # Required-nullable: the key must be on the wire (null for sessionless). | ||
| "session_id": None, | ||
| } | ||
|
|
||
| # Every SingleCircuitJob required key, with the values the provider state's | ||
| # seed produces; required-nullable keys are asserted as null. results pins the | ||
| # format-keyed v1 descriptor the provider synthesizes (its legacy {url} | ||
| # entries ride along as unasserted extras). | ||
|
Comment on lines
+61
to
+64
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I find these comments hard to read and understand, could they be rephrased? |
||
| GET_RESPONSE_BODY = { | ||
| "id": JOB_ID, | ||
| "status": "completed", | ||
| "type": "ionq.circuit.v1", | ||
| "backend": match.string("simulator"), | ||
| "dry_run": match.boolean(False), | ||
| "submitter_id": match.string("66841feb7addb210ae6214c2"), | ||
| "project_id": match.uuid("31a4dc21-9b52-4a51-89db-c62f1f77f356"), | ||
| "parent_job_id": None, | ||
| "session_id": None, | ||
| "metadata": None, | ||
| "name": match.string("pact test job"), | ||
| "submitted_at": match.regex("2026-09-09T12:00:00.000Z", regex=ISO_TIMESTAMP), | ||
| "started_at": None, | ||
| "completed_at": None, | ||
| # Null for completed jobs (the wait is over); the SDK only needs the key. | ||
| "predicted_wait_time_ms": None, | ||
| "predicted_execution_duration_ms": None, | ||
| # The provider computes this and sends 0 when no execution times exist. | ||
| "execution_duration_ms": match.integer(0), | ||
| "failure": None, | ||
| "output": match.like({}), | ||
| "settings": match.like({}), | ||
| "stats": match.like({}), | ||
| "results": { | ||
| "ionq.result.probabilities.json.v1": match.like( | ||
| { | ||
| "id": match.string("probabilities"), | ||
| "format": match.string("ionq.result.probabilities.json.v1"), | ||
| "media_type": match.string("application/json"), | ||
| } | ||
| ) | ||
| }, | ||
| "child_job_ids": None, | ||
| } | ||
|
|
||
|
|
||
| def test_jobs_api_contract() -> None: | ||
| pact = Pact("ionq-core-python", "cloud-job-manager-http").with_specification("V3") | ||
|
|
||
| ( | ||
| pact.upon_receiving("a request to create a circuit job") | ||
| .given("a valid project and org region exist") | ||
| .with_request("POST", "/v0.4/jobs") | ||
| .with_body(CREATE_PAYLOAD.to_dict(), content_type="application/json") | ||
| .will_respond_with(201) | ||
| .with_body(CREATE_RESPONSE_BODY, content_type="application/json") | ||
| ) | ||
| ( | ||
| pact.upon_receiving("a request to get a completed job") | ||
| .given("a completed circuit job with results exists", id=JOB_ID) | ||
| .with_request("GET", f"/v0.4/jobs/{JOB_ID}") | ||
| .will_respond_with(200) | ||
| .with_body(GET_RESPONSE_BODY, content_type="application/json") | ||
| ) | ||
|
|
||
| with ( | ||
| pact.serve() as srv, | ||
| AuthenticatedClient( | ||
| base_url=f"{srv.url}/v0.4", | ||
| token="pact-test-key", | ||
| prefix="apiKey", | ||
| auth_header_name="Authorization", | ||
| ) as client, | ||
| ): | ||
| created = create_job.sync(client=client, body=CREATE_PAYLOAD) | ||
| assert isinstance(created, JobCreationResponse) | ||
| assert created.status == "submitted" | ||
| assert created.session_id is None | ||
|
|
||
| job = get_job.sync(uuid=JOB_ID, client=client) | ||
| assert isinstance(job, SingleCircuitJob) | ||
| assert job.id == JOB_ID | ||
| assert job.status == "completed" | ||
| assert job.results is not None | ||
|
|
||
| PACT_DIR.mkdir(exist_ok=True) | ||
| pact.write_file(PACT_DIR, overwrite=True) | ||
|
Comment on lines
+141
to
+142
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do these instructions do? |
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's good to remove
since these can change and then the comment becomes easily outdated.