mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
4f79803885
Add --config-override feature
* add test and argument handler for runtime override of configurations.
* identify location to apply override in "main"
* update gitignore
* remove unneeded import
* add jrnl interface test for overriden configurations
* trivial whitespace change
* implement runtime override
* make format
* refactor override unittest
* clean up unused import
* start writing integration test
* add linewrap override scenario
* implement editor override step
* add dev dependencies on pytest -mock and -cov
* make format
* remove unused imports
* make format
* rename --override to --config-override
* move override implementation into own module
* begin TDD of dot notated overrides
* rewrite behavior scenario
* implement recursive config overrides
* clean up unittests
* iterate on behave step
* make format
* cleanup
* move override behave tests out of core
* refactor recursive code
* make format
* code cleanup
* remove unused import
* update test config
* rewrite test for better mock call expect
* make format
* binary search misbehaving windows test
* unittest multiple overrides
* uncomment dot notation unittest
* add multiple override scenario spec
* make format
* make format
* update unittests for new syntax
* update integ tests for new syntax
* update gitignore
* guard override application
* deserialize function as return type
* make format
* organize deserialization unittests
* better, more specific behave tests
* test different editor launch commands
* formatting
* handle datatypes in deserialization and update helptext
* stick to config convention in testbed
* update tests ith better verifications
* make format
* space
* review feedbac
* make format
* skip on win
* update deps
* update tests with better verifications
make format
space
review feedbac
* skip on win
* update deps
* refactor deserialization
organize test_parse_args
make format
* skip on win
* refactor deserialization
organize test_parse_args
make format
* update tests ith better verifications
* make format
* space
* make format
* document apply_overrides
* update gitignore
* document config-override enhancement
* Simplify config override syntax (#5)
* update tests and expected behavior
* clean up arg parsing tests
* update deserialization
* update deserialization
* config argparse action
* update override application logic
* update tests; delete unused imports
* override param must be list
* update docstring
* update test input to SUT
* update remaining override unittests
* make format
* forgot to update CLI syntax
* update documentation to sphinx style
* variable renames
* Lockfile merge (#7)
* Add brew and gitter badges to README
* Update changelog [ci skip]
* Make journal selection behavior more consistent when there's a colon with no date (#1164)
* Simplify config override syntax (#8)
* update tests and expected behavior
* clean up arg parsing tests
* update deserialization
* update deserialization
* config argparse action
* update override application logic
* update tests; delete unused imports
* override param must be list
* update docstring
* update test input to SUT
* update remaining override unittests
* make format
* forgot to update CLI syntax
* formatting
* Update pyproject.toml
* update lockfile to remove pytest-cov and pytest-mock deps
* update docs
* reuse existing mock; delete unneeded code
* move overrides earlier in the execution
use existing configs instead of custom
make format
clean up imports
* update for passworded access
context.parser -> parsed_args
* test that no editor is launched
* remove unnecessary mocks
* rename variable for intent
* reinstate getpass deletion
* update gitignore
* capture failure mode
* remove unneeded imports
* renamed variable
* delete redundant step
* comment on step
* clean up step behavior description
* [WIP] lock down journal access behavior
* skip -> wip
* correct command for overriding journal via dot keys
* update wip test for updating a "temp" journal and then reading baack its entries
* remove "mock" from poetry file
* make CI happy
* complex behavior sequence for default journal override
* separate out smaller pieces of logic
test that apply_overrides acts on base configuration and not the copy
* defer modification of loaded configuration to update_config
remove unused fixtures
delete complicated UT since behavior is covered in overrides.feature integ test
delete redundant UT
* Update .gitignore
* remove skip_win
* forward override unpacking to yaml library
* merge config override step with existing config_var step in core
delete config_override step
unify step description syntax
* delete unused and redundant code
* rebases are hard
* remove wip tag from test
* remove skipped tests for windows
* Address code review
yield -> return
remove needless copy
adjust spacing
re-inline args return
reset packaging info to e6c0a16342
revert package version for this PR
* consolidate imports
* Defer config_override unpacking to dict *after* base config is loaded
store cli overrides without unpacking just yet
move deserialize_config_args to config module
delete custom Action class for config operations
apply [k,v] -> {k, v} for each override
update test data
update import
* rename deserialize_config_args to better express intent
make format
79 lines
2.2 KiB
Python
79 lines
2.2 KiB
Python
import pytest
|
|
|
|
from jrnl.override import (
|
|
apply_overrides,
|
|
_recursively_apply,
|
|
_get_config_node,
|
|
_get_key_and_value_from_pair,
|
|
_convert_dots_to_list,
|
|
)
|
|
|
|
|
|
@pytest.fixture()
|
|
def minimal_config():
|
|
cfg = {
|
|
"colors": {"body": "red", "date": "green"},
|
|
"default": "/tmp/journal.jrnl",
|
|
"editor": "vim",
|
|
"journals": {"default": "/tmp/journals/journal.jrnl"},
|
|
}
|
|
return cfg
|
|
|
|
|
|
def test_apply_override(minimal_config):
|
|
overrides = [["editor", "nano"]]
|
|
apply_overrides(overrides, minimal_config)
|
|
assert minimal_config["editor"] == "nano"
|
|
|
|
|
|
def test_override_dot_notation(minimal_config):
|
|
overrides = [["colors.body", "blue"]]
|
|
|
|
cfg = apply_overrides(overrides=overrides, base_config=minimal_config)
|
|
assert cfg["colors"] == {"body": "blue", "date": "green"}
|
|
|
|
|
|
def test_multiple_overrides(minimal_config):
|
|
overrides = [
|
|
["colors.title", "magenta"],
|
|
["editor", "nano"],
|
|
["journals.burner", "/tmp/journals/burner.jrnl"],
|
|
] # as returned by parse_args, saved in parser.config_override
|
|
|
|
cfg = apply_overrides(overrides, minimal_config)
|
|
assert cfg["editor"] == "nano"
|
|
assert cfg["colors"]["title"] == "magenta"
|
|
assert "burner" in cfg["journals"]
|
|
assert cfg["journals"]["burner"] == "/tmp/journals/burner.jrnl"
|
|
|
|
|
|
def test_recursively_apply():
|
|
cfg = {"colors": {"body": "red", "title": "green"}}
|
|
cfg = _recursively_apply(cfg, ["colors", "body"], "blue")
|
|
assert cfg["colors"]["body"] == "blue"
|
|
|
|
|
|
def test_get_config_node(minimal_config):
|
|
assert len(minimal_config.keys()) == 4
|
|
assert _get_config_node(minimal_config, "editor") == "vim"
|
|
assert _get_config_node(minimal_config, "display_format") == None
|
|
|
|
|
|
def test_get_kv_from_pair():
|
|
pair = {"ab.cde": "fgh"}
|
|
k, v = _get_key_and_value_from_pair(pair)
|
|
assert k == "ab.cde"
|
|
assert v == "fgh"
|
|
|
|
|
|
class TestDotNotationToList:
|
|
def test_unpack_dots_to_list(self):
|
|
|
|
keys = "a.b.c.d.e.f"
|
|
keys_list = _convert_dots_to_list(keys)
|
|
assert len(keys_list) == 6
|
|
|
|
def test_sequential_delimiters(self):
|
|
k = "g.r..h.v"
|
|
k_l = _convert_dots_to_list(k)
|
|
assert len(k_l) == 4
|