verchew.script.vendor_script() - Code Metrics - Inspection of "Add command to download script for offline use" - jacebrowning/verchew - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#68)

by Jace

created 2020-04-18 12:17 UTC

verchew.script.vendor_script() A

↳ Parent: verchew.script

Complexity

Conditions

Size

Total Lines	12
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
eloc	10
dl	0
loc	12
rs	9.9
c	0
b	0
f	0
ccs	9
cts	9
cp	1
cc	2
nop	1
crap	2

#!/usr/bin/env python
# -*- coding: utf-8 -*-

# The MIT License (MIT)
# Copyright © 2016, Jace Browning
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# Source: https://github.com/jacebrowning/verchew
# Documentation: https://verchew.readthedocs.io
# Package: https://pypi.org/project/verchew


from __future__ import unicode_literals

import argparse
import logging
import os
import re
import sys
from collections import OrderedDict
from subprocess import PIPE, STDOUT, Popen


PY2 = sys.version_info[0] == 2

if PY2:
    import ConfigParser as configparser
    from urllib import urlretrieve
else:
    import configparser
    from urllib.request import urlretrieve

__version__ = '3.1b1'

SCRIPT_URL = (
    "https://raw.githubusercontent.com/jacebrowning/verchew/master/verchew/script.py"
)

CONFIG_FILENAMES = ['verchew.ini', '.verchew.ini', '.verchewrc', '.verchew']

SAMPLE_CONFIG = """
[Python]

cli = python
version = Python 3.5 || Python 3.6

[Legacy Python]

cli = python2
version = Python 2.7

[virtualenv]

cli = virtualenv
version = 15
message = Only required with Python 2.

[Make]

cli = make
version = GNU Make
optional = true

""".strip()

STYLE = {"~": "✔", "*": "⭑", "?": "⚠", "x": "✘"}

COLOR = {
    "x": "\033[91m",  # red
    "~": "\033[92m",  # green
    "?": "\033[93m",  # yellow
    "*": "\033[94m",  # cyan
    None: "\033[0m",  # reset
}

QUIET = False

log = logging.getLogger(__name__)


def main():
    global QUIET

    args = parse_args()
    configure_logging(args.verbose)
    if args.quiet:
        QUIET = True

    log.debug("PWD: %s", os.getenv('PWD'))
    log.debug("PATH: %s", os.getenv('PATH'))

    if args.vendor:
        vendor_script(args.vendor)
        sys.exit(0)

    path = find_config(args.root, generate=args.init)
    config = parse_config(path)

    if not check_dependencies(config) and args.exit_code:
        sys.exit(1)


def parse_args():
    parser = argparse.ArgumentParser(description="System dependency version checker.",)

    version = "%(prog)s v" + __version__
    parser.add_argument(
        '--version', action='version', version=version,
    )
    parser.add_argument(
        '-r', '--root', metavar='PATH', help="specify a custom project root directory"
    )
    parser.add_argument(
        '--exit-code',
        action='store_true',
        help="return a non-zero exit code on failure",
    )

    group_logging = parser.add_mutually_exclusive_group()
    group_logging.add_argument(
        '-v', '--verbose', action='count', default=0, help="enable verbose logging"
    )
    group_logging.add_argument(
        '-q', '--quiet', action='store_true', help="suppress all output on success"
    )

    group_commands = parser.add_argument_group('commands')
    group_commands.add_argument(
        '--init', action='store_true', help="generate a sample configuration file"
    )

    group_commands.add_argument(
        '--vendor', metavar='PATH', help="download the program for offline use"
    )

    args = parser.parse_args()

    return args


def configure_logging(count=0):
    if count == 0:
        level = logging.WARNING
    elif count == 1:
        level = logging.INFO
    else:
        level = logging.DEBUG

    logging.basicConfig(level=level, format="%(levelname)s: %(message)s")


