Summary

Add the GNU diff tool implementation.

Review Request #12600 — Created Sept. 14, 2022 and submitted Sept. 28, 2022, 12:50 a.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

~~12599~~

Blocks

12601

Reviewers

Groups

rbtools

People

Description

This introduces the first diff tool, GNUDiffTool. This wraps around

GNU Diff, properly checking search paths, building the correct command

line, and interpreting results.
If there are multiple diff executables found in the path, this will

end up checking each until it finds GNU Diff or exhausts all options.
The implementation handles all documented GNU Diff exit codes, providing

text vs. binary flags in the result (handling old legacy binary file

indicators) and all diff output.
This will be a step up from a lot of the GNU diff executions we

currently have in the codebase, and will let us remove a lot of

different forms of error handling, binary file support, and execute name

determination.

Testing Done

Unit tests passed.

Tested this with some in-progress changes to switch SCMClients over. They
successfully ran GNU Diff and handled the results.

Commits

Summary	ID
Add the GNU diff tool implementation. This introduces the first diff tool, `GNUDiffTool`. This wraps around GNU Diff, properly checking search paths, building the correct command line, and interpreting results. If there are multiple `diff` executables found in the path, this will end up checking each until it finds GNU Diff or exhausts all options. The implementation handles all documented GNU Diff exit codes, providing text vs. binary flags in the result (handling old legacy binary file indicators) and all diff output. This will be a step up from a lot of the GNU diff executions we currently have in the codebase, and will let us remove a lot of different forms of error handling, binary file support, and execute name determination.	b46242c3c7161b42c0232a5ab1476461454ae9b1

Summary

Add the GNU diff tool implementation.

This introduces the first diff tool, `GNUDiffTool`. This wraps around GNU Diff, properly checking search paths, building the correct command line, and interpreting results. If there are multiple `diff` executables found in the path, this will end up checking each until it finds GNU Diff or exhausts all options. The implementation handles all documented GNU Diff exit codes, providing text vs. binary flags in the result (handling old legacy binary file indicators) and all diff output. This will be a step up from a lot of the GNU diff executions we currently have in the codebase, and will let us remove a lot of different forms of error handling, binary file support, and execute name determination.

b46242c3c7161b42c0232a5ab1476461454ae9b1

Issues

Description	From	Last Updated
Add a Version Added:.	maubin	Sept. 21, 2022, 7:11 p.m.
Add a Version Added:.	maubin	Sept. 20, 2022, 11:35 a.m.

flake8 passed.

JSHint passed.

Bugs:: 12599
Depends On:: ~~12599 - Add the beginnings of a Diff Tool layer.~~

rbtools/diffs/tests/test_gnu_diff_tool.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Add a Version Added:.
```
rbtools/diffs/tests/test_gnu_diff_tool.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Add a Version Added:.
```

Change Summary:


Added a missing Version Added.
Updated for new requirements in the base tool support.
Updated to handle binary diffs when there's an exit code of 1 (documentation says it'll happen with exit code 2, but that's not happening locally).

Commits:

	Summary	ID
	Add the GNU diff tool implementation. This introduces the first diff tool, `GNUDiffTool`. This wraps around GNU Diff, properly checking search paths, building the correct command line, and interpreting results. If there are multiple `diff` executables found in the path, this will end up checking each until it finds GNU Diff or exhausts all options. The implementation handles all documented GNU Diff exit codes, providing text vs. binary flags in the result (handling old legacy binary file indicators) and all diff output. This will be a step up from a lot of the GNU diff executions we currently have in the codebase, and will let us remove a lot of different forms of error handling, binary file support, and execute name determination.	3b9cb6438fa355c3431a2fe0d38209ef549112ad
	Add the GNU diff tool implementation. This introduces the first diff tool, `GNUDiffTool`. This wraps around GNU Diff, properly checking search paths, building the correct command line, and interpreting results. If there are multiple `diff` executables found in the path, this will end up checking each until it finds GNU Diff or exhausts all options. The implementation handles all documented GNU Diff exit codes, providing text vs. binary flags in the result (handling old legacy binary file indicators) and all diff output. This will be a step up from a lot of the GNU diff executions we currently have in the codebase, and will let us remove a lot of different forms of error handling, binary file support, and execute name determination.	b46242c3c7161b42c0232a5ab1476461454ae9b1

Diff:

Revision 2 (+1242)

Show changes

	docs/rbtools/api/coderef/index.rst
	rbtools/diffs/tests/test_gnu_diff_tool.py
	rbtools/diffs/tools/backends/__init__.py
	rbtools/diffs/tools/backends/gnu.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.x (533d38e)