runem 0.0.31__tar.gz → 0.1.0__tar.gz

{runem-0.0.31 → runem-0.1.0}/HISTORY.md

@@ -4,6 +4,194 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #57 from lursight/feat/replace_halo_with_rich.
+  [Frank Harrison]
+
+  feat(rich): moves to using rich instead of halo for spinners
+- Feat(rich): moves to using rich instead of halo for spinners. [Frank
+  Harrison]
+- Merge pull request #56 from lursight/feat/better_job_function_typing.
+  [Frank Harrison]
+
+  feat(better-job-function-typing): adds stronger typing for job and hook tasks
+- Feat(better-job-function-typing): adds stronger typing for job and
+  hook tasks. [Frank Harrison]
+
+  We do this by typing the kwargs convenience variable, for which we need
+  to use `Unpack` (for back compatibility), and `type_extensions` for
+  cross-python-version compatibility (i.e. something that work for all
+  targeted version of python).
+
+  As a side-effect of this we get the benefit of seeing when and where we
+  add extra data into the call-stack for `job_execute()` and it emerges
+  that we only extend the key-word args when we are calling hooks in a
+  non-threaded way, which makes sense.
+
+  We do several things to achieve this:
+    1. We have common parameters passed to both hooks and job-tasks
+        - These common parameters make the hooks and job-task feel similar
+          to develop.
+    2. We put all hook-specific kwargs in one place, and mark each as
+       optional.
+        - this, for now, is mainly because we only have one hook, so this
+          will likely change.
+    3. We share and combine kwargs in a range of inheritance types, mainly
+       to work with(/around?) python-typing, which isn't great in this
+       type of situation.
+- Chore(ignores): adds the tox/ dir to the ignores. [Frank Harrison]
+- Chore(ignores): update git ignore for coverage files and docs gen.
+  [Frank Harrison]
+
+  The docs are recent additions.
+- Merge pull request #55 from lursight/chore/test_improvements. [Frank
+  Harrison]
+
+  Chore/test improvements
+- Chore(coverage): reduce false-positives by deleteing old
+  coverage_report files. [Frank Harrison]
+
+  Sometimes we would have stale .coverage_report.* files left behind where
+  from the multi-distributed pytest runs. These would lead more lines
+  being reported as coverage than actual - aka false-positive test passes
+  for coverage.
+- Chore(help-tests): fixes the help output width in tests. [Frank
+  Harrison]
+
+  This reduces false-negative test results where we get word-splits in
+  directories or between process counters or other dynamic content.
+
+  This was due to the width of the terminal when the test was being run
+  being variant with developer-machine. This uses a fixed-width output,
+  reducing, if not stopping issues.
+- Chore(deps): updates black 24.3.0 -> 24.10.0. [Frank Harrison]
+- Chore(deps): updates to latest pytest 8.1.1 -> 8.3.3 + plugins. [Frank
+  Harrison]
+
+
+0.0.32 (2024-11-17)
+-------------------
+- Release: version 0.0.32 🚀 [Frank Harrison]
+- Merge pull request #54 from lursight/chore/use_tox_on_release. [Frank
+  Harrison]
+
+  chore(release): use tox on 'make release'
+- Chore(release): use tox on 'make release' [Frank Harrison]
+
+  This will run the checks across all versions, hopefully making
+  everything more solid.
+- Merge pull request #53 from lursight/dependabot/npm_and_yarn/cross-
+  spawn-7.0.5. [Frank Harrison]
+
+  chore(deps): bump cross-spawn from 7.0.3 to 7.0.5
+- Chore(deps): bump cross-spawn from 7.0.3 to 7.0.5. [dependabot[bot]]
+
+  Bumps [cross-spawn](https://github.com/moxystudio/node-cross-spawn) from 7.0.3 to 7.0.5.
+  - [Changelog](https://github.com/moxystudio/node-cross-spawn/blob/master/CHANGELOG.md)
+  - [Commits](https://github.com/moxystudio/node-cross-spawn/compare/v7.0.3...v7.0.5)
+
+  ---
+  updated-dependencies:
+  - dependency-name: cross-spawn
+    dependency-type: indirect
+  ...
+- Merge pull request #49 from
+  lursight/feat/allow_additional_files_to_be_checked. [Frank Harrison]
+
+  Feat/allow additional files to be checked
+- Feat(file-controls): adds way to get files changed between branches.
+  [Frank Harrison]
+
+  This is useful if we want to do quick checks only on code that has
+  changed since 'main' when pushing, or on a sibling branch or similar.
+
+  For example, if we are using `--exec` in a rebase, we can start running
+  check half-way through the list of commits, instead of every commit, but
+  have the code check all files that have changes - meaning we can see the
+  impact of changes throughout the branch, without working on *every*
+  commit - sometimes this is very useful.
+- Feat(file-controls): adds --always-files switch to force files to be
+  checked. [Frank Harrison]
+
+  Because of how we apply filters, filters for the files are applied
+  before they're passed to the relevant jobs.
+
+  This means that runem can now always check a subset of files, even if
+  they're not in the HEAD or staged files, meaning we can verify if some
+  files that we care about for a rebase or similar are copecetic.
+- Merge pull request #52 from lursight/chore/pre-push_checks. [Frank
+  Harrison]
+
+  Chore/pre push checks
+- Chore(tox): adds tox to run against multiple version of python on pre-
+  push. [Frank Harrison]
+- Chore(pre-push-checks): adds a clean-checkout pre-push git hook.
+  [Frank Harrison]
+- Chore(pre-push-checks): renames setup.py extras test -> tests. [Frank
+  Harrison]
+- Chore(pre-push-checks): adds option to get the root-path from the cli.
+  [Frank Harrison]
+
+  This will support pre-push hooks amongst other things, replacing
+  ENV-variable that other projects I work on use.
+- Chore(help-tests): fixes the tests when dirs are long. [Frank
+  Harrison]
+
+  If the dir-path was too long it would wrap and we could do a simple replace on it.
+- Chore(help-tests): shows the failing output when the help comparrisons
+  fail. [Frank Harrison]
+- Chore(help-tests): stops the help files being overwritten
+  unexpectedly. [Frank Harrison]
+- Chore(typo): fixes argsparse -> argparse. [Frank Harrison]
+- Chore(tox): runs checks against multiple targets of python using tox.
+  [Frank Harrison]
+- Chore(yarn): unconditionally installs yarn deps, at least once, in
+  clean checkouts. [Frank Harrison]
+
+  Reminder that we use yarn because it's simpler and better for
+  spell-checking and git-hooks, mainly because the hooks get
+  auto-installed when the yarn deps are installed.
+- Chore(pretty): updates docs config file missed formatting after
+  pervious PR. [Frank Harrison]
+- Merge pull request #51 from lursight/chore/docs. [Frank Harrison]
+
+  Chore/docs
+- Chore(better-docs): make links in README.md absolute to docs. [Frank
+  Harrison]
+- Chore(better-docs): change label in docs badge to emoticon. [Frank
+  Harrison]
+- Chore(better-docs): adds docs badge and moves others to top. [Frank
+  Harrison]
+- Chore(better-docs): rewrites and restructures the docs. [Frank
+  Harrison]
+
+  We split README into multiple mark-down files in docs/ allowing github
+  pages to publish them via Jekyll.
+- Chore(better-docs): configures Jekyll theme ahead of publish docs as
+  pages. [Frank Harrison]
+
+  We configure the docs in the root-dir so that the index of the Docs site
+  is the same-same as the README.md at the root of the checkout.
+- Merge pull request #50 from
+  lursight/dependabot/npm_and_yarn/micromatch-4.0.8. [Frank Harrison]
+
+  chore(deps): bump micromatch from 4.0.5 to 4.0.8
+- Chore(deps): bump micromatch from 4.0.5 to 4.0.8. [dependabot[bot]]
+
+  Bumps [micromatch](https://github.com/micromatch/micromatch) from 4.0.5 to 4.0.8.
+  - [Release notes](https://github.com/micromatch/micromatch/releases)
+  - [Changelog](https://github.com/micromatch/micromatch/blob/master/CHANGELOG.md)
+  - [Commits](https://github.com/micromatch/micromatch/compare/4.0.5...4.0.8)
+
+  ---
+  updated-dependencies:
+  - dependency-name: micromatch
+    dependency-type: indirect
+  ...
+
+
+0.0.31 (2024-04-20)
+-------------------
+- Release: version 0.0.31 🚀 [Frank Harrison]
 - Merge pull request #48 from
   lursight/feat/merge_head_and_modified_files_in_git. [Frank Harrison]
 

{runem-0.0.31 → runem-0.1.0}/MANIFEST.in

@@ -1,3 +1,5 @@
+include requirements.txt
+include requirements-test.txt
 include LICENSE
 include HISTORY.md
 include Containerfile

runem-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: runem
+Version: 0.1.0
+Summary: Awesome runem created by lursight
+Home-page: https://github.com/lursight/runem/
+Author: lursight
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging
+Requires-Dist: PyYAML
+Requires-Dist: rich
+Requires-Dist: typing_extensions
+Provides-Extra: tests
+Requires-Dist: black==24.10.0; extra == "tests"
+Requires-Dist: coverage==7.5; extra == "tests"
+Requires-Dist: docformatter==1.7.5; extra == "tests"
+Requires-Dist: flake8-bugbear==24.2.6; extra == "tests"
+Requires-Dist: flake8==7.0.0; extra == "tests"
+Requires-Dist: gitchangelog==3.0.4; extra == "tests"
+Requires-Dist: isort==5.13.2; extra == "tests"
+Requires-Dist: mkdocs==1.5.3; extra == "tests"
+Requires-Dist: mypy==1.9.0; extra == "tests"
+Requires-Dist: pydocstyle==6.3.0; extra == "tests"
+Requires-Dist: pylint==3.1.0; extra == "tests"
+Requires-Dist: pylama==8.4.1; extra == "tests"
+Requires-Dist: pytest-cov==6.0.0; extra == "tests"
+Requires-Dist: pytest-profiling==1.7.0; extra == "tests"
+Requires-Dist: pytest-xdist==3.6.1; extra == "tests"
+Requires-Dist: pytest==8.3.3; extra == "tests"
+Requires-Dist: setuptools; extra == "tests"
+Requires-Dist: termplotlib==0.3.9; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: types-PyYAML==6.0.12.20240311; extra == "tests"
+Requires-Dist: requests-mock==1.11.0; extra == "tests"
+Requires-Dist: types-setuptools; extra == "tests"
+
+<!-- [![codecov](https://codecov.io/gh/lursight/runem/branch/main/graph/badge.svg?token=run-test_token_here)](https://codecov.io/gh/lursight/runem) -->
+[![CI](https://github.com/lursight/runem/actions/workflows/main.yml/badge.svg)](https://github.com/lursight/runem/actions/workflows/main.yml)
+[![DOCS](https://lursight.github.io/runem/docs/VIEW-DOCS-31c553.svg)](https://lursight.github.io/runem/)
+
+# Run'em: Accelerate Your Development Workflow
+**Boost Efficiency and Save Time**
+Runem is a flexible, multi-process tool designed to speed up your everyday tasks by running them in parallel. Whether you're testing, linting, or deploying, runem helps you work smarter and faster.
+
+## Why Choose Run'em?
+- **Streamlined Task Management**: Configure tasks with ease using declarative .runem.yml files.
+- **Multiprocess Execution**: Run multiple tasks simultaneously, minimizing wall-clock time.
+- **Optimized for Monorepos**: Supports multiple projects and task types, with easy filtering and configuration.
+- **Detailed Reporting**: Get insights into task execution time and efficiency gains.
+
+## Contents
+- [Run'em: Accelerate Your Development Workflow](#runem-accelerate-your-development-workflow)
+  - [Why Choose Run'em?](#why-choose-runem)
+  - [Contents](#contents)
+- [Features At A Glance:](#features-at-a-glance)
+- [Using Run'em](#using-runem)
+  - [Installation](#installation)
+  - [Quick-start](#quick-start)
+  - [Basic quick-start](#basic-quick-start)
+    - [A more complete quick-start](#a-more-complete-quick-start)
+  - [Basic Use](#basic-use)
+  - [Advanced Use](#advanced-use)
+    - [Advanced configuration options](#advanced-configuration-options)
+    - [Custom reports](#custom-reports)
+- [Help and job discovery](#help-and-job-discovery)
+- [Troubleshooting](#troubleshooting)
+- [Contributing to and supporting runem](#contributing-to-and-supporting-runem)
+  - [Development](#development)
+  - [Sponsor](#sponsor)
+- [About runem](#about-runem)
+
+
+# Features At A Glance:
+- **Tagging**: Easily run specific job groups (e.g., lint, test, python).
+- **Phases**: Organize tasks by phase (e.g., edit, test, deploy).
+- **Configurable Options**: Customize how jobs are executed using simple options.
+- **Declarative**: Jobs are define using simple YAML in [.runem.yml](https://lursight.github.io/runem/docs/configuration.html) .
+
+# Using Run'em
+
+## Installation
+
+```bash
+pip install runem
+```
+
+## Quick-start
+
+## Basic quick-start
+Create the following `.runem.yml` file at the root of your project:
+
+```yml
+- job:
+    command: echo "hello world!"
+```
+
+Then anywhere in your project run `runem` to see how and when that task is run, and how long it took:
+```bash
+runem
+```
+
+To see the actual log output you will need to use `--verbose` as `runem` hides anything that isn't important. Only failures and reports are considered important.
+```bash
+# Or, to see "hello world!", use --verbose
+runem --verbose  # add --verbose to see the actual output
+```
+
+To see how you can control your job use `--help`:
+```bash
+runem --help
+```
+
+### A more complete quick-start
+
+See [quick-start docs](https://lursight.github.io/runem/docs/quick_start.html) for more quick-start tips.
+
+## Basic Use
+
+See [docs on basic use and use-cases](https://lursight.github.io/runem/docs/basic_use.html) for a comprehensive introduction.
+
+## Advanced Use
+
+### Advanced configuration options
+See [configuration docs](https://lursight.github.io/runem/docs/configuration.html) for advanced configuration and use.
+
+### Custom reports
+See [reporting docs](https://lursight.github.io/runem/docs/reports.html) for more information on how reporting works.
+
+
+# Help and job discovery
+
+`--help` is designed to help your team discover what jobs and tasks they can automated. Read more at 
+[help and discovery docs](https://lursight.github.io/runem/docs/help_and_job_discovery.html).
+
+# Troubleshooting
+
+See [troubleshooting and known issues docs](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html).
+
+---
+# Contributing to and supporting runem
+
+Awesome runem created by lursight
+
+## Development
+
+Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Sponsor
+
+[❤️ Sponsor this project](https://github.com/sponsors/lursight/)
+
+# About runem
+The runem mission is to improve developer velocity at
+[Lursight Ltd.](https://lursight.com), read more about the runem
+[mission](https://lursight.github.io/runem/docs/mission.html).

runem-0.1.0/README.md

@@ -0,0 +1,120 @@
+<!-- [![codecov](https://codecov.io/gh/lursight/runem/branch/main/graph/badge.svg?token=run-test_token_here)](https://codecov.io/gh/lursight/runem) -->
+[![CI](https://github.com/lursight/runem/actions/workflows/main.yml/badge.svg)](https://github.com/lursight/runem/actions/workflows/main.yml)
+[![DOCS](https://lursight.github.io/runem/docs/VIEW-DOCS-31c553.svg)](https://lursight.github.io/runem/)
+
+# Run'em: Accelerate Your Development Workflow
+**Boost Efficiency and Save Time**
+Runem is a flexible, multi-process tool designed to speed up your everyday tasks by running them in parallel. Whether you're testing, linting, or deploying, runem helps you work smarter and faster.
+
+## Why Choose Run'em?
+- **Streamlined Task Management**: Configure tasks with ease using declarative .runem.yml files.
+- **Multiprocess Execution**: Run multiple tasks simultaneously, minimizing wall-clock time.
+- **Optimized for Monorepos**: Supports multiple projects and task types, with easy filtering and configuration.
+- **Detailed Reporting**: Get insights into task execution time and efficiency gains.
+
+## Contents
+- [Run'em: Accelerate Your Development Workflow](#runem-accelerate-your-development-workflow)
+  - [Why Choose Run'em?](#why-choose-runem)
+  - [Contents](#contents)
+- [Features At A Glance:](#features-at-a-glance)
+- [Using Run'em](#using-runem)
+  - [Installation](#installation)
+  - [Quick-start](#quick-start)
+  - [Basic quick-start](#basic-quick-start)
+    - [A more complete quick-start](#a-more-complete-quick-start)
+  - [Basic Use](#basic-use)
+  - [Advanced Use](#advanced-use)
+    - [Advanced configuration options](#advanced-configuration-options)
+    - [Custom reports](#custom-reports)
+- [Help and job discovery](#help-and-job-discovery)
+- [Troubleshooting](#troubleshooting)
+- [Contributing to and supporting runem](#contributing-to-and-supporting-runem)
+  - [Development](#development)
+  - [Sponsor](#sponsor)
+- [About runem](#about-runem)
+
+
+# Features At A Glance:
+- **Tagging**: Easily run specific job groups (e.g., lint, test, python).
+- **Phases**: Organize tasks by phase (e.g., edit, test, deploy).
+- **Configurable Options**: Customize how jobs are executed using simple options.
+- **Declarative**: Jobs are define using simple YAML in [.runem.yml](https://lursight.github.io/runem/docs/configuration.html) .
+
+# Using Run'em
+
+## Installation
+
+```bash
+pip install runem
+```
+
+## Quick-start
+
+## Basic quick-start
+Create the following `.runem.yml` file at the root of your project:
+
+```yml
+- job:
+    command: echo "hello world!"
+```
+
+Then anywhere in your project run `runem` to see how and when that task is run, and how long it took:
+```bash
+runem
+```
+
+To see the actual log output you will need to use `--verbose` as `runem` hides anything that isn't important. Only failures and reports are considered important.
+```bash
+# Or, to see "hello world!", use --verbose
+runem --verbose  # add --verbose to see the actual output
+```
+
+To see how you can control your job use `--help`:
+```bash
+runem --help
+```
+
+### A more complete quick-start
+
+See [quick-start docs](https://lursight.github.io/runem/docs/quick_start.html) for more quick-start tips.
+
+## Basic Use
+
+See [docs on basic use and use-cases](https://lursight.github.io/runem/docs/basic_use.html) for a comprehensive introduction.
+
+## Advanced Use
+
+### Advanced configuration options
+See [configuration docs](https://lursight.github.io/runem/docs/configuration.html) for advanced configuration and use.
+
+### Custom reports
+See [reporting docs](https://lursight.github.io/runem/docs/reports.html) for more information on how reporting works.
+
+
+# Help and job discovery
+
+`--help` is designed to help your team discover what jobs and tasks they can automated. Read more at 
+[help and discovery docs](https://lursight.github.io/runem/docs/help_and_job_discovery.html).
+
+# Troubleshooting
+
+See [troubleshooting and known issues docs](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html).
+
+---
+# Contributing to and supporting runem
+
+Awesome runem created by lursight
+
+## Development
+
+Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Sponsor
+
+[❤️ Sponsor this project](https://github.com/sponsors/lursight/)
+
+# About runem
+The runem mission is to improve developer velocity at
+[Lursight Ltd.](https://lursight.com), read more about the runem
+[mission](https://lursight.github.io/runem/docs/mission.html).
+

runem-0.1.0/requirements-test.txt

@@ -0,0 +1,23 @@
+# This requirements are for development and testing only, not for production.
+black==24.10.0
+coverage==7.5
+docformatter==1.7.5
+flake8-bugbear==24.2.6
+flake8==7.0.0
+gitchangelog==3.0.4
+isort==5.13.2
+mkdocs==1.5.3
+mypy==1.9.0
+pydocstyle==6.3.0
+pylint==3.1.0
+pylama==8.4.1
+pytest-cov==6.0.0
+pytest-profiling==1.7.0
+pytest-xdist==3.6.1
+pytest==8.3.3
+setuptools
+termplotlib==0.3.9
+tox
+types-PyYAML==6.0.12.20240311
+requests-mock==1.11.0
+types-setuptools

runem-0.1.0/requirements.txt

@@ -0,0 +1,9 @@
+packaging
+PyYAML
+
+# For UI Elements
+rich
+
+# For pre python3.12 Unpack features we need the `typing_extensions` module to
+# be installed.
+typing_extensions

runem-0.1.0/runem/VERSION

@@ -0,0 +1 @@
+0.1.0

{runem-0.0.31 → runem-0.1.0}/runem/command_line.py

@@ -12,6 +12,45 @@ from runem.types import JobNames, OptionConfig, OptionsWritable
 from runem.utils import printable_set
 
 
+class HelpFormatterFixedWidth(argparse.HelpFormatter):
+    """This works around test issues via constant width helo output.
+
+    This ensures that we get more constant for help-text by fixing the width to
+    something reasonable.
+    """
+
+    def __init__(self, prog: typing.Any) -> None:
+        # Override the default width with a fixed width, for tests.
+        super().__init__(
+            prog,
+            # Pretty wide so we do not get wrapping on directories
+            # or process-count output.
+            width=1000,
+        )
+
+
+def _get_argparse_help_formatter() -> typing.Any:
+    """Returns a help-formatter for argparse.
+
+    This is for tests only to fake terminals of a constant with when rendering help
+    output.
+    """
+    # Check environment variable to see if we're in tests and need a fixed width
+    # help output.
+    use_fixed_width = os.getenv("RUNEM_FIXED_HELP_WIDTH", None)
+
+    if use_fixed_width:
+        # Use custom formatter with the width specified in the environment variable
+        return (
+            lambda prog: HelpFormatterFixedWidth(  # pylint: disable=unnecessary-lambda
+                prog
+            )
+        )
+
+    # Use default formatter
+    return argparse.HelpFormatter
+
+
 def parse_args(
     config_metadata: ConfigMetadata, argv: typing.List[str]
 ) -> ConfigMetadata:
@@ -23,7 +62,9 @@ def parse_args(
     Returns the parsed args, the jobs_names_to_run, job_phases_to_run, job_tags_to_run
     """
     parser = argparse.ArgumentParser(
-        add_help=False, description="Runs the Lursight Lang test-suite"
+        add_help=False,
+        description="Runs the Lursight Lang test-suite",
+        formatter_class=_get_argparse_help_formatter(),
     )
     parser.add_argument(
         "-H", "--help", action="help", help="show this help message and exit"
@@ -136,6 +177,29 @@ def parse_args(
         default=False,
         required=False,
     )
+    parser.add_argument(
+        "--always-files",
+        dest="always_files",
+        help=(
+            "list of paths/files to always check (overriding -f/-h), if the path "
+            "matches the filter regex and if file-paths exist"
+        ),
+        nargs="+",
+        default=None,
+        required=False,
+    )
+
+    parser.add_argument(
+        "--git-files-since-branch",
+        dest="git_since_branch",
+        help=(
+            "Get the list of paths/files changed between a branch, e.g., since "
+            "'origin/main'. Useful for checking files changed before pushing."
+        ),
+        default=None,  # Default to None if no branch is specified
+        required=False,  # Not required, users may not want to specify a branch
+        type=str,  # Accepts a string input representing the branch name
+    )
 
     parser.add_argument(
         "--procs",
@@ -151,7 +215,7 @@ def parse_args(
         type=int,
     )
 
-    config_dir: pathlib.Path = config_metadata.cfg_filepath.parent
+    config_dir: pathlib.Path = _get_config_dir(config_metadata)
     parser.add_argument(
         "--root",
         dest="root_dir",
@@ -163,6 +227,15 @@ def parse_args(
         required=False,
     )
 
+    parser.add_argument(
+        "--root-show",
+        dest="show_root_path_and_exit",
+        help="show the root-path of runem and exit",
+        action=argparse.BooleanOptionalAction,
+        default=False,
+        required=False,
+    )
+
     parser.add_argument(
         "--spinner",
         dest="show_spinner",
@@ -196,6 +269,11 @@ def parse_args(
 
     args = parser.parse_args(argv[1:])
 
+    if args.show_root_path_and_exit:
+        log(str(config_metadata.cfg_filepath.parent), decorate=False)
+        # cleanly exit
+        sys.exit(0)
+
     if args.show_version_and_exit:
         log(str(get_runem_version()), decorate=False)
         # cleanly exit
@@ -219,6 +297,11 @@ def parse_args(
     return config_metadata
 
 
+def _get_config_dir(config_metadata: ConfigMetadata) -> pathlib.Path:
+    """A function to get the path, that we can mock in tests."""
+    return config_metadata.cfg_filepath.parent
+
+
 def _validate_filters(
     config_metadata: ConfigMetadata,
     args: argparse.Namespace,
@@ -338,7 +421,7 @@ def _define_option_args(
 
 
 def _alias_to_switch(switch_name_alias: str, negatise: bool = False) -> str:
-    """Util function to generate a alias switch for argsparse."""
+    """Util function to generate a alias switch for argparse."""
     single_letter_variant = not negatise and len(switch_name_alias) == 1
     if single_letter_variant:
         return f"-{switch_name_alias}"