Prepare 4.0.0 release (#440)

* Step 1: bump galaxy.yml to 4.0.0 on main branch * Remove deprecated options. * Update some docs. Many are left for CE... * Add changelog * Remove connection: local support. * Add PR URL. * Update ignore.txt files. Delete old ones no longer needed. * More cleanup. * Avoid too long line.
ansible-collections · May 27, 2022 · 5c394a2 · 5c394a2
1 parent 0dae599
commit 5c394a2
Show file tree

Hide file tree

Showing 59 changed files with 65 additions and 4,272 deletions.
diff --git a/changelogs/fragments/remove-connection-local.yml b/changelogs/fragments/remove-connection-local.yml
@@ -0,0 +1,7 @@
+removed_features:
+  - "aireos modules - removed deprecated ``connection: local`` support. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "aruba modules - removed deprecated ``connection: local`` support. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "ce modules - removed deprecated ``connection: local`` support. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "enos modules - removed deprecated ``connection: local`` support. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "ironware modules - removed deprecated ``connection: local`` support. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "sros modules - removed deprecated ``connection: local`` support. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
diff --git a/changelogs/fragments/remove-provider.yml b/changelogs/fragments/remove-provider.yml
@@ -0,0 +1,7 @@
+removed_features:
+  - "aireos modules - removed deprecated ``provider`` option. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "aruba modules - removed deprecated ``provider`` option. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "ce modules - removed deprecated ``provider`` option. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "enos modules - removed deprecated ``provider`` option. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "ironware modules - removed deprecated ``provider`` option. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
+  - "sros modules - removed deprecated ``provider`` option. Use ``connection: network_cli`` instead (https://github.com/ansible-collections/community.network/pull/440)."
diff --git a/galaxy.yml b/galaxy.yml
@@ -1,6 +1,6 @@
 namespace: community
 name: network
-version: 3.1.0
+version: 4.0.0
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)

diff --git a/plugins/action/aireos.py b/plugins/action/aireos.py
@@ -46,33 +46,10 @@ def run(self, tmp=None, task_vars=None):
                 display.warning('provider is unnecessary when using network_cli and will be ignored')
                 del self._task.args['provider']
         elif self._play_context.connection == 'local':
