clan_cli: Renamed ClanUrl to FlakeId
This commit is contained in:
parent
f4f3176374
commit
372e212c0c
@ -10,22 +10,30 @@ from .errors import ClanError
|
|||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
class ClanUrl:
|
class FlakeId:
|
||||||
value: str | Path
|
_value: str | Path
|
||||||
|
|
||||||
def __str__(self) -> str:
|
def __str__(self) -> str:
|
||||||
return (
|
return f"{self._value}" # The __str__ method returns a custom string representation
|
||||||
f"{self.value}" # The __str__ method returns a custom string representation
|
|
||||||
)
|
@property
|
||||||
|
def path(self) -> Path:
|
||||||
|
assert isinstance(self._value, Path)
|
||||||
|
return self._value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def url(self) -> str:
|
||||||
|
assert isinstance(self._value, str)
|
||||||
|
return self._value
|
||||||
|
|
||||||
def __repr__(self) -> str:
|
def __repr__(self) -> str:
|
||||||
return f"ClanUrl({self.value})"
|
return f"ClanUrl({self._value})"
|
||||||
|
|
||||||
def is_local(self) -> bool:
|
def is_local(self) -> bool:
|
||||||
return isinstance(self.value, Path)
|
return isinstance(self._value, Path)
|
||||||
|
|
||||||
def is_remote(self) -> bool:
|
def is_remote(self) -> bool:
|
||||||
return isinstance(self.value, str)
|
return isinstance(self._value, str)
|
||||||
|
|
||||||
|
|
||||||
# Parameters defined here will be DELETED from the nested uri
|
# Parameters defined here will be DELETED from the nested uri
|
||||||
@ -37,19 +45,19 @@ class MachineParams:
|
|||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
class MachineData:
|
class MachineData:
|
||||||
url: ClanUrl
|
flake_id: FlakeId
|
||||||
name: str = "defaultVM"
|
name: str = "defaultVM"
|
||||||
params: MachineParams = dataclasses.field(default_factory=MachineParams)
|
params: MachineParams = dataclasses.field(default_factory=MachineParams)
|
||||||
|
|
||||||
def get_id(self) -> str:
|
def get_id(self) -> str:
|
||||||
return f"{self.url}#{self.name}"
|
return f"{self.flake_id}#{self.name}"
|
||||||
|
|
||||||
|
|
||||||
# Define the ClanURI class
|
# Define the ClanURI class
|
||||||
class ClanURI:
|
class ClanURI:
|
||||||
_orig_uri: str
|
_orig_uri: str
|
||||||
_components: urllib.parse.ParseResult
|
_components: urllib.parse.ParseResult
|
||||||
url: ClanUrl
|
flake_id: FlakeId
|
||||||
_machines: list[MachineData]
|
_machines: list[MachineData]
|
||||||
|
|
||||||
# Initialize the class with a clan:// URI
|
# Initialize the class with a clan:// URI
|
||||||
@ -77,7 +85,7 @@ class ClanURI:
|
|||||||
)
|
)
|
||||||
|
|
||||||
# Parse the URL into a ClanUrl object
|
# Parse the URL into a ClanUrl object
|
||||||
self.url = self._parse_url(clean_comps)
|
self.flake_id = self._parse_url(clean_comps)
|
||||||
|
|
||||||
# Parse the fragment into a list of machine queries
|
# Parse the fragment into a list of machine queries
|
||||||
# Then parse every machine query into a MachineParameters object
|
# Then parse every machine query into a MachineParameters object
|
||||||
@ -90,10 +98,10 @@ class ClanURI:
|
|||||||
|
|
||||||
# If there are no machine fragments, add a default machine
|
# If there are no machine fragments, add a default machine
|
||||||
if len(machine_frags) == 0:
|
if len(machine_frags) == 0:
|
||||||
default_machine = MachineData(url=self.url)
|
default_machine = MachineData(flake_id=self.flake_id)
|
||||||
self._machines.append(default_machine)
|
self._machines.append(default_machine)
|
||||||
|
|
||||||
def _parse_url(self, comps: urllib.parse.ParseResult) -> ClanUrl:
|
def _parse_url(self, comps: urllib.parse.ParseResult) -> FlakeId:
|
||||||
comb = (
|
comb = (
|
||||||
comps.scheme,
|
comps.scheme,
|
||||||
comps.netloc,
|
comps.netloc,
|
||||||
@ -104,11 +112,11 @@ class ClanURI:
|
|||||||
)
|
)
|
||||||
match comb:
|
match comb:
|
||||||
case ("file", "", path, "", "", _) | ("", "", path, "", "", _): # type: ignore
|
case ("file", "", path, "", "", _) | ("", "", path, "", "", _): # type: ignore
|
||||||
url = ClanUrl(Path(path).expanduser().resolve())
|
flake_id = FlakeId(Path(path).expanduser().resolve())
|
||||||
case _:
|
case _:
|
||||||
url = ClanUrl(comps.geturl())
|
flake_id = FlakeId(comps.geturl())
|
||||||
|
|
||||||
return url
|
return flake_id
|
||||||
|
|
||||||
def _parse_machine_query(self, machine_frag: str) -> MachineData:
|
def _parse_machine_query(self, machine_frag: str) -> MachineData:
|
||||||
comp = urllib.parse.urlparse(machine_frag)
|
comp = urllib.parse.urlparse(machine_frag)
|
||||||
@ -128,7 +136,7 @@ class ClanURI:
|
|||||||
# we need to make sure there are no conflicts
|
# we need to make sure there are no conflicts
|
||||||
del query[dfield.name]
|
del query[dfield.name]
|
||||||
params = MachineParams(**machine_params)
|
params = MachineParams(**machine_params)
|
||||||
machine = MachineData(url=self.url, name=machine_name, params=params)
|
machine = MachineData(flake_id=self.flake_id, name=machine_name, params=params)
|
||||||
return machine
|
return machine
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@ -139,19 +147,7 @@ class ClanURI:
|
|||||||
return self._orig_uri
|
return self._orig_uri
|
||||||
|
|
||||||
def get_url(self) -> str:
|
def get_url(self) -> str:
|
||||||
return str(self.url)
|
return str(self.flake_id)
|
||||||
|
|
||||||
def to_json(self) -> dict[str, Any]:
|
|
||||||
return {
|
|
||||||
"_orig_uri": self._orig_uri,
|
|
||||||
"url": str(self.url),
|
|
||||||
"machines": [dataclasses.asdict(m) for m in self._machines],
|
|
||||||
}
|
|
||||||
|
|
||||||
def from_json(self, data: dict[str, Any]) -> None:
|
|
||||||
self._orig_uri = data["_orig_uri"]
|
|
||||||
self.url = data["url"]
|
|
||||||
self._machines = [MachineData(**m) for m in data["machines"]]
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def from_str(
|
def from_str(
|
||||||
|
@ -66,7 +66,7 @@ class Machine:
|
|||||||
if machine is None:
|
if machine is None:
|
||||||
uri = ClanURI.from_str(str(flake), name)
|
uri = ClanURI.from_str(str(flake), name)
|
||||||
machine = uri.machine
|
machine = uri.machine
|
||||||
self.flake: str | Path = machine.url.value
|
self.flake: str | Path = machine.flake_id._value
|
||||||
self.name: str = machine.name
|
self.name: str = machine.name
|
||||||
self.data: MachineData = machine
|
self.data: MachineData = machine
|
||||||
else:
|
else:
|
||||||
@ -77,12 +77,12 @@ class Machine:
|
|||||||
self._flake_path: Path | None = None
|
self._flake_path: Path | None = None
|
||||||
self._deployment_info: None | dict[str, str] = deployment_info
|
self._deployment_info: None | dict[str, str] = deployment_info
|
||||||
|
|
||||||
state_dir = vm_state_dir(flake_url=str(self.data.url), vm_name=self.data.name)
|
state_dir = vm_state_dir(flake_url=str(self.flake), vm_name=self.data.name)
|
||||||
|
|
||||||
self.vm: QMPWrapper = QMPWrapper(state_dir)
|
self.vm: QMPWrapper = QMPWrapper(state_dir)
|
||||||
|
|
||||||
def __str__(self) -> str:
|
def __str__(self) -> str:
|
||||||
return f"Machine(name={self.data.name}, flake={self.data.url})"
|
return f"Machine(name={self.data.name}, flake={self.data.flake_id})"
|
||||||
|
|
||||||
def __repr__(self) -> str:
|
def __repr__(self) -> str:
|
||||||
return str(self)
|
return str(self)
|
||||||
@ -139,12 +139,12 @@ class Machine:
|
|||||||
if self._flake_path:
|
if self._flake_path:
|
||||||
return self._flake_path
|
return self._flake_path
|
||||||
|
|
||||||
if self.data.url.is_local():
|
if self.data.flake_id.is_local():
|
||||||
self._flake_path = Path(str(self.data.url))
|
self._flake_path = self.data.flake_id.path
|
||||||
elif self.data.url.is_remote():
|
elif self.data.flake_id.is_remote():
|
||||||
self._flake_path = Path(nix_metadata(str(self.data.url))["path"])
|
self._flake_path = Path(nix_metadata(self.data.flake_id.url)["path"])
|
||||||
else:
|
else:
|
||||||
raise ClanError(f"Unsupported flake url: {self.data.url}")
|
raise ClanError(f"Unsupported flake url: {self.data.flake_id}")
|
||||||
|
|
||||||
assert self._flake_path is not None
|
assert self._flake_path is not None
|
||||||
return self._flake_path
|
return self._flake_path
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from clan_cli.clan_uri import ClanURI, ClanUrl
|
from clan_cli.clan_uri import ClanURI
|
||||||
|
|
||||||
|
|
||||||
def test_get_url() -> None:
|
def test_get_url() -> None:
|
||||||
@ -21,22 +21,13 @@ def test_get_url() -> None:
|
|||||||
def test_local_uri() -> None:
|
def test_local_uri() -> None:
|
||||||
# Create a ClanURI object from a local URI
|
# Create a ClanURI object from a local URI
|
||||||
uri = ClanURI("clan://file:///home/user/Downloads")
|
uri = ClanURI("clan://file:///home/user/Downloads")
|
||||||
match uri.url:
|
assert uri.flake_id.path == Path("/home/user/Downloads")
|
||||||
case ClanUrl.LOCAL.value(path):
|
|
||||||
assert path == Path("/home/user/Downloads") # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_is_remote() -> None:
|
def test_is_remote() -> None:
|
||||||
# Create a ClanURI object from a remote URI
|
# Create a ClanURI object from a remote URI
|
||||||
uri = ClanURI("clan://https://example.com")
|
uri = ClanURI("clan://https://example.com")
|
||||||
|
assert uri.flake_id.url == "https://example.com"
|
||||||
match uri.url:
|
|
||||||
case ClanUrl.REMOTE.value(url):
|
|
||||||
assert url == "https://example.com" # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_direct_local_path() -> None:
|
def test_direct_local_path() -> None:
|
||||||
@ -56,12 +47,7 @@ def test_remote_with_clanparams() -> None:
|
|||||||
uri = ClanURI("clan://https://example.com")
|
uri = ClanURI("clan://https://example.com")
|
||||||
|
|
||||||
assert uri.machine.name == "defaultVM"
|
assert uri.machine.name == "defaultVM"
|
||||||
|
assert uri.flake_id.url == "https://example.com"
|
||||||
match uri.url:
|
|
||||||
case ClanUrl.REMOTE.value(url):
|
|
||||||
assert url == "https://example.com" # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_remote_with_all_params() -> None:
|
def test_remote_with_all_params() -> None:
|
||||||
@ -69,11 +55,7 @@ def test_remote_with_all_params() -> None:
|
|||||||
assert uri.machine.name == "myVM"
|
assert uri.machine.name == "myVM"
|
||||||
assert uri._machines[1].name == "secondVM"
|
assert uri._machines[1].name == "secondVM"
|
||||||
assert uri._machines[1].params.dummy_opt == "1"
|
assert uri._machines[1].params.dummy_opt == "1"
|
||||||
match uri.url:
|
assert uri.flake_id.url == "https://example.com?password=12345"
|
||||||
case ClanUrl.REMOTE.value(url):
|
|
||||||
assert url == "https://example.com?password=12345" # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_from_str_remote() -> None:
|
def test_from_str_remote() -> None:
|
||||||
@ -82,11 +64,7 @@ def test_from_str_remote() -> None:
|
|||||||
assert uri.get_orig_uri() == "clan://https://example.com#myVM"
|
assert uri.get_orig_uri() == "clan://https://example.com#myVM"
|
||||||
assert uri.machine.name == "myVM"
|
assert uri.machine.name == "myVM"
|
||||||
assert len(uri._machines) == 1
|
assert len(uri._machines) == 1
|
||||||
match uri.url:
|
assert uri.flake_id.url == "https://example.com"
|
||||||
case ClanUrl.REMOTE.value(url):
|
|
||||||
assert url == "https://example.com" # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_from_str_local() -> None:
|
def test_from_str_local() -> None:
|
||||||
@ -95,11 +73,8 @@ def test_from_str_local() -> None:
|
|||||||
assert uri.get_orig_uri() == "clan://~/Projects/democlan#myVM"
|
assert uri.get_orig_uri() == "clan://~/Projects/democlan#myVM"
|
||||||
assert uri.machine.name == "myVM"
|
assert uri.machine.name == "myVM"
|
||||||
assert len(uri._machines) == 1
|
assert len(uri._machines) == 1
|
||||||
match uri.url:
|
assert uri.flake_id.is_local()
|
||||||
case ClanUrl.LOCAL.value(path):
|
assert str(uri.flake_id).endswith("/Projects/democlan") # type: ignore
|
||||||
assert str(path).endswith("/Projects/democlan") # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_from_str_local_no_machine() -> None:
|
def test_from_str_local_no_machine() -> None:
|
||||||
@ -108,11 +83,8 @@ def test_from_str_local_no_machine() -> None:
|
|||||||
assert uri.get_orig_uri() == "clan://~/Projects/democlan"
|
assert uri.get_orig_uri() == "clan://~/Projects/democlan"
|
||||||
assert uri.machine.name == "defaultVM"
|
assert uri.machine.name == "defaultVM"
|
||||||
assert len(uri._machines) == 1
|
assert len(uri._machines) == 1
|
||||||
match uri.url:
|
assert uri.flake_id.is_local()
|
||||||
case ClanUrl.LOCAL.value(path):
|
assert str(uri.flake_id).endswith("/Projects/democlan") # type: ignore
|
||||||
assert str(path).endswith("/Projects/democlan") # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
|
||||||
|
|
||||||
def test_from_str_local_no_machine2() -> None:
|
def test_from_str_local_no_machine2() -> None:
|
||||||
@ -121,8 +93,5 @@ def test_from_str_local_no_machine2() -> None:
|
|||||||
assert uri.get_orig_uri() == "clan://~/Projects/democlan#syncthing-peer1"
|
assert uri.get_orig_uri() == "clan://~/Projects/democlan#syncthing-peer1"
|
||||||
assert uri.machine.name == "syncthing-peer1"
|
assert uri.machine.name == "syncthing-peer1"
|
||||||
assert len(uri._machines) == 1
|
assert len(uri._machines) == 1
|
||||||
match uri.url:
|
assert uri.flake_id.is_local()
|
||||||
case ClanUrl.LOCAL.value(path):
|
assert str(uri.flake_id).endswith("/Projects/democlan") # type: ignore
|
||||||
assert str(path).endswith("/Projects/democlan") # type: ignore
|
|
||||||
case _:
|
|
||||||
assert False
|
|
||||||
|
@ -115,15 +115,15 @@ class VMObject(GObject.Object):
|
|||||||
uri = ClanURI.from_str(
|
uri = ClanURI.from_str(
|
||||||
url=self.data.flake.flake_url, machine_name=self.data.flake.flake_attr
|
url=self.data.flake.flake_url, machine_name=self.data.flake.flake_attr
|
||||||
)
|
)
|
||||||
if uri.url.is_local():
|
if uri.flake_id.is_local():
|
||||||
self.machine = Machine(
|
self.machine = Machine(
|
||||||
name=self.data.flake.flake_attr,
|
name=self.data.flake.flake_attr,
|
||||||
flake=Path(str(uri.url)),
|
flake=uri.flake_id.path,
|
||||||
)
|
)
|
||||||
if uri.url.is_remote():
|
if uri.flake_id.is_remote():
|
||||||
self.machine = Machine(
|
self.machine = Machine(
|
||||||
name=self.data.flake.flake_attr,
|
name=self.data.flake.flake_attr,
|
||||||
flake=str(uri.url),
|
flake=uri.flake_id.url,
|
||||||
)
|
)
|
||||||
yield self.machine
|
yield self.machine
|
||||||
self.machine = None
|
self.machine = None
|
||||||
|
@ -111,7 +111,7 @@ class ClanStore:
|
|||||||
del self.clan_store[vm.data.flake.flake_url][vm.data.flake.flake_attr]
|
del self.clan_store[vm.data.flake.flake_url][vm.data.flake.flake_attr]
|
||||||
|
|
||||||
def get_vm(self, uri: ClanURI) -> None | VMObject:
|
def get_vm(self, uri: ClanURI) -> None | VMObject:
|
||||||
vm_store = self.clan_store.get(str(uri.url))
|
vm_store = self.clan_store.get(str(uri.flake_id))
|
||||||
if vm_store is None:
|
if vm_store is None:
|
||||||
return None
|
return None
|
||||||
machine = vm_store.get(uri.machine.name, None)
|
machine = vm_store.get(uri.machine.name, None)
|
||||||
|
Loading…
Reference in New Issue
Block a user