Feature: add owner and group filter to builtin.find

[phoehnel]

SUMMARY

Adds new parameters to builtin.find to be able to filter results by owner and group.
See examples below for clarification.

The filters are built in a similar way to the existing age and size filter.
They work on the existing data after the file list is obtained.
The filters work for directories, files and links.

Fixes #76586

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

ansible.builtin.find

ADDITIONAL INFORMATION

How to Use

- name: find all elements owned by user and group example
    find: 
        paths: /opt/myapp
        user: example
        group: example

- name: find all elements owned by one of the user in a given list
  find:
    paths: /etc
    users:
      - user1
      - user2

[webknjaz]

This needs a rebase.

[phoehnel]

@webknjaz rebase is done! 👍🏻

[sivel]

Outside of the rebase, the permissions functionality will need removed, as it has already been implemented in ca08261 via a slightly different mechanism.

Note, I've not performed any review of this PR.

[phoehnel]

Outside of the rebase, the permissions functionality will need removed, as it has already been implemented in ca08261 via a slightly different mechanism.

ah fair! didn't saw that. Removed the function now

[s-hertel]

This change would need a minor_changes changelog fragment and test cases added to https://github.com/ansible/ansible/blob/devel/test/integration/targets/find/ ensure it keeps working.

[s-hertel]

The version_added for the new options should be "2.21" now.

[s-hertel]

Calling statinfo for every path more than once feels inefficient. Can we convert the list of users and groups to a list of ints in main() for quick comparison? Then this could be:

Suggested change

	if (users is None or (iter(users) and len(users) < 1)) and \
	(groups is None or (iter(groups) and len(groups) < 1)):
	return True
	if (iter(users) and len(users) > 0) or (iter(groups) and len(groups) > 0):
	stinfo = statinfo(st)
	if iter(users) and len(users) > 0:
	if stinfo['pw_name'] not in users:
	return False
	if iter(groups) and len(groups) > 0:
	if stinfo['gr_name'] not in groups:
	return False
	if users and st.st_uid not in users:
	return False
	if groups and st.st_gid not in groups:
	return False

[s-hertel]

find has -uid/-gid flags too. We could support either with something like:

    uids = []
    for user in params['users']:
        try:
            uid = int(user)
        except ValueError:
            try:
                uid = pwd.getpwnam(user).pw_uid
            except KeyError:
                module.fail_json(msg=f'Failed to look up user {user}')
        uids.append(uid)

    gids = []
    for group in params['groups']:
        try:
            gid = int(group)
        except ValueError:
            try:
                gid = grp.getgrnam(group).gr_gid
            except KeyError:
                module.fail_json(msg=f'Failed to look up group {group}')
        gids.append(gid)

[Akasurde]

Suggested change

	users:
	description:
	- If set, only elements owned by a user in the list are returned
	type: list
	aliases: [ user ]
	elements: str
	version_added: "2.17"
	default: []
	users:
	description:
	- If set, only elements owned by a user in the list are returned.
	type: list
	elements: str
	version_added: "2.21"

[Akasurde]

Suggested change

	groups:
	description:
	- If set, only elements owned by a group in the list are returned
	type: list
	aliases: [ group ]
	elements: str
	version_added: "2.17"
	default: []
	groups:
	description:
	- If set, only elements owned by a group in the list are returned.
	type: list
	elements: str
	version_added: "2.21"

[Akasurde]

I would keep the plural form to maintain uniformity.