-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42 from jurraca/test-cli
Add tests for the CLI
- Loading branch information
Showing
3 changed files
with
153 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| """CLI functionality for Kartograf.""" | ||
|
|
||
| import argparse | ||
| import os | ||
| import sys | ||
| import kartograf | ||
| from kartograf.kartograf import Kartograf | ||
|
|
||
|
|
||
| def create_parser(): | ||
| parser = argparse.ArgumentParser() | ||
|
|
||
| # Command which program Kartograf should run | ||
| subparsers = parser.add_subparsers(dest="command") | ||
|
|
||
| parser_map = subparsers.add_parser("map") | ||
|
|
||
| # Write extended logging information to a debug.log file | ||
| # TODO: This is always enabled for now but this should be changed when the | ||
| # tool is more stable | ||
| parser_map.add_argument("-d", "--debug", action="store_true", default=True) | ||
| # Delete artifacts from building the requested map | ||
| parser_map.add_argument("-c", "--cleanup", action="store_true", default=False) | ||
|
|
||
| parser_map.add_argument("-irr", "--irr", action="store_true", default=False) | ||
| parser_map.add_argument("-rv", "--routeviews", action="store_true", default=False) | ||
|
|
||
| # Reproduce a map file from a previous run by using provided input files. | ||
| # The input related arguments are ignored if this flag is set. All provided | ||
| # input files will be used if they are present in the reproduce folder and | ||
| # in the right format. The epoch argument is required for this to work. | ||
| parser_map.add_argument("-r", "--reproduce", type=str, default=None) | ||
| parser_map.add_argument("-t", "--epoch", type=str, default=None) | ||
|
|
||
| # Waits until the provided epoch is reached before starting the map | ||
| parser_map.add_argument("-w", "--wait", type=str, default=None) | ||
|
|
||
| # Ignore ASNs too high to be compatible with the current asmap encoder | ||
| # Set to 0 to disable | ||
| parser_map.add_argument("-me", "--max_encode", type=int, default=33521664) | ||
|
|
||
| # TODO: | ||
| # Save the final output file in a different location that the default out | ||
| # folder | ||
| # parser_map.add_argument("-o", "--output", action="store_true", default=os.getcwd()) | ||
|
|
||
| # TODO: | ||
| # Filter RPKI and IRR data by checking against RIPE RIS and Routeviews data | ||
| # and removing all entries that have not been seen announced to those | ||
| # services. | ||
| # parser_map.add_argument("-f", "--announced_filter", action="store_true", default=False) | ||
|
|
||
| # TODO: | ||
| # Include multiple ASNs that validate correctly for the same prefix. | ||
| # parser_map.add_argument("-m", "--multi_map", action="store_true", default=False) | ||
|
|
||
| parser_merge = subparsers.add_parser("merge") | ||
|
|
||
| parser_merge.add_argument("-b", "--base", default=f"{os.getcwd()}/base_file.txt") | ||
| parser_merge.add_argument("-e", "--extra", default=f"{os.getcwd()}/extra_file.txt") | ||
| parser_merge.add_argument("-o", "--output", default=f"{os.getcwd()}/out_file.txt") | ||
|
|
||
| parser_cov = subparsers.add_parser("cov") | ||
|
|
||
| # IP prefix to ASN map to be used for the coverage report. | ||
| parser_cov.add_argument("map", type=argparse.FileType("r")) | ||
|
|
||
| # List of IPs to be used for the coverage report. | ||
| parser_cov.add_argument("list", type=argparse.FileType("r")) | ||
|
|
||
| parser.add_argument( | ||
| "--version", | ||
| action="version", | ||
| version=f"%(prog)s (version {kartograf.__version__})", | ||
| ) | ||
|
|
||
| return parser | ||
|
|
||
|
|
||
| def main(args=None): | ||
| parser = create_parser() | ||
| args = parser.parse_args(args) | ||
|
|
||
| if args.command == "run": | ||
| if args.reproduce and not args.epoch: | ||
| parser.error("--reproduce is required when --epoch is set.") | ||
| elif not args.epoch and args.reproduce: | ||
| parser.error("--epoch is required when --reproduce is set.") | ||
|
|
||
| if args.wait and args.reproduce: | ||
| parser.error("--reproduce is not compatible with --wait.") | ||
|
|
||
| if args.command == "map": | ||
| Kartograf.map(args) | ||
| elif args.command == "cov": | ||
| Kartograf.cov(args) | ||
| elif args.command == "merge": | ||
| Kartograf.merge(args) | ||
| else: | ||
| parser.print_help() | ||
| sys.exit("Please provide a command.") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import pytest | ||
| from kartograf.cli import create_parser | ||
|
|
||
| parser = create_parser() | ||
|
|
||
| def test_map_command(): | ||
| args = parser.parse_args(['map']) | ||
| assert args.command == 'map' | ||
| assert args.debug is True # default is True | ||
| assert args.cleanup is False # default is False | ||
| assert args.irr is False # default is False | ||
| assert args.routeviews is False # default is False | ||
| assert args.reproduce is None | ||
| assert args.epoch is None | ||
| assert args.max_encode == 33521664 | ||
|
|
||
| def test_map_with_options(): | ||
| args = parser.parse_args(['map', '-c', '-irr', '-rv', '-r', '/path', '-t', '123']) | ||
| assert args.cleanup is True | ||
| assert args.irr is True | ||
| assert args.routeviews is True | ||
| assert args.reproduce == '/path' | ||
| assert args.epoch == '123' | ||
|
|
||
| def test_merge_command(): | ||
| args = parser.parse_args(['merge']) | ||
| assert args.command == 'merge' | ||
| assert args.base.endswith('base_file.txt') | ||
| assert args.extra.endswith('extra_file.txt') | ||
| assert args.output.endswith('out_file.txt') | ||
|
|
||
| def test_cov_command(capsys): | ||
| with pytest.raises(SystemExit): | ||
| # Should fail without required arguments | ||
| parser.parse_args(['cov']) | ||
| captured = capsys.readouterr() | ||
| assert captured.err.startswith("usage:") | ||
|
|
||
| def test_invalid_command(capsys): | ||
| with pytest.raises(SystemExit): | ||
| parser.parse_args(['invalid']) | ||
| captured = capsys.readouterr() | ||
| assert captured.err.startswith("usage:") | ||
|
|
||
| def test_version_flag(capsys): | ||
| with pytest.raises(SystemExit) as excinfo: | ||
| parser.parse_args(['--version']) | ||
| assert excinfo.value.code == 0 | ||
| captured = capsys.readouterr() | ||
| assert "version" in captured.out |