Deprecate and remove __utils__ usage.

Implementation of saltstack/salt-enhancement-proposals#66

Fixes saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

.pre-commit-config.yaml

@@ -1124,21 +1124,30 @@ repos:
 
   - repo: https://github.com/s0undt3ch/salt-rewrite
     # Automatically rewrite code with known rules
-    rev: 1.3.2
+    rev: 2.0.0
     hooks:
       - id: salt-rewrite
         alias: rewrite-docstrings
         name: Salt docstrings auto-fixes
         files: ^salt/.*\.py$
         args: [--silent, -F, fix_docstrings]
+        exclude: >
+            (?x)^(
+                salt/ext/.*
+            )$:
+      - id: salt-rewrite
+        alias: rewrite-dunder-utils
+        name: Remove __utils__ usage auto-fixes
+        files: ^salt/.*\.py$
+        args: [--silent, -F, fix_dunder_utils]
         exclude: >
             (?x)^(
                 salt/ext/.*
             )$
 
   - repo: https://github.com/s0undt3ch/salt-rewrite
     # Automatically rewrite code with known rules
-    rev: 1.3.2
+    rev: 2.0.0
     hooks:
       - id: salt-rewrite
         alias: rewrite-tests

salt/cloud/clouds/aliyun.py

@@ -354,7 +354,7 @@ def list_nodes_full(call=None):
         provider = comps[0]
 
     __opts__["update_cachedir"] = True
-    __utils__["cloud.cache_node_list"](ret, provider, __opts__)
+    salt.utils.cloud.cache_node_list(ret, provider, __opts__)
 
     return ret
 
@@ -608,11 +608,11 @@ def create(vm_):
     except AttributeError:
         pass
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "starting create",
         "salt/cloud/{}/creating".format(vm_["name"]),
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "creating", vm_, ["name", "profile", "provider", "driver"]
         ),
         sock_dir=__opts__["sock_dir"],
@@ -644,11 +644,11 @@ def create(vm_):
     if "systemdisk_category" in vm_:
         kwargs["SystemDisk.Category"] = vm_["systemdisk_category"]
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "requesting instance",
         "salt/cloud/{}/requesting".format(vm_["name"]),
-        args=__utils__["cloud.filter_event"]("requesting", kwargs, list(kwargs)),
+        args=salt.utils.cloud.filter_event("requesting", kwargs, list(kwargs)),
         sock_dir=__opts__["sock_dir"],
         transport=__opts__["transport"],
     )
@@ -710,17 +710,17 @@ def __query_node_data(vm_name):
     vm_["ssh_host"] = ssh_ip
 
     # The instance is booted and accessible, let's Salt it!
-    ret = __utils__["cloud.bootstrap"](vm_, __opts__)
+    ret = salt.utils.cloud.bootstrap(vm_, __opts__)
     ret.update(data)
 
     log.info("Created Cloud VM '%s'", vm_["name"])
     log.debug("'%s' VM creation details:\n%s", vm_["name"], pprint.pformat(data))
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "created instance",
         "salt/cloud/{}/created".format(vm_["name"]),
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "created", vm_, ["name", "profile", "provider", "driver"]
         ),
         sock_dir=__opts__["sock_dir"],
@@ -979,7 +979,7 @@ def destroy(name, call=None):
             "The destroy action must be called with -d, --destroy, -a or --action."
         )
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "destroying instance",
         "salt/cloud/{}/destroying".format(name),
@@ -998,7 +998,7 @@ def destroy(name, call=None):
 
     node = query(params)
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "destroyed instance",
         "salt/cloud/{}/destroyed".format(name),

salt/cloud/clouds/azurearm.py

@@ -602,7 +602,7 @@ def show_instance(name, call=None):
         log.debug("Failed to get data for node '%s'", name)
         node = {}
 
-    __utils__["cloud.cache_node"](node, _get_active_provider_name(), __opts__)
+    salt.utils.cloud.cache_node(node, _get_active_provider_name(), __opts__)
 
     return node
 
@@ -1253,11 +1253,11 @@ def request_instance(vm_, kwargs=None):
         availability_set=availability_set,
     )
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "requesting instance",
         "salt/cloud/{}/requesting".format(vm_["name"]),
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "requesting", vm_, ["name", "profile", "provider", "driver"]
         ),
         sock_dir=__opts__["sock_dir"],
@@ -1305,17 +1305,17 @@ def create(vm_):
     if vm_.get("bootstrap_interface") is None:
         vm_["bootstrap_interface"] = "public"
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "starting create",
         "salt/cloud/{}/creating".format(vm_["name"]),
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "creating", vm_, ["name", "profile", "provider", "driver"]
         ),
         sock_dir=__opts__["sock_dir"],
         transport=__opts__["transport"],
     )
-    __utils__["cloud.cachedir_index_add"](
+    salt.utils.cloud.cachedir_index_add(
         vm_["name"], vm_["profile"], "azurearm", vm_["driver"]
     )
     if not vm_.get("location"):
@@ -1379,19 +1379,19 @@ def _query_node_data(name, bootstrap_interface):
             "ssh_username", vm_, __opts__
         )
     vm_["password"] = config.get_cloud_config_value("ssh_password", vm_, __opts__)
-    ret = __utils__["cloud.bootstrap"](vm_, __opts__)
+    ret = salt.utils.cloud.bootstrap(vm_, __opts__)
 
     data = show_instance(vm_["name"], call="action")
     log.info("Created Cloud VM '%s'", vm_["name"])
     log.debug("'%s' VM creation details:\n%s", vm_["name"], pprint.pformat(data))
 
     ret.update(data)
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "created instance",
         "salt/cloud/{}/created".format(vm_["name"]),
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "created", vm_, ["name", "profile", "provider", "driver"]
         ),
         sock_dir=__opts__["sock_dir"],
