Skip to content
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

Add more information on testing for devs #642

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Conversation

olethanh
Copy link
Collaborator

No description provided.

@olethanh olethanh requested review from hoh and nesitor June 20, 2024 08:00
@github-actions github-actions bot added the BLACK This PR has critical implications and must be reviewed by a senior engineer. label Jun 20, 2024
Copy link

Category: BLACK

Explanation: The PR contains extensive changes that have a high potential for introducing bugs or that require deep understanding of the project architecture. This includes a large number of changes to the TESTING.md file, which is a documentation file. The PR includes instructions for debugging tests and runtimes, which are critical for developers who are working on the project. Additionally, the PR modifies the shebang line of a runtime file, which could potentially lead to unexpected behavior.

Highlight:

diff  --git a/TESTING.md b/TESTING.md
index 67f9143b..7adbae0c 100644
--- a/TESTING.md
+++ b/TESTING.md
@@ -44,3 +44,30  @@ hatch env create testing
 ```shell
 hatch run testing:test

+## Debugging the tests
+Some tricks and options that might help debugging problematic tests.
+
+Only launch pytest with a test name and more verbose debugging
+shell +hatch run testing:pytest -vv --log-level=DEBUG --full-trace -o log_cli=true -k <TEST NAME> +
+
+
+Specify --capture=no to pytest so it launch. This way you get the full output, including firecracker logs
+
+## Debugging runtimes
+If the error is in the runtime:
+Modify the # to pass the -v option to python, which will print all the debugging info
+#!/usr/bin/python3 -vOO
+
+To have these modification take effect you need to rebuild the runtime file using create_disk_image.sh as root
+
+shell +sudo bash create_disk_image.sh +
+
+Don't forget to have the print system log option set ALEPH_VM_PRINT_SYSTEM_LOGS=1
+
+aleph-debian-12-python is used in test_create_execution


The PR also includes a change to the runtime file, which could potentially lead to unexpected behavior. The PR also includes a large number of changes to the TESTING.md file, which is a documentation file. Therefore, this PR falls into the 'BLACK' category.

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.84%. Comparing base (7b89523) to head (c99d67e).
Report is 17 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #642      +/-   ##
==========================================
- Coverage   53.87%   53.84%   -0.04%     
==========================================
  Files          58       58              
  Lines        5310     5310              
  Branches      594      594              
==========================================
- Hits         2861     2859       -2     
- Misses       2311     2313       +2     
  Partials      138      138              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@olethanh olethanh merged commit 834ae4d into main Jun 20, 2024
23 of 24 checks passed
@Psycojoker Psycojoker deleted the ol-enh-doc-testing branch July 24, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BLACK This PR has critical implications and must be reviewed by a senior engineer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants