Fix: Transient IT test_snapshot_listing fails in anvilbox (#5096) #6919

achave11-ucsc · 2025-02-20T17:34:21Z

Connected issues: #5096

Checklist

Author

PR is a draft
Target branch is develop
Name of PR branch matches issues/<GitHub handle of author>/<issue#>-<slug>
On ZenHub, PR is connected to all issues it (partially) resolves
PR description links to connected issues
PR title matches¹ that of a connected issue _{or comment in PR explains why they're different}
PR title references all connected issues
For each connected issue, there is at least one commit whose title references that issue

¹ when the issue title describes a problem, the corresponding PR
title is Fix: followed by the issue title

Author (partiality)

Added p tag to titles of partial commits
This PR is labeled partial _{or completely resolves all connected issues}
This PR partially resolves each of the connected issues _{or does not have the partial label}

Author (chains)

This PR is blocked by previous PR in the chain _{or is not chained to another PR}
The blocking PR is labeled base _{or this PR is not chained to another PR}
This PR is labeled chained _{or is not chained to another PR}

Author (reindex, API changes)

Added r tag to commit title _{or the changes introduced by this PR will not require reindexing of any deployment}
This PR is labeled reindex:dev _{or the changes introduced by it will not require reindexing of dev}
This PR is labeled reindex:anvildev _{or the changes introduced by it will not require reindexing of anvildev}
This PR is labeled reindex:anvilprod _{or the changes introduced by it will not require reindexing of anvilprod}
This PR is labeled reindex:prod _{or the changes introduced by it will not require reindexing of prod}
This PR is labeled reindex:partial and its description documents the specific reindexing procedure for dev, anvildev, anvilprod and prod _{or requires a full reindex or carries none of the labels reindex:dev, reindex:anvildev, reindex:anvilprod and reindex:prod}
This PR and its connected issues are labeled API _{or this PR does not modify a REST API}
Added a (A) tag to commit title for backwards (in)compatible changes _{or this PR does not modify a REST API}
Updated REST API version number in app.py _{or this PR does not modify a REST API}

Author (upgrading deployments)

Ran make docker_images.json and committed the resulting changes _{or this PR does not modify azul_docker_images, or any other variables referenced in the definition of that variable}
Documented upgrading of deployments in UPGRADING.rst _{or this PR does not require upgrading deployments}
Added u tag to commit title _{or this PR does not require upgrading deployments}
This PR is labeled upgrade _{or does not require upgrading deployments}
This PR is labeled deploy:shared _{or does not modify docker_images.json, and does not require deploying the shared component for any other reason}
This PR is labeled deploy:gitlab _{or does not require deploying the gitlab component}
This PR is labeled deploy:runner _{or does not require deploying the runner image}

Author (hotfixes)

Added F tag to main commit title _{or this PR does not include permanent fix for a temporary hotfix}
Reverted the temporary hotfixes for any connected issues _{or the none of the stable branches (anvilprod and prod) have temporary hotfixes for any of the issues connected to this PR}

Author (before every review)

Rebased PR branch on develop, squashed old fixups
Ran make requirements_update _{or this PR does not modify requirements*.txt, common.mk, Makefile and Dockerfile}
Added R tag to commit title _{or this PR does not modify requirements*.txt}
This PR is labeled reqs _{or does not modify requirements*.txt}
make integration_test passes in personal deployment _{or this PR does not modify functionality that could affect the IT outcome}

Peer reviewer (after approval)

PR is not a draft
Ticket is in Review requested column
PR is awaiting requested review from system administrator
PR is assigned to only the system administrator

System administrator (after approval)

Actually approved the PR
Labeled connected issues as demo or no demo
Commented on connected issues about demo expectations _{or all connected issues are labeled no demo}
Decided if PR can be labeled no sandbox
A comment to this PR details the completed security design review
PR title is appropriate as title of merge commit
N reviews label is accurate
Moved connected issues to Approved column
PR is assigned to only the operator

Operator (before pushing merge the commit)

System administrator

Background migrations for dev.gitlab are complete _{or this PR is not labeled deploy:gitlab}
Background migrations for anvildev.gitlab are complete _{or this PR is not labeled deploy:gitlab}
PR is assigned to only the operator

Operator (before pushing merge the commit)

Operator (chain shortening)

Changed the target branch of the blocked PR to develop _{or this PR is not labeled base}
Removed the chained label from the blocked PR _{or this PR is not labeled base}
Removed the blocking relationship from the blocked PR _{or this PR is not labeled base}
Removed the base label from this PR _{or this PR is not labeled base}

Operator (after pushing the merge commit)

Operator (reindex)

Operator

Propagated the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels to the next promotion PRs _{or this PR carries none of these labels}
Propagated any specific instructions related to the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels, from the description of this PR to that of the next promotion PRs _{or this PR carries none of these labels}
PR is assigned to no one

Shorthand for review comments

L line is too long
W line wrapping is wrong
Q bad quotes
F other formatting problem

codecov · 2025-02-20T17:58:27Z

Codecov Report

Attention: Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.

Project coverage is 85.66%. Comparing base (272cf3b) to head (200a979).

Files with missing lines	Patch %	Lines
test/integration_test.py	0.00%	9 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6919      +/-   ##
===========================================
- Coverage    85.68%   85.66%   -0.02%     
===========================================
  Files          148      148              
  Lines        21562    21566       +4     
===========================================
  Hits         18475    18475              
- Misses        3087     3091       +4

☔ 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.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coveralls · 2025-02-20T17:59:27Z

coverage: 85.696% (-0.004%) from 85.7%
when pulling 200a979 on issues/achave11-ucsc/5096-fix-it
into 272cf3b on develop.

test/integration_test.py

nadove-ucsc · 2025-02-24T19:54:55Z

test/integration_test.py

-            paged_snapshots = self._public_tdr_client.snapshot_names_by_id()
-        snapshots = self._public_tdr_client.snapshot_names_by_id()
-        self.assertEqual(snapshots, paged_snapshots)
+        deployment_specific_prefix_filter = {


It is a substring filter, not a prefix filter.

Suggested change

deployment_specific_prefix_filter = {

# Without a filter, the test takes so long that there's a real risk of

# failure due to new snapshots being added mid-test

snapshot_filters_by_deployment = {

nadove-ucsc · 2025-02-24T19:57:04Z

test/integration_test.py

+        Test with minimal page sizes (1, 2) and a subset of deployment-specific
+        snapshots (obtain via a filtered request). To make sure paging works.


Too much detail IMO. I moved the 2nd half to an inline comment.

Suggested change

Test with minimal page sizes (1, 2) and a subset of deployment-specific

snapshots (obtain via a filtered request). To make sure paging works.

Test with small page sizes to make sure paging works.

test/integration_test.py

hannes-ucsc · 2025-02-28T04:46:36Z

Security design review

achave11-ucsc · 2025-03-04T04:29:18Z

Previous code owner approval is now ineffective. Assigned active code owner for re-approval.

nadove-ucsc · 2025-03-04T04:56:40Z

test/integration_test.py

+            with self.subTest(page_size=page_size):
+                with mock.patch.object(TDRClient, 'page_size', page_size):
+                    paged_snapshots = self._public_tdr_client.snapshot_names_by_id()
+                    self.assertGreater(1, self._public_tdr_client.page_size)


The test does not pass when I check out this commit. We just patched the page size to be 1, so it makes no sense to assert that it's greater than 1:

2025-03-03 20:53:55,622 INFO MainThread test.integration_test: Failed sub-test [None] {'page_size': 1} SubTest failure: Traceback (most recent call last): File "/home/nadove/.pyenv/versions/3.12.9/lib/python3.12/unittest/case.py", line 58, in testPartExecutor yield File "/home/nadove/.pyenv/versions/3.12.9/lib/python3.12/unittest/case.py", line 539, in subTest yield File "/home/nadove/PycharmProjects/azul-sc/test/integration_test.py", line 363, in subTest yield File "/home/nadove/PycharmProjects/azul-sc/test/integration_test.py", line 395, in test_snapshot_listing self.assertGreater(1, self._public_tdr_client.page_size) AssertionError: 1 not greater than 1

I think @hannes-ucsc's feedback

I also think we should assert the number of pages to be greater than 1

has not been implemented here. I think this code erroneously asserts that the page size is > 1 instead of asserting that the page count is > 1.

To that end:

Subject: [PATCH] REVIEW --- Index: test/integration_test.py IDEA additional info: Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP <+>UTF-8 =================================================================== diff --git a/test/integration_test.py b/test/integration_test.py --- a/test/integration_test.py (revision b829c3bc23a76f05f0a123bb5e0771d3f42af607) +++ b/test/integration_test.py (date 1741064353322) @@ -392,7 +392,7 @@ with self.subTest(page_size=page_size): with mock.patch.object(TDRClient, 'page_size', page_size): paged_snapshots = self._public_tdr_client.snapshot_names_by_id() - self.assertGreater(1, self._public_tdr_client.page_size) + self.assertGreater(len(paged_snapshots), page_size) snapshots = self._public_tdr_client.snapshot_names_by_id() self.assertEqual(snapshots, paged_snapshots)

We can't directly observe the page count from outside the method, but this assertion proves that multiple pages were fetched via the pigeonhole principle.

nadove-ucsc · 2025-03-04T05:06:47Z

test/integration_test.py

+                    self.assertGreater(len(paged_snapshots), 0)
+                snapshots = self._tdr_client.snapshot_names_by_id(filter=filter)
+                self.assertLess(len(snapshots), 20)


Since we assert that the lists are equal, it's a bit confusing to make separate assertions about their sizes. I believe this simplifies to:

Suggested change

self.assertGreater(len(paged_snapshots), 0)

snapshots = self._tdr_client.snapshot_names_by_id(filter=filter)

self.assertLess(len(snapshots), 20)

snapshots = self._tdr_client.snapshot_names_by_id(filter=filter)

self.assertIn(len(snapshots), range(1, 20))

nadove-ucsc · 2025-03-08T00:14:15Z

test/integration_test.py

+                with mock.patch.object(TDRClient, 'page_size', page_size):
+                    paged_snapshots = self._tdr_client.snapshot_names_by_id(filter=filter)
+                snapshots = self._tdr_client.snapshot_names_by_id(filter=filter)
+                self.assertIn(len(snapshots), range(1, 20))


Changed my mind about using range for this check, because I think the lower bound should be higher:

Suggested change

self.assertIn(len(snapshots), range(1, 20))

self.assertLess(len(snapshots), 20)

# This proves that multiple pages were fetched via the pigeonhole principle

self.assertGreater(len(snapshots), page_size)

github-actions bot added the orange [process] Done by the Azul team label Feb 20, 2025

achave11-ucsc force-pushed the issues/achave11-ucsc/5096-fix-it branch 6 times, most recently from d651b26 to 0efb3eb Compare February 21, 2025 19:09

achave11-ucsc requested a review from nadove-ucsc February 21, 2025 19:49

achave11-ucsc assigned nadove-ucsc Feb 21, 2025

nadove-ucsc requested changes Feb 24, 2025

View reviewed changes

nadove-ucsc removed their assignment Feb 24, 2025

achave11-ucsc force-pushed the issues/achave11-ucsc/5096-fix-it branch from 0efb3eb to e812d4b Compare February 25, 2025 03:11

achave11-ucsc requested a review from nadove-ucsc February 25, 2025 03:43

achave11-ucsc assigned nadove-ucsc Feb 25, 2025

nadove-ucsc previously approved these changes Feb 25, 2025

View reviewed changes

nadove-ucsc marked this pull request as ready for review February 25, 2025 09:28

nadove-ucsc requested a review from hannes-ucsc as a code owner February 25, 2025 09:28

nadove-ucsc assigned hannes-ucsc and unassigned nadove-ucsc Feb 25, 2025

hannes-ucsc requested changes Feb 25, 2025

View reviewed changes

test/integration_test.py Show resolved Hide resolved

hannes-ucsc added the 0 reviews [process] Lead didn't request any changes label Feb 25, 2025

hannes-ucsc removed their assignment Feb 25, 2025

achave11-ucsc dismissed nadove-ucsc’s stale review via e8a081e February 26, 2025 18:28

achave11-ucsc force-pushed the issues/achave11-ucsc/5096-fix-it branch 2 times, most recently from 6cb51b3 to ef62937 Compare February 26, 2025 22:46

achave11-ucsc commented Feb 26, 2025

View reviewed changes

test/integration_test.py Outdated Show resolved Hide resolved

achave11-ucsc requested a review from hannes-ucsc February 27, 2025 02:41

achave11-ucsc assigned hannes-ucsc Feb 27, 2025

hannes-ucsc removed their assignment Feb 27, 2025

achave11-ucsc force-pushed the issues/achave11-ucsc/5096-fix-it branch 2 times, most recently from 56c0316 to 0184141 Compare February 27, 2025 20:50

achave11-ucsc commented Feb 27, 2025

View reviewed changes

test/integration_test.py Show resolved Hide resolved

achave11-ucsc requested a review from hannes-ucsc February 27, 2025 22:59

achave11-ucsc assigned hannes-ucsc Feb 27, 2025

hannes-ucsc previously approved these changes Feb 28, 2025

View reviewed changes

hannes-ucsc assigned dsotirho-ucsc and unassigned hannes-ucsc Feb 28, 2025

dsotirho-ucsc assigned achave11-ucsc and unassigned dsotirho-ucsc Mar 3, 2025

achave11-ucsc force-pushed the issues/achave11-ucsc/5096-fix-it branch 2 times, most recently from 6fb1b84 to 3624370 Compare March 4, 2025 04:24

achave11-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label Mar 4, 2025

achave11-ucsc requested a review from nadove-ucsc March 4, 2025 04:26

achave11-ucsc assigned nadove-ucsc and unassigned achave11-ucsc Mar 4, 2025

nadove-ucsc requested changes Mar 4, 2025

View reviewed changes

nadove-ucsc removed their assignment Mar 4, 2025

achave11-ucsc added the hold warm [process] PR can't land just yet but needs to be rebased daily label Mar 4, 2025

achave11-ucsc added 2 commits March 6, 2025 10:41

Test smaller page sizes in test_snapshot_listing IT

752353d

Fix: Transient IT test_snapshot_listing fails in anvilbox (#5096)

200a979

achave11-ucsc dismissed hannes-ucsc’s stale review via 752353d March 6, 2025 18:42

achave11-ucsc force-pushed the issues/achave11-ucsc/5096-fix-it branch from 3624370 to 752353d Compare March 6, 2025 18:42

achave11-ucsc requested a review from nadove-ucsc March 6, 2025 19:14

achave11-ucsc assigned nadove-ucsc Mar 6, 2025

nadove-ucsc requested changes Mar 8, 2025

View reviewed changes

nadove-ucsc removed their assignment Mar 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Transient IT test_snapshot_listing fails in anvilbox (#5096) #6919

Fix: Transient IT test_snapshot_listing fails in anvilbox (#5096) #6919

achave11-ucsc commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading

coveralls commented Feb 20, 2025 •

edited

Loading

nadove-ucsc Feb 24, 2025

nadove-ucsc Feb 24, 2025

hannes-ucsc commented Feb 28, 2025

achave11-ucsc commented Mar 4, 2025 •

edited

Loading

nadove-ucsc Mar 4, 2025

nadove-ucsc Mar 4, 2025

nadove-ucsc Mar 4, 2025

nadove-ucsc Mar 4, 2025 •

edited

Loading

nadove-ucsc Mar 8, 2025

-        deployment_specific_prefix_filter = {
+        # Without a filter, the test takes so long that there's a real risk of
+        # failure due to new snapshots being added mid-test
+        snapshot_filters_by_deployment = {

		Test with minimal page sizes (1, 2) and a subset of deployment-specific
		snapshots (obtain via a filtered request). To make sure paging works.

	Test with minimal page sizes (1, 2) and a subset of deployment-specific
	snapshots (obtain via a filtered request). To make sure paging works.
	Test with small page sizes to make sure paging works.

Fix: Transient IT test_snapshot_listing fails in anvilbox (#5096) #6919

Are you sure you want to change the base?

Fix: Transient IT test_snapshot_listing fails in anvilbox (#5096) #6919

Conversation

achave11-ucsc commented Feb 20, 2025 • edited Loading

Checklist

Author

Author (partiality)

Author (chains)

Author (reindex, API changes)

Author (upgrading deployments)

Author (hotfixes)

Author (before every review)

Peer reviewer (after approval)

System administrator (after approval)

Operator (before pushing merge the commit)

System administrator

Operator (before pushing merge the commit)

Operator (chain shortening)

Operator (after pushing the merge commit)

Operator (reindex)

Operator

Shorthand for review comments

codecov bot commented Feb 20, 2025 • edited Loading

Codecov Report

coveralls commented Feb 20, 2025 • edited Loading

nadove-ucsc Feb 24, 2025

Choose a reason for hiding this comment

nadove-ucsc Feb 24, 2025

Choose a reason for hiding this comment

hannes-ucsc commented Feb 28, 2025

Security design review

achave11-ucsc commented Mar 4, 2025 • edited Loading

nadove-ucsc Mar 4, 2025

Choose a reason for hiding this comment

nadove-ucsc Mar 4, 2025

Choose a reason for hiding this comment

nadove-ucsc Mar 4, 2025

Choose a reason for hiding this comment

nadove-ucsc Mar 4, 2025 • edited Loading

Choose a reason for hiding this comment

nadove-ucsc Mar 8, 2025

Choose a reason for hiding this comment

achave11-ucsc commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading

coveralls commented Feb 20, 2025 •

edited

Loading

achave11-ucsc commented Mar 4, 2025 •

edited

Loading

nadove-ucsc Mar 4, 2025 •

edited

Loading