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
use {Error, regex, std, tempdir};

// RAII wrapper for a child process that kills the process when dropped.
struct AutoKillProcess(std::process::Child);

impl Drop for AutoKillProcess {
    fn drop(&mut self) {
        let AutoKillProcess(ref mut process) = *self;
        process.kill().unwrap();
        process.wait().unwrap();
    }
}

/// `FakeServer` manages a CouchDB server process for application testing.
///
/// # Summary
///
/// * `FakeServer` is an RAII-wrapper for an external CouchDB server process
///   useful for testing.
///
/// * The external CouchDB process's underlying storage persists to the system's
///   default temporary directory (e.g., `/tmp`) and is deleted when the
///   `FakeServer` instance drops.
///
/// # Remarks
///
/// `FakeServer` is a fake, not a mock, meaning an application may use it to
/// send HTTP requests to a real CouchDB server and receive real responses.
/// Consequently, this means that CouchDB must be installed on the local machine
/// in order to use `FakeServer`.
///
/// The CouchDB server will open an unused port on the local machine. The
/// application may obtain the server's exact address via the `FakeServer::url`
/// method.
///
/// The CouchDB server remains up and running for the lifetime of the
/// `FakeServer` instance. When the instance drops, the server shuts down and
/// all of its data are deleted.
///
/// # Example
///
/// ```rust
/// extern crate couchdb;
/// extern crate reqwest;
///
/// let server_url = {
///     let server = match couchdb::testing::FakeServer::new() {
///         Ok(x) => x,
///         Err(e) => {
///             println!("Is CouchDB installed locally? ({})", e);
///             return;
///         }
///     };
///
///     let mut response = reqwest::get(server.url()).unwrap();
///     assert!(response.status().is_success());
///
///     let root: couchdb::Root = response.json().unwrap();
///     println!("CouchDB welcome message: {}", root.couchdb);
///
///     server.url().to_string()
///
///     // Server shuts down when `server` goes out of scope.
/// };
///
/// // The server is now shut down, so the client request fails.
/// reqwest::get(&server_url).unwrap_err();
/// ```
///
pub struct FakeServer {
    // Rust drops structure fields in forward order, not reverse order. The
    // child process must exit before we remove the temporary directory.
    _process: AutoKillProcess,
    _tmp_root: tempdir::TempDir,
    url: String,
}

impl FakeServer {
    /// Spawns a CouchDB server process for testing.
    pub fn new() -> Result<FakeServer, Error> {

        let tmp_root = try!(tempdir::TempDir::new("couchdb_test").map_err(|e| {
            Error::from((
                "Failed to create temporary directory for CouchDB server",
                e,
            ))
        }));

        {
            use std::io::Write;
            let path = tmp_root.path().join("couchdb.conf");
            let mut f = try!(std::fs::File::create(&path).map_err(|e| {
                Error::from(("Failed to open CouchDB server configuration file", e))
            }));
            try!(
                f.write_all(
                    b"[couchdb]\n\
                database_dir = var\n\
                uri_file = couchdb.uri\n\
                view_index_dir = view\n\
                \n\
                [log]\n\
                file = couchdb.log\n\
                \n\
                [httpd]\n\
                port = 0\n\
                ",
                ).map_err(|e| {
                        Error::from(("Failed to write CouchDB server configuration file", e))
                    })
            );
        }

        let child = try!(new_test_server_command(&tmp_root).spawn().map_err(|e| {
            Error::from(("Failed to spawn CouchDB server process", e))
        }));
        let mut process = AutoKillProcess(child);

        let (tx, rx) = std::sync::mpsc::channel();
        let mut process_out;
        {
            let AutoKillProcess(ref mut process) = process;
            let stdout = std::mem::replace(&mut process.stdout, None).unwrap();
            process_out = std::io::BufReader::new(stdout);
        }

        let t = std::thread::spawn(move || {

            let re = regex::Regex::new(r"Apache CouchDB has started on (http.*)").unwrap();
            let mut line = String::new();

            loop {
                use std::io::BufRead;
                line.clear();
                process_out.read_line(&mut line).unwrap();
                let line = line.trim_right();
                match re.captures(line) {
                    None => (),
                    Some(caps) => {
                        tx.send(caps.get(1).unwrap().as_str().to_owned()).unwrap();

                        // TODO: Instead of breaking out of the loop, continue
                        // looking for URL updates due to `POST /_restart`.

                        break;
                    }
                }
            }

            // Drain stdout.
            loop {
                use std::io::BufRead;
                line.clear();
                process_out.read_line(&mut line).unwrap();
                if line.is_empty() {
                    break;
                }
            }
        });

        // Wait for the CouchDB server to start its HTTP service.
        let url = try!(rx.recv().map_err(|e| {
            t.join().unwrap_err();
            Error::from((
                "Failed to obtain URL from CouchDB server",
                std::io::Error::new(std::io::ErrorKind::Other, e),
            ))
        }));

        Ok(FakeServer {
            _process: process,
            _tmp_root: tmp_root,
            url: url,
        })
    }

    /// Returns the CouchDB server's URL.
    pub fn url(&self) -> &str {
        &self.url
    }
}

#[cfg(any(windows))]
fn new_test_server_command(tmp_root: &tempdir::TempDir) -> std::process::Command {

    // Getting a one-shot CouchDB server running on Windows is tricky:
    // http://stackoverflow.com/questions/11812365/how-to-use-a-custom-couch-ini-on-windows
    //
    // TODO: Support CouchDB being installed in a non-default directory.

    let couchdb_dir = "c:/program files (x86)/apache software foundation/couchdb";

    let erl = format!("{}/bin/erl", couchdb_dir);
    let default_ini = format!("{}/etc/couchdb/default.ini", couchdb_dir);
    let local_ini = format!("{}/etc/couchdb/local.ini", couchdb_dir);

    let mut c = std::process::Command::new(erl);
    c.arg("-couch_ini");
    c.arg(default_ini);
    c.arg(local_ini);
    c.arg("couchdb.conf");
    c.arg("-s");
    c.arg("couch");
    c.current_dir(tmp_root.path());
    c.stdout(std::process::Stdio::piped());
    c
}

#[cfg(any(not(windows)))]
fn new_test_server_command(tmp_root: &tempdir::TempDir) -> std::process::Command {
    let mut c = std::process::Command::new("couchdb");
    c.arg("-a");
    c.arg("couchdb.conf");
    c.current_dir(tmp_root.path());
    c.stdout(std::process::Stdio::piped());
    c
}