Test/add xfel calibrate cli tests

Description

This MR adds in some basic tests for the CLI in xfel_calibrate. Done since I want to edit the CLI a bit for SQS Moonshot but the CLI is kinda spaghetti so I'm worried about breaking things and not realising it.

How Has This Been Tested?

Locally, tested by breaking code and checking that the tests fail.

Relevant Documents (optional)

Part of SQS Moonshot, see:

• https://git.xfel.eu/gitlab/moonshot/sqs/issues/13
• https://git.xfel.eu/gitlab/moonshot/sqs/issues/19

Types of changes

• Test (additional or refactored tests)

Checklist:

• My code follows the code style of this project.

Reviewers

@calibration

added In Progress label

changed milestone to %SQS Moonshot

added 1 commit

• ffaa9e08 - Add `pytest-subprocess` dependency

Compare with previous version

added 1 commit

• 8738d444 - Mock the version

Compare with previous version

added 2 commits

• 08acf3df - Add note from Cyril
• 348fe9a8 - MORE TESTS!

Compare with previous version

added 1 commit

• 39711987 - Minor whitespace changes

Compare with previous version

added 8 commits

• db082c7e - Adjust formatting
• 044a38fd - Add intellilist test
• d8b82712 - Move tests to module directory
• 03ec6b30 - Update gitignore
• f0fa8ce5 - Add required plugins for pytest
• 3a28e3ce - Remove tests init file
• cecdbe8f - Skip if GPFS is not available
• 6d0d6a66 - Rename to cli

Compare with previous version

added 6 commits

• bd00649b - Add todo note for using `feature_version` kwarg
• 96acc382 - Add todo
• 04246249 - Add test docstring
• eaff032c - Expand tests to cover multiple additional help
• 6bdd86c2 - Attempt to add in tests for other notebooks
• b7492f4a - Refactor tests

Compare with previous version

mentioned in commit bd00649b

added 1 commit

• c00510ff - Add sequences to agipd nb test

Compare with previous version

@kluyvert I've massacred this and turned it from a relatively simple use of pytest to something a fair bit more complex, tests/test_xfel_calibrate/conftest.py now contains some fixtures to make it (I think) easier and way more flexible to set up tests calling xfel-calibrate in different ways.

The actual implementation of the tests themselves hasn't changed, it's just nicer to set them up, e.g.:

class TestTutorialNotebook:
    @pytest.fixture(scope="function")
    def mock_proposal(self, tmp_path):
        return MockProposal(tmp_path, runs=4)

    @pytest.fixture(scope="function")
    def calibrate_call(self, mock_proposal: MockProposal, capsys, tmp_path):
        return CalibrateCall(
            tmp_path,
            capsys,
            out_folder=mock_proposal.path_proc,
            detector="Tutorial",
            cal_type="TEST",
            extra_args=["--runs", "1000"],
        )

And

class TestIntelliList:
    @pytest.fixture(scope="function")
    def mock_proposal(self, tmp_path):
        return MockProposal(tmp_path, runs=4)

    @pytest.fixture(scope="function")
    def calibrate_call(self, mock_proposal: MockProposal, capsys, tmp_path):
        return CalibrateCall(
            tmp_path,
            capsys,
            out_folder=mock_proposal.path_proc,
            detector="Tutorial",
            cal_type="TEST",
            extra_args=["--random-seed", "1,2,3-10"],
        )

And

class TestAgipdNotebook:
    @pytest.fixture(scope="function")
    def mock_proposal(self, tmp_path):
        return MockProposal(tmp_path, runs=4)

    @pytest.fixture(scope="function")
    def calibrate_call(self, mock_proposal: MockProposal, capsys, tmp_path):
        return CalibrateCall(
            tmp_path,
            capsys,
            in_folder=mock_proposal.path_raw,
            out_folder=mock_proposal.path_proc,
            detector="AGIPD",
            cal_type="CORRECT",
            extra_args=["--run", "0", "--sequences", "1-3"],
        )

With the way I did it before this kinda thing was a bit of a pain but now it's a tad smoother... I think/hope

You free to have another look some time?

added 2 commits

• bf32aa65 - Improve docstrings
• e2cdb287 - Potential fix for unicode encode error

Compare with previous version

added 2 commits

• ba6f3c77 - Add todo for later
• 3a849607 - Commit using WB mode

Compare with previous version

added 2 commits

• ba6f3c77 - Add todo for later
• 3a849607 - Commit using WB mode

Compare with previous version

mentioned in commit 73e9b0cb

mentioned in commit 83a2792c