Add test case to trigger the reclaim_space task #14397

vsedmik · 2024-03-13T16:57:55Z

Problem Statement

A test case (and nailgun support) to trigger the Reclaim space task was missing. Also a BZ complained about wrong endpoint being referenced in apidoc.

Solution

This PR adds one.

PRT test Cases example

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py -k 'reclaim_space'
nailgun: 1111

vsedmik · 2024-03-13T16:58:03Z

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py -k 'reclaim_space'
nailgun: 1111

Satellite-QE · 2024-03-13T17:44:36Z

PRT Result

Build Number: 6061
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/api/test_capsulecontent.py -k reclaim_space --external-logging
Test Result : =========== 1 failed, 21 deselected, 1 warning in 1811.44s (0:30:11) ===========

vsedmik · 2024-03-13T18:48:30Z

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py -k 'content_library_sync or reclaim_space'
nailgun: 1111

vsedmik · 2024-03-13T20:09:59Z

"trigger": "test-robottelo"
"pytest": "tests/foreman/api/test_capsulecontent.py -k 'content_library_sync or reclaim_space'"
"nailgun": "1111"

Satellite-QE · 2024-03-13T20:43:01Z

PRT Result

Build Number: 6065
Build Status: SUCCESS
PRT Comment: pytest /opt/app-root/src/robottelo/tests/foreman -v -m build_sanity --external-logging
Test Result : ======== 11 passed, 6091 deselected, 81 warnings in 1571.33s (0:26:11) =========

vsedmik · 2024-03-13T20:56:28Z

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space
nailgun: 1111

Satellite-QE · 2024-03-13T21:25:55Z

PRT Result

Build Number: 6067
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space --external-logging
Test Result : ================= 2 passed, 45 warnings in 1400.86s (0:23:20) ==================

vsedmik · 2024-03-13T21:33:56Z

Okay so the first PRT fail was due to reclaim_space run against a blank/unsynced capsule. After some struggle with test collection and PRT job reporting back to GH the final run triggered and reported correctly.

damoore044

nice work!

tests/foreman/api/test_capsulecontent.py

ogajduse

co-reviewed with @jameerpathan111.

The intention of the test is good, but I would choose different steps to achieve the same.

tests/foreman/api/test_capsulecontent.py

vsedmik · 2024-03-15T10:43:58Z

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space
nailgun: 1111

Satellite-QE · 2024-03-15T11:16:51Z

PRT Result

Build Number: 6080
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space --external-logging
Test Result : ============ 1 failed, 1 passed, 42 warnings in 1483.41s (0:24:43) =============

Satellite-QE · 2024-03-15T12:27:59Z

PRT Result

Build Number: 6081
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space --external-logging
Test Result : ============ 1 failed, 1 passed, 41 warnings in 1551.28s (0:25:51) =============

vsedmik · 2024-03-15T13:29:44Z

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space
nailgun: 1111

Satellite-QE · 2024-03-15T14:15:32Z

PRT Result

Build Number: 6087
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space --external-logging
Test Result : ================= 2 passed, 40 warnings in 2326.98s (0:38:46) ==================

ogajduse

Nice work, @vsedmik!
There is only one blocking comment - verify_ssl should be parametrized by settings.

robottelo/hosts.py

ogajduse · 2024-03-18T11:22:04Z

robottelo/hosts.py

+    @property
+    def apidoc(self):
+        """Provide Satellite's apidoc via apypie"""
+        if not self._apidoc:
+            self._apidoc = apypie.Api(
+                uri=self.url,
+                username=settings.server.admin_username,
+                password=settings.server.admin_password,
+                api_version=2,
+                verify_ssl=False,
+            ).apidoc
+        return self._apidoc


@JacobCallahan Do you see any benefit in making it a @cached_property instead of the current design?

tests/foreman/api/test_capsulecontent.py

vsedmik · 2024-03-19T09:46:06Z

trigger: test-robottelo
pytest: tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space
nailgun: 1111

Satellite-QE · 2024-03-19T10:16:00Z

PRT Result

Build Number: 6122
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_uploaded_content_library_sync tests/foreman/api/test_capsulecontent.py::TestCapsuleContentManagement::test_positive_reclaim_space --external-logging
Test Result : ================= 2 passed, 41 warnings in 1445.32s (0:24:05) ==================

pondrejk · 2024-03-19T16:34:29Z

tests/foreman/api/test_capsulecontent.py

