Summary

Update TFS support to use the new run_process().

Review Request #12565 — Created Aug. 24, 2022 and submitted Sept. 13, 2022, 12:08 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This updates the TFS wrapper classes to switch over from execute() to
run_process(). This gives us greater type safety across TFS, which is
important in keeping this client implementation maintainable.

All call sites now explicitly read either the byte stream or the Unicode
stream, depending on their needs. There's no longer a risk of expecting
one type and ending up with another.

Unit tests have been updated to spy on run_process_exec(), which gives
us a safe, checked way of returning data for tests that guarantees
proper interpreration by TFS.

Testing Done

Unit tests pass on Python 3.7-3.11.

Commits

Summary	ID
Update TFS support to use the new run_process(). This updates the TFS wrapper classes to switch over from `execute()` to `run_process()`. This gives us greater type safety across TFS, which is important in keeping this client implementation maintainable. All call sites now explicitly read either the byte stream or the Unicode stream, depending on their needs. There's no longer a risk of expecting one type and ending up with another. Unit tests have been updated to spy on `run_process_exec()`, which gives us a safe, checked way of returning data for tests that guarantees proper interpreration by TFS.	62a79008503fc21c41307130f2ec1879d64281f5

Summary

Update TFS support to use the new run_process().

This updates the TFS wrapper classes to switch over from `execute()` to `run_process()`. This gives us greater type safety across TFS, which is important in keeping this client implementation maintainable. All call sites now explicitly read either the byte stream or the Unicode stream, depending on their needs. There's no longer a risk of expecting one type and ending up with another. Unit tests have been updated to spy on `run_process_exec()`, which gives us a safe, checked way of returning data for tests that guarantees proper interpreration by TFS.

62a79008503fc21c41307130f2ec1879d64281f5

Issues

Description	From	Last Updated
'rbtools.utils.process.RunProcessError' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 24, 2022, 12:57 a.m.
'rbtools.utils.process.RunProcessResult' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 24, 2022, 12:57 a.m.
Can take this out.	maubin	Sept. 12, 2022, 11:30 a.m.
This comment no longer applies.	maubin	Sept. 12, 2022, 11:31 a.m.
Same here.	maubin	Sept. 12, 2022, 11:31 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/clients/tests/test_tfs.py (Diff revision 1)

The issue has been resolved. Show all issues

'rbtools.utils.process.RunProcessError' imported but unused

Column: 1
Error code: F401

rbtools/clients/tests/test_tfs.py (Diff revision 1)

The issue has been resolved. Show all issues

'rbtools.utils.process.RunProcessResult' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Update TFS support to use the new run_process(). This updates the TFS wrapper classes to switch over from `execute()` to `run_process()`. This gives us greater type safety across TFS, which is important in keeping this client implementation maintainable. All call sites now explicitly read either the byte stream or the Unicode stream, depending on their needs. There's no longer a risk of expecting one type and ending up with another. Unit tests have been updated to spy on `run_process_exec()`, which gives us a safe, checked way of returning data for tests that guarantees proper interpreration by TFS.	2dd2b22ca1c9d39ffdf457ec01e2d533d4d01fdc
	Update TFS support to use the new run_process(). This updates the TFS wrapper classes to switch over from `execute()` to `run_process()`. This gives us greater type safety across TFS, which is important in keeping this client implementation maintainable. All call sites now explicitly read either the byte stream or the Unicode stream, depending on their needs. There's no longer a risk of expecting one type and ending up with another. Unit tests have been updated to spy on `run_process_exec()`, which gives us a safe, checked way of returning data for tests that guarantees proper interpreration by TFS.	008ef203f8ffe68c3e8ef62c928f3c221e24746c

Diff:

Revision 2 (+670 -646)

Show changes

	rbtools/clients/tfs.py
	rbtools/clients/tests/test_tfs.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/clients/tfs.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can take this out.
```
rbtools/clients/tfs.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This comment no longer applies.
```
rbtools/clients/tfs.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Same here.
```

Change Summary:


Removed an unused **kwargs docstring.
Updated two comment blocks to describe how the XML content is decoded, removing legacy execute-specific information.

Commits:

	Summary	ID
	Update TFS support to use the new run_process(). This updates the TFS wrapper classes to switch over from `execute()` to `run_process()`. This gives us greater type safety across TFS, which is important in keeping this client implementation maintainable. All call sites now explicitly read either the byte stream or the Unicode stream, depending on their needs. There's no longer a risk of expecting one type and ending up with another. Unit tests have been updated to spy on `run_process_exec()`, which gives us a safe, checked way of returning data for tests that guarantees proper interpreration by TFS.	008ef203f8ffe68c3e8ef62c928f3c221e24746c
	Update TFS support to use the new run_process(). This updates the TFS wrapper classes to switch over from `execute()` to `run_process()`. This gives us greater type safety across TFS, which is important in keeping this client implementation maintainable. All call sites now explicitly read either the byte stream or the Unicode stream, depending on their needs. There's no longer a risk of expecting one type and ending up with another. Unit tests have been updated to spy on `run_process_exec()`, which gives us a safe, checked way of returning data for tests that guarantees proper interpreration by TFS.	62a79008503fc21c41307130f2ec1879d64281f5

Diff:

Revision 3 (+682 -668)

Show changes

	rbtools/clients/tfs.py
	rbtools/clients/tests/test_tfs.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.x (5df9cc1)