def vendor_script(path):
    root = os.path.abspath(os.path.join(path, os.pardir))
    if not os.path.isdir(root):
        log.info("Creating directory %s", root)
        os.makedirs(root)

    log.info("Downloading %s to %s", SCRIPT_URL, path)
    urlretrieve(SCRIPT_URL, path)

    log.debug("Making %s executable", path)
    mode = os.stat(path).st_mode
    os.chmod(path, mode | 0o111)


def find_config(root=None, filenames=None, generate=False):
    root = root or os.getcwd()
    filenames = filenames or CONFIG_FILENAMES

    path = None
    log.info("Looking for config file in: %s", root)
    log.debug("Filename options: %s", ", ".join(filenames))
    for filename in os.listdir(root):
        if filename in filenames:
            path = os.path.join(root, filename)
            log.info("Found config file: %s", path)
            return path

    if generate:
        path = generate_config(root, filenames)
        return path

    msg = "No config file found in: {0}".format(root)
    raise RuntimeError(msg)


def generate_config(root=None, filenames=None):
    root = root or os.getcwd()
    filenames = filenames or CONFIG_FILENAMES

    path = os.path.join(root, filenames[0])

    log.info("Generating sample config: %s", path)
    with open(path, 'w') as config:
        config.write(SAMPLE_CONFIG + '\n')

    return path


def parse_config(path):
    data = OrderedDict()  # type: ignore

    log.info("Parsing config file: %s", path)
    config = configparser.ConfigParser()
    config.read(path)

    for section in config.sections():
        data[section] = OrderedDict()
        for name, value in config.items(section):
            data[section][name] = value

    for name in data:
        version = data[name].get('version') or ""
        data[name]['version'] = version
        data[name]['patterns'] = [v.strip() for v in version.split('||')]

    return data


def check_dependencies(config):
    success = []

    for name, settings in config.items():
        show("Checking for {0}...".format(name), head=True)
        output = get_version(settings['cli'], settings.get('cli_version_arg'))

        for pattern in settings['patterns']:
            if match_version(pattern, output):
                show(_("~") + " MATCHED: {0}".format(pattern or "<anything>"))
                success.append(_("~"))
                break
        else:
            if settings.get('optional'):
                show(_("?") + " EXPECTED: {0}".format(settings['version']))
                success.append(_("?"))
            else:
                if QUIET:
                    print(
                        "Unmatched {0} version: {1}".format(
                            name, settings['version'] or "<anything>"
                        )
                    )
                show(
                    _("x")
                    + " EXPECTED: {0}".format(settings['version'] or "<anything>")
                )
                success.append(_("x"))
            if settings.get('message'):
                show(_("*") + " MESSAGE: {0}".format(settings['message']))

    show("Results: " + " ".join(success), head=True)

    return _("x") not in success


def get_version(program, argument=None):
    if argument is None:
        args = [program, '--version']
    elif argument:
        args = [program, argument]
    else:
        args = [program]

    show("$ {0}".format(" ".join(args)))
    output = call(args)
    lines = output.splitlines()
    show(lines[0] if lines else "<nothing>")

    return output


def match_version(pattern, output):
    if "not found" in output.split('\n')[0]:
        return False

    regex = pattern.replace('.', r'\.') + r'(\b|/)'

    log.debug("Matching %s: %s", regex, output)
    match = re.match(regex, output)
    if match is None:
        match = re.match(r'.*[^\d.]' + regex, output)

    return bool(match)


def call(args):
    try:
        process = Popen(args, stdout=PIPE, stderr=STDOUT)
    except OSError:
        log.debug("Command not found: %s", args[0])
        output = "sh: command not found: {0}".format(args[0])
    else:
        raw = process.communicate()[0]
        output = raw.decode('utf-8').strip()
        log.debug("Command output: %r", output)

    return output


def show(text, start='', end='\n', head=False):
    """Python 2 and 3 compatible version of print."""
    if QUIET:
        return

    if head:
        start = '\n'
        end = '\n\n'

    if log.getEffectiveLevel() < logging.WARNING:
        log.info(text)
    else:
        formatted = start + text + end
        if PY2:
            formatted = formatted.encode('utf-8')
        sys.stdout.write(formatted)
        sys.stdout.flush()