+        ), 'Unexpected task triggered'
+        assert 'success' in task['result'], 'Reclaim task did not succeed'
+
+        # Check the apidoc references the correct endpoint


I like the test up to this line, I know the apidoc check responds to the bz, but I'm not convinced it really makes sense to check the apidoc for one specific endpoint. I mean, how likely it is that the same problem reappears at the same endpoint? If it re-appears on a different one we won't catch it anyway. Maybe this would warrant a more general discussion about how (and if) we want to tackle apidoc issues like this one. My hunch is that this should be a case for upstream unit tests.

Yup. The primary goal was to add some coverage for reclaim_space functionality and the following lines were added just for the case when some reviewer comes and says "but that BZ talks about wrong apidoc, where is it checked".
We can remove it after some generic test for entire apidoc is added? Which would be probably handled by the team owning the API component.

ogajduse

ACK, changes are fine by me. I will leave the merge up to @pondrejk if they get to a conclusion in the philosophical debate about customer case automation.

lhellebr · 2024-03-25T15:55:17Z

Should this verify some space has actually been reclaimed?

lhellebr · 2024-03-25T15:55:23Z

Related: #14425

vsedmik · 2024-03-26T08:23:02Z

Should this verify some space has actually been reclaimed?

Replied here already #14397 (comment)

I can imagine two scenarios where this is tested

Function-scoped capsule (to avoid interference with other tests). Cons - yet another VM checked out and set up just for this case, unusable for n_minus testing.
Add some "unusual" repo syncing. Cons - here you rely that no one adds a test to sync the same repo with immediate dwl policy in the future, which would break the assertion.

pondrejk

talked to @vsedmik offline, we agreed the best way forward atm is to merge it as is

* Add test case to trigger the reclaim_space task * Use apypie for apidoc parsing * Address improvement suggestions, rebase (cherry picked from commit ac4b0cf)

