Summary

Allow diff generation to specify extra_data for a review request.

Review Request #12253 — Created April 22, 2022 and submitted April 27, 2022, 2:36 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

SCMClient.diff() can now return a review_request_extra_data

dictionary containing state to store on the review request's

extra_data.
If posting a brand-new review request, this will be stored directly on

the review request. If updating an existing one, this will be stored on

the draft.
This can be useful for storing metadata that should show up in fields on

a review request, or for providing metadata that can be used for

enhanced matching of review requests when using rbt post -u (a

feature coming for RBTools 3.1 in an upcoming change).
The data will be sent to Review Board through a JSON Merge Patch.

Testing Done

Unit tests pass for all supported versions of Python.

Modified the Git diff output to include some nested metadata and posted
locally. Verified the results in the posted review request, and then in the
draft.

Tested an earlier version of this with the SOS work, verifying that the data
got into the review request and was displayed in the custom fields.

Commits

Summary	ID
Allow diff generation to specify extra_data for a review request. `SCMClient.diff()` can now return a `review_request_extra_data` dictionary containing state to store on the review request's ``extra_data``. If posting a brand-new review request, this will be stored directly on the review request. If updating an existing one, this will be stored on the draft. This can be useful for storing metadata that should show up in fields on a review request, or for providing metadata that can be used for enhanced matching of review requests when using `rbt post -u` (a feature coming for RBTools 3.1 in an upcoming change). The data will be sent to Review Board through a JSON Merge Patch.	2d14cb2c946112491af8c936da2aa9074ee2c371

Summary

Allow diff generation to specify extra_data for a review request.

`SCMClient.diff()` can now return a `review_request_extra_data` dictionary containing state to store on the review request's ``extra_data``. If posting a brand-new review request, this will be stored directly on the review request. If updating an existing one, this will be stored on the draft. This can be useful for storing metadata that should show up in fields on a review request, or for providing metadata that can be used for enhanced matching of review requests when using `rbt post -u` (a feature coming for RBTools 3.1 in an upcoming change). The data will be sent to Review Board through a JSON Merge Patch.

2d14cb2c946112491af8c936da2aa9074ee2c371

Issues

Description	From	Last Updated
F401 'json' imported but unused	reviewbot	April 22, 2022, 6:39 p.m.
E501 line too long (80 > 79 characters)	reviewbot	April 22, 2022, 6:39 p.m.
This is big. Can we reformat with one parameter per line?	david	April 26, 2022, 2:59 p.m.
Can we reformat with one parameter per line?	david	April 26, 2022, 3 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/commands/post.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'json' imported but unused
```
rbtools/commands/post.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E501 line too long (80 > 79 characters)
```

Change Summary:


Removed an unused import.
Fixed a line length issue.

Commits:

	Summary	ID
	Allow diff generation to specify extra_data for a review request. `SCMClient.diff()` can now return a `review_request_extra_data` dictionary containing state to store on the review request's ``extra_data``. If posting a brand-new review request, this will be stored directly on the review request. If updating an existing one, this will be stored on the draft. This can be useful for storing metadata that should show up in fields on a review request, or for providing metadata that can be used for enhanced matching of review requests when using `rbt post -u` (a feature coming for RBTools 3.1 in an upcoming change). The data will be sent to Review Board through a JSON Merge Patch.	961204ef3060c5cd0dd2c7c9dfdf2579ca208770
	Allow diff generation to specify extra_data for a review request. `SCMClient.diff()` can now return a `review_request_extra_data` dictionary containing state to store on the review request's ``extra_data``. If posting a brand-new review request, this will be stored directly on the review request. If updating an existing one, this will be stored on the draft. This can be useful for storing metadata that should show up in fields on a review request, or for providing metadata that can be used for enhanced matching of review requests when using `rbt post -u` (a feature coming for RBTools 3.1 in an upcoming change). The data will be sent to Review Board through a JSON Merge Patch.	014423304f58cae5c65ef709da01eed421529f10

Diff:

Revision 2 (+1066 -68)

Show changes

	rbtools/clients/__init__.py
	rbtools/commands/post.py
	rbtools/commands/tests/test_post.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/commands/tests/test_post.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This is big. Can we reformat with one parameter per line?
```
rbtools/commands/tests/test_post.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can we reformat with one parameter per line?
```

Change Summary:

Reformatted test helper functions to list one parameter per line.

Commits:

	Summary	ID
	Allow diff generation to specify extra_data for a review request. `SCMClient.diff()` can now return a `review_request_extra_data` dictionary containing state to store on the review request's ``extra_data``. If posting a brand-new review request, this will be stored directly on the review request. If updating an existing one, this will be stored on the draft. This can be useful for storing metadata that should show up in fields on a review request, or for providing metadata that can be used for enhanced matching of review requests when using `rbt post -u` (a feature coming for RBTools 3.1 in an upcoming change). The data will be sent to Review Board through a JSON Merge Patch.	014423304f58cae5c65ef709da01eed421529f10
	Allow diff generation to specify extra_data for a review request. `SCMClient.diff()` can now return a `review_request_extra_data` dictionary containing state to store on the review request's ``extra_data``. If posting a brand-new review request, this will be stored directly on the review request. If updating an existing one, this will be stored on the draft. This can be useful for storing metadata that should show up in fields on a review request, or for providing metadata that can be used for enhanced matching of review requests when using `rbt post -u` (a feature coming for RBTools 3.1 in an upcoming change). The data will be sent to Review Board through a JSON Merge Patch.	2d14cb2c946112491af8c936da2aa9074ee2c371

Diff:

Revision 3 (+1096 -72)

Show changes

	rbtools/clients/__init__.py
	rbtools/commands/post.py
	rbtools/commands/tests/test_post.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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

rbtools/commands/post.py (Diff revision 1)

rbtools/commands/post.py (Diff revision 1)