[RFE] check container help file inside image in roff format

[phracek]

Nowadays, MTF uses help.md (Markdown) format for testing some sanity checks.
https://github.com/fedora-modularity/meta-test-family/blob/devel/moduleframework/tools/helpmd_lint.py#L30
https://github.com/fedora-modularity/meta-test-family/blob/devel/moduleframework/helpfile_linter.py

It would be nice to add also possibility for roff format.

MTF will not check roff format in container/image. This is case for conu. Therefore reassigning.
MTF issue is here: fedora-modularity/meta-test-family#138

[TomasTomecek]

I'm +1 on having code in conu which checks whether a help file is present in a container (image).

I'm -1 on the code which parses the help file, be it roff or markdown. Maintaining such code is completely infeasible from my PoV. If you have some good arguments here, I would like to hear them.

[phracek]

@TomasTomecek Yes, checking only presence of help file is fine. And I guess only roff file has to be used in container(image). I would check only sections like:

.TH "MEMCACHED"
.SH NAME
.SH DESCRIPTION
.SH USAGE
.SH ENVIRONMENT VARIABLES
.SH SECURITY IMPLICATIONS

Some of them are invalid if e.g. environment variables does not exist in Dockerfile or even they are not specified.

[dhodovsk]

AC: implement basic method for checking existence of help file and for getting help file. Those methods then will be used in external linter or mtf.

[dhodovsk]

Since #197 help file can be check and obtained using image.mount()

Example:

with image.mount() as fs:
    fs.file_is_present('/help.1')

Can we close the issue or are shortcut methods image.has_help_file() and image.get_help_file required?

[TomasTomecek]

Agreed that this may no longer be needed.

[dhodovsk]

This will be done in colin user-cont/colin#83