Progress Bar Implementation

[TitusSmith33]

Progress Bar Implementation

Description

This PR introduced a progress bar into the gatorgrade that demonstrates some dynamic progress bar to the user. The base implementation -what is included when you run the command gatorgrade in your terminal- is a dynamic progress bar that updates a progress bar based on if a check passes or fails, while the checks are being run. If a check passes, the progress updates the green section of the bar and any failed checks remain red on the progress bar. Below is an image of the expected output for the gatorgrade command, where as you can see some checks failed so that is represented in the progress bar:

This is what the progress bar output should look like if all the checks pass:

If you run gatorgrade --run_status_bar the functionality of the progress bar changes. Instead of updating the dynamic progress bar based on whether the checks pass or fail, this progress bar updates dynamically based on whether a gatorgrade check runs or fails to run. This implementation is useful for debugging and more advanced uses of gatorgrade. Similarly to the default progress bar, the bar updates green if a check runs and any failed checks keep a section of the bar red. Below is an image of the expected output for the gatorgrade --run_status_bar command, where as you can see some checks failed, however this progress bar is only concerned on if the checks run or not:

Lastly, there is an implementation using the command gatorgrade --no_status_bar which disables all progress bars and simply produces the output from gatorgrade with no progress bar present. Below is an image of the expected output for the gatorgrade --no_status_bar command, where there is no progress bar at all:

The implementation for this feature are in output.py in the run_checks functions, and the flags update for --run_status_bar and --no_status_bar are in main.py. I have run and tested this on a Windows 11 OS and would love to have another OS review this PR to ensure the feature is compatible across different OS. Thank you!!

Type of Change

• Feature
• Bug fix
• Documentation

Contributors

• @TitusSmith33

[rebekahrudd]

This worked on my Ubuntu computer running Linux.

Commands Ran:

gatorgrade

--run_status_bar

--no_status_bar

[CalebKendra]

LGTM!

[AlishChhetri]

LGTM!

[dyga01]

This feature appears to be working on Mac OS. Here is the output I got from running gatorgrade --config config/gatorgrade.yml: