mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-18 12:08:31 +02:00
1a7e8d8ea2
* behavior outline
* FIrst pass at allow external plugins
* remove template exporter
* Add listing of active plugins to '--version' output
* Documentation for plugins
* [Docs] add custom imports and exporters to site TOC
* [Docs] better linewrapping
* enforce positive initial linewrap
Check column widths
update gitignore
throw error when linewrap too small
simply check for large enough linewrap value
* delete unused error message
* PR feedback
make exception more informative
update check_linewrap signature in src and test
make check_linewrap a free function
* delete unused function
* delete else..pass block
* newline for make format
* Include dates_exporter
* Use Base classes for importer and exporters.
* [Docs] improve documentation of custom Importers and Exporters
* [Testing] separate run with external plugin!
* basic behavior test
* prototype unittest for JSON Exporter
test for unimplemented method
* make format
delete unused imports
* Remove 'importer' or 'exporter' from filenames where not needed
* [Test] run different tests with or without the external plugins installed
* [Test] move test rot13 plugin into git tree
from 0dc912af82
* consolidate demo plugins to common package
* [Docs] name page for plugins
* [Docs] include the sample plug in code files directly
* style fixes
* [test] determine whether to run external plug in tests based on installed packages
* improved code documentation
* style fixes for GitHub actions
* Convert "short" and "pretty" (and "default") formaters to plugins
further to https://github.com/jrnl-org/jrnl/pull/1177
* more code clean up
tests pass locally...now for GitHub...
* [tests] dynamically determine jrnl version for plugin tests
* [GitHub Actions] direct install of testing plugins
* Remove template code
* [plugins] meta --> collector
* [Docs] create scripted entries using an custom importer
* (closer to) being able to run behave tests outside project root directory
* We already know when exporter to use
Don't re-calculate it!
* [Tests] don't name test plugin 'testing"
If so named, pip won't install it.
* [Test] run behave tests with test plugins outside project root
* [Test] behave tests pass locally
* [Docs] fix typo
* [GitHub Actions] run test commands from poetry's shell
* black-ify code
* [GitHub Actions] move downstream (rather than up) to run tests
* [GitHub Actions] set shell to poetry
* [GitHub Workflows] Manually activate virtual environment
* [GitHub Actions] Skip Windows & Python 3.8
Can't seem to find Python exe?
* [GiotHub Actions] explicitly use virtual env
* [GitHub Actions] create virutal env directly
* [GitHub Actions] better activate of Windows virtual env
* [GitHub Actions] create virtual env on Mac
* [Github Actions] install wheel and upgrade pip
* [GitHub Actions] skip virtual environments altogether
* [GitHub Actions] change directory for behave test
* Remove Windows exclusions from CI as per note -- they should be working now
Co-authored-by: Suhas <sugas182@gmail.com>
Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
86 lines
5.2 KiB
Gherkin
86 lines
5.2 KiB
Gherkin
Feature: Functionality of Importer and Exporter Plugins
|
|
|
|
@skip_no_external_plugins
|
|
Scenario Outline: List buildin plugin names in --version
|
|
Given We use the config "basic_onefile.yaml"
|
|
When We run "jrnl --version"
|
|
Then the output should contain pyproject.toml version
|
|
And The output should contain "<plugin_name> : <version> from jrnl.<source>.<type>.<filename>"
|
|
And the output should not contain ".contrib."
|
|
|
|
Examples:
|
|
| plugin_name | version | source | type | filename |
|
|
| jrnl | <pyproject.toml version> | plugins | importer | jrnl |
|
|
| boxed | <pyproject.toml version> | plugins | exporter | fancy |
|
|
| dates | <pyproject.toml version> | plugins | exporter | dates |
|
|
| default | <pyproject.toml version> | plugins | exporter | pretty |
|
|
| fancy | <pyproject.toml version> | plugins | exporter | fancy |
|
|
| json | <pyproject.toml version> | plugins | exporter | json |
|
|
| markdown | <pyproject.toml version> | plugins | exporter | markdown |
|
|
| md | <pyproject.toml version> | plugins | exporter | markdown |
|
|
| pretty | <pyproject.toml version> | plugins | exporter | pretty |
|
|
| short | <pyproject.toml version> | plugins | exporter | short |
|
|
| tags | <pyproject.toml version> | plugins | exporter | tag |
|
|
| text | <pyproject.toml version> | plugins | exporter | text |
|
|
| txt | <pyproject.toml version> | plugins | exporter | text |
|
|
| xml | <pyproject.toml version> | plugins | exporter | xml |
|
|
| yaml | <pyproject.toml version> | plugins | exporter | yaml |
|
|
|
|
@skip_only_with_external_plugins
|
|
Scenario Outline: List external plugin names in --version
|
|
Given We use the config "basic_onefile.yaml"
|
|
When We run "jrnl --version"
|
|
Then the output should contain pyproject.toml version
|
|
And The output should contain "<plugin_name> : <version> from jrnl.<source>.<type>.<filename>"
|
|
Examples:
|
|
| plugin_name | version | source | type | filename |
|
|
| jrnl | <pyproject.toml version> | plugins | importer | jrnl |
|
|
| json | v1.0.0 | contrib | importer | simple_json |
|
|
| boxed | <pyproject.toml version> | plugins | exporter | fancy |
|
|
| dates | <pyproject.toml version> | plugins | exporter | dates |
|
|
| default | <pyproject.toml version> | plugins | exporter | pretty |
|
|
| fancy | <pyproject.toml version> | plugins | exporter | fancy |
|
|
| json | v1.0.0 | contrib | exporter | custom_json |
|
|
| markdown | <pyproject.toml version> | plugins | exporter | markdown |
|
|
| md | <pyproject.toml version> | plugins | exporter | markdown |
|
|
| pretty | <pyproject.toml version> | plugins | exporter | pretty |
|
|
| rot13 | v1.0.0 | contrib | exporter | rot13 |
|
|
| short | <pyproject.toml version> | plugins | exporter | short |
|
|
| tags | <pyproject.toml version> | plugins | exporter | tag |
|
|
| testing | v0.0.1 | contrib | exporter | flag |
|
|
| text | <pyproject.toml version> | plugins | exporter | text |
|
|
| txt | v1.0.0 | contrib | exporter | rot13 |
|
|
| xml | <pyproject.toml version> | plugins | exporter | xml |
|
|
| yaml | <pyproject.toml version> | plugins | exporter | yaml |
|
|
|
|
@skip_only_with_external_plugins
|
|
Scenario Outline: Do not list overridden plugin names in --version
|
|
Given We use the config "basic_onefile.yaml"
|
|
When We run "jrnl --version"
|
|
Then the output should contain pyproject.toml version
|
|
And the output should not contain "<plugin_name> : <version> from jrnl.<source>.<type>.<filename>"
|
|
|
|
Examples:
|
|
| plugin_name | version | source | type | filename |
|
|
| json | <pyproject.toml version> | plugins | exporter | json |
|
|
| txt | <pyproject.toml version> | plugins | exporter | text |
|
|
|
|
|
|
@skip_only_with_external_plugins
|
|
Scenario Outline: JSON format
|
|
Given we use the config "<config>.yaml"
|
|
And we use the password "test" if prompted
|
|
When we run "jrnl --format json"
|
|
Then we should get no error
|
|
And the output should be parsable as json
|
|
And "entries" in the json output should have 3 elements
|
|
And entry 1 should not have an array "tags"
|
|
And entry 2 should not have an array "tags"
|
|
And entry 3 should not have an array "tags"
|
|
|
|
Examples: configs
|
|
| config |
|
|
| basic_onefile |
|
|
| basic_encrypted |
|
|
| basic_folder |
|
|
| basic_dayone |
|