elba 0.3.0

elba is a package manager for Idris
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

//! Locking to make sure that multiple copies of `elba` don't clobber each other.
//!
//! As it is currently designed, `elba` doesn't need to lock individual files. It does, however,
//! need to lock directories to prevent other processes from using them.

use failure::{bail, format_err, Error, ResultExt};
use fs2::FileExt;
use std::{
    fs,
    path::{Path, PathBuf},
};

/// A lock on a directory. This just generates a sibling file to the directory which indicates that
/// the directory is locked.
#[derive(Debug, PartialEq, Eq)]
pub struct DirLock {
    path: PathBuf,
    lock_path: PathBuf,
}

impl DirLock {
    pub fn acquire(path: &Path) -> Result<Self, Error> {
        fs::create_dir_all(&path).with_context(|e| {
            format_err!(
                "couldn't create dir {} while locking: {}",
                path.display(),
                e
            )
        })?;

        let lock_path = path.join(".dirlock");

        let f = fs::OpenOptions::new()
            .write(true)
            .create(true)
            .open(&lock_path)
            .with_context(|e| {
                format_err!("couldn't open lockfile {}: {}", lock_path.display(), e)
            })?;

        if f.metadata()
            .with_context(|e| format_err!("couldn't get lockfile metadata: {}", e))?
            .len()
            != 0
        {
            bail!(
                "lockfile name conflict with existing file {}",
                lock_path.display()
            )
        }

        f.lock_exclusive().with_context(|e| {
            format_err!("couldn't lock lockfile {}: {}", lock_path.display(), e)
        })?;

        Ok(DirLock {
            path: path.to_path_buf(),
            lock_path,
        })
    }

    pub fn path(&self) -> &Path {
        &self.path
    }
}

impl Drop for DirLock {
    fn drop(&mut self) {
        let f = fs::OpenOptions::new()
            .read(true)
            .create(true)
            .open(&self.lock_path);

        if let Ok(f) = f {
            let _ = f.unlock();
        }

        let _ = fs::remove_file(&self.lock_path);
    }
}

#[cfg(test)]
mod test {
    extern crate tempdir;

    use super::*;
    use std::fs;

    #[test]
    fn dirlock_simple() {
        // As long as nothing panics, we're ok.
        let tmp = tempdir::TempDir::new("elba").unwrap();
        DirLock::acquire(tmp.path()).unwrap();
    }

    #[test]
    fn dirlock_wrong_order() {
        // As long as nothing panics, we're ok.
        let tmp = tempdir::TempDir::new("elba").unwrap();
        let lock = DirLock::acquire(tmp.path()).unwrap();

        // Purposely drop in the wrong order
        drop(tmp);
        drop(lock);
    }

    #[test]
    fn dirlock_existing_err() {
        let tmp = tempdir::TempDir::new("elba").unwrap();
        fs::write(tmp.path().join(".dirlock"), b"hello world").unwrap();

        let lock = DirLock::acquire(tmp.path());

        assert!(lock.is_err());
    }
}