Make all doc fragments, module utils, and plugin utils private (#11896)

* Make all doc fragments private.

* Make all plugin utils private.

* Make all module utils private.

* Reformat.

* Changelog fragment.

* Update configs and ignores.

* Adjust unit test names.

tests/unit/plugins/module_utils/_hwc_utils/test_dict_comparison.py

@@ -9,7 +9,7 @@ from __future__ import annotations
 
 import unittest
 
-from ansible_collections.community.general.plugins.module_utils.hwc_utils import are_different_dicts
+from ansible_collections.community.general.plugins.module_utils._hwc_utils import are_different_dicts
 
 
 class HwcDictComparisonTestCase(unittest.TestCase):

tests/unit/plugins/module_utils/_hwc_utils/test_hwc_utils.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 import unittest
 
-from ansible_collections.community.general.plugins.module_utils.hwc_utils import HwcModuleException, navigate_value
+from ansible_collections.community.general.plugins.module_utils._hwc_utils import HwcModuleException, navigate_value
 
 
 class HwcUtilsTestCase(unittest.TestCase):

tests/unit/plugins/module_utils/_identity/keycloak/test_keycloak_connect.py

@@ -10,7 +10,7 @@ from urllib.error import HTTPError
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import (
+from ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak import (
     KeycloakError,
     get_token,
 )
@@ -70,7 +70,7 @@ def mock_good_connection(mocker):
         ),
     }
     return mocker.patch(
-        "ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak.open_url",
+        "ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak.open_url",
         side_effect=build_mocked_request(count(), token_response),
         autospec=True,
     )
@@ -98,7 +98,7 @@ def mock_bad_json_returned(mocker):
         "http://keycloak.url/auth/realms/master/protocol/openid-connect/token": create_wrapper('{"access_token":'),
     }
     return mocker.patch(
-        "ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak.open_url",
+        "ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak.open_url",
         side_effect=build_mocked_request(count(), token_response),
         autospec=True,
     )
@@ -130,7 +130,7 @@ def mock_401_returned(mocker):
         ),
     }
     return mocker.patch(
-        "ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak.open_url",
+        "ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak.open_url",
         side_effect=build_mocked_request(count(), token_response),
         autospec=True,
     )
@@ -154,7 +154,7 @@ def mock_json_without_token_returned(mocker):
         ),
     }
     return mocker.patch(
-        "ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak.open_url",
+        "ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak.open_url",
         side_effect=build_mocked_request(count(), token_response),
         autospec=True,
     )

tests/unit/plugins/module_utils/_identity/keycloak/test_keycloak_module_utils.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 import unittest
 
-from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import is_struct_included
+from ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak import is_struct_included
 
 
 class KeycloakIsStructIncludedTestCase(unittest.TestCase):

tests/unit/plugins/module_utils/_net_tools/pritunl/test_api.py

@@ -10,7 +10,7 @@ from unittest.mock import MagicMock
 import pytest
 from ansible.module_utils.common.dict_transformations import dict_merge
 
