Summary

Add testing utilities for pre-generating temp filename and asserting diffs.

Review Request #11801 — Created Aug. 24, 2021 and submitted Sept. 28, 2021, 5:24 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

In an effort to reduce the workload of some unit tests, and create a

more standardized set of testing functions, TestCase has gained two

new functions:


precreate_tempfiles() will generate a specified number of temporary

   filenames (using make_tempfile()), spy on make_tempfile, and then

   return that list. The list of temp filenames are also returned to the

   caller. This allows the caller to pre-generate some command

   executions or spy operations that may need to know those temp

   filenames.


assertDiffEqual(), which compares two diffs, ensuring both are

   bytestrings and comparing the lines of each to ensure correct content

   (or to make diffing of mismatches clear).


Along with this, maxDiff was set to a high number, allowing assertion

failures that compare strings or lists to provide more useful

information, rather than truncating prematurely.
kgb 6.1 is now required, in order to support the spy operation

functionality needed by precreate_tempfiles().

Testing Done

Successfully made use of the new functionality in some upcoming unit tests.

Commits

Summary	ID
Add testing utilities for pre-generating temp filename and asserting diffs. In an effort to reduce the workload of some unit tests, and create a more standardized set of testing functions, `TestCase` has gained two new functions: 1. `precreate_tempfiles()` will generate a specified number of temporary filenames (using `make_tempfile()`), spy on `make_tempfile`, and then return that list. The list of temp filenames are also returned to the caller. This allows the caller to pre-generate some command executions or spy operations that may need to know those temp filenames. 2. `assertDiffEqual()`, which compares two diffs, ensuring both are bytestrings and comparing the lines of each to ensure correct content (or to make difffing of mismatches clear). Along with this, `maxDiff` was set to a high number, allowing assertion failures that compare strings or lists to provide more useful information, rather than truncating prematurely. kgb 6.1 is now required, in order to support the spy operation functionality needed by `precreate_tempfiles()`.	df57e3e9f5318cb423f86adb0900935729467741

Summary

Add testing utilities for pre-generating temp filename and asserting diffs.

In an effort to reduce the workload of some unit tests, and create a more standardized set of testing functions, `TestCase` has gained two new functions: 1. `precreate_tempfiles()` will generate a specified number of temporary filenames (using `make_tempfile()`), spy on `make_tempfile`, and then return that list. The list of temp filenames are also returned to the caller. This allows the caller to pre-generate some command executions or spy operations that may need to know those temp filenames. 2. `assertDiffEqual()`, which compares two diffs, ensuring both are bytestrings and comparing the lines of each to ensure correct content (or to make difffing of mismatches clear). Along with this, `maxDiff` was set to a high number, allowing assertion failures that compare strings or lists to provide more useful information, rather than truncating prematurely. kgb 6.1 is now required, in order to support the spy operation functionality needed by `precreate_tempfiles()`.

df57e3e9f5318cb423f86adb0900935729467741

Issues

Description	From	Last Updated
Typo in description: difffing	david	Sept. 28, 2021, 5:24 p.m.
F841 local variable 'tmpfiles' is assigned to but never used	reviewbot	Aug. 26, 2021, 2:36 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/testing/testcase.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F841 local variable 'tmpfiles' is assigned to but never used
```

Ship it!

The issue has been resolved. Show all issues
```
Typo in description: difffing
```

Description:: In an effort to reduce the workload of some unit tests, and create a
more standardized set of testing functions, TestCase has gained two
new functions:

precreate_tempfiles() will generate a specified number of temporary
filenames (using make_tempfile()), spy on make_tempfile, and then
return that list. The list of temp filenames are also returned to the
caller. This allows the caller to pre-generate some command
executions or spy operations that may need to know those temp
filenames.

~

assertDiffEqual(), which compares two diffs, ensuring both are
bytestrings and comparing the lines of each to ensure correct content
(or to make difffing of mismatches clear).

~

assertDiffEqual(), which compares two diffs, ensuring both are
bytestrings and comparing the lines of each to ensure correct content
(or to make diffing of mismatches clear).

Along with this, maxDiff was set to a high number, allowing assertion
failures that compare strings or lists to provide more useful
information, rather than truncating prematurely.

kgb 6.1 is now required, in order to support the spy operation
functionality needed by precreate_tempfiles().

Status:: Completed
Change Summary:: Pushed to master (948e581)

		In an effort to reduce the workload of some unit tests, and create a
		more standardized set of testing functions, `TestCase` has gained two
		new functions:

		`precreate_tempfiles()` will generate a specified number of temporary filenames (using `make_tempfile()`), spy on `make_tempfile`, and then return that list. The list of temp filenames are also returned to the caller. This allows the caller to pre-generate some command executions or spy operations that may need to know those temp filenames.
~		`assertDiffEqual()`, which compares two diffs, ensuring both are bytestrings and comparing the lines of each to ensure correct content (or to make difffing of mismatches clear).
	~	`assertDiffEqual()`, which compares two diffs, ensuring both are bytestrings and comparing the lines of each to ensure correct content (or to make diffing of mismatches clear).

		Along with this, `maxDiff` was set to a high number, allowing assertion
		failures that compare strings or lists to provide more useful
		information, rather than truncating prematurely.

		kgb 6.1 is now required, in order to support the spy operation
		functionality needed by `precreate_tempfiles()`.

rbtools/testing/testcase.py (Diff revision 1)