initial nfs_exports_info module #10122

yousefenzhad · 2025-05-12T08:53:12Z

SUMMARY

This pull request introduces a new Ansible module that parses the /etc/exports file
to extract NFS shared folder information, including export paths and associated options.
This is useful for automation tasks that require visibility into NFS export configurations.

ISSUE TYPE

New Module/Plugin Pull Request

COMPONENT NAME

nfs_exports_info

ADDITIONAL INFORMATION

This module reads and parses the /etc/exports file line by line, ignoring comments and blank lines,
and returns a structured list of dictionaries with the following information for each export:

path
clients and their export options

felixfontein

Thanks for your contribution!

felixfontein · 2025-05-15T05:08:36Z

plugins/modules/nfs_exports_info.py

+# SPDX-License-Identifier: GPL-3.0-or-later
+# Copyright: (c) 2025, Samaneh Yousefnezhad <[email protected]>
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)


Suggested change

# SPDX-License-Identifier: GPL-3.0-or-later

# Copyright: (c) 2025, Samaneh Yousefnezhad <[email protected]>

# GNU General Public License v3.0+

# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

#!/usr/bin/python

# Copyright (c) 2025, Samaneh Yousefnezhad <[email protected]>

# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)

# SPDX-License-Identifier: GPL-3.0-or-later

felixfontein · 2025-05-15T05:08:55Z

tests/unit/plugins/modules/test_nfs_exports_info.py

@@ -0,0 +1,74 @@
+# SPDX-License-Identifier: GPL-3.0-or-later


Suggested change

# SPDX-License-Identifier: GPL-3.0-or-later

# Copyright (c) 2025, Samaneh Yousefnezhad <[email protected]>

# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)

# SPDX-License-Identifier: GPL-3.0-or-later

this also applies for the module itself

felixfontein · 2025-05-15T05:09:11Z

plugins/modules/nfs_exports_info.py

+---
+module: nfs_exports_info
+
+short_description: Extract folders, IPs, and options from /etc/exports


Suggested change

short_description: Extract folders, IPs, and options from /etc/exports

short_description: Extract folders, IPs, and options from C(/etc/exports)

version_added: 10.7.0

plugins/modules/nfs_exports_info.py

felixfontein · 2025-05-15T05:10:21Z

plugins/modules/nfs_exports_info.py

