munich-quantum-toolkit / munich-quantum-toolkit/debugger

:white_check_mark: Test DAP Server

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
C++
Stars
21
Forks
7
Avg merge
9h 28m
Merged PRs (30d)
42

Description

What's the problem this feature will solve?

Currently, the package has no tests for the DAP server, and the dap submodule is ignored by codecov. Changes to the structure of the Debugging backend could easily break the DAP server, and manually testing it can be cumbersome.

It would be great to have automated tests in the CI pipeline. However, to test the DAP Server, we practically need a semi-functional DAP client, which can be quite some work to implement.

Describe the solution you'd like

The perfect solution would be a pytest file that uses a fixture that sets up the communication between a DAP server instance and a client. In different test cases, the client would send typical messages to the server, and the test cases would check whether the returned responses are correct or not.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the DAP server entry point and the existing pytest and CI configuration. Add a pytest fixture that connects a semi-functional client to the server, exercise typical DAP messages, and verify the responses in CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
ci-cd, devtools, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.