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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
use std::cell::{RefCell, RefMut};
use std::fmt;
use std::fs::File;
use std::io::Read;
use std::ops::Deref;
use std::path::Path;

use bollard::Docker;
use clap::crate_version;
use hyper::client::connect::Connect;
use lazy_static::lazy_static;
use regex::Regex;
use serde::de::{self, Deserializer, Unexpected, Visitor};
use serde::ser::Serializer;
use serde::{Deserialize, Serialize};

use crate::data_dir::DataDirectory;
use crate::prelude::*;
use crate::repository::RepositoryManager;

pub mod data_dir;
pub mod docker;
pub mod error;
pub mod ops;
pub mod prelude;
pub mod problem;
pub mod repository;
pub mod template;

pub const VERSION: &str = crate_version!();

pub trait Printer {
    type Handle;

    fn get_current_handle(&mut self) -> Self::Handle;
    fn write_line_at(&mut self, handle: &Self::Handle, message: &str);
    fn write_line(&mut self, message: &str);
}

pub struct Environment<'a, C: 'static, P: Printer + 'static> {
    username: NameString,
    repo_manager: RepositoryManager<'a>,
    docker: Docker<C>,
    printer: RefCell<P>,
}

impl<'a, C, P> Environment<'a, C, P>
where
    C: Connect,
    P: Printer,
{
    pub fn new(
        username: String,
        data_dir: &'a mut DataDirectory,
        docker: Docker<C>,
        printer: P,
    ) -> SomaResult<Environment<'a, C, P>> {
        let repo_manager = data_dir.register::<RepositoryManager>()?;
        let username = NameString::try_from(username)?;

        Ok(Environment {
            username,
            repo_manager,
            docker,
            printer: RefCell::new(printer),
        })
    }

    pub fn username(&self) -> &NameString {
        &self.username
    }

    pub fn printer(&self) -> RefMut<P> {
        self.printer.borrow_mut()
    }

    pub fn repo_manager(&self) -> &RepositoryManager<'a> {
        &self.repo_manager
    }

    pub fn repo_manager_mut(&mut self) -> &mut RepositoryManager<'a> {
        &mut self.repo_manager
    }
}

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct NameString {
    inner: String,
}

lazy_static! {
    static ref NAME_REGEX: Regex = Regex::new(r"^[a-z0-9]+((?:_|__|[-]*)[a-z0-9]+)*$").unwrap();
}

impl NameString {
    // TODO: Use TryFrom trait when Rust stabilizes it.
    pub fn try_from(s: impl AsRef<str>) -> SomaResult<NameString> {
        let s = s.as_ref();
        if NAME_REGEX.is_match(s) {
            Ok(NameString {
                inner: s.to_owned(),
            })
        } else {
            Err(SomaError::InvalidName)?
        }
    }
}

impl PartialEq<String> for NameString {
    fn eq(&self, other: &String) -> bool {
        &self.inner == other
    }
}

impl PartialEq<str> for NameString {
    fn eq(&self, other: &str) -> bool {
        self.inner == other
    }
}

impl PartialEq<NameString> for String {
    fn eq(&self, other: &NameString) -> bool {
        self == &other.inner
    }
}

impl PartialEq<NameString> for str {
    fn eq(&self, other: &NameString) -> bool {
        self == other.inner
    }
}

impl fmt::Display for NameString {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.inner)
    }
}

impl Deref for NameString {
    type Target = String;

    fn deref(&self) -> &String {
        &self.inner
    }
}

impl AsRef<str> for NameString {
    fn as_ref(&self) -> &str {
        &self.inner
    }
}

impl AsRef<Path> for NameString {
    fn as_ref(&self) -> &Path {
        Path::new(&self.inner)
    }
}

impl Serialize for NameString {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.as_ref())
    }
}

impl<'de> Deserialize<'de> for NameString {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        deserializer.deserialize_str(NameStringVisitor)
    }
}

struct NameStringVisitor;

impl<'de> Visitor<'de> for NameStringVisitor {
    type Value = NameString;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        write!(formatter, "a string satisfying docker name component rules")
    }

    fn visit_str<E>(self, s: &str) -> Result<Self::Value, E>
    where
        E: de::Error,
    {
        let name = NameString::try_from(s);
        match name {
            Ok(name) => Ok(name),
            Err(_) => Err(de::Error::invalid_value(Unexpected::Str(s), &self)),
        }
    }
}

fn read_file_contents(path: impl AsRef<Path>) -> SomaResult<Vec<u8>> {
    let mut file = File::open(path)?;
    let mut contents = Vec::new();
    file.read_to_end(&mut contents)?;
    Ok(contents)
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_test::{assert_de_tokens_error, assert_tokens, Token};

    #[test]
    fn test_name_eq() {
        assert_eq!("asdf", &NameString::try_from("asdf").unwrap());
        assert_eq!(&NameString::try_from("asdf").unwrap(), "asdf");
        assert_eq!(String::from("asdf"), NameString::try_from("asdf").unwrap());
        assert_eq!(NameString::try_from("asdf").unwrap(), String::from("asdf"));
        assert_ne!("qwer", &NameString::try_from("asdf").unwrap());
        assert_ne!(&NameString::try_from("qwer").unwrap(), "asdf");
        assert_ne!(String::from("qwer"), NameString::try_from("asdf").unwrap());
        assert_ne!(NameString::try_from("qwer").unwrap(), String::from("asdf"));
    }

    #[test]
    fn test_name_serde() {
        assert_tokens(
            &NameString::try_from("asdf0").unwrap(),
            &[Token::Str("asdf0")],
        );
        assert_tokens(
            &NameString::try_from("asdf0_qwer").unwrap(),
            &[Token::Str("asdf0_qwer")],
        );
        assert_tokens(
            &NameString::try_from("asdf0__qwer").unwrap(),
            &[Token::Str("asdf0__qwer")],
        );
        assert_tokens(
            &NameString::try_from("asdf0-qwer").unwrap(),
            &[Token::Str("asdf0-qwer")],
        );
        assert_tokens(
            &NameString::try_from("asdf0--qwer").unwrap(),
            &[Token::Str("asdf0--qwer")],
        );
        assert_tokens(
            &NameString::try_from("asdf0---qwer").unwrap(),
            &[Token::Str("asdf0---qwer")],
        );
    }

    #[test]
    fn test_name_de_error() {
        assert_de_tokens_error::<NameString>(
            &[Token::Str("")],
            "invalid value: string \"\", expected a string satisfying docker name component rules",
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("ASDF")
            ], "invalid value: string \"ASDF\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("AS@DF")
            ], "invalid value: string \"AS@DF\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("asdf0.qwer")
            ], "invalid value: string \"asdf0.qwer\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("asdf..qwer")
            ], "invalid value: string \"asdf..qwer\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("asdf___qwer")
            ], "invalid value: string \"asdf___qwer\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("asdf.")
            ], "invalid value: string \"asdf.\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("asdf_")
            ], "invalid value: string \"asdf_\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("asdf-")
            ], "invalid value: string \"asdf-\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str(".asdf")
            ], "invalid value: string \".asdf\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("_asdf")
            ], "invalid value: string \"_asdf\", expected a string satisfying docker name component rules"
        );
        assert_de_tokens_error::<NameString>(&[
                Token::Str("-asdf")
            ], "invalid value: string \"-asdf\", expected a string satisfying docker name component rules"
        );
    }
}