Summary:

JSON Output for RBTools Status Command

Review Request #11541 — Created March 20, 2021 and submitted Oct. 25, 2021, 9:38 p.m.

Information
Owner:	ryankang
Repository:	RBTools
Branch:	master
Bugs:
Depends On:	~~11521~~
Reviewers
Groups:	rbtools, students
People:

Description

Depends on JSON output object from r#11521. Adding information
that goes into rows of the status table into a JSON object. If no requests
are found the array remains empty. Also adds info if format_results is
called.

Testing Done

Ran unit tests in Commands and passed all tests

Commits

Summary
added new method to print JSON to stream object and tests to ensure it works properly
each summary is added as a json object to a list in summaries
moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
fixed extra spaces in no line
Removed setting status because it is done in __init__ by checking for errosr
Importing kgb instead of specific package inside kgb

Screenshots

Issues

Description	From	Last Updated
The diff of this includes the changes from your other review request. You probably want to post and explicitly specify …	david	March 28, 2021, 4:05 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:46 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:46 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:47 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:47 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:48 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:48 p.m.
E303 too many blank lines (2)	reviewbot	March 28, 2021, 2:48 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:48 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:48 p.m.
E501 line too long (80 > 79 characters)	reviewbot	March 28, 2021, 2:48 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 2:48 p.m.
W291 trailing whitespace	reviewbot	March 28, 2021, 2:48 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 4:04 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 4:04 p.m.
W293 blank line contains whitespace	reviewbot	March 28, 2021, 4:04 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/commands/__init__.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/__init__.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/__init__.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/status.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/status.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/status.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/tests/test_main.py (Diff revision 1)
Show all issues
```
E303 too many blank lines (2)
```
rbtools/commands/tests/test_main.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/tests/test_main.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/tests/test_main.py (Diff revision 1)
Show all issues
```
E501 line too long (80 > 79 characters)
```
rbtools/commands/tests/test_main.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/tests/test_main.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```

Show all issues

The diff of this includes the changes from your other review request.

You probably want to post and explicitly specify which commits you want to include. For example, to include just the latest two commits:

rbt post -r 11541 HEAD^^..HEAD

If you have two branch tips, you can also do:

rbt post -r 11541 json-branch..json-status-branch

Commits:

	Summary
-	added JSON wrapper class to main.py which inputs to a dictionary and outputs a JSON object. Added tests for JSON wrapper functionality in test_main.py
-	added new method to print JSON to stream object and tests to ensure it works properly
-	added new global command --json
-	added conditional at the end of command cycle to print JSON is enabled
-	added method to append to classes and tests to ensure items are appended correctly
-	added new method to add errors to existing errors key or create a new one
-	each summary is added as a json object to a list in summaries
-	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
+	each summary is added as a json object to a list in summaries
+	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key

Diff:

Revision 2 (+31 -5)

Show changes

rbtools/commands/status.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbtools/commands/status.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/status.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/status.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```

Commits:

Summary

each summary is added as a json object to a list in summaries

moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key

fixed extra spaces in no line

Diff:

Revision 3 (+6 -6)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary
-	fixed extra spaces in no line
+	each summary is added as a json object to a list in summaries
+	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
+	fixed extra spaces in no line

Diff:

Revision 4 (+32 -6)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary
-	each summary is added as a json object to a list in summaries
-	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
-	fixed extra spaces in no line
+	each summary is added as a json object to a list in summaries
+	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
+	fixed extra spaces in no line

Diff:

Revision 5 (+32 -6)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Description:

~		Depends on JSON wrapper object from r#11521. Adding information
	~	Depends on JSON output object from r#11521. Adding information
		that goes into rows of the status table into a JSON object. If no requests
		are found the array remains empty. Also adds `info` if format_results is
		called.

Commits:

	Summary
-	each summary is added as a json object to a list in summaries
-	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
-	fixed extra spaces in no line
+	each summary is added as a json object to a list in summaries
+	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
+	fixed extra spaces in no line
+	Removed setting status because it is done in __init__ by checking for errosr

Diff:

Revision 6 (+30 -8)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	[WIP] JSON Output for RBTools Status Command
+	JSON Output for RBTools Status Command

Commits:

	Summary
-	each summary is added as a json object to a list in summaries
-	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
-	fixed extra spaces in no line
-	Removed setting status because it is done in __init__ by checking for errosr
+	added new method to print JSON to stream object and tests to ensure it works properly
+	each summary is added as a json object to a list in summaries
+	moved definition of summaries to before if statement so that if no requests are found, there still exists a summaries key
+	fixed extra spaces in no line
+	Removed setting status because it is done in __init__ by checking for errosr
+	Importing kgb instead of specific package inside kgb

Depends On:

+	~~11521 - JSON wrapper which inputs to a dictionary and outputs a JSON object~~

Groups:

+	students

Diff:

Revision 7 (+34 -12)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Status: Closed (submitted)

Change Summary:

Pushed to master (82a7118)

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

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

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

rbtools/commands/status.py (Diff revision 2)