Color indicators for "check result" column about kernel-hardening-checker

[frakman1]

If you only want to see the failures, you can use the -m show_fail option

[a13xp0p0v]

Thanks @frakman1 !

I would propose creating a function colorize_result() and call several times to avoid copying the code.

[frakman1]

Done.
#86

[harisphnx]

If so, I can make the change and create a PR

[a13xp0p0v]

Yes, it would be nice.
Looking forward to your PR.

[frakman1]

Has anyone done this yet?
I made a hacky attempt of this last year before the sysctl support was added. I added different colors for the two sections too:

I just tried to overlay it onto the latest code but it's too different now. My changes were in kconfig_hardened_check/__init__.py but everything has moved since then. Unfortunately, not an easy merge.

[a13xp0p0v]

@frakman1 thanks, it looks nice.
Could you give a link to your commit? I'll help to rebase it.

[frakman1]

Thank you @a13xp0p0v.
I just checked and my changes were based on this commit:

* 899752c - (Sun Oct 2 21:45:13 2022 +0300) Also check 'nospectre_v2' with 'spectre_v2' - <Alexander Popov> (HEAD -> master, origin/master, origin/HEAD)

Unfortunately, I never commited it and just stashed it before doing a git pull

Original File (rename to .py):
init.txt

Colored File (rename to .py):
init.color.txt

I created a patch file using:

git diff --no-index --patch --output=color.diff __init__.py __init__.color.py

patch file (optionally rename to .diff):
color.txt

[a13xp0p0v]

Thanks, I see the approach.

Let's print OK results in green and FAIL results in red.

We need to modify the table_print() method of classes in engine.py.

I would recommend something like that:

1. defining ANSI escape sequences at the beginning of the file:

GREEN_COLOR = '\x1b[32m'
RED_COLOR = '\x1b[31m'
COLOR_END = '\x1b[0m'

2. modify printing methods this way:

if with_results:
    if self.result.startswith('OK'):
        color = GREEN_COLOR
    elif self.result.startswith('FAIL:'):
        color = RED_COLOR
    else:
        assert(False), f'unexpected result "{self.result}"'
    colored_result = f'{color}{self.result}{COLOR_END}'
    print(f'| {colored_result}', end='')

What do you think?
Would you like to prepare a pull request?

Thanks!

[trclst]

I would only going to color OK and FAIL not full line.
Besides, I don't know if there aren't more important things a | grep FAIL can do.
Maybe it is better to keep the code small, the information is still there whether in color or not.
Anyway hope it looks fancy.

[frakman1]

What do you think? Would you like to prepare a pull request?

I like it. Thank you for the guidance. I just attempted it and it seems I have to repeat that logic in three places before I could get all the prints.

sample output:

Diffs located in my fork here

@a13xp0p0v Let me know if that looks good. If so, I will issue a pull request.

[frakman1]

I've updated the code with your recommendations. See changes here

[a13xp0p0v]

I've left some comments. The main point: it's better to leave printing inside of the table_print() method. The colorize_result() function should only return the colored string.

[frakman1]

Changes applied here

[a13xp0p0v]

Good!

Please remove the unneeded whitespaces and send the pull request.

Looking forward to it.