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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
use std::collections::HashMap;
use crate::configuration::DEFAULT_API_URL;
use serde::{Deserialize, Serialize};
use super::path::path_from_env_or_home;
use super::{LoadError, DEFAULT_GRPC_API_URL};
pub const SETTINGS_PATH_VAR: &str = "QCS_SETTINGS_FILE_PATH";
pub(crate) async fn load() -> Result<Settings, LoadError> {
let path = path_from_env_or_home(SETTINGS_PATH_VAR, "settings.toml")?;
let content =
tokio::fs::read_to_string(&path)
.await
.map_err(|source| LoadError::FileOpenError {
path: path.clone(),
source,
})?;
toml::from_str(&content).map_err(|source| LoadError::FileParseError { path, source })
}
#[derive(Deserialize, Debug, PartialEq, Serialize)]
pub(crate) struct Settings {
pub(crate) default_profile_name: String,
#[serde(default = "default_profiles")]
pub(crate) profiles: HashMap<String, Profile>,
#[serde(default)]
pub(crate) auth_servers: HashMap<String, AuthServer>,
}
impl Default for Settings {
fn default() -> Self {
Self {
default_profile_name: "default".to_string(),
profiles: default_profiles(),
auth_servers: default_auth_servers(),
}
}
}
fn default_profiles() -> HashMap<String, Profile> {
let mut map = HashMap::with_capacity(1);
map.insert("default".to_string(), Profile::default());
map
}
fn default_auth_servers() -> HashMap<String, AuthServer> {
let mut map = HashMap::with_capacity(1);
map.insert("default".to_string(), AuthServer::default());
map
}
#[derive(Deserialize, Debug, PartialEq, Serialize)]
pub(crate) struct Profile {
pub(crate) api_url: String,
#[serde(default = "default_grpc_api_url")]
pub(crate) grpc_api_url: String,
pub(crate) auth_server_name: String,
pub(crate) credentials_name: String,
#[serde(default)]
pub(crate) applications: Applications,
}
impl Default for Profile {
fn default() -> Self {
Self {
api_url: DEFAULT_API_URL.to_string(),
grpc_api_url: DEFAULT_GRPC_API_URL.to_string(),
auth_server_name: "default".to_string(),
credentials_name: "default".to_string(),
applications: Applications::default(),
}
}
}
fn default_grpc_api_url() -> String {
DEFAULT_GRPC_API_URL.to_string()
}
#[derive(Deserialize, Debug, Default, PartialEq, Serialize)]
pub(crate) struct Applications {
pub(crate) pyquil: Pyquil,
}
#[derive(Deserialize, Debug, PartialEq, Serialize)]
pub(crate) struct Pyquil {
pub(crate) qvm_url: String,
pub(crate) quilc_url: String,
}
impl Default for Pyquil {
fn default() -> Self {
Self {
qvm_url: super::DEFAULT_QVM_URL.to_string(),
quilc_url: super::DEFAULT_QUILC_URL.to_string(),
}
}
}
#[derive(Clone, Deserialize, Debug, PartialEq, Eq, Serialize)]
pub struct AuthServer {
client_id: String,
issuer: String,
}
#[allow(clippy::missing_const_for_fn)]
impl AuthServer {
#[must_use]
pub fn client_id(&self) -> &str {
&self.client_id
}
#[must_use]
pub fn set_client_id(mut self, id: String) -> Self {
self.client_id = id;
self
}
#[must_use]
pub fn issuer(&self) -> &str {
&self.issuer
}
#[must_use]
pub fn set_issuer(mut self, issuer: String) -> Self {
self.issuer = issuer;
self
}
}
const QCS_DEFAULT_CLIENT_ID_PRODUCTION: &str = "0oa3ykoirzDKpkfzk357";
const QCS_DEFAULT_AUTH_ISSUER_PRODUCTION: &str =
"https://auth.qcs.rigetti.com/oauth2/aus8jcovzG0gW2TUG355";
impl Default for AuthServer {
fn default() -> Self {
Self {
client_id: QCS_DEFAULT_CLIENT_ID_PRODUCTION.to_string(),
issuer: QCS_DEFAULT_AUTH_ISSUER_PRODUCTION.to_string(),
}
}
}
#[cfg(test)]
mod describe_load {
use std::io::Write;
use tempfile::NamedTempFile;
use super::{load, Settings, SETTINGS_PATH_VAR};
#[tokio::test]
async fn it_returns_default_if_missing_path() {
std::env::set_var(SETTINGS_PATH_VAR, "/blah/doesnt_exist.toml");
let settings = load().await;
std::env::remove_var(SETTINGS_PATH_VAR);
assert!(settings.is_err());
}
#[tokio::test]
async fn it_loads_from_env_var_path() {
let mut file = NamedTempFile::new().expect("Failed to create temporary settings file");
let settings = Settings {
default_profile_name: "THIS IS A TEST".to_string(),
..Settings::default()
};
let settings_string =
toml::to_string(&settings).expect("Could not serialize test settings");
file.write_all(settings_string.as_bytes())
.expect("Failed to write test settings");
std::env::set_var(SETTINGS_PATH_VAR, file.path());
let loaded = load().await.expect("Failed to load settings");
assert_eq!(settings, loaded);
}
}