@@ -1435,7 +1435,7 @@ def destroy(name, call=None, kwargs=None):  # pylint: disable=unused-argument
     result.wait()
 
     if __opts__.get("update_cachedir", False) is True:
-        __utils__["cloud.delete_minion_cachedir"](
+        salt.utils.cloud.delete_minion_cachedir(
             name, _get_active_provider_name().split(":")[0], __opts__
         )
 

salt/cloud/clouds/clc.py

@@ -68,6 +68,7 @@
 import time
 
 import salt.config as config
+import salt.utils.cloud
 import salt.utils.json
 from salt.exceptions import SaltCloudSystemExit
 
@@ -418,7 +419,7 @@ def create(vm_):
     )
     req_id = clc_return["RequestID"]
     vm_["ssh_host"] = get_build_status(req_id, name)
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "waiting for ssh",
         "salt/cloud/{}/waiting_for_ssh".format(name),
@@ -428,7 +429,7 @@ def create(vm_):
     )
 
     # Bootstrap!
-    ret = __utils__["cloud.bootstrap"](vm_, __opts__)
+    ret = salt.utils.cloud.bootstrap(vm_, __opts__)
     return_message = {"Server Name": name, "IP Address": vm_["ssh_host"]}
     ret.update(return_message)
     return return_message

salt/cloud/clouds/cloudstack.py

@@ -297,12 +297,12 @@ def create(vm_):
     except AttributeError:
         pass
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "starting create",
         "salt/cloud/{}/creating".format(vm_["name"]),
         sock_dir=__opts__["sock_dir"],
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "creating", vm_, ["name", "profile", "provider", "driver"]
         ),
         transport=__opts__["transport"],
@@ -339,13 +339,13 @@ def create(vm_):
     event_data["image"] = kwargs["image"].name
     event_data["size"] = kwargs["size"].name
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "requesting instance",
         "salt/cloud/{}/requesting".format(vm_["name"]),
         sock_dir=__opts__["sock_dir"],
         args={
-            "kwargs": __utils__["cloud.filter_event"](
+            "kwargs": salt.utils.cloud.filter_event(
                 "requesting",
                 event_data,
                 ["name", "profile", "provider", "driver", "image", "size"],
@@ -368,7 +368,7 @@ def create(vm_):
                 ex_blockdevicemapping["VirtualName"] = "{}-{}".format(
                     vm_["name"], len(volumes)
                 )
-            __utils__["cloud.fire_event"](
+            salt.utils.cloud.fire_event(
                 "event",
                 "requesting volume",
                 "salt/cloud/{}/requesting".format(ex_blockdevicemapping["VirtualName"]),
@@ -435,7 +435,7 @@ def create(vm_):
     vm_["ssh_host"] = get_ip(data)
     vm_["password"] = data.extra["password"]
     vm_["key_filename"] = get_key()
-    ret = __utils__["cloud.bootstrap"](vm_, __opts__)
+    ret = salt.utils.cloud.bootstrap(vm_, __opts__)
 
     ret.update(data.__dict__)
 
@@ -447,12 +447,12 @@ def create(vm_):
         "'%s' VM creation details:\n%s", vm_["name"], pprint.pformat(data.__dict__)
     )
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "created instance",
         "salt/cloud/{}/created".format(vm_["name"]),
         sock_dir=__opts__["sock_dir"],
-        args=__utils__["cloud.filter_event"](
+        args=salt.utils.cloud.filter_event(
             "created", vm_, ["name", "profile", "provider", "driver"]
         ),
         transport=__opts__["transport"],
@@ -470,7 +470,7 @@ def destroy(name, conn=None, call=None):
             "The destroy action must be called with -d, --destroy, -a or --action."
         )
 
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "destroying instance",
         "salt/cloud/{}/destroying".format(name),
@@ -495,7 +495,7 @@ def destroy(name, conn=None, call=None):
             )
             continue
         log.info("Detaching volume: %s", volume.name)
-        __utils__["cloud.fire_event"](
+        salt.utils.cloud.fire_event(
             "event",
             "detaching volume",
             "salt/cloud/{}/detaching".format(volume.name),
@@ -506,7 +506,7 @@ def destroy(name, conn=None, call=None):
             log.error("Failed to Detach volume: %s", volume.name)
             return False
         log.info("Detached volume: %s", volume.name)
-        __utils__["cloud.fire_event"](
+        salt.utils.cloud.fire_event(
             "event",
             "detached volume",
             "salt/cloud/{}/detached".format(volume.name),
@@ -515,7 +515,7 @@ def destroy(name, conn=None, call=None):
         )
 
         log.info("Destroying volume: %s", volume.name)
-        __utils__["cloud.fire_event"](
+        salt.utils.cloud.fire_event(
             "event",
             "destroying volume",
             "salt/cloud/{}/destroying".format(volume.name),
@@ -526,7 +526,7 @@ def destroy(name, conn=None, call=None):
             log.error("Failed to Destroy volume: %s", volume.name)
             return False
         log.info("Destroyed volume: %s", volume.name)
-        __utils__["cloud.fire_event"](
+        salt.utils.cloud.fire_event(
             "event",
             "destroyed volume",
             "salt/cloud/{}/destroyed".format(volume.name),
@@ -541,7 +541,7 @@ def destroy(name, conn=None, call=None):
     log.info("Destroyed VM: %s", name)
     # Fire destroy action
     event = salt.utils.event.SaltEvent("master", __opts__["sock_dir"])
-    __utils__["cloud.fire_event"](
+    salt.utils.cloud.fire_event(
         "event",
         "destroyed instance",
         "salt/cloud/{}/destroyed".format(name),