python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

Merge pull request #299 from kellyjonbrazil/cli-refactor

Browse Source 
Cli refactor
This commit is contained in:
Kelly Brazil
2022-10-04 21:18:58 +00:00
committed by GitHub
parent 5486957141 6f1ef09d2a
commit fee6a61f19
3 changed files with 739 additions and 677 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1216
jc/cli.py
View File

File diff suppressed because it is too large Load Diff

39
jc/cli_data.py
View File

@ -55,3 +55,42 @@ old_pygments_colors = {
'brightcyan': '#ansiturquoise', 'brightcyan': '#ansiturquoise',
'white': '#ansiwhite', 'white': '#ansiwhite',
} }
helptext_preamble_string = f'''\
jc converts the output of many commands, file-types, and strings to JSON or YAML
Usage:
Standard syntax:
COMMAND | jc [OPTIONS] PARSER
cat FILE | jc [OPTIONS] PARSER
echo STRING | jc [OPTIONS] PARSER
Magic syntax:
jc [OPTIONS] COMMAND
jc [OPTIONS] /proc/<path-to-procfile>
Parsers:
'''
helptext_end_string = '''\
Examples:
Standard Syntax:
$ dig www.google.com | jc --pretty --dig
$ cat /proc/meminfo | jc --pretty --proc
Magic Syntax:
$ jc --pretty dig www.google.com
$ jc --pretty /proc/meminfo
Parser Documentation:
$ jc --help --dig
Show Hidden Parsers:
$ jc -hh
'''

161
tests/test_jc_cli.py
View File

