Skip to content

Feature/hakh11 nrl 1563 enhance debugging capability #1000

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.

Sign up for GitHub

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

Merged
hamzakhan24-nhs merged 2 commits into from
Aug 13, 2025
Merged

Feature/hakh11 nrl 1563 enhance debugging capability #1000

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c57cd1
NRL-1563 Correct typos
hamzakhan24-nhs Aug 8, 2025
014afad
NRL-1563 Update Readme.md with debugging section
hamzakhan24-nhs Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 67 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ To run all the feature integration tests:
make test-features-integration
```

To run indivudal feature test scenario(s) using the custom tag :
To run individual feature test scenario(s) using the custom tag :

1. Add `@custom_tag` before each 'Scenario' that needs to be run (in each .feature file)
2. Run the command below:
Expand All @@ -104,12 +104,77 @@ To run indivudal feature test scenario(s) using the custom tag :
make integration-test-with-custom_tag
```

To run all the feature integration tests and generate an interactive Allure report therafter :
To run all the feature integration tests and generate an interactive Allure report thereafter :

```
make test-features-integration-report
```

### Debugging Behave Integration Tests in VS Code

Integration tests can be debugged directly in **VS Code** using a launch configuration. Instructions on how to set this up for the first time and run the debugger are below.

---

#### 1. Create the Launch Configuration

To get started:

1. Open VS Code and press `Ctrl+Shift+P`
2. Search for **“Add Configuration”** and select it
3. Choose **Python** > **Module**
4. Replace the generated entry in `.vscode/launch.json` with an appropriate launch.json configuration. Below is a example which can be modified as required:

```json
// .vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug Behave",
"type": "debugpy",
"request": "launch",
"module": "behave",
"args": [
"-D",
"env=example-env",
"tests/features",
"-D",
"integration_test=true",
"--tags=@custom_tag"
],
"console": "integratedTerminal",
"justMyCode": true,
"env": {
"PYTHONPATH": "${workspaceFolder}" // adds your project code to Python path
},
"cwd": "${workspaceFolder}" // resolves to the root directory
}
]
}
```

Once steps 1-4 are done, "Debug Behave" should appear in the Run and Debug panel.

#### 2. Customizing the Debug Configuration

You can tailor the args section in .vscode/launch.json to suit your specific environment, tags, or test structure.

For example:
To run only tests with the @api tag, set the --tags accordingly:

```
"args": ["--tags=@api"..]
```

#### 3. Running the Debugger

To start debugging using the launch configuration from VS Code:

1. Go to the Run and Debug panel `Ctrl+Shift+D`
2. Ensure **“Debug Behave”** (if this is the name used in **“launch.json”**) is selected from the dropdown at the top
3. Press `F5` to start debugging

### Smoke testing

For smoke tests, you need to have deployed your infrastructure (using Terraform).
Expand Down