Sort, reorder and color build summary output

[neha170]

Merge Checklist

All boxes should be checked before merging the PR (just tick any boxes which don't apply to this PR)

• The toolchain has been rebuilt successfully (or no changes were made to it)
• The toolchain/worker package manifests are up-to-date
• Any updated packages successfully build (or no packages were changed)
• Packages depending on static components modified in this PR (Golang, *-static subpackages, etc.) have had their Release tag incremented.
• Package tests (%check section) have been verified with RUN_CHECK=y for existing SPEC files, or added to new SPEC files
• All package sources are available
• cgmanifest files are up-to-date and sorted (./cgmanifest.json, ./toolkit/scripts/toolchain/cgmanifest.json, .github/workflows/cgmanifest.json)
• LICENSE-MAP files are up-to-date (./SPECS/LICENSES-AND-NOTICES/data/licenses.json, ./SPECS/LICENSES-AND-NOTICES/LICENSES-MAP.md, ./SPECS/LICENSES-AND-NOTICES/LICENSE-EXCEPTIONS.PHOTON)
• All source files have up-to-date hashes in the *.signatures.json files
• sudo make go-tidy-all and sudo make go-test-coverage pass
• Documentation has been updated to match any changes to the build system
• Ready to merge

---

Summary

Sort summary, reorder summary, add option to color output on terminal

Change Log

• Add new make option LOG_COLOR with options auto (default), always, never
• LOG_COLOR = always: Color both terminal output and logs
• LOG_COLOR = auto: Color only terminal output but not the logs
• LOG_COLOR = never: Disable color in both log and terminal output
• Remove color codes from logs when LOG_COLOR is not always
• Print SRPMs in build summary in alphabetical order
• Reorder summary (print failed, built and prebuilt ones at the end)
• Add new color package import for golang

Does this affect the toolchain?

NO

Associated issues

• Some initial discussion can be found here #46098944

Test Methodology

• Locally built and confirmed the changes in build summary

Summary( before without sort/color):

Sorted and colored summary:

Logs are non-colored when option is not LOG_COLOR=always:

On dark background

[corvus-callidus]

Is there a way to make the color optional for accessibility purposes?

[neha170]

Is there a way to make the color optional for accessibility purposes?

@https://github.com/dmcilvaney Are we ok adding another make option for choosing to keep color on or off?
I am thinking something like LOG_COLOR=on/off like we have LOG_LEVEL...

[PawelWMS]

Let's update the SetToSliceAll function's name to make it clear we're allowing duplicates in this case (see: comments near that function).

And let's try to strip the colouring from file logs to keep the easy to read, parse, and search through them. You can try modifying newWriterHook inside toolkit/tools/internal/logger/writerhook.go so that it cuts out the colouring when useColors is false.

Ideally, let's also try to find and use existing libraries to help with coloring the output.

Minor comments aside from that.

Thank you for cleaning this up!

[dmcilvaney]

Is there a way to make the color optional for accessibility purposes?

@https://github.com/dmcilvaney Are we ok adding another make option for choosing to keep color on or off? I am thinking something like LOG_COLOR=on/off like we have LOG_LEVEL...

I think always, never, auto is the tuple I've always seen with most linux tools, but the flag name is fine with me.

[neha170]

Keeping this PR focused on summary (color, sort, reorder) and making a separate PR for changes requested in https://microsoft.visualstudio.com/OS/_workitems/edit/46098944
PR: #6768