Add free-form text to qube for notes, comments, ... by alimirjamali · Pull Request #334 · QubesOS/qubes-core-admin-client

alimirjamali · 2025-02-16T16:56:29Z

qubesadmin part of adding free-form text to each qube for comments, notes, descriptions, remarks, reminders, etc.

codecov · 2025-02-16T17:13:27Z

Codecov Report

Attention: Patch coverage is 96.61017% with 4 lines in your changes missing coverage. Please review.

Project coverage is 76.12%. Comparing base (16834f9) to head (ee39d27).
Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
qubesadmin/backup/core3.py	20.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #334      +/-   ##
==========================================
+ Coverage   75.80%   76.12%   +0.32%     
==========================================
  Files          52       53       +1     
  Lines        9080     9198     +118     
==========================================
+ Hits         6883     7002     +119     
+ Misses       2197     2196       -1

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

alimirjamali · 2025-05-01T15:22:24Z

@marmarek please let me know if you agree with qvm-notes syntax and options. So I can proceed with its unittests. in the meantime, I will write the unittests for the rest.

marmarek · 2025-05-02T15:49:36Z

Generally qvm-notes interface looks fine (based on its man page). I think append action needs a clarification regarding newlines if any are inserted automatically.

As for the implementation, IMO too many of the actions ask for confirmation. Maybe remove should, but others seems unnecessary.

alimirjamali · 2025-05-02T18:15:44Z

