mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
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
98 lines
4.3 KiB
Gherkin
98 lines
4.3 KiB
Gherkin
Feature: Implementing Runtime Overrides for Select Configuration Keys
|
|
|
|
Scenario: Override configured editor with built-in input === editor:''
|
|
Given we use the config "basic_encrypted.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl --config-override editor ''"
|
|
Then the stdin prompt should have been called
|
|
|
|
Scenario: Postconfig commands with overrides
|
|
Given We use the config "basic_encrypted.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl --decrypt --config-override highlight false --config-override editor nano"
|
|
Then the config should have "highlight" set to "bool:false"
|
|
And no editor should have been called
|
|
|
|
Scenario: Override configured linewrap with a value of 23
|
|
Given we use the config "simple.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl -2 --config-override linewrap 23 --format fancy"
|
|
Then the output should be
|
|
|
|
"""
|
|
┎─────╮2013-06-09 15:39
|
|
┃ My ╘═══════════════╕
|
|
┃ fir st ent ry. │
|
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
|
┃ Everything is │
|
|
┃ alright │
|
|
┖─────────────────────┘
|
|
┎─────╮2013-06-10 15:40
|
|
┃ Lif ╘═══════════════╕
|
|
┃ e is goo d. │
|
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
|
┃ But I'm better. │
|
|
┖─────────────────────┘
|
|
"""
|
|
|
|
Scenario: Override color selections with runtime overrides
|
|
Given we use the config "basic_encrypted.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl -1 --config-override colors.body blue"
|
|
Then the config should have "colors.body" set to "blue"
|
|
|
|
Scenario: Apply multiple config overrides
|
|
Given we use the config "basic_encrypted.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl -1 --config-override colors.body green --config-override editor 'nano'"
|
|
Then the config should have "colors.body" set to "green"
|
|
And the config should have "editor" set to "nano"
|
|
|
|
|
|
Scenario Outline: Override configured editor
|
|
Given we use the config "basic_encrypted.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl --config-override editor '<editor>'"
|
|
Then the editor <editor> should have been called
|
|
Examples: Editor Commands
|
|
| editor |
|
|
| nano |
|
|
| vi -c startinsert |
|
|
| code -w |
|
|
|
|
Scenario: Override default journal
|
|
Given we use the config "basic_dayone.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl --debug --config-override journals.default features/journals/simple.journal 20 Mar 2000: The rain in Spain comes from clouds"
|
|
Then we should get no error
|
|
And we should see the message "Entry added"
|
|
When we run "jrnl -3 --debug --config-override journals.default features/journals/simple.journal"
|
|
Then the output should be
|
|
"""
|
|
2000-03-20 09:00 The rain in Spain comes from clouds
|
|
|
|
2013-06-09 15:39 My first entry.
|
|
| Everything is alright
|
|
|
|
2013-06-10 15:40 Life is good.
|
|
| But I'm better.
|
|
"""
|
|
|
|
|
|
Scenario: Make an entry into an overridden journal
|
|
Given we use the config "basic_dayone.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl --config-override journals.temp features/journals/simple.journal temp Sep 06 1969: @say Ni"
|
|
Then we should get no error
|
|
And we should see the message "Entry added"
|
|
When we run "jrnl --config-override journals.temp features/journals/simple.journal temp -3"
|
|
Then the output should be
|
|
"""
|
|
1969-09-06 09:00 @say Ni
|
|
|
|
2013-06-09 15:39 My first entry.
|
|
| Everything is alright
|
|
|
|
2013-06-10 15:40 Life is good.
|
|
| But I'm better.
|
|
"""
|