Add --include_path option to include external folders in Docker build context

[mikaelsimard5]

Currently mlops run() builds a docker image from the local context i.e. assumes the docker file is located at ./Dockerfile and the image will be created from ./.

In some projects, there may be some shared utility folders outside of the context of mlops run() which may need to be included in the docker image. Rather than copy-pasting the necessary folders into the local context, you could now use mlops run() with the -i option to include a folder.

This PR also corrects some of the GitHub actions tests that have been failing for the past year or so on any PR made - see specific comments in the Files changed tab for more.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
mlops
Experiment.py	171	40	77%	48–53, 77, 82–83, 104, 106, 111, 167–178, 201–215, 234, 236–237, 285–286, 290–294, 298–299, 306–307
ProjectFile.py	23	1	96%	41
cli.py	55	17	69%	19–22, 36, 59–66, 86–88, 96–99, 107–108, 113
mlops/release
Release.py	33	7	79%	24, 28, 33–38
mlops/release/destinations
ReleaseDestination.py	9	1	89%	18
SharepointDestination.py	6	2	67%	12–13
ZenodoDestination.py	33	19	42%	21–25, 29–35, 43–60
mlops/release/sources
MLFlowSource.py	13	6	54%	13–14, 21–27
ReleaseSource.py	14	2	86%	14, 23
mlops/utils
Config.py	17	17	0%	1–24
TOTAL	411	112	73%

Tests	Skipped	Failures	Errors	Time
17	0 💤	0 ❌	0 🔥	2m 55s ⏱️

[mikewoodward94]

I apologise that this feature addition also became a bug fix, but thank you for finding the cause of the problems and also fixing those!

Great work here, just a small function to be added for safety/ease of debugging at the time of use.

[mikewoodward94]

I think this could result in accidental folder deletions, say someone accidentally set the include_path as "config" it would then delete the config folder (and do so silently).

Could we have a check_include_path() function that's called at init if the variable is passed? Think it just needs to do the following two things, and then can raise easy to action useful errors!

1. Makes sure the path exists to include:

if not os.path.exists(include_path):
    raise FileNotFoundError(f"Source folder does not exist: {include_path}")

2. Makes sure the destination folder doesn't already exist:

if os.path.exists(included_folder_dest):
    raise FileExistsError(f"Destination folder already exists: {included_folder_dest}. Please remove it first or rename your source folder.")

Feel free to add to this for anything else you think of thats worth checking.

[mikaelsimard5]

Good catch!

I think in general it makes more sense to perform this action while initiating the experiment (similarly to the check_dirty, env_setup, ... methods), so I moved the action from run() to init, and added the suggested checks - see c42301c (main changes), and 48bd4db and bccf904 (two small bug fixes to the logic implemented in c42301c).

[mikewoodward94]

LGTM!