mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-06-11 18:45:34 +00:00
a626f30660
- Rename REPOSITORY_STATE_MAP to STATE_MAP and add snapshot (deleted, expired, listed, verified) and policy (set, shown) entries. - Expand _PROVIDER_BACKEND_MAP with new backend fields for azure (client_id, client_secret, tenant_id, azure_federated_token_file), gcs/gdrive (embed_credentials, read_only bool flags), rclone (rclone_exe, rclone_args, rclone_env, embed_rclone_config), and sftp (sftp_password, key_data, known_hosts_data, embed_credentials, external, ssh_command, ssh_args). - Update fmt_backend() to handle bool (flag-only) and list (per-item) param types; _PROVIDER_BACKEND_MAP values changed from plain flag strings to (flag, kind) tuples so fmt_backend() can dispatch on type.
373 lines
11 KiB
Python
373 lines
11 KiB
Python
# Copyright (c) 2026, Dexter Le <dextersydney2001@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
from ansible_collections.community.general.plugins.module_utils._kopia import (
|
|
KOPIA_COMMON_ARGUMENT_SPEC,
|
|
STATE_MAP,
|
|
fmt_backend,
|
|
)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# KOPIA_COMMON_ARGUMENT_SPEC
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_common_argument_spec_has_password():
|
|
assert "password" in KOPIA_COMMON_ARGUMENT_SPEC
|
|
spec = KOPIA_COMMON_ARGUMENT_SPEC["password"]
|
|
assert spec["type"] == "str"
|
|
assert spec["no_log"] is True
|
|
|
|
|
|
def test_common_argument_spec_has_config():
|
|
assert "config" in KOPIA_COMMON_ARGUMENT_SPEC
|
|
assert KOPIA_COMMON_ARGUMENT_SPEC["config"]["type"] == "path"
|
|
|
|
|
|
def test_common_argument_spec_only_two_keys():
|
|
assert set(KOPIA_COMMON_ARGUMENT_SPEC.keys()) == {"password", "config"}
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# STATE_MAP
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_state_map_repository_entries():
|
|
assert STATE_MAP["created"] == "create"
|
|
assert STATE_MAP["connected"] == "connect"
|
|
assert STATE_MAP["disconnected"] == "disconnect"
|
|
assert STATE_MAP["synced"] == "sync-to"
|
|
assert STATE_MAP["throttled"] == "throttle"
|
|
|
|
|
|
def test_state_map_snapshot_entries():
|
|
assert STATE_MAP["deleted"] == "delete"
|
|
assert STATE_MAP["expired"] == "expire"
|
|
assert STATE_MAP["listed"] == "list"
|
|
assert STATE_MAP["verified"] == "verify"
|
|
|
|
|
|
def test_state_map_policy_entries():
|
|
assert STATE_MAP["set"] == "set"
|
|
assert STATE_MAP["shown"] == "show"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# fmt_backend
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
TC_FMT_BACKEND = dict(
|
|
server=(
|
|
{"provider": "server"},
|
|
[],
|
|
),
|
|
filesystem_path=(
|
|
{"provider": "filesystem", "path": "/mnt/backup"},
|
|
["filesystem", "--path=/mnt/backup"],
|
|
),
|
|
filesystem_no_path=(
|
|
{"provider": "filesystem"},
|
|
["filesystem"],
|
|
),
|
|
s3_full=(
|
|
{
|
|
"provider": "s3",
|
|
"bucket": "my-bucket",
|
|
"access_key": "keyid",
|
|
"secret_access_key": "secret",
|
|
"endpoint": "https://s3.example.com",
|
|
"region": "us-east-1",
|
|
"prefix": "backups/",
|
|
"session_token": "tok123",
|
|
},
|
|
[
|
|
"s3",
|
|
"--bucket=my-bucket",
|
|
"--access-key=keyid",
|
|
"--secret-access-key=secret",
|
|
"--endpoint=https://s3.example.com",
|
|
"--region=us-east-1",
|
|
"--prefix=backups/",
|
|
"--session-token=tok123",
|
|
],
|
|
),
|
|
s3_minimal=(
|
|
{"provider": "s3", "bucket": "my-bucket"},
|
|
["s3", "--bucket=my-bucket"],
|
|
),
|
|
azure_full=(
|
|
{
|
|
"provider": "azure",
|
|
"container": "my-container",
|
|
"storage_account": "myaccount",
|
|
"storage_key": "mykey",
|
|
"sas_token": "mytoken",
|
|
"storage_domain": "blob.core.windows.net",
|
|
"prefix": "data/",
|
|
},
|
|
[
|
|
"azure",
|
|
"--container=my-container",
|
|
"--storage-account=myaccount",
|
|
"--storage-key=mykey",
|
|
"--sas-token=mytoken",
|
|
"--storage-domain=blob.core.windows.net",
|
|
"--prefix=data/",
|
|
],
|
|
),
|
|
azure_minimal=(
|
|
{"provider": "azure", "container": "my-container", "storage_account": "myaccount"},
|
|
["azure", "--container=my-container", "--storage-account=myaccount"],
|
|
),
|
|
azure_service_principal=(
|
|
{
|
|
"provider": "azure",
|
|
"container": "my-container",
|
|
"storage_account": "myaccount",
|
|
"client_id": "cid",
|
|
"client_secret": "csecret",
|
|
"tenant_id": "tid",
|
|
},
|
|
[
|
|
"azure",
|
|
"--container=my-container",
|
|
"--storage-account=myaccount",
|
|
"--client-id=cid",
|
|
"--client-secret=csecret",
|
|
"--tenant-id=tid",
|
|
],
|
|
),
|
|
azure_federated_token=(
|
|
{
|
|
"provider": "azure",
|
|
"container": "my-container",
|
|
"storage_account": "myaccount",
|
|
"azure_federated_token_file": "/var/run/secrets/azure/token",
|
|
},
|
|
[
|
|
"azure",
|
|
"--container=my-container",
|
|
"--storage-account=myaccount",
|
|
"--azure-federated-token-file=/var/run/secrets/azure/token",
|
|
],
|
|
),
|
|
gcs_full=(
|
|
{
|
|
"provider": "gcs",
|
|
"bucket": "my-bucket",
|
|
"credentials_file": "/etc/gcs.json",
|
|
"prefix": "kopia/",
|
|
},
|
|
["gcs", "--bucket=my-bucket", "--credentials-file=/etc/gcs.json", "--prefix=kopia/"],
|
|
),
|
|
gcs_embed_credentials=(
|
|
{
|
|
"provider": "gcs",
|
|
"bucket": "my-bucket",
|
|
"embed_credentials": True,
|
|
},
|
|
["gcs", "--bucket=my-bucket", "--embed-credentials"],
|
|
),
|
|
gcs_embed_credentials_false=(
|
|
{
|
|
"provider": "gcs",
|
|
"bucket": "my-bucket",
|
|
"embed_credentials": False,
|
|
},
|
|
["gcs", "--bucket=my-bucket"],
|
|
),
|
|
gcs_read_only=(
|
|
{
|
|
"provider": "gcs",
|
|
"bucket": "my-bucket",
|
|
"read_only": True,
|
|
},
|
|
["gcs", "--bucket=my-bucket", "--read-only"],
|
|
),
|
|
gdrive=(
|
|
{"provider": "gdrive", "folder_id": "abc123", "credentials_file": "/etc/gdrive.json"},
|
|
["gdrive", "--folder-id=abc123", "--credentials-file=/etc/gdrive.json"],
|
|
),
|
|
gdrive_read_only=(
|
|
{"provider": "gdrive", "folder_id": "abc123", "read_only": True},
|
|
["gdrive", "--folder-id=abc123", "--read-only"],
|
|
),
|
|
b2_full=(
|
|
{"provider": "b2", "bucket": "my-b2-bucket", "access_key": "kid", "secret_access_key": "sec"},
|
|
["b2", "--bucket=my-b2-bucket", "--key-id=kid", "--key=sec"],
|
|
),
|
|
rclone_minimal=(
|
|
{"provider": "rclone", "path": "remote:backup"},
|
|
["rclone", "--remote-path=remote:backup"],
|
|
),
|
|
rclone_with_exe=(
|
|
{"provider": "rclone", "path": "remote:backup", "rclone_exe": "/usr/local/bin/rclone"},
|
|
["rclone", "--remote-path=remote:backup", "--rclone-exe=/usr/local/bin/rclone"],
|
|
),
|
|
rclone_with_args=(
|
|
{
|
|
"provider": "rclone",
|
|
"path": "remote:backup",
|
|
"rclone_args": ["--transfers=4", "--checkers=8"],
|
|
},
|
|
[
|
|
"rclone",
|
|
"--remote-path=remote:backup",
|
|
"--rclone-args",
|
|
"--transfers=4",
|
|
"--rclone-args",
|
|
"--checkers=8",
|
|
],
|
|
),
|
|
rclone_with_env=(
|
|
{
|
|
"provider": "rclone",
|
|
"path": "remote:backup",
|
|
"rclone_env": ["RCLONE_CONFIG=/etc/rclone.conf", "HOME=/root"],
|
|
},
|
|
[
|
|
"rclone",
|
|
"--remote-path=remote:backup",
|
|
"--rclone-env",
|
|
"RCLONE_CONFIG=/etc/rclone.conf",
|
|
"--rclone-env",
|
|
"HOME=/root",
|
|
],
|
|
),
|
|
rclone_embed_config=(
|
|
{"provider": "rclone", "path": "remote:backup", "embed_rclone_config": True},
|
|
["rclone", "--remote-path=remote:backup", "--embed-rclone-config"],
|
|
),
|
|
sftp_full=(
|
|
{
|
|
"provider": "sftp",
|
|
"path": "/backup",
|
|
"host": "sftp.example.com",
|
|
"username": "admin",
|
|
"port": 22,
|
|
"keyfile": "/root/.ssh/id_rsa",
|
|
"known_hosts": "/root/.ssh/known_hosts",
|
|
},
|
|
[
|
|
"sftp",
|
|
"--path=/backup",
|
|
"--host=sftp.example.com",
|
|
"--username=admin",
|
|
"--port=22",
|
|
"--keyfile=/root/.ssh/id_rsa",
|
|
"--known-hosts=/root/.ssh/known_hosts",
|
|
],
|
|
),
|
|
sftp_password=(
|
|
{
|
|
"provider": "sftp",
|
|
"path": "/backup",
|
|
"host": "sftp.example.com",
|
|
"username": "admin",
|
|
"sftp_password": "s3cr3t",
|
|
},
|
|
[
|
|
"sftp",
|
|
"--path=/backup",
|
|
"--host=sftp.example.com",
|
|
"--username=admin",
|
|
"--sftp-password=s3cr3t",
|
|
],
|
|
),
|
|
sftp_key_data=(
|
|
{
|
|
"provider": "sftp",
|
|
"path": "/backup",
|
|
"host": "sftp.example.com",
|
|
"username": "admin",
|
|
"key_data": "-----BEGIN RSA PRIVATE KEY-----\n...",
|
|
"known_hosts_data": "sftp.example.com ssh-rsa AAAA...",
|
|
},
|
|
[
|
|
"sftp",
|
|
"--path=/backup",
|
|
"--host=sftp.example.com",
|
|
"--username=admin",
|
|
"--key-data=-----BEGIN RSA PRIVATE KEY-----\n...",
|
|
"--known-hosts-data=sftp.example.com ssh-rsa AAAA...",
|
|
],
|
|
),
|
|
sftp_embed_credentials=(
|
|
{
|
|
"provider": "sftp",
|
|
"path": "/backup",
|
|
"host": "sftp.example.com",
|
|
"username": "admin",
|
|
"embed_credentials": True,
|
|
},
|
|
[
|
|
"sftp",
|
|
"--path=/backup",
|
|
"--host=sftp.example.com",
|
|
"--username=admin",
|
|
"--embed-credentials",
|
|
],
|
|
),
|
|
sftp_external=(
|
|
{
|
|
"provider": "sftp",
|
|
"path": "/backup",
|
|
"host": "sftp.example.com",
|
|
"username": "admin",
|
|
"external": True,
|
|
"ssh_command": "/usr/bin/ssh",
|
|
"ssh_args": ["-o", "StrictHostKeyChecking=no"],
|
|
},
|
|
[
|
|
"sftp",
|
|
"--path=/backup",
|
|
"--host=sftp.example.com",
|
|
"--username=admin",
|
|
"--external",
|
|
"--ssh-command=/usr/bin/ssh",
|
|
"--ssh-args",
|
|
"-o",
|
|
"--ssh-args",
|
|
"StrictHostKeyChecking=no",
|
|
],
|
|
),
|
|
webdav_full=(
|
|
{
|
|
"provider": "webdav",
|
|
"url": "https://dav.example.com",
|
|
"webdav_username": "user",
|
|
"webdav_password": "pass",
|
|
},
|
|
["webdav", "--url=https://dav.example.com", "--webdav-username=user", "--webdav-password=pass"],
|
|
),
|
|
none_values_skipped=(
|
|
{"provider": "s3", "bucket": "b", "access_key": None, "secret_access_key": None},
|
|
["s3", "--bucket=b"],
|
|
),
|
|
bool_false_skipped=(
|
|
{"provider": "gcs", "bucket": "b", "embed_credentials": False, "read_only": False},
|
|
["gcs", "--bucket=b"],
|
|
),
|
|
empty_list_skipped=(
|
|
{"provider": "rclone", "path": "remote:b", "rclone_args": []},
|
|
["rclone", "--remote-path=remote:b"],
|
|
),
|
|
)
|
|
|
|
TC_FMT_BACKEND_IDS = sorted(TC_FMT_BACKEND.keys())
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"backend, expected",
|
|
(TC_FMT_BACKEND[tc] for tc in TC_FMT_BACKEND_IDS),
|
|
ids=TC_FMT_BACKEND_IDS,
|
|
)
|
|
def test_fmt_backend(backend, expected):
|
|
assert fmt_backend(backend) == expected
|