Make all module_utils and plugin_utils private (#887)

* Add leading underscore. Remove deprecated module utils.

* Document module and plugin utils as private. Add changelog fragment.

* Convert relative to absolute imports.

* Remove unnecessary imports.

tests/sanity/ignore-2.17.txt

@@ -1,18 +1,18 @@
-plugins/module_utils/acme/account.py pep8:E704
-plugins/module_utils/acme/acme.py pep8:E704
-plugins/module_utils/acme/acme.py pylint:unpacking-non-sequence
-plugins/module_utils/acme/backend_openssl_cli.py pep8:E704
-plugins/module_utils/acme/certificate.py pep8:E704
-plugins/module_utils/crypto/cryptography_support.py pep8:E704
-plugins/module_utils/crypto/module_backends/certificate.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_entrust.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_ownca.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_selfsigned.py no-assert
-plugins/module_utils/crypto/module_backends/csr.py no-assert
-plugins/module_utils/crypto/module_backends/privatekey_convert.py no-assert
-plugins/module_utils/crypto/support.py pep8:E704
-plugins/module_utils/openssh/backends/keypair_backend.py no-assert
-plugins/module_utils/openssh/certificate.py pep8:E704
+plugins/module_utils/_acme/account.py pep8:E704
+plugins/module_utils/_acme/acme.py pep8:E704
+plugins/module_utils/_acme/acme.py pylint:unpacking-non-sequence
+plugins/module_utils/_acme/backend_openssl_cli.py pep8:E704
+plugins/module_utils/_acme/certificate.py pep8:E704
+plugins/module_utils/_crypto/cryptography_support.py pep8:E704
+plugins/module_utils/_crypto/module_backends/certificate.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_entrust.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_ownca.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py no-assert
+plugins/module_utils/_crypto/module_backends/csr.py no-assert
+plugins/module_utils/_crypto/module_backends/privatekey_convert.py no-assert
+plugins/module_utils/_crypto/support.py pep8:E704
+plugins/module_utils/_openssh/backends/keypair_backend.py no-assert
+plugins/module_utils/_openssh/certificate.py pep8:E704
 plugins/modules/acme_account.py pylint:unpacking-non-sequence
 plugins/modules/acme_account_info.py pylint:unpacking-non-sequence
 plugins/modules/acme_certificate.py pylint:unpacking-non-sequence

tests/sanity/ignore-2.18.txt

@@ -1,17 +1,17 @@
-plugins/module_utils/acme/account.py pep8:E704
-plugins/module_utils/acme/acme.py pep8:E704
-plugins/module_utils/acme/backend_openssl_cli.py pep8:E704
-plugins/module_utils/acme/certificate.py pep8:E704
-plugins/module_utils/crypto/cryptography_support.py pep8:E704
-plugins/module_utils/crypto/module_backends/certificate.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_entrust.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_ownca.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_selfsigned.py no-assert
-plugins/module_utils/crypto/module_backends/csr.py no-assert
-plugins/module_utils/crypto/module_backends/privatekey_convert.py no-assert
-plugins/module_utils/crypto/support.py pep8:E704
-plugins/module_utils/openssh/backends/keypair_backend.py no-assert
-plugins/module_utils/openssh/certificate.py pep8:E704
+plugins/module_utils/_acme/account.py pep8:E704
+plugins/module_utils/_acme/acme.py pep8:E704
+plugins/module_utils/_acme/backend_openssl_cli.py pep8:E704
+plugins/module_utils/_acme/certificate.py pep8:E704
+plugins/module_utils/_crypto/cryptography_support.py pep8:E704
+plugins/module_utils/_crypto/module_backends/certificate.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_entrust.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_ownca.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py no-assert
+plugins/module_utils/_crypto/module_backends/csr.py no-assert
+plugins/module_utils/_crypto/module_backends/privatekey_convert.py no-assert
+plugins/module_utils/_crypto/support.py pep8:E704
+plugins/module_utils/_openssh/backends/keypair_backend.py no-assert
+plugins/module_utils/_openssh/certificate.py pep8:E704
 plugins/modules/acme_certificate.py no-assert
 plugins/modules/luks_device.py no-assert
 plugins/modules/openssl_pkcs12.py no-assert

tests/sanity/ignore-2.19.txt

@@ -1,10 +1,10 @@
-plugins/module_utils/crypto/module_backends/certificate.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_entrust.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_ownca.py no-assert
-plugins/module_utils/crypto/module_backends/certificate_selfsigned.py no-assert
-plugins/module_utils/crypto/module_backends/csr.py no-assert
-plugins/module_utils/crypto/module_backends/privatekey_convert.py no-assert
-plugins/module_utils/openssh/backends/keypair_backend.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_entrust.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_ownca.py no-assert
+plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py no-assert
+plugins/module_utils/_crypto/module_backends/csr.py no-assert
+plugins/module_utils/_crypto/module_backends/privatekey_convert.py no-assert
+plugins/module_utils/_openssh/backends/keypair_backend.py no-assert
 plugins/modules/acme_certificate.py no-assert
 plugins/modules/luks_device.py no-assert
 plugins/modules/openssl_pkcs12.py no-assert

tests/unit/plugins/module_utils/_acme/backend_data.py

@@ -9,19 +9,19 @@ import datetime
 import os
 import typing as t
 
-from ansible_collections.community.crypto.plugins.module_utils.acme.backends import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.backends import (
     CertificateInformation,
     CryptoBackend,
 )
-from ansible_collections.community.crypto.plugins.module_utils.acme.errors import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.errors import (
     BackendException,
 )
 
-from ..test_time import TIMEZONES, cartesian_product
+from ..test__time import TIMEZONES, cartesian_product
 
 
 if t.TYPE_CHECKING:
-    from ansible_collections.community.crypto.plugins.module_utils.acme.backends import (
+    from ansible_collections.community.crypto.plugins.module_utils._acme.backends import (
         Criterium,
     )
 

tests/unit/plugins/module_utils/_acme/test_backend_cryptography.py

@@ -11,20 +11,20 @@ from unittest.mock import (
 )
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.acme.backend_cryptography import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.backend_cryptography import (
     HAS_CURRENT_CRYPTOGRAPHY,
     CryptographyBackend,
 )
-from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import (
+from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import (
     CRYPTOGRAPHY_TIMEZONE,
 )
-from ansible_collections.community.crypto.plugins.module_utils.time import (
+from ansible_collections.community.crypto.plugins.module_utils._time import (
     UTC,
     ensure_utc_timezone,
 )
 from freezegun import freeze_time
 
-from ..test_time import TIMEZONES
+from ..test__time import TIMEZONES
 from .backend_data import (
     TEST_CERT,
     TEST_CERT_DAYS,
@@ -37,7 +37,7 @@ from .backend_data import (
 
 
 if t.TYPE_CHECKING:
-    from ansible_collections.community.crypto.plugins.module_utils.acme.backends import (
+    from ansible_collections.community.crypto.plugins.module_utils._acme.backends import (
         CertificateInformation,
     )
 

tests/unit/plugins/module_utils/_acme/test_backend_openssl_cli.py

@@ -11,10 +11,10 @@ from unittest.mock import (
 )
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.acme.backend_openssl_cli import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.backend_openssl_cli import (
     OpenSSLCLIBackend,
 )
-from ansible_collections.community.crypto.plugins.module_utils.time import (
+from ansible_collections.community.crypto.plugins.module_utils._time import (
     UTC,
     ensure_utc_timezone,
 )
@@ -33,7 +33,7 @@ from .backend_data import (
 
 
 if t.TYPE_CHECKING:
-    from ansible_collections.community.crypto.plugins.module_utils.acme.backends import (
+    from ansible_collections.community.crypto.plugins.module_utils._acme.backends import (
         CertificateInformation,
     )
 

tests/unit/plugins/module_utils/_acme/test_challenges.py

@@ -10,13 +10,13 @@ from unittest.mock import (
 )
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import (
     Authorization,
     Challenge,
     combine_identifier,
     split_identifier,
 )
-from ansible_collections.community.crypto.plugins.module_utils.acme.errors import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.errors import (
     ACMEProtocolException,
     ModuleFailException,
 )

tests/unit/plugins/module_utils/_acme/test_errors.py

@@ -10,7 +10,7 @@ from unittest.mock import (
 )
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.acme.errors import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.errors import (
     ACMEProtocolException,
     format_error_problem,
 )

tests/unit/plugins/module_utils/_acme/test_io.py

@@ -8,7 +8,7 @@ from unittest.mock import (
     MagicMock,
 )
 
-from ansible_collections.community.crypto.plugins.module_utils.acme.io import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.io import (
     read_file,
     write_file,
 )

tests/unit/plugins/module_utils/_acme/test_orders.py

@@ -9,10 +9,10 @@ from unittest.mock import (
 )
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.acme.errors import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.errors import (
     ACMEProtocolException,
 )
-from ansible_collections.community.crypto.plugins.module_utils.acme.orders import Order
+from ansible_collections.community.crypto.plugins.module_utils._acme.orders import Order
 
 
 def test_order_from_json() -> None:

tests/unit/plugins/module_utils/_acme/test_utils.py

@@ -8,11 +8,11 @@ import datetime
 import typing as t
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.acme.backends import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.backends import (
     CertificateInformation,
     CryptoBackend,
 )
-from ansible_collections.community.crypto.plugins.module_utils.acme.utils import (
+from ansible_collections.community.crypto.plugins.module_utils._acme.utils import (
     compute_cert_id,
     nopad_b64,
     parse_retry_after,

tests/unit/plugins/module_utils/_crypto/test_asn1.py

@@ -9,7 +9,7 @@ import re
 import subprocess
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.crypto._asn1 import (
+from ansible_collections.community.crypto.plugins.module_utils._crypto._asn1 import (
     serialize_asn1_string_as_der,
 )
 

tests/unit/plugins/module_utils/_crypto/test_cryptography_support.py

@@ -9,16 +9,16 @@ import typing as t
 
 import cryptography
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import (
+from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import (
     OpenSSLObjectError,
 )
-from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import (
+from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import (
     _adjust_idn,
     _parse_dn,
     _parse_dn_component,
     cryptography_get_name,
 )
-from ansible_collections.community.crypto.plugins.module_utils.version import (
+from ansible_collections.community.crypto.plugins.module_utils._version import (
     LooseVersion,
 )
 from cryptography.x509 import NameAttribute, OtherName, oid

tests/unit/plugins/module_utils/_crypto/test_math.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.crypto.math import (
+from ansible_collections.community.crypto.plugins.module_utils._crypto.math import (
     binary_exp_mod,
     convert_bytes_to_int,
     convert_int_to_bytes,

tests/unit/plugins/module_utils/_crypto/test_pem.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing as t
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import (
+from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import (
     extract_first_pem,
     identify_pem_format,
     identify_private_key_format,

tests/unit/plugins/module_utils/_openssh/test_certificate.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.openssh.certificate import (
+from ansible_collections.community.crypto.plugins.module_utils._openssh.certificate import (
     OpensshCertificate,
     OpensshCertificateOption,
     OpensshCertificateTimeParameters,

tests/unit/plugins/module_utils/_openssh/test_cryptography.py

@@ -12,7 +12,7 @@ from socket import gethostname
 from tempfile import mkdtemp
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptography import (
+from ansible_collections.community.crypto.plugins.module_utils._openssh.cryptography import (
     HAS_OPENSSH_SUPPORT,
     InvalidCommentError,
     InvalidKeySizeError,
@@ -25,7 +25,7 @@ from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptogra
 
 
 if t.TYPE_CHECKING:
-    from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptography import (
+    from ansible_collections.community.crypto.plugins.module_utils._openssh.cryptography import (
         KeyType,
     )
 

tests/unit/plugins/module_utils/_openssh/test_utils.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing as t
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.openssh.utils import (
+from ansible_collections.community.crypto.plugins.module_utils._openssh.utils import (
     OpensshParser,
     _OpensshWriter,
     parse_openssh_version,

tests/unit/plugins/module_utils/test__time.py

@@ -8,7 +8,7 @@ import datetime
 import typing as t
 
 import pytest
-from ansible_collections.community.crypto.plugins.module_utils.time import (
+from ansible_collections.community.crypto.plugins.module_utils._time import (
     UTC,
     add_or_remove_timezone,
     convert_relative_to_datetime,