mirror of
https://github.com/linux-system-roles/network.git
synced 2026-01-23 10:25:28 +00:00
e4d499763c
The old ansible-community ansible-lint is deprecated. There is a new ansible-lint github action. The new ansible-lint has several checks related to ansible-test and the ignore files. Many of our ignore settings are not allowed any more and are required to be fixed or addressed in the Ansible preferred way. The python imports have to be wrapped in a try/except ImportError, and where possible, an error must be returned from the module explaining what was not able to be imported. The module documentation must comply with the Ansible standards. One aspect of this is the `version_added` must be a valid ansible-core version in X.Y.Z format. Note that this version isn't really used anywhere, so it doesn't matter for users of the role, it is purely an `ansible-test` and import gating issue. The result of this is that the .sanity files can be reduced to the bare minimum which will greatly reduce the maintenance burden of those files, make it easier to support newer versions of Ansible, and make it easier to import the system roles collection into Galaxy and Automation Hub. The latest Ansible repo gating tests run ansible-lint against the collection format instead of against individual roles. We have to convert the role to collection format before running ansible-test. Role developers can run this locally using `tox -e collection,ansible-lint-collection` See https://github.com/linux-system-roles/tox-lsr/pull/125 Add `---` doc start to .markdownlint.yaml The file `examples/down_profile+delete_interface.yml` was not used and was causing ansible-lint errors. ansible-lint enforces the order of keywords in plays - `name`, then `hosts`, then `vars`, then `tasks`. Signed-off-by: Rich Megginson <rmeggins@redhat.com>
106 lines
3 KiB
Python
106 lines
3 KiB
Python
# SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
import logging
|
|
|
|
# Relative import is not support by ansible 2.8 yet
|
|
# pylint: disable=import-error, no-name-in-module
|
|
from ansible.module_utils.network_lsr.nm import error # noqa:E501
|
|
|
|
try:
|
|
import gi
|
|
except ImportError:
|
|
NETWORK_HAS_GI = False
|
|
else:
|
|
NETWORK_HAS_GI = True
|
|
|
|
if NETWORK_HAS_GI:
|
|
try:
|
|
gi.require_version("NM", "1.0")
|
|
|
|
# It is required to state the NM version before importing it
|
|
# But this break the flake8 rule: https://www.flake8rules.com/rules/E402.html
|
|
# Use NOQA: E402 to suppress it.
|
|
from gi.repository import NM # NOQA: E402
|
|
from gi.repository import GLib # NOQA: E402
|
|
from gi.repository import Gio # NOQA: E402
|
|
|
|
# pylint: enable=import-error, no-name-in-module
|
|
|
|
NM
|
|
GLib
|
|
Gio
|
|
except ValueError:
|
|
# This is to workaround a bug in ansible 2.9 which causes
|
|
# this code to be executed on the control node, where NM
|
|
# is not guaranteed to exist. On the other hand, it is
|
|
# ensured on the managed nodes as NM package is installed
|
|
# in the network role. Therefore, this exception handling
|
|
# does not affect the network installation and configuration
|
|
# on the managed nodes.
|
|
pass
|
|
|
|
|
|
def get_client():
|
|
return NM.Client.new()
|
|
|
|
|
|
class _NmMainLoop(object):
|
|
def __init__(self, timeout):
|
|
self._mainloop = GLib.MainLoop()
|
|
self._cancellable = Gio.Cancellable.new()
|
|
self._timeout = timeout
|
|
self._timeout_id = None
|
|
|
|
def run(self):
|
|
logging.debug("NM mainloop running")
|
|
user_data = None
|
|
self._timeout_id = GLib.timeout_add(
|
|
int(self._timeout * 1000),
|
|
self._timeout_call_back,
|
|
user_data,
|
|
)
|
|
logging.debug("Added timeout checker")
|
|
self._mainloop.run()
|
|
|
|
def _timeout_call_back(self, _user_data):
|
|
logging.error("Timeout")
|
|
self.fail(error.LsrNetworkNmError("Timeout"))
|
|
|
|
@property
|
|
def cancellable(self):
|
|
return self._cancellable
|
|
|
|
@property
|
|
def is_cancelled(self):
|
|
if self._cancellable:
|
|
return self._cancellable.is_cancelled()
|
|
return True
|
|
|
|
def _clean_up(self):
|
|
logging.debug("NM mainloop cleaning up")
|
|
if self._timeout_id:
|
|
logging.debug("Removing timeout checker")
|
|
GLib.source_remove(self._timeout_id)
|
|
self._timeout_id = None
|
|
if self._cancellable:
|
|
logging.debug("Canceling all pending tasks")
|
|
self._cancellable.cancel()
|
|
self._cancellable = None
|
|
self._mainloop = None
|
|
|
|
def quit(self):
|
|
logging.debug("NM mainloop quiting")
|
|
self._mainloop.quit()
|
|
self._clean_up()
|
|
|
|
def fail(self, exception):
|
|
self.quit()
|
|
raise exception
|
|
|
|
|
|
def get_mainloop(timeout):
|
|
return _NmMainLoop(timeout)
|