Add flatpak module

[steveno]

What does this PR do?

Add support for flatpak

Tests written?

No

Commits signed with GPG?

Yes

[steveno]

A lot of inspiration was taken from #51625

[steveno]

I don't understand why the pr/docs job failed. If someone would be willing to explain to me what's going on there I'm sure I could push a fix pretty quickly.

[steveno]

Gentle ping.

[steveno]

@rallytime This PR is ready for review

[twangboy]

Hey, @steveno, thanks for the PR! Could you write some tests for these two new modules?

[steveno]

@twangboy I have made the requested corrections.

I did not, however, add the tests you requested. I have nothing against adding tests for this, but honestly, I don't know how.

[twangboy]

Just a few more minor things

[steveno]

@twangboy I have updated the docstrings as you requested.

[twangboy]

@steveno Looks like there's some lint:

salt.modules.flatpak.py:11, PyLint, Priority: Normal
--
Unused import subprocess


salt.states.flatpak.py:65, PyLint, Priority: High
--
Undefined variable 'install'


salt.states.flatpak.py:164, PyLint, Priority: High
--
Undefined variable 'install'

[steveno]

@twangboy I corrected the lint errors.

Thank you for your patience!

[twangboy]

Sorry, one more thing and then I think we're good. The docs test failed. The suggestion should take care of it. Thanks for your commitment to quality code!

[steveno]

@twangboy I made the suggested edits to the docs.

[twangboy]

@steveno We're still seeing an issue with the docs. It's saying that it's an unexpected indentation in the add_remote docstring. Here's the actual error:

09:44:05 /var/jenkins/workspace/pr-doc_PR-51993-NSZVPOPKEFAWZQJEFY6OXP5GGETQE5ZOYGKZRVLHMUZW34NHQMRQ/salt/modules/flatpak.py:docstring of salt.modules.flatpak.add_remote:13:Unexpected indentation.

I'm not seeing it. Maybe you have a tab somewhere.

[steveno]

@twangboy I can't find anything either. There are no tabs.

[steveno]

The docs job is infuriating. Can someone help me understand how to fix this issue?

13:44:40 Warning, treated as error:
13:44:40 /var/jenkins/workspace/pr-doc_PR-51993-NSZVPOPKEFAWZQJEFY6OXP5GGETQE5ZOYGKZRVLHMUZW34NHQMRQ/salt/states/flatpak.py:docstring of salt.states.flatpak.add_remote:1:duplicate object description of salt.states.flatpak.add_remote, other instance in /var/jenkins/workspace/pr-doc_PR-51993-NSZVPOPKEFAWZQJEFY6OXP5GGETQE5ZOYGKZRVLHMUZW34NHQMRQ/doc/ref/states/all/salt.modules.flatpak.rst, use :noindex: for one of them

I don't want to abuse the CI job with 10 commits just trying to figure this out.

[waynew]

@steveno Do you have sphinx & whatnot locally to build the docs? I'm giving it a shot myself to see if I can figure out what's going on, but that might be helpful.

[steveno]

@waynew I do not. I had not seen that page on how to do it, though. I'll give it a try myself.

[steveno]

I obviously don't know what I'm doing because the only message I get trying to build the docs is

Makefile:72: recipe for target 'html' failed
make: *** [html] Segmentation fault (core dumped)

In fact, I get that segfault every time I try any of the make commands. pip installed sphinx 1.8.5

[waynew]

@steveno That's super weird. I have a vague recollection of someone having that error before, but I'm not getting it myself. Did you pip install sphinx with python2 or python3? I'm using 3 on mac OSX, FWIW.

[steveno]

I blew away my virtualenv and created a new one exclusively using pip3 and now sphinx seems to be working for me locally. Thanks for the help @waynew !

[steveno]

I managed to fix the docs job!! 🎊

I think this fixes all of the review comments. I once again appreciate all of the help I got with this merge!

[waynew]

🎉 Awesome!

We're still tweaking our settings with codeclimate - it's reporting some (potential) issues, though I don't know how much I agree that those are problems, at least not problems that we can do anything about 🤷‍♂️