This is ready for review. Only 3 lines are not covered by tests but two lines are abstract lines (maybe I should add #pragma: no cover) and one other is for backup restore notes failure which is highly unlikely to happen (this is covered in lots of other places).

Generally qvm-notes interface looks fine (based on its man page). I think append action needs a clarification regarding newlines if any are inserted automatically.

This is done. I also added some more notes for better clarification

As for the implementation, IMO too many of the actions ask for confirmation. Maybe remove should, but others seems unnecessary.

Theoretically It is possible to check with get_notes and only ask for confirmation on set, delete & import actions that the action is going to replace existing note. On the other hand, it will require admin.vm.notes.Get permission. So I implemented your recommendation.

qubesadmin part of adding free-form text to each qube for comments, notes, descriptions, remarks, reminders, etc. fixes: QubesOS/qubes-issues#899 Additional options to skip legacy backup tests or super slow tests

alimirjamali · 2025-05-21T13:54:30Z

@marmarek I just rebased this and excluded few irrelevant lines for codecov. Otherwise nothing is changed.

qubesadmin part of adding free-form text to each qube for comments, notes, descriptions, remarks, reminders, etc. fixes: QubesOS/qubes-issues#899 requires: QubesOS/qubes-core-admin-client#334

qubesos-bot · 2025-05-22T11:14:29Z

OpenQA test summary

Complete test suite and dependencies: https://openqa.qubes-os.org/tests/overview?distri=qubesos&version=4.3&build=2025052321-4.3&flavor=pull-requests

Test run included the following:

New failures, excluding unstable

Compared to: https://openqa.qubes-os.org/tests/overview?distri=qubesos&version=4.3&build=2025031804-4.3&flavor=update

system_tests_whonix
- whonix_torbrowser: unnamed test (unknown)
- whonix_torbrowser: Failed (test died)
  # Test died: no candidate needle with tag(s) 'anon-whonix-tor-brows...
system_tests_dispvm
- TC_20_DispVM_debian-12-xfce: test_015_dvm_run_preload_race_more (error)
  raise TimeoutError from exc_val... TimeoutError
- TC_20_DispVM_fedora-41-xfce: test_014_dvm_run_preload_nogui (error + cleanup)
  qubes.exc.QubesValueError: Qube GUI is 'False' and does not support...
- TC_20_DispVM_fedora-41-xfce: test_015_dvm_run_preload_race_more (error + cleanup)
  raise TimeoutError from exc_val... TimeoutError
- TC_20_DispVM_fedora-41-xfce: test_016_dvm_run_preload_race_less (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_017_dvm_run_preload_autostart (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_020_gui_app (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_030_edit_file (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_100_open_in_dispvm (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
system_tests_kde_gui_interactive
- gui_keyboard_layout: wait_serial (wait serial expected)
  # wait_serial expected: "echo -e '[Layout]\nLayoutList=us,de' | sud...
- gui_keyboard_layout: Failed (test died)
  # Test died: command 'test "$(cd ~user;ls e1*)" = "$(qvm-run -p wor...
system_tests_qwt_win10_seamless@hw13
- windows_clipboard_and_filecopy: unnamed test (unknown)
- windows_clipboard_and_filecopy: Failed (test died)
  # Test died: no candidate needle with tag(s) 'windows-Edge-address-...
system_tests_qwt_win11@hw13
- windows_install: wait_serial (wait serial expected)
  # wait_serial expected: qr/dcWzE-\d+-/...
- windows_install: Failed (test died + timed out)
  # Test died: command 'script -e -c 'bash -x /usr/bin/qvm-create-win...
system_tests_gui_tools@hw7
- qui_widgets_devices: unnamed test (unknown)
- qui_widgets_devices: Failed (test died)
  # Test died: no candidate needle with tag(s) 'qui-devices-dev-opene...

Failed tests

18 failures

system_tests_whonix
- whonix_torbrowser: unnamed test (unknown)
- whonix_torbrowser: Failed (test died)
  # Test died: no candidate needle with tag(s) 'anon-whonix-tor-brows...
system_tests_dispvm
- TC_20_DispVM_debian-12-xfce: test_015_dvm_run_preload_race_more (error)
  raise TimeoutError from exc_val... TimeoutError
- TC_20_DispVM_fedora-41-xfce: test_014_dvm_run_preload_nogui (error + cleanup)
  qubes.exc.QubesValueError: Qube GUI is 'False' and does not support...
- TC_20_DispVM_fedora-41-xfce: test_015_dvm_run_preload_race_more (error + cleanup)
  raise TimeoutError from exc_val... TimeoutError
- TC_20_DispVM_fedora-41-xfce: test_016_dvm_run_preload_race_less (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_017_dvm_run_preload_autostart (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_020_gui_app (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_030_edit_file (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
- TC_20_DispVM_fedora-41-xfce: test_100_open_in_dispvm (failure)
  AssertionError: unexpected selector map entries: {5: SelectorKey(fi...
system_tests_kde_gui_interactive
- gui_keyboard_layout: wait_serial (wait serial expected)
  # wait_serial expected: "echo -e '[Layout]\nLayoutList=us,de' | sud...
- gui_keyboard_layout: Failed (test died)
  # Test died: command 'test "$(cd ~user;ls e1*)" = "$(qvm-run -p wor...
system_tests_qwt_win10_seamless@hw13
- windows_clipboard_and_filecopy: unnamed test (unknown)
- windows_clipboard_and_filecopy: Failed (test died)
  # Test died: no candidate needle with tag(s) 'windows-Edge-address-...
system_tests_qwt_win11@hw13
- windows_install: wait_serial (wait serial expected)
  # wait_serial expected: qr/dcWzE-\d+-/...
- windows_install: Failed (test died + timed out)
  # Test died: command 'script -e -c 'bash -x /usr/bin/qvm-create-win...
system_tests_gui_tools@hw7
- qui_widgets_devices: unnamed test (unknown)
- qui_widgets_devices: Failed (test died)
  # Test died: no candidate needle with tag(s) 'qui-devices-dev-opene...

Fixed failures

Compared to: https://openqa.qubes-os.org/tests/132953#dependencies

14 fixed

system_tests_whonix
- whonixcheck: fail (unknown)
  Whonixcheck for sys-whonix failed...
- whonixcheck: unnamed test (unknown)
system_tests_suspend
- suspend: unnamed test (unknown)
- suspend: Failed (test died)
  # Test died: no candidate needle with tag(s) 'SUSPEND-FAILED' match...
system_tests_basic_vm_qrexec_gui
- TC_20_NonAudio_whonix-gateway-17: test_300_bug_1028_gui_memory_pinning (failure)
  AssertionError: Dom0 window doesn't match VM window content, saved ...
system_tests_qrexec
- TC_00_Qrexec_fedora-41-xfce: test_081_qrexec_service_argument_allow_specific (error)
  subprocess.CalledProcessError: Command '/usr/lib/qubes/qrexec-clien...
system_tests_kde_gui_interactive
- clipboard_and_web: unnamed test (unknown)
- clipboard_and_web: Failed (test died)
  # Test died: no candidate needle with tag(s) 'qubes-website' matche...
- clipboard_and_web: wait_serial (wait serial expected)
  # wait_serial expected: "lspci; echo 2E8vz-\$?-"...
system_tests_guivm_vnc_gui_interactive
- gui_filecopy: unnamed test (unknown)
- gui_filecopy: Failed (test died)
  # Test died: no candidate needle with tag(s) 'files-work' matched...
system_tests_audio
- TC_20_AudioVM_Pulse_whonix-workstation-17: test_252_audio_playback_audiovm_switch_hvm (failure)
  AssertionError: only silence detected, no useful audio data
system_tests_whonix@hw7
- whonixcheck: fail (unknown)
  Whonixcheck for sys-whonix failed...
- whonixcheck: unnamed test (unknown)

Unstable tests

Details

system_tests_update
update2/Failed (1/5 times with errors)
- job 139051 # Test died: command 'script -c 'qubes-vm-update --force-update --l...
system_tests_update@hw1
update2/Failed (1/5 times with errors)
- job 139051 # Test died: command 'script -c 'qubes-vm-update --force-update --l...
system_tests_update@hw7
update2/Failed (1/5 times with errors)
- job 139051 # Test died: command 'script -c 'qubes-vm-update --force-update --l...
system_tests_update@hw13
update2/Failed (1/5 times with errors)
- job 139051 # Test died: command 'script -c 'qubes-vm-update --force-update --l...

Performance Tests

Performance degradation:

15 performance degradations

debian-12-xfce_exec: 8.56 🔺 ( previous job: 7.12, degradation: 120.17%)
fedora-41-xfce_exec-data-duplex: 79.08 🔺 ( previous job: 71.56, degradation: 110.51%)
dom0_root_seq1m_q8t1_read 3:read_bandwidth_kb: 214696.00 :small_red_triangle: ( previous job: 446963.00, degradation: 48.03%)
dom0_root_seq1m_q1t1_read 3:read_bandwidth_kb: 224919.00 :small_red_triangle: ( previous job: 294295.00, degradation: 76.43%)
dom0_varlibqubes_seq1m_q8t1_write 3:write_bandwidth_kb: 141171.00 :small_red_triangle: ( previous job: 250795.00, degradation: 56.29%)
dom0_varlibqubes_rnd4k_q1t1_write 3:write_bandwidth_kb: 3093.00 :small_red_triangle: ( previous job: 4903.00, degradation: 63.08%)
fedora-41-xfce_root_seq1m_q1t1_read 3:read_bandwidth_kb: 271230.00 :small_red_triangle: ( previous job: 318716.00, degradation: 85.10%)
fedora-41-xfce_root_seq1m_q1t1_write 3:write_bandwidth_kb: 39245.00 :small_red_triangle: ( previous job: 87940.00, degradation: 44.63%)
fedora-41-xfce_root_rnd4k_q32t1_write 3:write_bandwidth_kb: 2673.00 :small_red_triangle: ( previous job: 3599.00, degradation: 74.27%)
fedora-41-xfce_private_seq1m_q8t1_write 3:write_bandwidth_kb: 143005.00 :small_red_triangle: ( previous job: 170062.00, degradation: 84.09%)
fedora-41-xfce_private_rnd4k_q32t1_write 3:write_bandwidth_kb: 1473.00 :small_red_triangle: ( previous job: 2215.00, degradation: 66.50%)
fedora-41-xfce_private_rnd4k_q1t1_write 3:write_bandwidth_kb: 795.00 :small_red_triangle: ( previous job: 1130.00, degradation: 70.35%)
fedora-41-xfce_volatile_seq1m_q8t1_write 3:write_bandwidth_kb: 120234.00 :small_red_triangle: ( previous job: 179949.00, degradation: 66.82%)
fedora-41-xfce_volatile_rnd4k_q32t1_write 3:write_bandwidth_kb: 2890.00 :small_red_triangle: ( previous job: 5672.00, degradation: 50.95%)
fedora-41-xfce_volatile_rnd4k_q1t1_write 3:write_bandwidth_kb: 1117.00 :small_red_triangle: ( previous job: 1953.00, degradation: 57.19%)

Remaining performance tests:

41 tests

debian-12-xfce_exec-root: 29.75 🔺 ( previous job: 28.65, degradation: 103.83%)
debian-12-xfce_socket: 8.19 🟢 ( previous job: 8.60, improvement: 95.16%)
debian-12-xfce_socket-root: 7.81 🟢 ( previous job: 8.52, improvement: 91.56%)
debian-12-xfce_exec-data-simplex: 76.07 🔺 ( previous job: 71.62, degradation: 106.21%)
debian-12-xfce_exec-data-duplex: 74.54 🔺 ( previous job: 70.34, degradation: 105.96%)
debian-12-xfce_exec-data-duplex-root: 71.93 🟢 ( previous job: 82.72, improvement: 86.96%)
debian-12-xfce_socket-data-duplex: 147.66 🟢 ( previous job: 156.96, improvement: 94.08%)
fedora-41-xfce_exec: 9.63 🔺 ( previous job: 9.27, degradation: 103.96%)
fedora-41-xfce_exec-root: 59.70 🟢 ( previous job: 61.51, improvement: 97.06%)
fedora-41-xfce_socket: 8.37 🟢 ( previous job: 8.63, improvement: 96.95%)
fedora-41-xfce_socket-root: 8.76 🔺 ( previous job: 8.71, degradation: 100.58%)
fedora-41-xfce_exec-data-simplex: 75.95 🔺 ( previous job: 75.53, degradation: 100.54%)
fedora-41-xfce_exec-data-duplex-root: 94.74 🟢 ( previous job: 109.13, improvement: 86.82%)
fedora-41-xfce_socket-data-duplex: 153.88 🔺 ( previous job: 150.61, degradation: 102.17%)
dom0_root_seq1m_q8t1_write 3:write_bandwidth_kb: 140551.00 :green_circle: ( previous job: 129298.00, improvement: 108.70%)
dom0_root_seq1m_q1t1_write 3:write_bandwidth_kb: 142793.00 :green_circle: ( previous job: 95454.00, improvement: 149.59%)
dom0_root_rnd4k_q32t1_read 3:read_bandwidth_kb: 95102.00 :green_circle: ( previous job: 79803.00, improvement: 119.17%)
dom0_root_rnd4k_q32t1_write 3:write_bandwidth_kb: 7184.00 :green_circle: ( previous job: 6149.00, improvement: 116.83%)
dom0_root_rnd4k_q1t1_read 3:read_bandwidth_kb: 12079.00 :green_circle: ( previous job: 10795.00, improvement: 111.89%)
dom0_root_rnd4k_q1t1_write 3:write_bandwidth_kb: 4642.00 :small_red_triangle: ( previous job: 4826.00, degradation: 96.19%)
dom0_varlibqubes_seq1m_q8t1_read 3:read_bandwidth_kb: 505825.00 :green_circle: ( previous job: 382273.00, improvement: 132.32%)
dom0_varlibqubes_seq1m_q1t1_read 3:read_bandwidth_kb: 443560.00 :green_circle: ( previous job: 437636.00, improvement: 101.35%)
dom0_varlibqubes_seq1m_q1t1_write 3:write_bandwidth_kb: 204187.00 :green_circle: ( previous job: 184752.00, improvement: 110.52%)
dom0_varlibqubes_rnd4k_q32t1_read 3:read_bandwidth_kb: 92496.00 :green_circle: ( previous job: 62195.00, improvement: 148.72%)
dom0_varlibqubes_rnd4k_q32t1_write 3:write_bandwidth_kb: 10526.00 :green_circle: ( previous job: 6479.00, improvement: 162.46%)
dom0_varlibqubes_rnd4k_q1t1_read 3:read_bandwidth_kb: 7759.00 :green_circle: ( previous job: 7669.00, improvement: 101.17%)
fedora-41-xfce_root_seq1m_q8t1_read 3:read_bandwidth_kb: 375295.00 :green_circle: ( previous job: 368309.00, improvement: 101.90%)
fedora-41-xfce_root_seq1m_q8t1_write 3:write_bandwidth_kb: 187051.00 :green_circle: ( previous job: 162081.00, improvement: 115.41%)
fedora-41-xfce_root_rnd4k_q32t1_read 3:read_bandwidth_kb: 86047.00 :green_circle: ( previous job: 82694.00, improvement: 104.05%)
fedora-41-xfce_root_rnd4k_q1t1_read 3:read_bandwidth_kb: 8695.00 :green_circle: ( previous job: 8485.00, improvement: 102.47%)
fedora-41-xfce_root_rnd4k_q1t1_write 3:write_bandwidth_kb: 488.00 :small_red_triangle: ( previous job: 542.00, degradation: 90.04%)
fedora-41-xfce_private_seq1m_q8t1_read 3:read_bandwidth_kb: 377185.00 :green_circle: ( previous job: 373957.00, improvement: 100.86%)
fedora-41-xfce_private_seq1m_q1t1_read 3:read_bandwidth_kb: 343795.00 :green_circle: ( previous job: 334687.00, improvement: 102.72%)
fedora-41-xfce_private_seq1m_q1t1_write 3:write_bandwidth_kb: 87088.00 :green_circle: ( previous job: 61534.00, improvement: 141.53%)
fedora-41-xfce_private_rnd4k_q32t1_read 3:read_bandwidth_kb: 84817.00 :green_circle: ( previous job: 80283.00, improvement: 105.65%)
fedora-41-xfce_private_rnd4k_q1t1_read 3:read_bandwidth_kb: 7690.00 :green_circle: ( previous job: 7540.00, improvement: 101.99%)
fedora-41-xfce_volatile_seq1m_q8t1_read 3:read_bandwidth_kb: 371440.00 :green_circle: ( previous job: 369868.00, improvement: 100.43%)
fedora-41-xfce_volatile_seq1m_q1t1_read 3:read_bandwidth_kb: 311797.00 :small_red_triangle: ( previous job: 324737.00, degradation: 96.02%)
fedora-41-xfce_volatile_seq1m_q1t1_write 3:write_bandwidth_kb: 29757.00 :green_circle: ( previous job: 17567.00, improvement: 169.39%)
fedora-41-xfce_volatile_rnd4k_q32t1_read 3:read_bandwidth_kb: 72455.00 :small_red_triangle: ( previous job: 79021.00, degradation: 91.69%)
fedora-41-xfce_volatile_rnd4k_q1t1_read 3:read_bandwidth_kb: 8489.00 :green_circle: ( previous job: 7867.00, improvement: 107.91%)

qubesadmin part of adding free-form text to each qube for comments, notes, descriptions, remarks, reminders, etc. fixes: QubesOS/qubes-issues#899 requires: QubesOS/qubes-core-admin-client#334

alimirjamali marked this pull request as draft February 16, 2025 17:11

alimirjamali force-pushed the issue-899 branch 2 times, most recently from fa3aa90 to dbce8cc Compare February 17, 2025 09:03

alimirjamali force-pushed the issue-899 branch from dbce8cc to dc029b3 Compare February 26, 2025 11:59

marmarek requested changes Feb 27, 2025

View reviewed changes

Comment thread qubesadmin/vm/__init__.py Outdated

Comment thread qubesadmin/vm/__init__.py Outdated

alimirjamali force-pushed the issue-899 branch 3 times, most recently from 767c9dd to e52e200 Compare May 1, 2025 15:01

alimirjamali force-pushed the issue-899 branch from e52e200 to 44604f7 Compare May 2, 2025 11:30

alimirjamali force-pushed the issue-899 branch 2 times, most recently from 2b98591 to 3e00807 Compare May 2, 2025 17:42

alimirjamali marked this pull request as ready for review May 2, 2025 18:08

alimirjamali requested a review from marmarek May 2, 2025 18:16

Add free-form text to qube for notes, comments, ...

ee39d27

qubesadmin part of adding free-form text to each qube for comments, notes, descriptions, remarks, reminders, etc. fixes: QubesOS/qubes-issues#899 Additional options to skip legacy backup tests or super slow tests

alimirjamali force-pushed the issue-899 branch from 3e00807 to ee39d27 Compare May 21, 2025 13:31

alimirjamali mentioned this pull request May 21, 2025

Add free-form text to qube for notes, comments, ... QubesOS/qubes-manager#406

Merged

marmarek added the openqa-pending label May 21, 2025

marmarek approved these changes May 25, 2025

View reviewed changes

marmarek merged commit 7b6008c into QubesOS:main May 25, 2025
4 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add free-form text to qube for notes, comments, ...#334

Add free-form text to qube for notes, comments, ...#334
marmarek merged 1 commit into
QubesOS:mainfrom
alimirjamali:issue-899

alimirjamali commented Feb 16, 2025

Uh oh!

codecov Bot commented Feb 16, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

alimirjamali commented May 1, 2025

Uh oh!

marmarek commented May 2, 2025

Uh oh!

alimirjamali commented May 2, 2025

Uh oh!

alimirjamali commented May 21, 2025

Uh oh!

qubesos-bot commented May 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

alimirjamali commented Feb 16, 2025

Uh oh!

codecov Bot commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

alimirjamali commented May 1, 2025

Uh oh!

marmarek commented May 2, 2025

Uh oh!

alimirjamali commented May 2, 2025

Uh oh!

alimirjamali commented May 21, 2025

Uh oh!

qubesos-bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

OpenQA test summary

New failures, excluding unstable

Failed tests

Fixed failures

Unstable tests

Performance Tests

Performance degradation:

Remaining performance tests:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Feb 16, 2025 •

edited

Loading

qubesos-bot commented May 22, 2025 •

edited

Loading