Purge option for RepoEntitlements #2763

renanrodrigo · 2023-09-29T08:43:50Z

This is intended to land after #2744 - it contains the commits from there and will be rebased on whatever lands on that side.

still missing: integration tests

Why is this needed?

This PR solves all of our problems because it implements the purge option when disabling services involving apt repositories. This removes/downgrades all the packages from that specific source.

Test Steps

Integration tests still to come - but generally run disable for all services with --purge and see what happens :D

Checklist

I have updated or added any unit tests accordingly
I have updated or added any integration tests accordingly
Changes here need to be documented, and this was done in:

Does this PR require extra reviews?

Yes
No

github-actions · 2023-09-29T08:44:06Z

Jira: This PR is not related to a Jira item. (The PR title does not include a SC-#### reference)

GitHub Issues: No GitHub issues are fixed by this PR. (No commits have Fixes: #### references)

Launchpad Bugs: No Launchpad bugs are fixed by this PR. (No commits have LP: #### references)

Documentation: The changes in this PR do require documentation changes, but those were not addressed yet.

👍 this comment to confirm that this is correct.

lucasmoura

I still need to review this more carefully, but these is the initial look

uaclient/entitlements/base.py

uaclient/entitlements/repo.py

lucasmoura

Also, how should we treat reboot here ? We will always say to the user that we need a reboot after running the purge operation or should we check after each step to see if a package needs a reboot to list to the user which ones are causing the reboot operation

uaclient/entitlements/repo.py

uaclient/util.py

uaclient/apt.py

uaclient/messages/__init__.py

orndorffgrant · 2023-10-02T17:00:18Z

uaclient/entitlements/repo.py

+        if not self.origin and self.purge:
+            return (
+                False,
+                CanDisableFailure(
+                    CanDisableFailureReason.NO_PURGE_WITHOUT_ORIGIN,
+                    messages.E_REPO_PURGE_FAIL_NO_ORIGIN.format(
+                        entitlement_name=self.title, title=self.title
+                    ),
+                ),
+            )


This is an error message for a bug if we, the developers, introduce a repo-entitlement without an origin. I wish we could structure the code in such a way that this is so unlikely as to not deserve a user-facing error message. But this is probably the right thing to do, I'm just complaining

uaclient/messages/__init__.py

uaclient/system.py

uaclient/messages/__init__.py

uaclient/entitlements/repo.py

renanrodrigo · 2023-10-02T20:23:53Z

Also we can add a warning telling this feature is experimental. We have many warnings, but this one should appear everywhere regardless.

uaclient/entitlements/repo.py

lucasmoura

I have tested this feature and it is working as expected. Just have a tiny nit, but overall LGTM

The "Origin" field in the apt metadata is what we use to identify whether a specific version for a package is part of what a service provides. Signed-off-by: Renan Rodrigo <[email protected]>

Signed-off-by: Renan Rodrigo <[email protected]>

This may exclude specific origins, and will be used in filtering which packages to remove and which packages to downgrade when purging RepoEntitlements Signed-off-by: Renan Rodrigo <[email protected]>

Signed-off-by: Renan Rodrigo <[email protected]>

this mimics what apt does, and enables us to clearly identify package lists in bigger chunks of text Signed-off-by: Renan Rodrigo <[email protected]>

perform_disable will check for the 'purge' flag, warn the user about the changed/removed packages, and perform the operations Signed-off-by: Renan Rodrigo <[email protected]>

Currently all RepoEntitlements have origins set, and thus can be purged based on that origin. If it happens that origin is not set, we cannot purge, and we block on can_disable. Signed-off-by: Renan Rodrigo <[email protected]>

Signed-off-by: Renan Rodrigo <[email protected]>

If a kernel package is part of the removal and we cannot detect any other Ubuntu kernel, block the operation. Otherwise, prompt the user. Signed-off-by: Renan Rodrigo <[email protected]>

Those messages indicate that packages will not be uninstalled Signed-off-by: Renan Rodrigo <[email protected]>

Signed-off-by: Renan Rodrigo <[email protected]>

renanrodrigo · 2023-10-04T01:37:49Z

Rebased.
The failing tests are related to fips-preview on focal mostly - those can be sorted out before release verification, as the behavior will change based on contract server changes.

renanrodrigo force-pushed the purge-repo-entitlements branch 2 times, most recently from 9eab136 to d7d4c4b Compare September 29, 2023 15:02

lucasmoura reviewed Sep 29, 2023

View reviewed changes

uaclient/entitlements/base.py Show resolved Hide resolved

uaclient/entitlements/repo.py Outdated Show resolved Hide resolved

lucasmoura reviewed Sep 30, 2023

View reviewed changes

uaclient/entitlements/repo.py Show resolved Hide resolved

uaclient/entitlements/repo.py Outdated Show resolved Hide resolved

uaclient/entitlements/repo.py Show resolved Hide resolved

uaclient/util.py Outdated Show resolved Hide resolved

uaclient/apt.py Show resolved Hide resolved

renanrodrigo force-pushed the purge-repo-entitlements branch 3 times, most recently from 50abbd5 to ceeb745 Compare October 2, 2023 16:29

orndorffgrant reviewed Oct 2, 2023

View reviewed changes

uaclient/messages/__init__.py Outdated Show resolved Hide resolved

orndorffgrant reviewed Oct 2, 2023

View reviewed changes

uaclient/messages/__init__.py Outdated Show resolved Hide resolved

orndorffgrant reviewed Oct 2, 2023

View reviewed changes

uaclient/system.py Show resolved Hide resolved

orndorffgrant reviewed Oct 2, 2023

View reviewed changes

uaclient/messages/__init__.py Outdated Show resolved Hide resolved

renanrodrigo force-pushed the purge-repo-entitlements branch from ceeb745 to 90b6090 Compare October 2, 2023 17:39

renanrodrigo added the next label Oct 2, 2023

renanrodrigo marked this pull request as ready for review October 2, 2023 18:54

renanrodrigo changed the title ~~WIP: Purge option for RepoEntitlements~~ Purge option for RepoEntitlements Oct 2, 2023

renanrodrigo force-pushed the purge-repo-entitlements branch from 43be049 to bc9ee25 Compare October 2, 2023 18:56

orndorffgrant reviewed Oct 2, 2023

View reviewed changes

uaclient/entitlements/repo.py Outdated Show resolved Hide resolved

renanrodrigo force-pushed the purge-repo-entitlements branch 2 times, most recently from 9376e7a to a44fbda Compare October 3, 2023 02:10

lucasmoura reviewed Oct 3, 2023

View reviewed changes

uaclient/entitlements/repo.py Show resolved Hide resolved

lucasmoura approved these changes Oct 3, 2023

View reviewed changes

orndorffgrant approved these changes Oct 3, 2023

View reviewed changes

renanrodrigo added 5 commits October 3, 2023 17:38

entitlements: make sure RepoEntitlements have origins defined

1e7067a

The "Origin" field in the apt metadata is what we use to identify whether a specific version for a package is part of what a service provides. Signed-off-by: Renan Rodrigo <[email protected]>

apt: add functionality to query packages by origin

8a6f7ed

Signed-off-by: Renan Rodrigo <[email protected]>

apt: add functionality to look for alternative versions

638d9b5

This may exclude specific origins, and will be used in filtering which packages to remove and which packages to downgrade when purging RepoEntitlements Signed-off-by: Renan Rodrigo <[email protected]>

chore: move print_package_list function to util.py

9c54af8

Signed-off-by: Renan Rodrigo <[email protected]>

fix: print two empty whitespaces when listing packages

207ef0d

this mimics what apt does, and enables us to clearly identify package lists in bigger chunks of text Signed-off-by: Renan Rodrigo <[email protected]>

renanrodrigo added 8 commits October 3, 2023 17:38

repoentitlement: implement basic purge functionality

72983fc

perform_disable will check for the 'purge' flag, warn the user about the changed/removed packages, and perform the operations Signed-off-by: Renan Rodrigo <[email protected]>

cli: add --purge option to the disable command

9b3139d

Signed-off-by: Renan Rodrigo <[email protected]>

repoentitlement: check for kernels when disabling with --purge

37dcf73

If a kernel package is part of the removal and we cannot detect any other Ubuntu kernel, block the operation. Otherwise, prompt the user. Signed-off-by: Renan Rodrigo <[email protected]>

disable: don't show pre-disable messages when --purge is used

564e73b

Those messages indicate that packages will not be uninstalled Signed-off-by: Renan Rodrigo <[email protected]>

messages: add gettext to new purge messages

8de34b2

Signed-off-by: Renan Rodrigo <[email protected]>

disable: messages to warn that --purge is experimental

5d46ac2

Signed-off-by: Renan Rodrigo <[email protected]>

po: run tools/update-pos.sh

48ab85c

Signed-off-by: Renan Rodrigo <[email protected]>

renanrodrigo force-pushed the purge-repo-entitlements branch from a44fbda to 48ab85c Compare October 3, 2023 20:44

renanrodrigo merged commit 1a05746 into main Oct 4, 2023
21 of 23 checks passed

renanrodrigo deleted the purge-repo-entitlements branch October 4, 2023 01:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Purge option for RepoEntitlements #2763

Purge option for RepoEntitlements #2763

renanrodrigo commented Sep 29, 2023 •

edited

Loading

github-actions bot commented Sep 29, 2023 •

edited

Loading

lucasmoura left a comment

lucasmoura left a comment

orndorffgrant Oct 2, 2023

renanrodrigo commented Oct 2, 2023

lucasmoura left a comment

renanrodrigo commented Oct 4, 2023

Purge option for RepoEntitlements #2763

Purge option for RepoEntitlements #2763

Conversation

renanrodrigo commented Sep 29, 2023 • edited Loading

Why is this needed?

Test Steps

Checklist

Does this PR require extra reviews?

github-actions bot commented Sep 29, 2023 • edited Loading

lucasmoura left a comment

Choose a reason for hiding this comment

lucasmoura left a comment

Choose a reason for hiding this comment

orndorffgrant Oct 2, 2023

Choose a reason for hiding this comment

renanrodrigo commented Oct 2, 2023

lucasmoura left a comment

Choose a reason for hiding this comment

renanrodrigo commented Oct 4, 2023

renanrodrigo commented Sep 29, 2023 •

edited

Loading

github-actions bot commented Sep 29, 2023 •

edited

Loading