-            provider = load_provider(aireos_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'aireos'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = int(provider['port'] or self._play_context.port or 22)
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin,
-                                                                       task_uuid=self._task._uuid)
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-            msg = "connection local support for this module is deprecated use either" \
-                  " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-            display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
 
         else:
             return dict(

diff --git a/plugins/action/aruba.py b/plugins/action/aruba.py
@@ -46,33 +46,10 @@ def run(self, tmp=None, task_vars=None):
                 display.warning('provider is unnecessary when using network_cli and will be ignored')
                 del self._task.args['provider']
         elif self._play_context.connection == 'local':
-            provider = load_provider(aruba_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'aruba'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = int(provider['port'] or self._play_context.port or 22)
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-            msg = "connection local support for this module is deprecated use either" \
-                  " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-            display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
         else:
             return dict(
                 failed=True,

diff --git a/plugins/action/ce.py b/plugins/action/ce.py
@@ -37,47 +37,10 @@ def run(self, tmp=None, task_vars=None):
         persistent_connection = self._play_context.connection.split('.')[-1]
 
         if self._play_context.connection == 'local':
-            provider = load_provider(ce_provider_spec, self._task.args)
-            transport = provider['transport'] or 'cli'
-
-            display.vvvv('connection transport is %s' % transport, self._play_context.remote_addr)
-
-            if transport == 'cli':
-                pc = copy.deepcopy(self._play_context)
-                pc.connection = 'network_cli'
-                pc.network_os = 'ce'
-                pc.remote_addr = provider['host'] or self._play_context.remote_addr
-                pc.port = int(provider['port'] or self._play_context.port or 22)
-                pc.remote_user = provider['username'] or self._play_context.connection_user
-                pc.password = provider['password'] or self._play_context.password
-                command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-                self._task.args['provider'] = provider.update(
-                    host=pc.remote_addr,
-                    port=pc.port,
-                    username=pc.remote_user,
-                    password=pc.password
-                )
-                if module_name in ['ce_netconf'] or module_name not in CLI_SUPPORTED_MODULES:
-                    pc.connection = 'netconf'
-
-                display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-                connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-                connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-                socket_path = connection.run()
-                display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-                if not socket_path:
-                    return {'failed': True,
-                            'msg': 'unable to open shell. Please see: ' +
-                                   'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-                task_vars['ansible_socket'] = socket_path
-                # make sure a transport value is set in args
-                self._task.args['transport'] = transport
-                self._task.args['provider'] = provider
-                msg = "connection local support for this module is deprecated use either" \
-                      " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-                display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
 
         elif persistent_connection in ('netconf', 'network_cli'):
             provider = self._task.args.get('provider', {})

diff --git a/plugins/action/cnos.py b/plugins/action/cnos.py
@@ -44,35 +44,10 @@ def run(self, tmp=None, task_vars=None):
                 display.warning('provider is unnecessary when using network_cli and will be ignored')
                 del self._task.args['provider']
         elif self._play_context.connection == 'local':
-            provider = load_provider(cnos_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'cnos'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = provider['port'] or self._play_context.port or 22
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-            pc.become = provider['authorize'] or True
-            pc.become_pass = provider['auth_pass']
-            pc.become_method = 'enable'
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-            msg = "connection local support for this module is deprecated use either" \
-                  " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-            display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
 
         result = super(ActionModule, self).run(task_vars=task_vars)
         return result
diff --git a/plugins/action/enos.py b/plugins/action/enos.py
@@ -44,35 +44,10 @@ def run(self, tmp=None, task_vars=None):
                 display.warning('provider is unnecessary when using network_cli and will be ignored')
                 del self._task.args['provider']
         elif self._play_context.connection == 'local':
-            provider = load_provider(enos_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'enos'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = provider['port'] or self._play_context.port or 22
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-            pc.become = provider['authorize'] or True
-            pc.become_pass = provider['auth_pass']
-            pc.become_method = 'enable'
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-            msg = "connection local support for this module is deprecated use either" \
-                  " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-            display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
 
         result = super(ActionModule, self).run(task_vars=task_vars)
         return result
diff --git a/plugins/action/ironware.py b/plugins/action/ironware.py
@@ -45,37 +45,10 @@ def run(self, tmp=None, task_vars=None):
                 display.warning('provider is unnecessary when using network_cli and will be ignored')
                 del self._task.args['provider']
         elif self._play_context.connection == 'local':
-            provider = load_provider(ironware_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'ironware'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = int(provider['port'] or self._play_context.port or 22)
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            pc.become = provider['authorize'] or False
-            if pc.become:
-                pc.become_method = 'enable'
-            pc.become_pass = provider['auth_pass']
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-
-            command_timeout = int(provider['timeout']) if provider['timeout'] else connection.get_option('persistent_command_timeout')
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-            msg = "connection local support for this module is deprecated use either" \
-                  " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-            display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
         else:
             return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}
 

diff --git a/plugins/action/sros.py b/plugins/action/sros.py
@@ -46,33 +46,10 @@ def run(self, tmp=None, task_vars=None):
                 display.warning('provider is unnecessary when using network_cli and will be ignored')
                 del self._task.args['provider']
         elif self._play_context.connection == 'local':
-            provider = load_provider(sros_provider_spec, self._task.args)
-
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'sros'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = int(provider['port'] or self._play_context.port or 22)
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                        'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-            msg = "connection local support for this module is deprecated use either" \
-                  " 'network_cli' or 'ansible.netcommon.network_cli' connection"
-            display.deprecated(msg, version='4.0.0', collection_name='community.network')
+            return {
+                'failed': True,
+                'msg': "connection local support for this module has been removed use either 'network_cli' or 'ansible.netcommon.network_cli' connection"
+            }
         else:
             return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}