compose_yml 0.0.59

Parse, manipulate and serialize docker-compose.yml in a strongly-typed fashion
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
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

use super::common::*;

/// Either a local directory path, or a Git-format "URL" (not necessarily a
/// real URL, alas).
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Context {
    /// A regular local directory.
    Dir(PathBuf),
    /// A Git repository, specified using any of the usual git repository
    /// syntaxes.
    GitUrl(GitUrl),
}

impl Context {
    /// Construct a new Context from a string, identifying it as either a
    /// local path or a remote git repository.
    ///
    /// ```
    /// use compose_yml::v2 as dc;
    /// dc::Context::new("https://github.com/docker/docker.git");
    /// dc::Context::new("src/myapp");
    /// ```
    pub fn new<S: AsRef<str>>(s: S) -> Context {
        let s_ref = s.as_ref();
        if GitUrl::should_treat_as_url(s_ref) {
            // unwrap is safe here because of contract on
            // `should_treat_as_url`.
            Context::GitUrl(GitUrl::new(s_ref.to_owned()).unwrap())
        } else {
            Context::Dir(Path::new(&s_ref).to_owned())
        }
    }

    /// Returns a new Context which is the same as the
    /// this one, but without any subdirectory part
    pub fn without_repository_subdirectory(&self) -> Context {
        match self {
            Context::Dir(_) => self.clone(),
            Context::GitUrl(git_url) => {
                Context::GitUrl(git_url.without_subdirectory())
            }
        }
    }
}

impl_interpolatable_value!(Context);

impl FromStr for Context {
    type Err = Void;

    fn from_str(s: &str) -> result::Result<Self, Self::Err> {
        Ok(Context::new(s))
    }
}

impl fmt::Display for Context {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match &self {
            Context::Dir(path) => write!(f, "{}", path.display()),
            Context::GitUrl(url) => write!(f, "{}", url),
        }
    }
}

#[test]
fn context_may_contain_git_urls() {
    // See http://stackoverflow.com/a/34120821/12089
    let urls = vec![
        "git://github.com/docker/docker",
        "git@github.com:docker/docker.git",
        "git@bitbucket.org:atlassianlabs/atlassian-docker.git",
        "https://github.com/docker/docker.git",
        "http://github.com/docker/docker.git",
        "github.com/docker/docker.git",
    ];

    for url in urls {
        let context: Context = FromStr::from_str(url).unwrap();
        assert_eq!(
            context,
            Context::GitUrl(GitUrl::new(url.to_string()).unwrap())
        );
        assert_eq!(context.to_string(), url);
    }
}

#[test]
fn context_may_contain_dir_paths() {
    let paths = vec![".", "./foo", "./foo/bar/"];
    for path in paths {
        let context: Context = FromStr::from_str(path).unwrap();
        assert_eq!(context, Context::Dir(Path::new(path).to_owned()));
        assert_eq!(context.to_string(), path);
    }
}

#[test]
fn without_subdirectory_removes_the_optional_subdir() {
    let dir: Context = FromStr::from_str("./foo").unwrap();
    let plain_repo: Context =
        FromStr::from_str("git@github.com:docker/docker.git").unwrap();
    let repo_with_branch: Context =
        FromStr::from_str("git@github.com:docker/docker.git#somebranch").unwrap();
    let repo_with_subdir: Context =
        FromStr::from_str("git@github.com:docker/docker.git#:somedir").unwrap();
    let repo_with_branch_and_subdir: Context =
        FromStr::from_str("git@github.com:docker/docker.git#somebranch:somedir")
            .unwrap();

    assert_eq!(dir, dir.without_repository_subdirectory());
    assert_eq!(plain_repo, plain_repo.without_repository_subdirectory());
    assert_eq!(
        repo_with_branch,
        repo_with_branch.without_repository_subdirectory()
    );

    assert_eq!(
        plain_repo,
        repo_with_subdir.without_repository_subdirectory()
    );
    assert_eq!(
        repo_with_branch,
        repo_with_branch_and_subdir.without_repository_subdirectory()
    );
}