Summary

Enable expansion of resource links in unit tests.

Review Request #12260 — Created April 26, 2022 and submitted May 3, 2022, 9:13 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

URLMapTransport now supports the ?expand= query string argument,
allowing links to be expanded. When set, the transport will look up any
links listed and try to expand them in the resource before returning it
(and will also attempt to recurse into the expanded resources and expand
links within those).

If an expanded URL is not registered, or it's mapped to a HTTP 404
response, then the expansion will be empty (None or []).

Normally, a list will be expanded to a list, and a dictionary to a
dictionary. This can be overridden to expand a dictionary into a 1-item
list of dictionaries (needed for review request drafts, due to a design
flaw in the original API). This is done through a link_expansion_types
dictionary that can be set during URL registration.

Testing Done

Made use of this with some in-development unit tests. All tests pass on
all supported versions of Python.

Same for all existing tests as of this change.

Commits

Summary	ID
Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	6bf5e29530c986ac4788d776b856da8d18fdeae2

Summary

Enable expansion of resource links in unit tests.

`URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.

6bf5e29530c986ac4788d776b856da8d18fdeae2

Issues

Description	From	Last Updated
F401 'six' imported but unused	reviewbot	April 26, 2022, 6:54 p.m.
F507 '...' % ... has 4 placeholder(s) but 3 substitution(s)	reviewbot	April 26, 2022, 9:42 p.m.
E501 line too long (80 > 79 characters)	reviewbot	April 26, 2022, 9:42 p.m.
Can we either make this conditional, or add assert link_key in payload['links'] above?	david	April 28, 2022, 3:07 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/testing/api/transport.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'six' imported but unused
```

Change Summary:

Fixed to allow dictionary item resources to be expanded as 1-item lists of dictionaries (needed for review request drafts).

Commits:

	Summary	ID
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). This requires that any expanded resources have their URLs registered first.	cafcca35ac25ef62c952fb4e7075ddb4177ead56
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). This requires that any expanded resources have their URLs registered first. Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	76a7d03aa79b30c0d85525b4442f738533245a14

Diff:

Revision 2 (+458 -30)

Show changes

	rbtools/testing/api/payloads.py
	rbtools/testing/api/transport.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Missing URLs or HTTP 404s are now considered empty expansions, just like with the normal API.

Description:

		`URLMapTransport` now supports the `?expand=` query string argument,
		allowing links to be expanded. When set, the transport will look up any
		links listed and try to expand them in the resource before returning it
		(and will also attempt to recurse into the expanded resources and expand
		links within those).

~		This requires that any expanded resources have their URLs registered
~		first.
	~	If an expanded URL is not registered, or it's mapped to a HTTP 404
	~	response, then the expansion will be empty (`None` or `[]`).
	+
	+	Normally, a list will be expanded to a list, and a dictionary to a
	+	dictionary. This can be overridden to expand a dictionary into a 1-item
	+	list of dictionaries (needed for review request drafts, due to a design
	+	flaw in the original API). This is done through a `link_expansion_types`
	+	dictionary that can be set during URL registration.

Commits:

	Summary	ID
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). This requires that any expanded resources have their URLs registered first. Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	76a7d03aa79b30c0d85525b4442f738533245a14
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	e64989dc4b288dbb63f24827bad7465e736bdf7c

Diff:

Revision 3 (+510 -30)

Show changes

	rbtools/testing/api/payloads.py
	rbtools/testing/api/transport.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbtools/testing/api/transport.py (Diff revision 3)
The issue has been resolved. Show all issues
```
F507 '...' % ... has 4 placeholder(s) but 3 substitution(s)
```
rbtools/testing/api/transport.py (Diff revision 3)
The issue has been resolved. Show all issues
```
E501 line too long (80 > 79 characters)
```

Change Summary:

Fixed a bad format string.

Commits:

	Summary	ID
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	e64989dc4b288dbb63f24827bad7465e736bdf7c
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	60e2ffb03d14905c8776604d87c7054116a0083e

Diff:

Revision 4 (+510 -30)

Show changes

	rbtools/testing/api/payloads.py
	rbtools/testing/api/transport.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/testing/api/payloads.py (Diff revision 4)

The issue has been resolved. Show all issues

Can we either make this conditional, or add assert link_key in payload['links'] above?

Change Summary:

Added an assertion to ensure a link name is present in links.

Commits:

	Summary	ID
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	60e2ffb03d14905c8776604d87c7054116a0083e
	Enable expansion of resource links in unit tests. `URLMapTransport` now supports the `?expand=` query string argument, allowing links to be expanded. When set, the transport will look up any links listed and try to expand them in the resource before returning it (and will also attempt to recurse into the expanded resources and expand links within those). If an expanded URL is not registered, or it's mapped to a HTTP 404 response, then the expansion will be empty (`None` or `[]`). Normally, a list will be expanded to a list, and a dictionary to a dictionary. This can be overridden to expand a dictionary into a 1-item list of dictionaries (needed for review request drafts, due to a design flaw in the original API). This is done through a `link_expansion_types` dictionary that can be set during URL registration.	6bf5e29530c986ac4788d776b856da8d18fdeae2

Diff:

Revision 5 (+512 -30)

Show changes

	rbtools/testing/api/payloads.py
	rbtools/testing/api/transport.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.x (3d688be)