add cli options for config file management

[ltalirz]

fixes #30
fixes #8
fixes #13

Add cli option:

--testing-config-action: Read config file if present ('read'), require config file ('require') or generate new config file ('generate').
--regenerate-test-data: Regenerate test data

A few things left to do:

• add docs
• use type hints more?

[ltalirz]

Just to point out that some strange stuff was going on with github actions (see e.g. the ci results of "add test for regeneration of test data").

Also, on my computer, the 4 tests that involve running the CalcJob fail with error messages

$ cd tests; pytest

...

    def check_diff_output(result):
        """
        Checks the result from a diff calculation against a reference.
        """
        diff_res_lines = tuple([
            line.strip() for line in result['diff'].get_content().splitlines() if line.strip()
        ])
>       assert diff_res_lines == (
            "1,2c1", "< Lorem ipsum dolor..", "<", "---",
            "> Please report to the ministry of silly walks."
        )
E       AssertionError: assert () == ('1,2c1', '< ...silly walks.')
E         Right contains 5 more items, first extra item: '1,2c1'
E         Use -v to get the full diff

(i.e. check_diff is empty for those). Haven't figured out why yet.

[ltalirz]

This seems to have been fixed by requiring the data directory to be an absolute path.

[greschd]

Very nice, thanks! I've added a few minor comments.

For regenerating the data, I think the "export cache" feature will need a similar flag, but they should probably be independent: Maybe we should rename --regenerate-test-data to something like --regenerate-mock-code-data, to distinguish them?

[greschd]

Are config, config_action and regenerate_test_data here passed just for being able to test the fixture internally, or do we expect users to set them?

I'm not really sure if there's an established convention for that, but maybe we could indicate this by a leading underscore in the kwarg names (_config, _config_action, _regenerate_test_data)?

[ltalirz]

done!

[greschd]

The generate_config parameter doesn't exist, and regenerate_test_data is missing in the docstring.

[ltalirz]

thanks, fixed!

[greschd]

Thanks! Do you want to create a new issue for the "add docs" part?

[ltalirz]

happy to add them in here, now that we've agreed on the names

[greschd]

fixes #30
fixes #8
fixes #13

Drei auf einen Streich! Nice 😄