-from ansible_collections.community.general.plugins.module_utils.net_tools.pritunl import (
+from ansible_collections.community.general.plugins.module_utils._net_tools.pritunl import (
     api,
 )
 

tests/unit/plugins/module_utils/_xenserver/conftest.py

@@ -42,7 +42,7 @@ def XenAPI():
     # First we use importlib.import_module() to import the module and assign
     # it to a local symbol.
     fake_xenapi = importlib.import_module(
-        "ansible_collections.community.general.tests.unit.plugins.module_utils.xenserver.FakeXenAPI"
+        "ansible_collections.community.general.tests.unit.plugins.module_utils._xenserver.FakeXenAPI"
     )
 
     # Now we populate Python module cache with imported fake module using the
@@ -61,7 +61,7 @@ def xenserver(XenAPI):
     # that depend on it have to be imported inside a test function. To make
     # this easier to handle and remove some code repetition, we wrap the import
     # of xenserver module util with a fixture.
-    from ansible_collections.community.general.plugins.module_utils import xenserver
+    from ansible_collections.community.general.plugins.module_utils import _xenserver as xenserver
 
     return xenserver
 

tests/unit/plugins/module_utils/_xenserver/test_gather_vm_params_and_facts.py

@@ -69,7 +69,7 @@ def test_gather_vm_params_and_facts(mocker, fake_ansible_module, XenAPI, xenserv
     mocked_xenapi.configure_mock(**mocked_returns)
 
     mocker.patch(
-        "ansible_collections.community.general.plugins.module_utils.xenserver.get_xenserver_version",
+        "ansible_collections.community.general.plugins.module_utils._xenserver.get_xenserver_version",
         return_value=[7, 2, 0],
     )
 

tests/unit/plugins/module_utils/_xenserver/test_set_vm_power_state.py

@@ -264,7 +264,7 @@ def test_set_vm_power_state_task_timeout(mocker, fake_ansible_module, XenAPI, xe
     mocked_xenapi.configure_mock(**mocked_returns)
 
     mocker.patch(
-        "ansible_collections.community.general.plugins.module_utils.xenserver.wait_for_task", return_value="timeout"
+        "ansible_collections.community.general.plugins.module_utils._xenserver.wait_for_task", return_value="timeout"
     )
 
     with pytest.raises(FailJsonException) as exc_info:
@@ -373,7 +373,7 @@ def test_set_vm_power_state_transition_async(
 
     mocked_xenapi.configure_mock(**mocked_returns)
 
-    mocker.patch("ansible_collections.community.general.plugins.module_utils.xenserver.wait_for_task", return_value="")
+    mocker.patch("ansible_collections.community.general.plugins.module_utils._xenserver.wait_for_task", return_value="")
 
     result = xenserver.set_vm_power_state(fake_ansible_module, fake_xenapi_ref("VM"), power_state_desired, timeout=1)
 

tests/unit/plugins/module_utils/_xenserver/test_xenserverobject.py

@@ -13,7 +13,7 @@ from .FakeAnsibleModule import FailJsonException
 
 def test_xenserverobject_xenapi_lib_detection(mocker, fake_ansible_module, xenserver):
     """Tests XenAPI lib detection code."""
-    mocker.patch("ansible_collections.community.general.plugins.module_utils.xenserver.HAS_XENAPI", new=False)
+    mocker.patch("ansible_collections.community.general.plugins.module_utils._xenserver.HAS_XENAPI", new=False)
 
     with pytest.raises(FailJsonException) as exc_info:
         xenserver.XenServerObject(fake_ansible_module)

tests/unit/plugins/module_utils/test__cmd_runner.py

@@ -9,7 +9,7 @@ from unittest.mock import MagicMock, PropertyMock
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
 
 TC_FORMATS = dict(
     simple_boolean__true=(partial(cmd_runner_fmt.as_bool, "--superflag"), True, ["--superflag"], None),

tests/unit/plugins/module_utils/test__csv.py

@@ -8,7 +8,7 @@ import typing as t
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils import csv
+from ansible_collections.community.general.plugins.module_utils import _csv as csv
 
 VALID_CSV = [
     (

tests/unit/plugins/module_utils/test__deps.py

@@ -9,7 +9,7 @@ from unittest.mock import MagicMock
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils import deps
+from ansible_collections.community.general.plugins.module_utils import _deps as deps
 
 
 @pytest.fixture

tests/unit/plugins/module_utils/test__module_helper.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils.module_helper import cause_changes
+from ansible_collections.community.general.plugins.module_utils._module_helper import cause_changes
 
 #
 # DEPRECATION NOTICE

tests/unit/plugins/module_utils/test__ocapi_utils.py

@@ -10,7 +10,7 @@ import shutil
 import tempfile
 import unittest
 
-from ansible_collections.community.general.plugins.module_utils.ocapi_utils import OcapiUtils
+from ansible_collections.community.general.plugins.module_utils._ocapi_utils import OcapiUtils
 
 
 class TestOcapiUtils(unittest.TestCase):

tests/unit/plugins/module_utils/test__onepassword.py

@@ -8,7 +8,7 @@ import os
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils.onepassword import OnePasswordConfig
+from ansible_collections.community.general.plugins.module_utils._onepassword import OnePasswordConfig
 
 
 @pytest.fixture

tests/unit/plugins/module_utils/test__opennebula.py

@@ -8,7 +8,7 @@ import textwrap
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils.opennebula import flatten, render
+from ansible_collections.community.general.plugins.module_utils._opennebula import flatten, render
 
 FLATTEN_VALID = [
     ([[[1]], [2], 3], False, [1, 2, 3]),

tests/unit/plugins/module_utils/test__python_runner.py

@@ -9,8 +9,8 @@ from unittest.mock import MagicMock, PropertyMock
 
 import pytest
 
-from ansible_collections.community.general.plugins.module_utils.cmd_runner import cmd_runner_fmt
-from ansible_collections.community.general.plugins.module_utils.python_runner import PythonRunner
+from ansible_collections.community.general.plugins.module_utils._cmd_runner import cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils._python_runner import PythonRunner
 
 TC_RUNNER = dict(
     # SAMPLE: This shows all possible elements of a test case. It does not actually run.

tests/unit/plugins/module_utils/test__sclaeway.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 import unittest
 
-from ansible_collections.community.general.plugins.module_utils.scaleway import SecretVariables, argon2
+from ansible_collections.community.general.plugins.module_utils._scaleway import SecretVariables, argon2
 
 
 class SecretVariablesTestCase(unittest.TestCase):

tests/unit/plugins/module_utils/test__utm_utils.py

@@ -11,7 +11,7 @@
 
 from __future__ import annotations
 
-from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM
+from ansible_collections.community.general.plugins.module_utils._utm_utils import UTM
 
 
 class FakeModule:

tests/unit/plugins/module_utils/test__vardict.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-from ansible_collections.community.general.plugins.module_utils.vardict import VarDict
+from ansible_collections.community.general.plugins.module_utils._vardict import VarDict
 
 
 def test_var_simple():