salt.wheel.file_roots.find missing subdir=true

[kevthehermit]

/srv/salt # salt --version
salt 3002.5

When using file_roots.write we are allowed to write to subdirs, however, if we try to read the newly created file we are blocked from doing so.

I believe it is because the find function is missing subdir=True from the clean_path check

salt/salt/wheel/file_roots.py

Line 29 in 4af72e7

if not salt.utils.verify.clean_path(root, full):

the write function has this check

salt/salt/wheel/file_roots.py

Line 115 in 4af72e7

if not salt.utils.verify.clean_path(root, dest, subdir=True):

Tests performed using the Pepper API

Write file

>>> pepper_client.api.low([{'client': 'wheel', 'fun': 'file_roots.write', 'path': 'frames/docker_linux.sls', 'data': 'hello world'}])
{'return': [{'tag': 'salt/wheel/20210314115719692923', 'data': {'fun': 'wheel.file_roots.write', 'jid': '20210314115719692923', 'tag': 'salt/wheel/20210314115719692923', 'user': 'salt', '_stamp': '2021-03-14T11:57:19.709197', 'return': 'Wrote data to file /srv/salt/frames/docker_linux.sls', 'success': True}}]}

read file

>>> pepper_client.api.low([{'client': 'wheel', 'fun': 'file_roots.read', 'path': 'frames/docker_linux.sls'}])
{'return': [{'tag': 'salt/wheel/20210314115802924030', 'data': {'fun': 'wheel.file_roots.read', 'jid': '20210314115802924030', 'tag': 'salt/wheel/20210314115802924030', 'user': 'salt', '_stamp': '2021-03-14T11:58:02.941864', 'return': [], 'success': True}}]}

find

>>> pepper_client.api.low([{'client': 'wheel', 'fun': 'file_roots.find', "path": "frames/docker_linux.sls"}])
{'return': [{'tag': 'salt/wheel/20210314120236946891', 'data': {'fun': 'wheel.file_roots.find', 'jid': '20210314120236946891', 'tag': 'salt/wheel/20210314120236946891', 'user': 'salt', '_stamp': '2021-03-14T12:02:36.960801', 'return': [], 'success': True}}]}

list env

>>> pepper_client.api.low([{'client': 'wheel', 'fun': 'file_roots.list_env'}])
{'return': [{'tag': 'salt/wheel/20210314115836835377', 'data': {'fun': 'wheel.file_roots.list_env', 'jid': '20210314115836835377', 'tag': 'salt/wheel/20210314115836835377', 'user': 'salt', '_stamp': '2021-03-14T11:58:36.850508', 'return': {'/srv/salt': {'frames': {'docker_linux.sls': 'f'}, 'test': 'f'}, '/srv/spm/salt': {}}, 'success': True}}]}

list roots

>>> pepper_client.api.low([{'client': 'wheel', 'fun': 'file_roots.list_roots'}])
{'return': [{'tag': 'salt/wheel/20210314115904413257', 'data': {'fun': 'wheel.file_roots.list_roots', 'jid': '20210314115904413257', 'tag': 'salt/wheel/20210314115904413257', 'user': 'salt', '_stamp': '2021-03-14T11:59:04.424949', 'return': {'base': [{'/srv/salt': {'frames': {'docker_linux.sls': 'f'}, 'test': 'f'}, '/srv/spm/salt': {}}]}, 'success': True}}]}

[welcome]

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

• Community Wiki
• Salt’s Contributor Guide
• Join our Community Slack
• IRC on Freenode
• SaltStack YouTube channel
• SaltStackInc Twitch channel

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at core@saltstack.com. We’re glad you’ve joined our community and look forward to doing awesome things with you!

[kevthehermit]

Confirmed that setting clean_path(root, full) to clean_path(root, full, subdir=True) allows me to read files as expected

>>> pepper_client.api.low([{'client': 'wheel', 'fun': 'file_roots.read', 'path': 'frames/docker_linux.sls'}])
{'return': [{'tag': 'salt/wheel/20210314130704569888', 'data': {'fun': 'wheel.file_roots.read', 'jid': '20210314130704569888', 'tag': 'salt/wheel/20210314130704569888', 'user': 'salt', '_stamp': '2021-03-14T13:07:05.005846', 'return': [{'/srv/salt/frames/docker_linux.sls': 'hello world'}], 'success': True}}]}