Add support for PyQt5 #610

eloquence · 2020-09-04T23:41:27Z

Status

Ready for review

Description of Changes

Fixes #607.

Uses the appropriate Qt version:

Qt4 on Qubes 4.0
Qt5 on Qubes 4.1, or if SDW_UPDATER_QT=5 is set
Qt4 on other operating systems.

Adds PyQt5 to dev-requirements.txt (renamed from test-requirements.txt for consistency with https://github.com/freedomofpress/securedrop-workstation/blob/main/dev-requirements.txt).

NOTE: Once this PR is merged, the Qt5 version of the UI will need to be regenerated along with the Qt4 version every time sdw_updater.ui is modified, using pyuic5.

Test plan

Qubes 4.0

Copy this branch into dom0 in a provisioned Qubes 4.0 SDW development or staging environment
Run the updater via python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater runs as before.

Run the updater via SDW_UPDATER_QT=5 python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater fails to run because Qt 5 is not installed.

Remove the file ~/.securedrop_launcher/sdw-last-updated
Ensure that your system uptime is at least 30 minutes.
Run the notify script via python3 launcher/sdw-notify.py

Observe that the update alert is shown as before.

Qubes 4.1 (nightly)

Copy this branch into dom0 in a provisioned Qubes 4.1-nightly SDW development or staging environment
Run the updater via python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater runs to completion with no graphical errors.

Remove the file ~/.securedrop_launcher/sdw-last-updated
Ensure that your system uptime is at least 30 minutes.
Run the notify script via python3 launcher/sdw-notify.py

Observe that the update alert is shown.

Development environment

Activate a virtualenv and install the Qt5 requirements via pip install --require-hashes -r launcher/qt5-requirements.txt
Run the updater via SDW_UPDATER_QT=5 python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater starts (you won't be able to run it), and that your terminal indicates that Qt5 is used.

Remove the file ~/.securedrop_launcher/sdw-last-updated
Ensure that your system uptime is at least 30 minutes.
Run the notify script via SDW_UPDATER_QT=5 python3 launcher/sdw-notify.py

Observe that the update alert is shown. (NB: The notifier checks for process contention with make, so if nothing appears, that may be because you have a dev env running -- check sdw-notify.log in ~/.securedrop_launcher if in doubt)

emkll

Thanks @eloquence, tested in both Qubes 4.1 and 4.0.3, and very pleased to report that the changes changes work as expected 🎉

Changes work well in Qubes 4.0. In 4.1 I did observe a popup (see below) , but these changes are very likely unrelated to the changes introduced here. I will add a note in #600

A couple of comments inline

Test plan

Qubes 4.0

Copy this branch into dom0 in a provisioned Qubes 4.0 SDW development or staging environment
Run the updater via python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater runs as before.

Run the updater via SDW_UPDATER_QT=5 python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater fails to run because Qt 5 is not installed.

Remove the file ~/.securedrop_launcher/sdw-last-updated
Ensure that your system uptime is at least 30 minutes.
Run the notify script via python3 launcher/sdw-notify.py

Observe that the update alert is shown as before.

Qubes 4.1 (nightly)

Copy this branch into dom0 in a provisioned Qubes 4.1-nightly SDW development or staging environment
Run the updater via python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater runs to completion with no graphical errors.

Remove the file ~/.securedrop_launcher/sdw-last-updated
Ensure that your system uptime is at least 30 minutes.
Run the notify script via python3 launcher/sdw-notify.py

Observe that the update alert is shown.

Development environment

Activate a virtualenv and install the Qt5 requirements via pip install --require-hashes -r launcher/qt5-requirements.txt
Run the updater via SDW_UPDATER_QT=5 python3 launcher/sdw-launcher.py --skip-delta 0

Observe that the updater starts (you won't be able to run it), and that your terminal indicates that Qt5 is used.

Remove the file ~/.securedrop_launcher/sdw-last-updated
Ensure that your system uptime is at least 30 minutes.
Run the notify script via SDW_UPDATER_QT=5 python3 launcher/sdw-notify.py

Observe that the update alert is shown. (NB: The notifier checks for process contention with make, so if nothing appears, that may be because you have a dev env running -- check sdw-notify.log in ~/.securedrop_launcher if in doubt)

emkll · 2020-09-09T20:47:06Z

launcher/README.md

+Activate a virtualenv and intall the requirements using the following
+command:
+
+pip install --require-hashes -r qt5-requirements.txt


are these requirements strictly required here? In my dev vm (Debian 10) I can run the launcher with QT4 and QT5 outside a virtualenv with no dependencies, using system-level qt packages. Is there a reason we should treat qt5 as a special case and track requirements ?

The main reason I think this may make sense is so that we all use a predictable version of PyQt during development, with a defined hash, which could be important during debugging. (For now it will fetch the same version as we use with securedrop-client, but ideally it should match whatever is shipped with Qubes 4.1.) This was not an option for PyQt4, which is no longer available via pypi.org, but it is an option for PyQt5.

We could consolidate test-requirements.txt and qt5-requirements.txt into a single dev-requirements.txt.

Since we aren't shipping/packaging/locking the PyQT dependency in dom0, I don't see the value in locking for development environment consistency (especially since we are using OS level packages)
However, locking for testing consistency makes sense here (since it will run both on developer machines but also in CI). Adding it to test-requirements (and optionally renaming, no strong preference here) sounds like a good approach to me

I've refactored accordingly. I cheated by not updating all requirements but only inserting the up-to-date PyQt5 requirements into dev-requirements.txt. (Updating all requirements will pull in a new version of black that'll require formatting changes.) Once this PR lands I think it'd be good idea to do a requirements refresh for both preflight updater & main repo requirements.

emkll · 2020-09-09T20:49:13Z

launcher/sdw_util/Util.py

+                except ValueError:
+                    continue


pytest is telling me that these two lines don't have test coverage

I'll add a bad-file-format fixture for this case.

Done in fd6b824

Also adds PyQt5 to shared requirements file and renames it to dev-requirements.txt for consistency.

emkll

Thanks for the changes @eloquence . Successfully went though another test plan in both 4.0.3 (Fedora 25) and 4.1 (Fedora 32) using RPMs (opened #611 to track F32 build issues). I didn't see the error I initially reported, but we are tracking that issue separately anyways.
Given the changes here and the comprehensive test coverage, the impact to the Fedora 25 logic is very minimal.

emkll · 2020-09-11T19:01:00Z

launcher/sdw_updater_gui/UpdaterAppUiQt5.py

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-


For packaging, this file is handled by https://github.com/freedomofpress/securedrop-workstation/blob/main/rpm-build/SPECS/securedrop-workstation-dom0-config.spec#L82-L83

Add support for PyQt5

eloquence force-pushed the 607-qt5 branch from 88ab830 to 8567d8b Compare September 4, 2020 23:42

eloquence mentioned this pull request Sep 4, 2020

Port preflight updater to Qt5 #607

Closed

eloquence added this to Ready for Review in SecureDrop Team Board Sep 4, 2020

eloquence marked this pull request as ready for review September 9, 2020 01:11

emkll moved this from Ready for Review to Under Review in SecureDrop Team Board Sep 9, 2020

emkll reviewed Sep 9, 2020

View reviewed changes

emkll mentioned this pull request Sep 9, 2020

Support for Qubes 4.1 #600

Closed

eloquence force-pushed the 607-qt5 branch from 8c87234 to 7e4b70a Compare September 9, 2020 22:38

eloquence moved this from Under Review to Ready for Review in SecureDrop Team Board Sep 9, 2020

Add support for PyQt5 to updater, notifier

1b4ad5f

Also adds PyQt5 to shared requirements file and renames it to dev-requirements.txt for consistency.

eloquence force-pushed the 607-qt5 branch from 7e4b70a to 1b4ad5f Compare September 9, 2020 22:54

emkll moved this from Ready for Review to Under Review in SecureDrop Team Board Sep 10, 2020

emkll approved these changes Sep 11, 2020

View reviewed changes

emkll merged commit b180a5a into main Sep 11, 2020

SecureDrop Team Board automation moved this from Under Review to Done Sep 11, 2020

emkll deleted the 607-qt5 branch September 11, 2020 19:12

conorsch mentioned this pull request Jan 3, 2022

Check for network connection before running preflight updater #743

Merged

6 tasks

cfm pushed a commit that referenced this pull request Apr 1, 2024

Merge pull request #610 from freedomofpress/607-qt5

7d2c00e

Add support for PyQt5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for PyQt5 #610

Add support for PyQt5 #610

eloquence commented Sep 4, 2020 •

edited

Loading

emkll left a comment

emkll Sep 9, 2020

eloquence Sep 9, 2020

emkll Sep 9, 2020

eloquence Sep 9, 2020 •

edited

Loading

emkll Sep 9, 2020

eloquence Sep 9, 2020

eloquence Sep 9, 2020

emkll left a comment •

edited

Loading

emkll Sep 11, 2020

Add support for PyQt5 #610

Add support for PyQt5 #610

Conversation

eloquence commented Sep 4, 2020 • edited Loading

Status

Description of Changes

Test plan

Qubes 4.0

Qubes 4.1 (nightly)

Development environment

emkll left a comment

Choose a reason for hiding this comment

Test plan

Qubes 4.0

Qubes 4.1 (nightly)

Development environment

emkll Sep 9, 2020

Choose a reason for hiding this comment

eloquence Sep 9, 2020

Choose a reason for hiding this comment

emkll Sep 9, 2020

Choose a reason for hiding this comment

eloquence Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

emkll Sep 9, 2020

Choose a reason for hiding this comment

eloquence Sep 9, 2020

Choose a reason for hiding this comment

eloquence Sep 9, 2020

Choose a reason for hiding this comment

emkll left a comment • edited Loading

Choose a reason for hiding this comment

emkll Sep 11, 2020

Choose a reason for hiding this comment

eloquence commented Sep 4, 2020 •

edited

Loading

eloquence Sep 9, 2020 •

edited

Loading

emkll left a comment •

edited

Loading