@ -1,39 +1,44 @@
import os
import unittest import unittest
from datetime import datetime, timezone from datetime import datetime, timezone
import pygments import pygments
from pygments.token import (Name, Number, String, Keyword) from pygments.token import (Name, Number, String, Keyword)
import jc.cli from jc.cli import JcCli
class MyTests(unittest.TestCase): class MyTests(unittest.TestCase):
def test_cli_magic_parser(self): def test_cli_magic_parser(self):
commands = { commands = {
'jc -p systemctl list-sockets': (True, ['systemctl', 'list-sockets'], '--systemctl-ls', ['p']), 'jc -p systemctl list-sockets': ('--systemctl-ls', ['p'], ['systemctl', 'list-sockets']),
'jc -p systemctl list-unit-files': (True, ['systemctl', 'list-unit-files'], '--systemctl-luf', ['p']), 'jc -p systemctl list-unit-files': ('--systemctl-luf', ['p'], ['systemctl', 'list-unit-files']),
'jc -p pip list': (True, ['pip', 'list'], '--pip-list', ['p']), 'jc -p pip list': ('--pip-list', ['p'], ['pip', 'list']),
'jc -p pip3 list': (True, ['pip3', 'list'], '--pip-list', ['p']), 'jc -p pip3 list': ('--pip-list', ['p'], ['pip3', 'list']),
'jc -p pip show jc': (True, ['pip', 'show', 'jc'], '--pip-show', ['p']), 'jc -p pip show jc': ('--pip-show', ['p'], ['pip', 'show', 'jc']),
'jc -p pip3 show jc': (True, ['pip3', 'show', 'jc'], '--pip-show', ['p']), 'jc -p pip3 show jc': ('--pip-show', ['p'], ['pip3', 'show', 'jc']),
'jc -prd last': (True, ['last'], '--last', ['p', 'r', 'd']), 'jc -prd last': ('--last', ['p', 'r', 'd'], ['last']),
'jc -prdd lastb': (True, ['lastb'], '--last', ['p', 'r', 'd', 'd']), 'jc -prdd lastb': ('--last', ['p', 'r', 'd', 'd'], ['lastb']),
'jc -p airport -I': (True, ['airport', '-I'], '--airport', ['p']), 'jc -p airport -I': ('--airport', ['p'], ['airport', '-I']),
'jc -p -r airport -I': (True, ['airport', '-I'], '--airport', ['p', 'r']), 'jc -p -r airport -I': ('--airport', ['p', 'r'], ['airport', '-I']),
'jc -prd airport -I': (True, ['airport', '-I'], '--airport', ['p', 'r', 'd']), 'jc -prd airport -I': ('--airport', ['p', 'r', 'd'], ['airport', '-I']),
'jc -p nonexistent command': (False, ['nonexistent', 'command'], None, ['p']), 'jc -p nonexistent command': (None, ['p'], ['nonexistent', 'command']),
'jc -ap': (False, None, None, []), 'jc -ap': (None, [], None),
'jc -a arp -a': (False, None, None, []), 'jc -a arp -a': (None, [], None),
'jc -v': (False, None, None, []), 'jc -v': (None, [], None),
'jc -h': (False, None, None, []), 'jc -h': (None, [], None),
'jc -h --arp': (False, None, None, []), 'jc -h --arp': (None, [], None),
'jc -h arp': (False, None, None, []), 'jc -h arp': (None, [], None),
'jc -h arp -a': (False, None, None, []), 'jc -h arp -a': (None, [], None),
'jc --pretty dig': (True, ['dig'], '--dig', ['p']), 'jc --pretty dig': ('--dig', ['p'], ['dig']),
'jc --pretty --monochrome --quiet --raw dig': (True, ['dig'], '--dig', ['p', 'm', 'q', 'r']), 'jc --pretty --monochrome --quiet --raw dig': ('--dig', ['p', 'm', 'q', 'r'], ['dig']),
'jc --about --yaml-out': (False, None, None, []) 'jc --about --yaml-out': (None, [], None)
} }
for command, expected_command in commands.items(): for command, expected in commands.items():
self.assertEqual(jc.cli.magic_parser(command.split(' ')), expected_command) cli = JcCli()
cli.args = command.split()
cli.magic_parser()
resulting_attributes = (cli.magic_found_parser, cli.magic_options, cli.magic_run_command)
self.assertEqual(expected, resulting_attributes)
def test_cli_set_env_colors(self): def test_cli_set_env_colors(self):
if pygments.__version__.startswith('2.3.'): if pygments.__version__.startswith('2.3.'):
@ -128,7 +133,10 @@ class MyTests(unittest.TestCase):
} }
for jc_colors, expected_colors in env.items(): for jc_colors, expected_colors in env.items():
self.assertEqual(jc.cli.set_env_colors(jc_colors), expected_colors) cli = JcCli()
os.environ["JC_COLORS"] = jc_colors
cli.set_custom_colors()
self.assertEqual(cli.custom_colors, expected_colors)
def test_cli_json_out(self): def test_cli_json_out(self):
test_input = [ test_input = [
@ -157,7 +165,11 @@ class MyTests(unittest.TestCase):
] ]
for test_dict, expected_json in zip(test_input, expected_output): for test_dict, expected_json in zip(test_input, expected_output):
self.assertEqual(jc.cli.json_out(test_dict), expected_json) cli = JcCli()
os.environ["JC_COLORS"] = "default,default,default,default"
cli.set_custom_colors()
cli.data_out = test_dict
self.assertEqual(cli.json_out(), expected_json)
def test_cli_json_out_mono(self): def test_cli_json_out_mono(self):
test_input = [ test_input = [
@ -177,7 +189,11 @@ class MyTests(unittest.TestCase):
] ]
for test_dict, expected_json in zip(test_input, expected_output): for test_dict, expected_json in zip(test_input, expected_output):
self.assertEqual(jc.cli.json_out(test_dict, mono=True), expected_json) cli = JcCli()
cli.set_custom_colors()
cli.mono = True
cli.data_out = test_dict
self.assertEqual(cli.json_out(), expected_json)
def test_cli_json_out_pretty(self): def test_cli_json_out_pretty(self):
test_input = [ test_input = [
@ -197,7 +213,11 @@ class MyTests(unittest.TestCase):
] ]
for test_dict, expected_json in zip(test_input, expected_output): for test_dict, expected_json in zip(test_input, expected_output):
self.assertEqual(jc.cli.json_out(test_dict, pretty=True), expected_json) cli = JcCli()
cli.pretty = True
cli.set_custom_colors()
cli.data_out = test_dict
self.assertEqual(cli.json_out(), expected_json)
def test_cli_yaml_out(self): def test_cli_yaml_out(self):
test_input = [ test_input = [
@ -226,7 +246,11 @@ class MyTests(unittest.TestCase):
] ]
for test_dict, expected_json in zip(test_input, expected_output): for test_dict, expected_json in zip(test_input, expected_output):
self.assertEqual(jc.cli.yaml_out(test_dict), expected_json) cli = JcCli()
os.environ["JC_COLORS"] = "default,default,default,default"
cli.set_custom_colors()
cli.data_out = test_dict
self.assertEqual(cli.yaml_out(), expected_json)
def test_cli_yaml_out_mono(self): def test_cli_yaml_out_mono(self):
test_input = [ test_input = [
@ -248,56 +272,61 @@ class MyTests(unittest.TestCase):
] ]
for test_dict, expected_json in zip(test_input, expected_output): for test_dict, expected_json in zip(test_input, expected_output):
self.assertEqual(jc.cli.yaml_out(test_dict, mono=True), expected_json) cli = JcCli()
cli.set_custom_colors()
cli.mono = True
cli.data_out = test_dict
self.assertEqual(cli.yaml_out(), expected_json)
def test_cli_about_jc(self): def test_cli_about_jc(self):
self.assertEqual(jc.cli.about_jc()['name'], 'jc') cli = JcCli()
self.assertGreaterEqual(jc.cli.about_jc()['parser_count'], 55) self.assertEqual(cli.about_jc()['name'], 'jc')
self.assertEqual(jc.cli.about_jc()['parser_count'], len(jc.cli.about_jc()['parsers'])) self.assertGreaterEqual(cli.about_jc()['parser_count'], 55)
self.assertEqual(cli.about_jc()['parser_count'], len(cli.about_jc()['parsers']))
def test_add_meta_to_simple_dict(self): def test_add_meta_to_simple_dict(self):
list_or_dict = {'a': 1, 'b': 2} cli = JcCli()
runtime = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc) cli.data_out = {'a': 1, 'b': 2}
magic_exit_code = 2 cli.run_timestamp = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc)
run_command = ['ping', '-c3', '192.168.1.123'] cli.magic_returncode = 2
parser_name = 'ping' cli.magic_run_command = ['ping', '-c3', '192.168.1.123']
cli.parser_name = 'ping'
expected = {'a': 1, 'b': 2, '_jc_meta': {'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}} expected = {'a': 1, 'b': 2, '_jc_meta': {'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}
jc.cli.add_metadata_to(list_or_dict, runtime, run_command, magic_exit_code, parser_name) cli.add_metadata_to_output()
self.assertEqual(cli.data_out, expected)
self.assertEqual(list_or_dict, expected)
def test_add_meta_to_simple_list(self): def test_add_meta_to_simple_list(self):
list_or_dict = [{'a': 1, 'b': 2},{'a': 3, 'b': 4}] cli = JcCli()
runtime = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc) cli.data_out = [{'a': 1, 'b': 2},{'a': 3, 'b': 4}]
magic_exit_code = 2 cli.run_timestamp = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc)
run_command = ['ping', '-c3', '192.168.1.123'] cli.magic_returncode = 2
parser_name = 'ping' cli.magic_run_command = ['ping', '-c3', '192.168.1.123']
cli.parser_name = 'ping'
expected = [{'a': 1, 'b': 2, '_jc_meta': {'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}, {'a': 3, 'b': 4, '_jc_meta': {'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}] expected = [{'a': 1, 'b': 2, '_jc_meta': {'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}, {'a': 3, 'b': 4, '_jc_meta': {'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}]
jc.cli.add_metadata_to(list_or_dict, runtime, run_command, magic_exit_code, parser_name) cli.add_metadata_to_output()
self.assertEqual(cli.data_out, expected)
self.assertEqual(list_or_dict, expected)
def test_add_meta_to_dict_existing_meta(self): def test_add_meta_to_dict_existing_meta(self):
list_or_dict = {'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar'}} cli = JcCli()
runtime = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc) cli.magic_run_command = ['ping', '-c3', '192.168.1.123']
magic_exit_code = 2 cli.magic_returncode = 2
run_command = ['ping', '-c3', '192.168.1.123'] cli.data_out = {'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar'}}
parser_name = 'ping' cli.run_timestamp = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc)
cli.parser_name = 'ping'
expected = {'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar', 'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}} expected = {'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar', 'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}
jc.cli.add_metadata_to(list_or_dict, runtime, run_command, magic_exit_code, parser_name) cli.add_metadata_to_output()
self.assertEqual(cli.data_out, expected)
self.assertEqual(list_or_dict, expected)
def test_add_meta_to_list_existing_meta(self): def test_add_meta_to_list_existing_meta(self):
list_or_dict = [{'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar'}},{'a': 3, 'b': 4, '_jc_meta': {'foo': 'bar'}}] cli = JcCli()
runtime = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc) cli.data_out = [{'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar'}},{'a': 3, 'b': 4, '_jc_meta': {'foo': 'bar'}}]
magic_exit_code = 2 cli.run_timestamp = datetime(2022, 8, 5, 0, 37, 9, 273349, tzinfo=timezone.utc)
run_command = ['ping', '-c3', '192.168.1.123'] cli.magic_returncode = 2
parser_name = 'ping' cli.magic_run_command = ['ping', '-c3', '192.168.1.123']
cli.parser_name = 'ping'
expected = [{'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar', 'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}, {'a': 3, 'b': 4, '_jc_meta': {'foo': 'bar', 'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}] expected = [{'a': 1, 'b': 2, '_jc_meta': {'foo': 'bar', 'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}, {'a': 3, 'b': 4, '_jc_meta': {'foo': 'bar', 'parser': 'ping', 'magic_command': ['ping', '-c3', '192.168.1.123'], 'magic_command_exit': 2, 'timestamp': 1659659829.273349}}]
jc.cli.add_metadata_to(list_or_dict, runtime, run_command, magic_exit_code, parser_name) cli.add_metadata_to_output()
self.assertEqual(cli.data_out, expected)
self.assertEqual(list_or_dict, expected)
if __name__ == '__main__': if __name__ == '__main__':
unittest.main() unittest.main()