microvms-domain 1.3.0

The MicroVMs client's rules and values: sizing, cost, regions, names, errors, with no I/O
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# ARCH-6: this crate performs no I/O. A rule that reads ambient state gives different answers
# on different machines, and it can't be tested without faking that state globally, so each
# input a rule needs arrives as a parameter. The crate root denies both lints, so a hit fails
# the build.
#
# Clippy takes fully qualified paths and no wildcards, so each item is named. Crates that do
# I/O (tokio, getrandom, reqwest) never get this far: the dependency set in
# `verify/arch/placement.toml` keeps them out, and `crates/microvms-cli/tests/dependency_direction.rs`
# asserts it and each dependency's declared features. This file covers what `std` can do
# without a dependency, and the clock, time zone and entropy reads that the allowed crates
# carry: jiff's `std` feature, which the domain needs, also brings `Timestamp::now`.
#
# `allow-invalid = true` marks a path that doesn't exist in every build: a feature this crate
# doesn't enable (another member can still turn it on through feature unification), or a
# Unix-only std item on the Windows leg. Without it clippy warns that the path doesn't refer
# to a reachable item, and the ban would lapse the day the item appears.
#
# `tools/test_ratchet.py`'s `DomainLintTests` pins this list and runs real clippy over a
# call from each group, so a deleted line fails there.

disallowed-types = [
  { path = "std::fs::File", reason = "take the bytes as a parameter: the caller reads the file (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::OpenOptions", reason = "return the bytes: the caller writes the file (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::ReadDir", reason = "take the entries as a parameter: the caller lists the directory (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::process::Command", reason = "a subprocess belongs behind a port in microvms-app, implemented in microvms-edges" },
  { path = "std::net::TcpStream", reason = "network access belongs behind a port in microvms-app, implemented in microvms-edges" },
  { path = "std::net::TcpListener", reason = "network access belongs behind a port in microvms-app, implemented in microvms-edges" },
  { path = "std::net::UdpSocket", reason = "network access belongs behind a port in microvms-app, implemented in microvms-edges" },
  { path = "std::time::SystemTime", reason = "take the time as a parameter, as CalendarDate::from_unix_secs does; the caller reads the clock (the Clock port in microvms-app)" },
  { path = "std::time::Instant", reason = "take the time as a parameter; the caller reads the clock (the Clock port in microvms-app)" },
  { path = "std::fs::DirBuilder", reason = "return the path: the caller creates the directory (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::os::unix::net::UnixStream", reason = "network access belongs behind a port in microvms-app, implemented in microvms-edges", allow-invalid = true },
  { path = "std::os::unix::net::UnixListener", reason = "network access belongs behind a port in microvms-app, implemented in microvms-edges", allow-invalid = true },
  { path = "std::os::unix::net::UnixDatagram", reason = "network access belongs behind a port in microvms-app, implemented in microvms-edges", allow-invalid = true },
]

disallowed-methods = [
  { path = "std::fs::read", reason = "take the bytes as a parameter: the caller reads the file (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::read_to_string", reason = "take the text as a parameter: the caller reads the file (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::write", reason = "return the bytes: the caller writes the file (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::read_dir", reason = "take the entries as a parameter: the caller lists the directory (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::create_dir_all", reason = "return the path: the caller creates the directory (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::remove_file", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::remove_dir_all", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::rename", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::copy", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::metadata", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::symlink_metadata", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::exists", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::canonicalize", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::read_link", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::create_dir", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::remove_dir", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::hard_link", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::fs::set_permissions", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::os::unix::fs::symlink", reason = "the caller changes the filesystem (a use case in microvms-app, through a port microvms-edges implements)", allow-invalid = true },
  { path = "std::path::Path::exists", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::try_exists", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::is_file", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::is_dir", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::is_symlink", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::metadata", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::symlink_metadata", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::read_dir", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::read_link", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::path::Path::canonicalize", reason = "take what the rule needs to know about the file as a parameter (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "std::env::var", reason = "take a lookup function, the way Region::from_env does; the caller decides where variables come from" },
  { path = "std::env::var_os", reason = "take a lookup function, the way Region::from_env does; the caller decides where variables come from" },
  { path = "std::env::vars", reason = "take a lookup function, the way Region::from_env does; the caller decides where variables come from" },
  { path = "std::env::vars_os", reason = "take a lookup function, the way Region::from_env does; the caller decides where variables come from" },
  { path = "std::env::temp_dir", reason = "take the directory as a parameter; the caller reads the environment" },
  { path = "std::env::current_dir", reason = "take the directory as a parameter; the caller reads the process state" },
  { path = "std::env::args", reason = "take the arguments as a parameter; the caller parses them" },
  { path = "std::env::args_os", reason = "take the arguments as a parameter; the caller parses them" },
  { path = "std::env::home_dir", reason = "take a lookup, the way names::default_state_root does; the caller reads the environment" },
  { path = "std::env::current_exe", reason = "take the path as a parameter; the caller reads the process state" },
  { path = "std::env::set_current_dir", reason = "the caller changes the process state" },
  { path = "std::io::stdin", reason = "take the input as a parameter; the caller reads the stream" },
  { path = "std::io::stdout", reason = "return the output; the caller writes the stream" },
  { path = "std::io::stderr", reason = "return the output; the caller writes the stream" },
  { path = "std::net::ToSocketAddrs::to_socket_addrs", reason = "a name lookup is network access, which belongs behind a port in microvms-app, implemented in microvms-edges" },
  { path = "std::time::SystemTime::now", reason = "take the time as a parameter, as CalendarDate::from_unix_secs does; the caller reads the clock (the Clock port in microvms-app)" },
  { path = "std::time::Instant::now", reason = "take the time as a parameter; the caller reads the clock (the Clock port in microvms-app)" },
  { path = "std::thread::sleep", reason = "a rule doesn't wait; the caller owns time (a use case in microvms-app, through a port microvms-edges implements)" },
  { path = "jiff::Timestamp::now", reason = "take the time as a parameter, as CalendarDate::from_unix_secs does; the caller reads the clock (the Clock port in microvms-app)" },
  { path = "jiff::Zoned::now", reason = "take the time as a parameter, as CalendarDate::from_unix_secs does; the caller reads the clock (the Clock port in microvms-app)" },
  { path = "jiff::tz::TimeZone::system", reason = "rate-table age is UTC; the system zone is ambient state (TZ, /etc/localtime)", allow-invalid = true },
  { path = "jiff::tz::TimeZone::try_system", reason = "rate-table age is UTC; the system zone is ambient state (TZ, /etc/localtime)", allow-invalid = true },
  { path = "jiff::tz::TimeZone::get", reason = "a named zone is read from the tz database on disk; rate-table age is UTC", allow-invalid = true },
  { path = "jiff::tz::db", reason = "the tz database is read from disk; rate-table age is UTC", allow-invalid = true },
  { path = "x25519_dalek::StaticSecret::random", reason = "take the seed as a parameter, as LaunchIdentity::from_seeds does; the caller draws it (the Entropy port in microvms-app)", allow-invalid = true },
  { path = "x25519_dalek::ReusableSecret::random", reason = "take the seed as a parameter, as LaunchIdentity::from_seeds does; the caller draws it (the Entropy port in microvms-app)", allow-invalid = true },
  { path = "x25519_dalek::EphemeralSecret::random", reason = "take the seed as a parameter, as LaunchIdentity::from_seeds does; the caller draws it (the Entropy port in microvms-app)", allow-invalid = true },
]