Files
@ 0590c952df64
Branch filter:
Location: gimmecert/tests/test_cli.py
0590c952df64
3.7 KiB
text/x-python
GC-11: Added a help subcommand to the tool:
- Updated functional test for checking on the help subcommand as well.
- Implemented the 'help' subcommand.
- Updated required function signature for the subcommand_parser
decorator (functions should return ArgumentParser instance).
- Fixed a typo in inline documentation.
- Updated the test for subcommand_parser decorator to be a more robust
when checking if function registration works.
- Updated functional test for checking on the help subcommand as well.
- Implemented the 'help' subcommand.
- Updated required function signature for the subcommand_parser
decorator (functions should return ArgumentParser instance).
- Fixed a typo in inline documentation.
- Updated the test for subcommand_parser decorator to be a more robust
when checking if function registration works.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | # -*- coding: utf-8 -*-
#
# Copyright (C) 2018 Branko Majic
#
# This file is part of Gimmecert.
#
# Gimmecert is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# Gimmecert is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# Gimmecert. If not, see <http://www.gnu.org/licenses/>.
#
import argparse
import gimmecert.cli
import gimmecert.decorators
from unittest import mock
def test_get_parser_returns_parser():
parser = gimmecert.cli.get_parser()
assert isinstance(parser, argparse.ArgumentParser)
@mock.patch('gimmecert.cli.get_parser')
def test_main_invokes_get_parser(mock_get_parser):
gimmecert.cli.main()
mock_get_parser.assert_called_once_with()
@mock.patch('gimmecert.cli.get_parser')
def test_main_invokes_argument_parsing(mock_get_parser):
mock_parser = mock.Mock()
mock_get_parser.return_value = mock_parser
gimmecert.cli.main()
mock_parser.parse_args.assert_called_once_with()
def test_cli_parser_has_description():
parser = gimmecert.cli.get_parser()
assert parser.description
def test_parser_sets_up_default_callback_function():
parser = gimmecert.cli.get_parser()
assert callable(parser.get_default('func'))
@mock.patch('gimmecert.cli.argparse.ArgumentParser.print_usage')
def test_parser_default_callback_function_calls_print_usage(mock_print_usage):
parser = gimmecert.cli.get_parser()
func = parser.get_default('func')
func(mock.Mock())
assert mock_print_usage.called
@mock.patch('gimmecert.cli.get_parser')
def test_main_invokes_parser_function(mock_get_parser):
mock_parser = mock.Mock()
mock_args = mock.Mock()
mock_parser.parse_args.return_value = mock_args
mock_get_parser.return_value = mock_parser
gimmecert.cli.main()
mock_args.func.assert_called_once_with(mock_args)
def test_parser_help_contains_examples():
parser = gimmecert.cli.get_parser()
assert 'Examples' in parser.description
def test_setup_help_subcommand_parser_registered():
registered_functions = gimmecert.decorators.get_subcommand_parser_setup_functions()
assert gimmecert.cli.setup_help_subcommand_parser in registered_functions
@mock.patch('gimmecert.cli.get_subcommand_parser_setup_functions')
def test_get_parser_calls_setup_subcommand_parser_functions(mock_get_subcommand_parser_setup_functions):
mock_setup1 = mock.Mock()
mock_setup2 = mock.Mock()
mock_get_subcommand_parser_setup_functions.return_value = [mock_setup1, mock_setup2]
gimmecert.cli.get_parser()
assert mock_setup1.called
assert mock_setup2.called
def test_setup_help_subcommand_parser_adds_parser():
mock_parser = mock.Mock()
mock_subparsers = mock.Mock()
gimmecert.cli.setup_help_subcommand_parser(mock_parser, mock_subparsers)
assert mock_subparsers.add_parser.called
def test_help_subcommand_returns_parser():
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
subparser = gimmecert.cli.setup_help_subcommand_parser(parser, subparsers)
assert isinstance(subparser, argparse.ArgumentParser)
def test_help_subcommand_sets_function_callback():
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
subparser = gimmecert.cli.setup_help_subcommand_parser(parser, subparsers)
assert callable(subparser.get_default('func'))
|