Add test case to trigger the reclaim_space task (#14397) * Add test case to trigger the reclaim_space task * Use apypie for apidoc parsing * Address improvement suggestions, rebase (cherry picked from commit ac4b0cf) Co-authored-by: vsedmik <[email protected]>

* Add test case to trigger the reclaim_space task * Use apypie for apidoc parsing * Address improvement suggestions, rebase

vsedmik added CherryPick PR needs CherryPick to previous branches 6.15.z Introduced in or relating directly to Satellite 6.15 labels Mar 13, 2024

vsedmik self-assigned this Mar 13, 2024

vsedmik requested a review from a team as a code owner March 13, 2024 16:57

vsedmik mentioned this pull request Mar 13, 2024

Add support for the reclaim_space endpoint SatelliteQE/nailgun#1111

Merged

Satellite-QE added the PRT-Failed Indicates that latest PRT run is failed for the PR label Mar 13, 2024

Satellite-QE added PRT-Passed Indicates that latest PRT run is passed for the PR and removed PRT-Failed Indicates that latest PRT run is failed for the PR labels Mar 13, 2024

damoore044 approved these changes Mar 13, 2024

View reviewed changes

vijaysawant reviewed Mar 14, 2024

View reviewed changes

tests/foreman/api/test_capsulecontent.py Show resolved Hide resolved

vijaysawant approved these changes Mar 14, 2024

View reviewed changes

tests/foreman/api/test_capsulecontent.py Show resolved Hide resolved

ogajduse requested changes Mar 14, 2024

View reviewed changes

tests/foreman/api/test_capsulecontent.py Outdated Show resolved Hide resolved

jameerpathan111 reviewed Mar 14, 2024

View reviewed changes

tests/foreman/api/test_capsulecontent.py Show resolved Hide resolved

Satellite-QE mentioned this pull request Mar 14, 2024

[6.15.z] Add support for the reclaim_space endpoint SatelliteQE/nailgun#1112

Merged

vsedmik force-pushed the reclaim-space branch from 354be8a to a292c78 Compare March 15, 2024 10:42

vsedmik requested a review from a team as a code owner March 15, 2024 10:42

vsedmik requested a review from ogajduse March 15, 2024 10:43

Satellite-QE added PRT-Failed Indicates that latest PRT run is failed for the PR and removed PRT-Passed Indicates that latest PRT run is passed for the PR labels Mar 15, 2024

vsedmik force-pushed the reclaim-space branch from a292c78 to 70c0f69 Compare March 15, 2024 11:56

vsedmik force-pushed the reclaim-space branch from 70c0f69 to 7a401b4 Compare March 15, 2024 13:17

Satellite-QE added PRT-Passed Indicates that latest PRT run is passed for the PR and removed PRT-Failed Indicates that latest PRT run is failed for the PR labels Mar 15, 2024

ogajduse requested changes Mar 18, 2024

View reviewed changes

vsedmik added 3 commits March 19, 2024 10:19

Add test case to trigger the reclaim_space task

a8e3dee

Use apypie for apidoc parsing

16dc975

Address improvement suggestions, rebase

d1a6a97

vsedmik force-pushed the reclaim-space branch from 7a401b4 to d1a6a97 Compare March 19, 2024 09:44

jameerpathan111 approved these changes Mar 19, 2024

View reviewed changes

pondrejk reviewed Mar 19, 2024

View reviewed changes

vsedmik requested a review from ogajduse March 19, 2024 19:41

ogajduse approved these changes Mar 20, 2024

View reviewed changes

lhellebr mentioned this pull request Mar 25, 2024

CC Automation - reclaim-space CLI test #14425

Merged

pondrejk approved these changes Mar 27, 2024

View reviewed changes

pondrejk merged commit ac4b0cf into SatelliteQE:master Mar 27, 2024
7 of 8 checks passed

Satellite-QE mentioned this pull request Mar 27, 2024

[6.15.z] Add test case to trigger the reclaim_space task #14541

Merged

shweta83 pushed a commit to shweta83/robottelo that referenced this pull request Apr 10, 2024

Add test case to trigger the reclaim_space task (SatelliteQE#14397)

ba7f08a

* Add test case to trigger the reclaim_space task * Use apypie for apidoc parsing * Address improvement suggestions, rebase

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add test case to trigger the reclaim_space task #14397

Add test case to trigger the reclaim_space task #14397

vsedmik commented Mar 13, 2024

vsedmik commented Mar 13, 2024

Satellite-QE commented Mar 13, 2024

vsedmik commented Mar 13, 2024

vsedmik commented Mar 13, 2024

Satellite-QE commented Mar 13, 2024

vsedmik commented Mar 13, 2024

Satellite-QE commented Mar 13, 2024

vsedmik commented Mar 13, 2024

damoore044 left a comment

ogajduse left a comment

vsedmik commented Mar 15, 2024

Satellite-QE commented Mar 15, 2024

Satellite-QE commented Mar 15, 2024

vsedmik commented Mar 15, 2024

Satellite-QE commented Mar 15, 2024

ogajduse left a comment

ogajduse Mar 18, 2024

vsedmik commented Mar 19, 2024

Satellite-QE commented Mar 19, 2024

pondrejk Mar 19, 2024

vsedmik Mar 19, 2024

ogajduse left a comment •

edited

Loading

lhellebr commented Mar 25, 2024

lhellebr commented Mar 25, 2024

vsedmik commented Mar 26, 2024

pondrejk left a comment

Add test case to trigger the reclaim_space task #14397

Add test case to trigger the reclaim_space task #14397

Conversation

vsedmik commented Mar 13, 2024

Problem Statement

Solution

PRT test Cases example

vsedmik commented Mar 13, 2024

Satellite-QE commented Mar 13, 2024

vsedmik commented Mar 13, 2024

vsedmik commented Mar 13, 2024

Satellite-QE commented Mar 13, 2024

vsedmik commented Mar 13, 2024

Satellite-QE commented Mar 13, 2024

vsedmik commented Mar 13, 2024

damoore044 left a comment

Choose a reason for hiding this comment

ogajduse left a comment

Choose a reason for hiding this comment

vsedmik commented Mar 15, 2024

Satellite-QE commented Mar 15, 2024

Satellite-QE commented Mar 15, 2024

vsedmik commented Mar 15, 2024

Satellite-QE commented Mar 15, 2024

ogajduse left a comment

Choose a reason for hiding this comment

ogajduse Mar 18, 2024

Choose a reason for hiding this comment

vsedmik commented Mar 19, 2024

Satellite-QE commented Mar 19, 2024

pondrejk Mar 19, 2024

Choose a reason for hiding this comment

vsedmik Mar 19, 2024

Choose a reason for hiding this comment

ogajduse left a comment • edited Loading

Choose a reason for hiding this comment

lhellebr commented Mar 25, 2024

lhellebr commented Mar 25, 2024

vsedmik commented Mar 26, 2024

pondrejk left a comment

Choose a reason for hiding this comment

ogajduse left a comment •

edited

Loading