def _(word, is_tty=None, supports_utf8=None, supports_ansi=None):
    """Format and colorize a word based on available encoding."""
    formatted = word

    if is_tty is None:
        is_tty = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()
    if supports_utf8 is None:
        supports_utf8 = str(sys.stdout.encoding).lower() == 'utf-8'
    if supports_ansi is None:
        supports_ansi = sys.platform != 'win32' or 'ANSICON' in os.environ

    style_support = supports_utf8
    color_support = is_tty and supports_ansi

    if style_support:
        formatted = STYLE.get(word, word)

    if color_support and COLOR.get(word):
        formatted = COLOR[word] + formatted + COLOR[None]

    return formatted


if __name__ == '__main__':  # pragma: no cover
    main()


1		#!/usr/bin/env python
2		# -- coding: utf-8 --
3
4		# The MIT License (MIT)
5		# Copyright © 2016, Jace Browning
6		#
7		# Permission is hereby granted, free of charge, to any person obtaining a copy
8		# of this software and associated documentation files (the "Software"), to deal
9		# in the Software without restriction, including without limitation the rights
10		# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11		# copies of the Software, and to permit persons to whom the Software is
12		# furnished to do so, subject to the following conditions:
13		#
14		# The above copyright notice and this permission notice shall be included in
15		# all copies or substantial portions of the Software.
16		#
17		# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18		# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19		# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20		# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21		# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22		# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23		# SOFTWARE.
24		#
25		# Source: https://github.com/jacebrowning/verchew
26		# Documentation: https://verchew.readthedocs.io
27		# Package: https://pypi.org/project/verchew
28
29
30	1	from __future__ import unicode_literals
31
32	1	import argparse
33	1	import logging
34	1	import os
35	1	import re
36	1	import sys
37		from collections import OrderedDict
38		from subprocess import PIPE, STDOUT, Popen
39	1
40	1
41	1	PY2 = sys.version_info[0] == 2
42
43	1	if PY2:
44		import ConfigParser as configparser
45	1	from urllib import urlretrieve
46	1	else:
47	1	import configparser
48		from urllib.request import urlretrieve
49
50		__version__ = '3.1b1'
51
52		SCRIPT_URL = (
53		"https://raw.githubusercontent.com/jacebrowning/verchew/master/verchew/script.py"
54		)
55
56		CONFIG_FILENAMES = ['verchew.ini', '.verchew.ini', '.verchewrc', '.verchew']
57
58		SAMPLE_CONFIG = """
59		[Python]
60
61		cli = python
62		version = Python 3.5 \|\| Python 3.6
63
64		[Legacy Python]
65
66		cli = python2
67		version = Python 2.7
68
69		[virtualenv]
70
71		cli = virtualenv
72		version = 15
73	1	message = Only required with Python 2.
74
75		[Make]
76
77		cli = make
78		version = GNU Make
79	1	optional = true
80
81		""".strip()
82
83		STYLE = {"~": "✔", "*": "⭑", "?": "⚠", "x": "✘"}
84
85		COLOR = {
86		"x": "\033[91m", # red
87	1	"~": "\033[92m", # green
88		"?": "\033[93m", # yellow
89		"*": "\033[94m", # cyan
90	1	None: "\033[0m", # reset
91	1	}
92	1
93		QUIET = False
94	1
95	1	log = logging.getLogger(__name__)
96
97	1
98	1	def main():
99		global QUIET
100	1
101	1	args = parse_args()
102		configure_logging(args.verbose)
103		if args.quiet:
104	1	QUIET = True
105	1
106		log.debug("PWD: %s", os.getenv('PWD'))
107	1	log.debug("PATH: %s", os.getenv('PATH'))
108	1
109	1	if args.vendor:
110		vendor_script(args.vendor)
111	1	sys.exit(0)
112
113	1	path = find_config(args.root, generate=args.init)
114		config = parse_config(path)
115	1
116		if not check_dependencies(config) and args.exit_code:
117		sys.exit(1)
118	1
119
120	1	def parse_args():
121		parser = argparse.ArgumentParser(description="System dependency version checker.",)
122
123	1	version = "%(prog)s v" + __version__
124	1	parser.add_argument(
125	1	'--version', action='version', version=version,
126		)
127		parser.add_argument(
128		'-r', '--root', metavar='PATH', help="specify a custom project root directory"
129		)
130		parser.add_argument(
131	1	'--exit-code',
132		action='store_true',
133		help="return a non-zero exit code on failure",
134	1	)
135	1
136	1	group_logging = parser.add_mutually_exclusive_group()
137		group_logging.add_argument(
138	1	'-v', '--verbose', action='count', default=0, help="enable verbose logging"
139	1	)
140	1	group_logging.add_argument(
141	1	'-q', '--quiet', action='store_true', help="suppress all output on success"
142	1	)
143	1
144	1	group_commands = parser.add_argument_group('commands')
145	1	group_commands.add_argument(
146		'--init', action='store_true', help="generate a sample configuration file"
147	1	)
148	1
149	1	group_commands.add_argument(
150		'--vendor', metavar='PATH', help="download the program for offline use"
151	1	)
152	1
153		args = parser.parse_args()
154
155	1	return args
156	1
157	1
158		def configure_logging(count=0):
159	1	if count == 0:
160		level = logging.WARNING
161	1	elif count == 1:
162	1	level = logging.INFO
163	1	else:
164		level = logging.DEBUG
165	1
166		logging.basicConfig(level=level, format="%(levelname)s: %(message)s")
167
168	1
169	1	def vendor_script(path):
170		root = os.path.abspath(os.path.join(path, os.pardir))
171	1	if not os.path.isdir(root):
172	1	log.info("Creating directory %s", root)
173	1	os.makedirs(root)
174
175	1	log.info("Downloading %s to %s", SCRIPT_URL, path)
176	1	urlretrieve(SCRIPT_URL, path)
177	1
178	1	log.debug("Making %s executable", path)
179		mode = os.stat(path).st_mode
180	1	os.chmod(path, mode \| 0o111)
181
182
183	1	def find_config(root=None, filenames=None, generate=False):
184	1	root = root or os.getcwd()
185		filenames = filenames or CONFIG_FILENAMES
186	1
187	1	path = None
188	1	log.info("Looking for config file in: %s", root)
189	1	log.debug("Filename options: %s", ", ".join(filenames))
190	1	for filename in os.listdir(root):
191	1	if filename in filenames:
192		path = os.path.join(root, filename)
193	1	log.info("Found config file: %s", path)
194	1	return path
195	1
196		if generate:
197	1	path = generate_config(root, filenames)
198	1	return path
199	1
200	1	msg = "No config file found in: {0}".format(root)
201		raise RuntimeError(msg)
202	1
203
204	1	def generate_config(root=None, filenames=None):
205		root = root or os.getcwd()
206		filenames = filenames or CONFIG_FILENAMES
207	1
208	1	path = os.path.join(root, filenames[0])
209	1
210		log.info("Generating sample config: %s", path)
211	1	with open(path, 'w') as config:
212	1	config.write(SAMPLE_CONFIG + '\n')
213	1
214		return path
215	1
216
217		def parse_config(path):
218	1	data = OrderedDict() # type: ignore
219	1
220		log.info("Parsing config file: %s", path)
221		config = configparser.ConfigParser()
222	1	config.read(path)
223	1
224	1	for section in config.sections():
225	1	data[section] = OrderedDict()
226	1	for name, value in config.items(section):
227	1	data[section][name] = value
228
229	1	for name in data:
230	1	version = data[name].get('version') or ""
231	1	data[name]['version'] = version
232		data[name]['patterns'] = [v.strip() for v in version.split('\|\|')]
233	1
234		return data
235
236	1
237		def check_dependencies(config):
238	1	success = []
239	1
240	1	for name, settings in config.items():
241		show("Checking for {0}...".format(name), head=True)
242	1	output = get_version(settings['cli'], settings.get('cli_version_arg'))
243	1
244		for pattern in settings['patterns']:
245	1	if match_version(pattern, output):
246	1	show(_("~") + " MATCHED: {0}".format(pattern or "<anything>"))
247		success.append(_("~"))
248	1	break
249	1	else:
250		if settings.get('optional'):
251		show(_("?") + " EXPECTED: {0}".format(settings['version']))
252	1	success.append(_("?"))
253		else:
254	1	if QUIET:
255		print(
256	1	"Unmatched {0} version: {1}".format(
257	1	name, settings['version'] or "<anything>"
258	1	)
259	1	)
260	1	show(
261	1	_("x")
262		+ " EXPECTED: {0}".format(settings['version'] or "<anything>")
263	1	)
264	1	success.append(_("x"))
265		if settings.get('message'):
266	1	show(_("*") + " MESSAGE: {0}".format(settings['message']))
267	1
268		show("Results: " + " ".join(success), head=True)
269	1
270	1	return _("x") not in success
271
272	1
273		def get_version(program, argument=None):
274		if argument is None:
275		args = [program, '--version']
276		elif argument:
277		args = [program, argument]
278		else:
279		args = [program]
280
281		show("$ {0}".format(" ".join(args)))
282		output = call(args)
283		lines = output.splitlines()
284		show(lines[0] if lines else "<nothing>")
285
286		return output
287
288
289		def match_version(pattern, output):
290		if "not found" in output.split('\n')[0]:
291		return False
292
293		regex = pattern.replace('.', r'\.') + r'(\b\|/)'
294
295		log.debug("Matching %s: %s", regex, output)
296		match = re.match(regex, output)
297		if match is None:
298		match = re.match(r'.*[^\d.]' + regex, output)
299
300		return bool(match)
301
302
303		def call(args):
304		try:
305		process = Popen(args, stdout=PIPE, stderr=STDOUT)
306		except OSError:
307		log.debug("Command not found: %s", args[0])
308		output = "sh: command not found: {0}".format(args[0])
309		else:
310		raw = process.communicate()[0]
311		output = raw.decode('utf-8').strip()
312		log.debug("Command output: %r", output)
313
314		return output
315
316
317		def show(text, start='', end='\n', head=False):
318		"""Python 2 and 3 compatible version of print."""
319		if QUIET:
320		return
321
322		if head:
323		start = '\n'
324		end = '\n\n'
325
326		if log.getEffectiveLevel() < logging.WARNING:
327		log.info(text)
328		else:
329		formatted = start + text + end
330		if PY2:
331		formatted = formatted.encode('utf-8')
332		sys.stdout.write(formatted)
333		sys.stdout.flush()
334
335
336		def _(word, is_tty=None, supports_utf8=None, supports_ansi=None):
337		"""Format and colorize a word based on available encoding."""
338		formatted = word
339
340		if is_tty is None:
341		is_tty = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()
342		if supports_utf8 is None:
343		supports_utf8 = str(sys.stdout.encoding).lower() == 'utf-8'
344		if supports_ansi is None:
345		supports_ansi = sys.platform != 'win32' or 'ANSICON' in os.environ
346
347		style_support = supports_utf8
348		color_support = is_tty and supports_ansi
349
350		if style_support:
351		formatted = STYLE.get(word, word)
352
353		if color_support and COLOR.get(word):
354		formatted = COLOR[word] + formatted + COLOR[None]
355
356		return formatted
357
358
359		if __name__ == '__main__': # pragma: no cover
360		main()
361

jacebrowning / verchew

Pull Request — develop (#68)

verchew.script.vendor_script() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like