Summary

Fix JSON output when crashing, and fix help and version information.

Review Request #12163 — Created March 17, 2022 and submitted March 18, 2022, 2:17 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

When using --json, if the command raises an unexpected exception, we
end up showing an empty "success" payload. This is clearly not what we
want. This change insteads records an "Internal Error" with the
exception's error message, allowing tools to know that something went
wrong.

The help string for --json has also been updated to include a trailing
period, matching other help strings. It also now includes an added_in
version for the documentation, and the Version Added for JSONOutput
now correctly shows 3.0.

Testing Done

Tested --json with an exception raised, and saw the exception details.

Saw the corrected help text.

Commits

Summary	ID
Fix JSON output when crashing, and fix help and version information. When using `--json`, if the command raises an unexpected exception, we end up showing an empty "success" payload. This is clearly not what we want. This change insteads records an "Internal Error" with the exception's error message, allowing tools to know that something went wrong. The help string for `--json` has also been updated to include a trailing period, matching other help strings. It also now includes an `added_in` version for the documentation, and the `Version Added` for `JSONOutput` now correctly shows 3.0.	3c63c5fd513fc17f22e86f874fc26ac4efb9fbfa

Summary

Fix JSON output when crashing, and fix help and version information.

When using `--json`, if the command raises an unexpected exception, we end up showing an empty "success" payload. This is clearly not what we want. This change insteads records an "Internal Error" with the exception's error message, allowing tools to know that something went wrong. The help string for `--json` has also been updated to include a trailing period, matching other help strings. It also now includes an `added_in` version for the documentation, and the `Version Added` for `JSONOutput` now correctly shows 3.0.

3c63c5fd513fc17f22e86f874fc26ac4efb9fbfa

flake8 passed.

JSHint passed.

Change Summary:

Updated to fix version information.

Summary:

-	Fix JSON output when crashing, and fix the help string.
+	Fix JSON output when crashing, and fix help and version information.

Description:

		When using `--json`, if the command raises an unexpected exception, we
		end up showing an empty "success" payload. This is clearly not what we
		want. This change insteads records an "Internal Error" with the
		exception's error message, allowing tools to know that something went
		wrong.

		The help string for `--json` has also been updated to include a trailing
~		period, matching other help strings.
	~	period, matching other help strings. It also now includes an `added_in`
	+	version for the documentation, and the `Version Added` for `JSONOutput`
	+	now correctly shows 3.0.

Commits:

	Summary	ID
	Fix JSON output when crashing, and fix the help string. When using `--json`, if the command raises an unexpected exception, we end up showing an empty "success" payload. This is clearly not what we want. This change insteads records an "Internal Error" with the exception's error message, allowing tools to know that something went wrong. The help string for `--json` has also been updated to include a trailing period, matching other help strings.	f20793af1d946a1ca6004e4b7259692612f1024f
	Fix JSON output when crashing, and fix help and version information. When using `--json`, if the command raises an unexpected exception, we end up showing an empty "success" payload. This is clearly not what we want. This change insteads records an "Internal Error" with the exception's error message, allowing tools to know that something went wrong. The help string for `--json` has also been updated to include a trailing period, matching other help strings. It also now includes an `added_in` version for the documentation, and the `Version Added` for `JSONOutput` now correctly shows 3.0.	3c63c5fd513fc17f22e86f874fc26ac4efb9fbfa

Diff:

Revision 2 (+10 -4)

Show changes

rbtools/commands/__init__.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (664aff7)