Terminal output #39

bjoernricks · 2019-11-20T11:55:05Z

Improve console output formatting.

Add Terminal class for console output
Allow for indentation of following output
Display message status at the right end of the current console line

E.g. hook output is now:

autohooks => pre-commit
    Running autohooks.plugins.black                                 
        Running black pre-commit hook
        No staged files for black available                                        [ ok ]                                                                                                                                                                                                  
    Running autohooks.plugins.pylint                                 
        Running pylint pre-commit hook
        No files to lint                                                           [ ok ]

Checklist:

Tests
CHANGELOG Entry
[n/a] Documentation

The Terminal class will improve the formatting. It allows for indentation and displaying the status at the right end of the current terminal line.

Mocking Terminal from blessings was very difficult because properties are added during runtime like the color methods. Therefore auto mocking doesn't work.

Use the terminal class instead of the function in the hooks API.

Also improve the output by adding indentation.

The functionality is provided by the Terminal class now.

The hooks plugins should use the current terminal instance for their output to use the actual indentation.

Mock.assert_called() doesn't exist before Python 3.6.

codecov · 2019-11-20T12:13:50Z

Codecov Report

Merging #39 into master will increase coverage by 1.34%.
The diff coverage is 31.77%.

@@            Coverage Diff             @@
##           master      #39      +/-   ##
==========================================
+ Coverage   42.17%   43.51%   +1.34%     
==========================================
  Files          13       13              
  Lines         524      563      +39     
==========================================
+ Hits          221      245      +24     
- Misses        303      318      +15

Impacted Files	Coverage Δ
autohooks/cli/check.py	`0% <0%> (ø)`	⬆️
autohooks/cli/activate.py	`0% <0%> (ø)`	⬆️
autohooks/precommit/run.py	`0% <0%> (ø)`	⬆️
autohooks/terminal.py	`94.59% <94.44%> (+25.84%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 91bba97...f4c55a4. Read the comment docs.

bjoernricks added 9 commits November 20, 2019 12:48

Introduce a new Terminal class

d9eb7ec

The Terminal class will improve the formatting. It allows for indentation and displaying the status at the right end of the current terminal line.

Allow to run unittest on test_path.py file directly

fb554ad

Add tests for the Terminal class

142b349

Mocking Terminal from blessings was very difficult because properties are added during runtime like the color methods. Therefore auto mocking doesn't work.

Update hook API for terminal output

7428866

Use the terminal class instead of the function in the hooks API.

Use terminal class for output in cli commands

e4b1fc8

Use Terminal for output for stating pre commit hooks

ddd2717

Also improve the output by adding indentation.

Remove unused terminal functions

4862b59

The functionality is provided by the Terminal class now.

Allow to set the terminal instance of the hooks API

16b6649

The hooks plugins should use the current terminal instance for their output to use the actual indentation.

Add tests for the hooks plugins console output API

d51cc8d

bjoernricks requested a review from wiegandm November 20, 2019 11:55

Fix tests for Python 3.5

35cbf54

Mock.assert_called() doesn't exist before Python 3.6.

Add changelog entries for console output formatting

f4c55a4

wiegandm approved these changes Nov 20, 2019

View reviewed changes

bjoernricks merged commit 18a043d into greenbone:master Nov 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Terminal output #39

Terminal output #39

bjoernricks commented Nov 20, 2019 •

edited

codecov bot commented Nov 20, 2019 •

edited

Terminal output #39

Terminal output #39

Conversation

bjoernricks commented Nov 20, 2019 • edited

codecov bot commented Nov 20, 2019 • edited

Codecov Report

bjoernricks commented Nov 20, 2019 •

edited

codecov bot commented Nov 20, 2019 •

edited