def test_add_overwrite_label():
"""Test add command while specifying a label manually.
Regression test against #4.
"""
# use temporary config
tmp_config = "[DATABASE]\nfile=/tmp/cobib_test_database.yaml\n"
with open('/tmp/cobib_test_config.ini', 'w') as file:
file.write(tmp_config)
CONFIG.set_config(Path('/tmp/cobib_test_config.ini'))
# ensure database file exists and is empty
open('/tmp/cobib_test_database.yaml', 'w').close()
# freshly read in database to overwrite anything that was read in during setup()
read_database(fresh=True)
# add some data
commands.AddCommand().execute(['-b', './test/example_literature.bib'])
# add potentially duplicate entry
commands.AddCommand().execute([
'-b', './test/example_duplicate_entry.bib', '--label',
'duplicate_resolver'
])
# compare with reference file
with open('./test/example_literature.yaml', 'r') as expected:
true_lines = expected.readlines()
with open('./test/example_duplicate_entry.yaml', 'r') as extra:
true_lines += extra.readlines()
with open('/tmp/cobib_test_database.yaml', 'r') as file:
for line, truth in zip_longest(file, true_lines):
assert line == truth
# clean up file system
os.remove('/tmp/cobib_test_database.yaml')
os.remove('/tmp/cobib_test_config.ini')
def test_tui_scrolling(keys, assertion, assertion_kwargs):
"""Test TUI scrolling behavior."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
# overwrite database file
CONFIG.config['DATABASE']['file'] = './test/scrolling_database.yaml'
read_database()
test_tui(None, keys, assertion, assertion_kwargs)
def test_tui_quit_prompt(setting, keys):
"""Test the prompt_before_quit setting of the TUI."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
# set prompt_before_quit setting
CONFIG.config['TUI']['prompt_before_quit'] = setting
read_database()
test_tui(None, keys, assert_quit, {'prompt': setting})
def setup():
"""Setup."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
# NOTE: normally you would never trigger an Add command before reading the database but in this
# controlled testing scenario we can be certain that this is fine
AddCommand().execute(['-b', './test/dummy_scrolling_entry.bib'])
read_database()
yield setup
DeleteCommand().execute(['dummy_entry_for_scroll_testing'])
def test_set_config(setup):
"""Test config setting.
Args:
setup: runs pytest fixture.
"""
# from setup
assert CONFIG.config['DATABASE'][
'file'] == './test/example_literature.yaml'
# change back to default
CONFIG.set_config()
assert CONFIG.config['DATABASE']['file'] == \
os.path.expanduser('~/.local/share/cobib/literature.yaml')
def test_tui_open_menu():
"""Test the open prompt menu for multiple associated files."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
# NOTE: normally you would never trigger an Add command before reading the database but in this
# controlled testing scenario we can be certain that this is fine
AddCommand().execute(['-b', './test/dummy_multi_file_entry.bib'])
read_database()
try:
test_tui(None, 'o', assert_open, {})
finally:
DeleteCommand().execute(['dummy_multi_file_entry'])
def test_tui_config_color():
"""Test TUI color configuration."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
# overwrite color configuration
CONFIG.config['COLORS']['top_statusbar_bg'] = 'red'
CONFIG.config['COLORS']['top_statusbar_fg'] = 'blue'
CONFIG.config['COLORS']['bottom_statusbar_bg'] = 'green'
CONFIG.config['COLORS']['bottom_statusbar_fg'] = 'magenta'
CONFIG.config['COLORS']['cursor_line_bg'] = 'white'
CONFIG.config['COLORS']['cursor_line_fg'] = 'black'
read_database()
test_tui(None, '', assert_config_color, {'colors': CONFIG.config['COLORS']})
def list_tags(args=None):
"""List all tags.
Args:
args (dict, optional): dictionary of keyword arguments.
Returns:
A list of all available tags in the database.
"""
if not args:
args = {}
CONFIG.set_config(args.get('config', None))
read_database()
tags = list(CONFIG.config['BIB_DATA'].keys())
return tags
def test_tui_config_keys(command, key):
"""Test TUI key binding configuration."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
# overwrite key binding configuration
CONFIG.config['KEY_BINDINGS'][command] = key
# NOTE: normally you would never trigger an Add command before reading the database but in this
# controlled testing scenario we can be certain that this is fine
AddCommand().execute(['-b', './test/dummy_scrolling_entry.bib'])
read_database()
try:
test_tui(None, key, assert_show, {})
finally:
DeleteCommand().execute(['dummy_entry_for_scroll_testing'])
def test_init_force():
"""Test init can be forced when database file exists."""
# use temporary config
tmp_config = "[DATABASE]\nfile=/tmp/cobib_test_database.yaml\n"
with open('/tmp/cobib_test_config.ini', 'w') as file:
file.write(tmp_config)
CONFIG.set_config(Path('/tmp/cobib_test_config.ini'))
# fill database file
with open('/tmp/cobib_test_database.yaml', 'w') as file:
file.write('test')
# try running init
commands.InitCommand().execute(['-f'])
# check init was forced and database file was overwritten
assert os.stat('/tmp/cobib_test_database.yaml').st_size == 0
# clean up file system
os.remove('/tmp/cobib_test_database.yaml')
os.remove('/tmp/cobib_test_config.ini')
def list_filters(args=None):
"""List all filters.
Args:
args (dict, optional): dictionary of keyword arguments.
Returns:
A list of all field names available for filtering.
"""
if not args:
args = {}
CONFIG.set_config(args.get('config', None))
read_database()
filters = set()
for entry in CONFIG.config['BIB_DATA'].values():
filters.update(entry.data.keys())
return filters
def test_init():
"""Test init command."""
# use temporary config
tmp_config = "[DATABASE]\nfile=/tmp/cobib_test_database.yaml\n"
with open('/tmp/cobib_test_config.ini', 'w') as file:
file.write(tmp_config)
CONFIG.set_config(Path('/tmp/cobib_test_config.ini'))
# store current time
now = float(datetime.now().timestamp())
commands.InitCommand().execute({})
# check creation time of temporary database file
ctime = os.stat('/tmp/cobib_test_database.yaml').st_ctime
# assert these times are close
assert ctime - now < 0.1 or now - ctime < 0.1
# clean up file system
os.remove('/tmp/cobib_test_database.yaml')
os.remove('/tmp/cobib_test_config.ini')
def test_init_safe():
"""Test init aborts when database file exists."""
# use temporary config
tmp_config = "[DATABASE]\nfile=/tmp/cobib_test_database.yaml\n"
with open('/tmp/cobib_test_config.ini', 'w') as file:
file.write(tmp_config)
CONFIG.set_config(Path('/tmp/cobib_test_config.ini'))
# fill database file
with open('/tmp/cobib_test_database.yaml', 'w') as file:
file.write('test')
# try running init
commands.InitCommand().execute({})
# check init aborted and database file still contains 'test'
with open('/tmp/cobib_test_database.yaml', 'r') as file:
assert file.read() == 'test'
# clean up file system
os.remove('/tmp/cobib_test_database.yaml')
os.remove('/tmp/cobib_test_config.ini')
def test_add():
"""Test add command."""
# use temporary config
tmp_config = "[DATABASE]\nfile=/tmp/cobib_test_database.yaml\n"
with open('/tmp/cobib_test_config.ini', 'w') as file:
file.write(tmp_config)
CONFIG.set_config(Path('/tmp/cobib_test_config.ini'))
# ensure database file exists and is empty
open('/tmp/cobib_test_database.yaml', 'w').close()
# freshly read in database to overwrite anything that was read in during setup()
read_database(fresh=True)
# add some data
commands.AddCommand().execute(['-b', './test/example_literature.bib'])
# compare with reference file
with open('/tmp/cobib_test_database.yaml', 'r') as file:
with open('./test/example_literature.yaml', 'r') as expected:
for line, truth in zip_longest(file, expected):
assert line == truth
# clean up file system
os.remove('/tmp/cobib_test_database.yaml')
os.remove('/tmp/cobib_test_config.ini')
def test_delete(labels):
"""Test delete command."""
# use temporary config
tmp_config = "[DATABASE]\nfile=/tmp/cobib_test_database.yaml\n"
with open('/tmp/cobib_test_config.ini', 'w') as file:
file.write(tmp_config)
CONFIG.set_config(Path('/tmp/cobib_test_config.ini'))
# copy example database to configured location
copyfile(Path('./test/example_literature.yaml'),
Path('/tmp/cobib_test_database.yaml'))
# delete some data
# NOTE: for testing simplicity we delete the last entry
commands.DeleteCommand().execute(labels)
with open('/tmp/cobib_test_database.yaml', 'r') as file:
with open('./test/example_literature.yaml', 'r') as expected:
# NOTE: do NOT use zip_longest to omit last entry (thus, we deleted the last one)
for line, truth in zip(file, expected):
assert line == truth
with pytest.raises(StopIteration):
file.__next__()
# clean up file system
os.remove('/tmp/cobib_test_database.yaml')
os.remove('/tmp/cobib_test_config.ini')
def main():
"""Main executable.
CoBib's main function used to parse optional keyword arguments and subcommands.
"""
if len(sys.argv) > 1 and any([a[0] == '_' for a in sys.argv]):
# zsh helper function called
zsh_main()
sys.exit()
# initialize logging
log_to_stream()
subcommands = [cmd.split(':')[0] for cmd in zsh_helper.list_commands()]
parser = argparse.ArgumentParser(prog='CoBib',
description="""
Cobib input arguments.
If no arguments are given, the TUI will start as a default.
""")
parser.add_argument("--version",
action="version",
version="%(prog)s v{}".format(__version__))
parser.add_argument('--verbose', '-v', action='count', default=0)
parser.add_argument("-l",
"--logfile",
type=argparse.FileType('w'),
help="Alternative log file")
parser.add_argument("-c",
"--config",
type=argparse.FileType('r'),
help="Alternative config file")
parser.add_argument('command',
help="subcommand to be called",
choices=subcommands,
nargs='?')
parser.add_argument('args', nargs=argparse.REMAINDER)
args = parser.parse_args()
if args.logfile:
LOGGER.info('Switching to FileHandler logger in %s', args.logfile.name)
log_to_file('DEBUG' if args.verbose > 1 else 'INFO',
logfile=args.logfile.name)
# set logging verbosity level
if args.verbose == 1:
logging.getLogger().setLevel(logging.INFO)
LOGGER.info('Logging level set to INFO.')
elif args.verbose > 1:
logging.getLogger().setLevel(logging.DEBUG)
LOGGER.info('Logging level set to DEBUG.')
CONFIG.set_config(args.config)
try:
CONFIG.validate()
except RuntimeError as exc:
LOGGER.error(exc)
sys.exit(1)
if args.command == 'init':
# the database file may not exist yet, thus we ensure to execute the command before trying
# to read the database file
subcmd = getattr(commands, 'InitCommand')()
subcmd.execute(args.args)
return
read_database()
if not args.command:
if args.logfile is None:
LOGGER.info('Switching to FileHandler logger in %s',
'/tmp/cobib.log')
log_to_file('DEBUG' if args.verbose > 1 else 'INFO')
else:
LOGGER.info(
'Already logging to %s. NOT switching to "/tmp/cobib.log"',
args.logfile)
tui()
else:
subcmd = getattr(commands, args.command.title() + 'Command')()
subcmd.execute(args.args)
def setup():
"""Setup."""
# ensure configuration is empty
CONFIG.config = {}
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
def setup():
"""Setup."""
root = os.path.abspath(os.path.dirname(__file__))
CONFIG.set_config(Path(root + '/../cobib/docs/debug.ini'))
read_database()
