-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move existing tests into subfolder `tests/unit`. Write integration tests that actually run the installed borg executable. Those tests can be found in `tests/integration`. Those pytest fixtures that are the same for both kinds of tests remain in `tests/conftest.py`. The others can be found in `tests/integration/conftest.py` or `tests/unit/conftest.py`. This adds nox to the project and configures it to run the tests with different borg versions. This also updates the ci workflow to run the integration tests using nox.
* noxfile.py : Run pytest with a matrix of borg versions OR a specific borg version
* Makefile : Run using nox. Add phonies `test-unit` and `test-integration`.
* tests/conftest.py : Move some fixtures/functions to `tests/unit/conftest.py`.
* tests/test_*.py --> tests/unit/ : Move unittests and assets into subfolder
* tests/integration/ : Write integration tests.
* requirements.d/dev.txt: Add `nox` and `pkgconfig`. The latter is needed for installing new borg versions.
* .github/actions/setup/action.yml : Update to install pre-commit and nox when needed. The action now no longer installs Vorta.
* .github/actions/install-dependencies/action.yml : Install system deps of borg with this new composite action.
* .github/workflows/test.yml : Rename `test` ci to `test-unit` and update it for the new test setup.
Implement `test-integration` ci.
Signed-off-by: Chirag Aggarwal <[email protected]>- Loading branch information
Showing
63 changed files
with
1,253 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: Install Dependencies | ||
| description: Installs system dependencies | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: Install system dependencies (Linux) | ||
| if: runner.os == 'Linux' | ||
| shell: bash | ||
| run: | | ||
| sudo apt update && sudo apt install -y \ | ||
| xvfb libssl-dev openssl libacl1-dev libacl1 fuse3 build-essential \ | ||
| libxkbcommon-x11-0 dbus-x11 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 \ | ||
| libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 libxcb-shape0 \ | ||
| libegl1 libxcb-cursor0 libfuse-dev libsqlite3-dev libfuse3-dev pkg-config \ | ||
| python3-pkgconfig libxxhash-dev borgbackup | ||
| - name: Install system dependencies (macOS) | ||
| if: runner.os == 'macOS' | ||
| shell: bash | ||
| run: | | ||
| brew install openssl readline xz xxhash pkg-config borgbackup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import os | ||
| import re | ||
| import sys | ||
|
|
||
| import nox | ||
|
|
||
| borg_version = os.getenv("BORG_VERSION") | ||
|
|
||
| if borg_version: | ||
| # Use specified borg version | ||
| supported_borgbackup_versions = [borg_version] | ||
| else: | ||
| # Generate a list of borg versions compatible with system installed python version | ||
| system_python_version = tuple(sys.version_info[:3]) | ||
|
|
||
| supported_borgbackup_versions = [ | ||
| borgbackup | ||
| for borgbackup in ("1.1.18", "1.2.2", "1.2.4", "2.0.0b6") | ||
| # Python version requirements for borgbackup versions | ||
| if (borgbackup == "1.1.18" and system_python_version >= (3, 5, 0)) | ||
| or (borgbackup == "1.2.2" and system_python_version >= (3, 8, 0)) | ||
| or (borgbackup == "1.2.4" and system_python_version >= (3, 8, 0)) | ||
| or (borgbackup == "2.0.0b6" and system_python_version >= (3, 9, 0)) | ||
| ] | ||
|
|
||
|
|
||
| @nox.session | ||
| @nox.parametrize("borgbackup", supported_borgbackup_versions) | ||
| def run_tests(session, borgbackup): | ||
| # install borgbackup | ||
| if (sys.platform == 'darwin'): | ||
| # in macOS there's currently no fuse package which works with borgbackup directly | ||
| session.install(f"borgbackup=={borgbackup}") | ||
| elif (borgbackup == "1.1.18"): | ||
| # borgbackup 1.1.18 doesn't support pyfuse3 | ||
| session.install("llfuse") | ||
| session.install(f"borgbackup[llfuse]=={borgbackup}") | ||
| else: | ||
| session.install(f"borgbackup[pyfuse3]=={borgbackup}") | ||
|
|
||
| # install dependencies | ||
| session.install("-r", "requirements.d/dev.txt") | ||
| session.install("-e", ".") | ||
|
|
||
| # check versions | ||
| cli_version = session.run("borg", "--version", silent=True).strip() | ||
| cli_version = re.search(r"borg (\S+)", cli_version).group(1) | ||
| python_version = session.run("python", "-c", "import borg; print(borg.__version__)", silent=True).strip() | ||
|
|
||
| session.log(f"Borg CLI version: {cli_version}") | ||
| session.log(f"Borg Python version: {python_version}") | ||
|
|
||
| assert cli_version == borgbackup | ||
| assert python_version == borgbackup | ||
|
|
||
| session.run("pytest", *session.posargs, env={"BORG_VERSION": borgbackup}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,8 @@ black==22.* | |
| coverage | ||
| flake8 | ||
| macholib | ||
| nox | ||
| pkgconfig | ||
| pre-commit | ||
| pyinstaller | ||
| pylint | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,11 @@ | ||
| import os | ||
| import sys | ||
| from datetime import datetime as dt | ||
| from unittest.mock import MagicMock | ||
|
|
||
| import pytest | ||
| import vorta | ||
| import vorta.application | ||
| import vorta.borg.jobs_manager | ||
| from peewee import SqliteDatabase | ||
| from vorta.store.models import ( | ||
| ArchiveModel, | ||
| BackupProfileModel, | ||
| EventLogModel, | ||
| RepoModel, | ||
| RepoPassword, | ||
| SchemaVersion, | ||
| SettingsModel, | ||
| SourceFileModel, | ||
| WifiSettingModel, | ||
| ) | ||
| from vorta.views.main_window import MainWindow | ||
|
|
||
| models = [ | ||
| RepoModel, | ||
| RepoPassword, | ||
| BackupProfileModel, | ||
| SourceFileModel, | ||
| SettingsModel, | ||
| ArchiveModel, | ||
| WifiSettingModel, | ||
| EventLogModel, | ||
| SchemaVersion, | ||
| ] | ||
|
|
||
|
|
||
| def pytest_configure(config): | ||
|
|
@@ -55,86 +29,8 @@ def qapp(tmpdir_factory): | |
|
|
||
| from vorta.application import VortaApp | ||
|
|
||
| VortaApp.set_borg_details_action = MagicMock() # Can't use pytest-mock in session scope | ||
| VortaApp.scheduler = MagicMock() | ||
|
|
||
| qapp = VortaApp([]) # Only init QApplication once to avoid segfaults while testing. | ||
|
|
||
| yield qapp | ||
| mock_db.close() | ||
| qapp.quit() | ||
|
|
||
|
|
||
| @pytest.fixture(scope='function', autouse=True) | ||
| def init_db(qapp, qtbot, tmpdir_factory): | ||
| tmp_db = tmpdir_factory.mktemp('Vorta').join('settings.sqlite') | ||
| mock_db = SqliteDatabase( | ||
| str(tmp_db), | ||
| pragmas={ | ||
| 'journal_mode': 'wal', | ||
| }, | ||
| ) | ||
| vorta.store.connection.init_db(mock_db) | ||
|
|
||
| default_profile = BackupProfileModel(name='Default') | ||
| default_profile.save() | ||
|
|
||
| new_repo = RepoModel(url='[email protected]:repo') | ||
| new_repo.encryption = 'none' | ||
| new_repo.save() | ||
|
|
||
| default_profile.repo = new_repo.id | ||
| default_profile.dont_run_on_metered_networks = False | ||
| default_profile.validation_on = False | ||
| default_profile.save() | ||
|
|
||
| test_archive = ArchiveModel(snapshot_id='99999', name='test-archive', time=dt(2000, 1, 1, 0, 0), repo=1) | ||
| test_archive.save() | ||
|
|
||
| test_archive1 = ArchiveModel(snapshot_id='99998', name='test-archive1', time=dt(2000, 1, 1, 0, 0), repo=1) | ||
| test_archive1.save() | ||
|
|
||
| source_dir = SourceFileModel(dir='/tmp/another', repo=new_repo, dir_size=100, dir_files_count=18, path_isdir=True) | ||
| source_dir.save() | ||
|
|
||
| qapp.main_window.deleteLater() | ||
| del qapp.main_window | ||
| qapp.main_window = MainWindow(qapp) # Re-open main window to apply mock data in UI | ||
|
|
||
| yield | ||
|
|
||
| qapp.jobs_manager.cancel_all_jobs() | ||
| qapp.backup_finished_event.disconnect() | ||
| qapp.scheduler.schedule_changed.disconnect() | ||
| qtbot.waitUntil(lambda: not qapp.jobs_manager.is_worker_running(), **pytest._wait_defaults) | ||
| mock_db.close() | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def choose_file_dialog(*args): | ||
| class MockFileDialog: | ||
| def __init__(self, *args, **kwargs): | ||
| pass | ||
|
|
||
| def open(self, func): | ||
| func() | ||
|
|
||
| def selectedFiles(self): | ||
| return ['/tmp'] | ||
|
|
||
| return MockFileDialog | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def borg_json_output(): | ||
| def _read_json(subcommand): | ||
| stdout = open(f'tests/borg_json_output/{subcommand}_stdout.json') | ||
| stderr = open(f'tests/borg_json_output/{subcommand}_stderr.json') | ||
| return stdout, stderr | ||
|
|
||
| return _read_json | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def rootdir(): | ||
| return os.path.dirname(os.path.abspath(__file__)) | ||
File renamed without changes.
Oops, something went wrong.