annotate test/pytest_patcher.py @ 7853:03c1b7ae3a68

issue2551328/issue2551264 unneeded next link and total_count incorrect Fix: issue2551328 - REST results show next link if number of results is a multiple of page size. (Found by members of team 3 in the UMass-Boston CS682 Spring 2024 class.) issue2551264 - REST X-Total-Count header and @total_size count incorrect when paginated These issues arose because we retrieved the exact number of rows from the database as requested by the user using the @page_size parameter. With this changeset, we retrieve up to 10 million + 1 rows from the database. If the total number of rows exceeds 10 million, we set the total_count indicators to -1 as an invalid size. (The max number of requested rows (default 10 million +1) can be modified by the admin through interfaces.py.) By retrieving more data than necessary, we can calculate the total count by adding @page_index*@page_size to the number of rows returned by the query. Furthermore, since we return more than @page_size rows, we can determine the existence of a row at @page_size+1 and use that information to determine if a next link should be provided. Previously, a next link was returned if @page_size rows were retrieved. This change does not guarantee that the user will get @page_size rows returned. Access policy filtering occurs after the rows are returned, and discards rows inaccessible by the user. Using the current @page_index/@page_size it would be difficult to have the roundup code refetch data and make sure that a full @page_size set of rows is returned. E.G. @page_size=100 and 5 of them are dropped due to access restrictions. We then fetch 10 items and add items 1-4 and 6 (5 is inaccessible). There is no way to calculate the new database offset at: @page_index*@page_size + 6 from the URL. We would need to add an @page_offset=6 or something. This could work since the client isn't adding 1 to @page_index to get the next page. Thanks to HATEOAS, the client just uses the 'next' url. But I am not going to cross that bridge without a concrete use case. This can also be handled client side by merging a short response with the next response and re-paginating client side. Also added extra index markers to the docs to highlight use of interfaces.py.
author John Rouillard <rouilj@ieee.org>
date Mon, 01 Apr 2024 09:57:16 -0400
parents 1c94afabb2cb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5109
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
1 """
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
2 The following code was taken from:
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
3
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
4 https://github.com/pytest-dev/pytest/issues/568#issuecomment-216569420
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
5
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
6 to resolve a bug with using pytest.mark.skip(). Once the bug is resolved in
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
7 pytest this file can be removed along with all the wrapper mark_class()
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
8 references in the other test files.
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
9 """
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
10 import types
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
11
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
12
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
13 def mark_class(marker):
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
14 '''Workaround for https://github.com/pytest-dev/pytest/issues/568'''
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
15 def copy_func(f):
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
16 try:
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
17 return types.FunctionType(f.__code__, f.__globals__,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
18 name=f.__name__, argdefs=f.__defaults__,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
19 closure=f.__closure__)
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
20 except AttributeError:
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
21 return types.FunctionType(f.func_code, f.func_globals,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
22 name=f.func_name,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
23 argdefs=f.func_defaults,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
24 closure=f.func_closure)
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
25
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
26 def mark(cls):
5111
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
27 if isinstance(cls, types.FunctionType):
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
28 return marker(copy_func(cls))
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
29
5109
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
30 for method in dir(cls):
5111
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
31 if method.startswith('test'):
5109
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
32 f = copy_func(getattr(cls, method))
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
33 setattr(cls, method, marker(f))
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
34 return cls
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
35 return mark

Roundup Issue Tracker: http://roundup-tracker.org/