+EXAMPLES = r"""
+- name: Get IPs and options per shared folder
+  fava.infra.nfs_exports_info:
+    output_format: 'ips_per_share'


I would add a register to make it more obvious that you should register the result:

Suggested change

output_format: 'ips_per_share'

output_format: 'ips_per_share'

register: result

felixfontein · 2025-05-15T05:11:44Z

plugins/modules/nfs_exports_info.py

+
+def get_exports(module, output_format, file_path="/etc/exports"):
+    try:
+        exports_file_digest = module.digest_from_file(file_path, 'sha1')


SHA1 is not always available. You need to do some fallback, or (better) provide at least a few different hash values based on availability. (I'd make the return value a dictionary with the key being the hash's name.)

plugins/modules/nfs_exports_info.py

felixfontein · 2025-05-15T05:12:58Z

plugins/modules/nfs_exports_info.py

+  mapping folders to their corresponding IP addresses and access options.
+
+author:
+  - Samaneh Yousefnezhad (@yousefenzhad)


Suggested change

- Samaneh Yousefnezhad (@yousefenzhad)

- Samaneh Yousefnezhad (@yousefenzhad)

extends_documentation_fragment:

- community.general.attributes

- community.general.attributes.info_module

felixfontein · 2025-05-15T05:13:29Z

tests/unit/plugins/modules/test_nfs_exports_info.py

+# Add plugins/modules to path for direct import
+sys.path.insert(0, os.path.abspath(
+    os.path.join(os.path.dirname(__file__), '../../../../plugins/modules')
+))
+
+from nfs_exports_info import get_exports


Suggested change

# Add plugins/modules to path for direct import

sys.path.insert(0, os.path.abspath(

os.path.join(os.path.dirname(__file__), '../../../../plugins/modules')

))

from nfs_exports_info import get_exports

from ansible_collections.community.general.plugins.modules.nfs_exports_info import get_exports

felixfontein · 2025-05-15T05:14:12Z

tests/unit/plugins/modules/test_nfs_exports_info.py

+try:
+    from unittest.mock import mock_open, patch, MagicMock
+except ImportError:
+    from mock import mock_open, patch, MagicMock


Suggested change

try:

from unittest.mock import mock_open, patch, MagicMock

except ImportError:

from mock import mock_open, patch, MagicMock

from ansible_collections.community.internal_test_tools.tests.unit.compat.mock import mock_open, patch, MagicMock

russoz

hi @yousefenzhad thanks for your contribution!

I left some comments.

plugins/modules/nfs_exports_info.py

russoz · 2025-05-20T08:39:05Z

plugins/modules/nfs_exports_info.py

+exports_info:
+  description:
+    - A mapping of shared folders to IPs and their options, or the reverse.
+    - What it is depends on O(output_format).
+  type: dict
+  returned: always


Personally, I think there should be two different return values, something like exports_per_ip, exports_per_share, and the format should be fixed for each one, instead of having a single return value with a variable format. The info part is redundant, given the module name.

russoz · 2025-05-20T22:50:10Z

plugins/modules/nfs_exports_info.py

+        try:
+            f = open(file_path, 'r')
+            output_lines = f.readlines()
+            f.close()
+        except IOError:
+            module.fail_json(msg="Could not read {}".format(file_path))


If I may suggest, make this a small, simple function, say read_exports or something similar, and that will simplify mocking/patching in tests/unit/plugins/modules/test_nfs_exports_info.py line 40

russoz · 2025-05-20T22:52:56Z

plugins/modules/nfs_exports_info.py

+        pattern = r'\s*(\S+)\s+(.+)'
+
+        for line in output_lines:
+            line = line.strip()
+            if not line or line.startswith('#'):
+                continue
+
+            match = re.match(pattern, line)


Strongly recommend compiling the regexp outside of the loop:

Suggested change

pattern = r'\s*(\S+)\s+(.+)'

for line in output_lines:

line = line.strip()

if not line or line.startswith('#'):

continue

match = re.match(pattern, line)

pattern = re.compile(r'\s*(\S+)\s+(.+)')

for line in output_lines:

line = line.strip()

if not line or line.startswith('#'):

continue

match = pattern.match(line)

russoz · 2025-05-20T22:53:50Z

plugins/modules/nfs_exports_info.py

+            folder = match.group(1)
+            rest = match.group(2)
+
+            entries = re.findall(r'(\d+\.\d+\.\d+\.\d+)\(([^)]+)\)', rest)


Compile it outside the loop as well, pls.

russoz · 2025-05-20T22:54:46Z

plugins/modules/nfs_exports_info.py

+        }
+
+    except Exception as e:
+        module.fail_json(msg="Error while processing exports: {}".format(str(e)))


I believe this is redundant, format() will already convert it to a string.

Suggested change

module.fail_json(msg="Error while processing exports: {}".format(str(e)))

module.fail_json(msg="Error while processing exports: {}".format(e))

russoz · 2025-05-20T22:58:27Z

@felixfontein I am thinking this might be better off as a facts module, rather than just info. It is some system information, unlikely to change often (for most cases).

felixfontein · 2025-05-21T05:12:08Z

@felixfontein I am thinking this might be better off as a facts module, rather than just info. It is some system information, unlikely to change often (for most cases).

That's fine with me. But in that case the output_format option needs to be redone or removed. (And the return values definitely have to be worked in that case. I also suggested that to be done in any case.)

initial nfs_exports_info module

309fe6d

ansibullbot added module module new_contributor Help guide this first time contributor new_plugin New plugin plugins plugin (any type) tests tests unit tests/unit labels May 12, 2025

This comment was marked as outdated.

Sign in to view

ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label May 12, 2025

change nfs_exports_info

05a326c

yousefenzhad closed this May 12, 2025

yousefenzhad reopened this May 12, 2025

This comment was marked as outdated.

Sign in to view

Yousefnezhad added 4 commits May 12, 2025 12:56

add line at the end of file

e0c4e3c

Fix: add __future__ imports to test for Python 2 compatibility

4aa341a

Fix: add __metaclass__ for Python 2 compatibility in test

8949e2b

Fix E302: add 2 blank lines before top-level function

fef3a83

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch labels May 12, 2025

Yousefnezhad added 2 commits May 13, 2025 07:33

correct ERROR collecting

2c75f3c

add blank

e97bc68

This comment was marked as outdated.

Sign in to view

Yousefnezhad added 5 commits May 13, 2025 08:00

error mock module

096f019

new line

6367ff0

new line end of file

a0fae4c

blank line at end of file

fc5073e

FATAL: Command "pytest "

9c2dbfc

ansibullbot added the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label May 13, 2025

Error Found 3 pep8 issue

128bb8b

ansibullbot removed the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label May 13, 2025

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label May 13, 2025

SPDX Format

7dd2544

felixfontein reviewed May 15, 2025

View reviewed changes

NOX Errors

fafc2c0

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels May 17, 2025

trailing whitespace

2c3bdff

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels May 17, 2025

SPDX-License

5eda6b9

russoz reviewed May 20, 2025

View reviewed changes

Erorr community

e77b24f

ansibullbot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels May 21, 2025

-short_description: Extract folders, IPs, and options from /etc/exports
+short_description: Extract folders, IPs, and options from C(/etc/exports)
+version_added: 10.7.0

	output_format: 'ips_per_share'
	output_format: 'ips_per_share'
	register: result

-  - Samaneh Yousefnezhad (@yousefenzhad)
+  - Samaneh Yousefnezhad (@yousefenzhad)
+extends_documentation_fragment:
+  - community.general.attributes
+  - community.general.attributes.info_module

	module.fail_json(msg="Error while processing exports: {}".format(str(e)))
	module.fail_json(msg="Error while processing exports: {}".format(e))

initial nfs_exports_info module #10122

Are you sure you want to change the base?

initial nfs_exports_info module #10122

Conversation

yousefenzhad commented May 12, 2025

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russoz May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russoz commented May 20, 2025

Uh oh!

felixfontein commented May 21, 2025

Uh oh!

Uh oh!

russoz May 20, 2025 •

edited

Loading