mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-19 17:01:25 -07:00
homebrew: Move repeated logic from homebrew modules into module_utils (#8324)
* gomebrew: Move repeated logic from homebrew modules into module_utils Fixes #8323. * ghangelog + unit test improvement * Update changelogs/fragments/8323-refactor-homebrew-logic-module-utils.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Kit Ham
GitHub
parent
136419c5c0
commit
3b7f13c58e
5 changed files with 145 additions and 177 deletions
|
|
@ -179,9 +179,10 @@ changed_pkgs:
|
|||
'''
|
||||
|
||||
import json
|
||||
import os.path
|
||||
import re
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.homebrew import HomebrewValidate
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six import iteritems, string_types
|
||||
|
||||
|
|
@ -208,98 +209,7 @@ def _check_package_in_json(json_output, package_type):
|
|||
class Homebrew(object):
|
||||
'''A class to manage Homebrew packages.'''
|
||||
|
||||
# class regexes ------------------------------------------------ {{{
|
||||
VALID_PATH_CHARS = r'''
|
||||
\w # alphanumeric characters (i.e., [a-zA-Z0-9_])
|
||||
\s # spaces
|
||||
: # colons
|
||||
{sep} # the OS-specific path separator
|
||||
. # dots
|
||||
\- # dashes
|
||||
'''.format(sep=os.path.sep)
|
||||
|
||||
VALID_BREW_PATH_CHARS = r'''
|
||||
\w # alphanumeric characters (i.e., [a-zA-Z0-9_])
|
||||
\s # spaces
|
||||
{sep} # the OS-specific path separator
|
||||
. # dots
|
||||
\- # dashes
|
||||
'''.format(sep=os.path.sep)
|
||||
|
||||
VALID_PACKAGE_CHARS = r'''
|
||||
\w # alphanumeric characters (i.e., [a-zA-Z0-9_])
|
||||
. # dots
|
||||
/ # slash (for taps)
|
||||
\+ # plusses
|
||||
\- # dashes
|
||||
: # colons (for URLs)
|
||||
@ # at-sign
|
||||
'''
|
||||
|
||||
INVALID_PATH_REGEX = _create_regex_group_complement(VALID_PATH_CHARS)
|
||||
INVALID_BREW_PATH_REGEX = _create_regex_group_complement(VALID_BREW_PATH_CHARS)
|
||||
INVALID_PACKAGE_REGEX = _create_regex_group_complement(VALID_PACKAGE_CHARS)
|
||||
# /class regexes ----------------------------------------------- }}}
|
||||
|
||||
# class validations -------------------------------------------- {{{
|
||||
@classmethod
|
||||
def valid_path(cls, path):
|
||||
'''
|
||||
`path` must be one of:
|
||||
- list of paths
|
||||
- a string containing only:
|
||||
- alphanumeric characters
|
||||
- dashes
|
||||
- dots
|
||||
- spaces
|
||||
- colons
|
||||
- os.path.sep
|
||||
'''
|
||||
|
||||
if isinstance(path, string_types):
|
||||
return not cls.INVALID_PATH_REGEX.search(path)
|
||||
|
||||
try:
|
||||
iter(path)
|
||||
except TypeError:
|
||||
return False
|
||||
else:
|
||||
paths = path
|
||||
return all(cls.valid_brew_path(path_) for path_ in paths)
|
||||
|
||||
@classmethod
|
||||
def valid_brew_path(cls, brew_path):
|
||||
'''
|
||||
`brew_path` must be one of:
|
||||
- None
|
||||
- a string containing only:
|
||||
- alphanumeric characters
|
||||
- dashes
|
||||
- dots
|
||||
- spaces
|
||||
- os.path.sep
|
||||
'''
|
||||
|
||||
if brew_path is None:
|
||||
return True
|
||||
|
||||
return (
|
||||
isinstance(brew_path, string_types)
|
||||
and not cls.INVALID_BREW_PATH_REGEX.search(brew_path)
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def valid_package(cls, package):
|
||||
'''A valid package is either None or alphanumeric.'''
|
||||
|
||||
if package is None:
|
||||
return True
|
||||
|
||||
return (
|
||||
isinstance(package, string_types)
|
||||
and not cls.INVALID_PACKAGE_REGEX.search(package)
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def valid_state(cls, state):
|
||||
'''
|
||||
|
|
@ -359,7 +269,7 @@ class Homebrew(object):
|
|||
|
||||
@path.setter
|
||||
def path(self, path):
|
||||
if not self.valid_path(path):
|
||||
if not HomebrewValidate.valid_path(path):
|
||||
self._path = []
|
||||
self.failed = True
|
||||
self.message = 'Invalid path: {0}.'.format(path)
|
||||
|
|
@ -379,7 +289,7 @@ class Homebrew(object):
|
|||
|
||||
@brew_path.setter
|
||||
def brew_path(self, brew_path):
|
||||
if not self.valid_brew_path(brew_path):
|
||||
if not HomebrewValidate.valid_brew_path(brew_path):
|
||||
self._brew_path = None
|
||||
self.failed = True
|
||||
self.message = 'Invalid brew_path: {0}.'.format(brew_path)
|
||||
|
|
@ -404,7 +314,7 @@ class Homebrew(object):
|
|||
|
||||
@current_package.setter
|
||||
def current_package(self, package):
|
||||
if not self.valid_package(package):
|
||||
if not HomebrewValidate.valid_package(package):
|
||||
self._current_package = None
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(package)
|
||||
|
|
@ -491,7 +401,7 @@ class Homebrew(object):
|
|||
|
||||
# checks ------------------------------------------------------- {{{
|
||||
def _current_package_is_installed(self):
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(self.current_package)
|
||||
raise HomebrewException(self.message)
|
||||
|
|
@ -514,7 +424,7 @@ class Homebrew(object):
|
|||
return _check_package_in_json(data, "formulae") or _check_package_in_json(data, "casks")
|
||||
|
||||
def _current_package_is_outdated(self):
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
return False
|
||||
|
||||
rc, out, err = self.module.run_command([
|
||||
|
|
@ -526,7 +436,7 @@ class Homebrew(object):
|
|||
return rc != 0
|
||||
|
||||
def _current_package_is_installed_from_head(self):
|
||||
if not Homebrew.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
return False
|
||||
elif not self._current_package_is_installed():
|
||||
return False
|
||||
|
|
@ -624,7 +534,7 @@ class Homebrew(object):
|
|||
|
||||
# installed ------------------------------ {{{
|
||||
def _install_current_package(self):
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(self.current_package)
|
||||
raise HomebrewException(self.message)
|
||||
|
|
@ -685,7 +595,7 @@ class Homebrew(object):
|
|||
def _upgrade_current_package(self):
|
||||
command = 'upgrade'
|
||||
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(self.current_package)
|
||||
raise HomebrewException(self.message)
|
||||
|
|
@ -756,7 +666,7 @@ class Homebrew(object):
|
|||
|
||||
# uninstalled ---------------------------- {{{
|
||||
def _uninstall_current_package(self):
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(self.current_package)
|
||||
raise HomebrewException(self.message)
|
||||
|
|
@ -805,7 +715,7 @@ class Homebrew(object):
|
|||
|
||||
# linked --------------------------------- {{{
|
||||
def _link_current_package(self):
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(self.current_package)
|
||||
raise HomebrewException(self.message)
|
||||
|
|
@ -852,7 +762,7 @@ class Homebrew(object):
|
|||
|
||||
# unlinked ------------------------------- {{{
|
||||
def _unlink_current_package(self):
|
||||
if not self.valid_package(self.current_package):
|
||||
if not HomebrewValidate.valid_package(self.current_package):
|
||||
self.failed = True
|
||||
self.message = 'Invalid package: {0}.'.format(self.current_package)
|
||||
raise HomebrewException(self.message)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue