pyrox.dev
1args@{ mkNode, ver, ... }:
2(import ../make-test-python.nix ({ pkgs, ...} : {
3 name = "garage-basic";
4 meta = {
5 maintainers = with pkgs.lib.maintainers; [ raitobezarius ];
6 };
7
8 nodes = {
9 single_node = mkNode { replicationMode = "none"; };
10 };
11
12 testScript = ''
13 from typing import List
14 from dataclasses import dataclass
15 import re
16
17 start_all()
18
19 cur_version_regex = re.compile('Current cluster layout version: (?P<ver>\d*)')
20 key_creation_regex = re.compile('Key name: (?P<key_name>.*)\nKey ID: (?P<key_id>.*)\nSecret key: (?P<secret_key>.*)')
21
22 @dataclass
23 class S3Key:
24 key_name: str
25 key_id: str
26 secret_key: str
27
28 @dataclass
29 class GarageNode:
30 node_id: str
31 host: str
32
33 def get_node_fqn(machine: Machine) -> GarageNode:
34 node_id, host = machine.succeed("garage node id").split('@')
35 return GarageNode(node_id=node_id, host=host)
36
37 def get_node_id(machine: Machine) -> str:
38 return get_node_fqn(machine).node_id
39
40 def get_layout_version(machine: Machine) -> int:
41 version_data = machine.succeed("garage layout show")
42 m = cur_version_regex.search(version_data)
43 if m and m.group('ver') is not None:
44 return int(m.group('ver')) + 1
45 else:
46 raise ValueError('Cannot find current layout version')
47
48 def apply_garage_layout(machine: Machine, layouts: List[str]):
49 for layout in layouts:
50 machine.succeed(f"garage layout assign {layout}")
51 version = get_layout_version(machine)
52 machine.succeed(f"garage layout apply --version {version}")
53
54 def create_api_key(machine: Machine, key_name: str) -> S3Key:
55 output = machine.succeed(f"garage key ${if ver == "0_8" then "new --name" else "create"} {key_name}")
56 m = key_creation_regex.match(output)
57 if not m or not m.group('key_id') or not m.group('secret_key'):
58 raise ValueError('Cannot parse API key data')
59 return S3Key(key_name=key_name, key_id=m.group('key_id'), secret_key=m.group('secret_key'))
60
61 def get_api_key(machine: Machine, key_pattern: str) -> S3Key:
62 output = machine.succeed(f"garage key info {key_pattern}")
63 m = key_creation_regex.match(output)
64 if not m or not m.group('key_name') or not m.group('key_id') or not m.group('secret_key'):
65 raise ValueError('Cannot parse API key data')
66 return S3Key(key_name=m.group('key_name'), key_id=m.group('key_id'), secret_key=m.group('secret_key'))
67
68 def test_bucket_writes(node):
69 node.succeed("garage bucket create test-bucket")
70 s3_key = create_api_key(node, "test-api-key")
71 node.succeed("garage bucket allow --read --write test-bucket --key test-api-key")
72 other_s3_key = get_api_key(node, 'test-api-key')
73 assert other_s3_key.secret_key == other_s3_key.secret_key
74 node.succeed(
75 f"mc alias set test-garage http://[::1]:3900 {s3_key.key_id} {s3_key.secret_key} --api S3v4"
76 )
77 node.succeed("echo test | mc pipe test-garage/test-bucket/test.txt")
78 assert node.succeed("mc cat test-garage/test-bucket/test.txt").strip() == "test"
79
80 def test_bucket_over_http(node, bucket='test-bucket', url=None):
81 if url is None:
82 url = f"{bucket}.web.garage"
83
84 node.succeed(f'garage bucket website --allow {bucket}')
85 node.succeed(f'echo hello world | mc pipe test-garage/{bucket}/index.html')
86 assert (node.succeed(f"curl -H 'Host: {url}' http://localhost:3902")).strip() == 'hello world'
87
88 with subtest("Garage works as a single-node S3 storage"):
89 single_node.wait_for_unit("garage.service")
90 single_node.wait_for_open_port(3900)
91 # Now Garage is initialized.
92 single_node_id = get_node_id(single_node)
93 apply_garage_layout(single_node, [f'-z qemutest -c ${if ver == "0_8" then "1" else "1G"} "{single_node_id}"'])
94 # Now Garage is operational.
95 test_bucket_writes(single_node)
96 test_bucket_over_http(single_node)
97 '';
98})) args