Merge pull request kstep#25 from tomprince/sticker-test

Add a basic test of sticker functionality.

Author: kstep

src/client.rs

@@ -22,6 +22,7 @@ use status::{ReplayGain, Status};
 use std::convert::From;
 use std::io::{BufRead, Lines, Read, Write};
 use std::net::{TcpStream, ToSocketAddrs};
+use sticker::Sticker;
 use version::Version;
 
 // Client {{{
@@ -598,8 +599,10 @@ impl<S: Read + Write> Client<S> {
     // Sticker methods {{{
     /// Show sticker value for a given object, identified by type and uri
     pub fn sticker(&mut self, typ: &str, uri: &str, name: &str) -> Result<String> {
-        self.run_command("sticker set", (typ, uri, name))
-            .and_then(|_| self.read_field("sticker"))
+        self.run_command("sticker get", (typ, uri, name))
+            // TODO: This should parse to a `Sticker` type.
+            .and_then(|_| self.read_field::<Sticker>("sticker"))
+            .map(|s| s.value)
     }
 
     /// Set sticker value for a given object, identified by type and uri

src/error.rs

@@ -370,6 +370,8 @@ pub enum ProtoError {
     BadBanner,
     /// expected some field, but it was missing
     NoField(&'static str),
+    /// expected sticker value, but didn't find it
+    BadSticker,
 }
 
 impl fmt::Display for ProtoError {
@@ -385,6 +387,7 @@ impl StdError for ProtoError {
             ProtoError::NotPair => "pair expected",
             ProtoError::BadBanner => "banner error",
             ProtoError::NoField(_) => "missing field",
+            ProtoError::BadSticker => "sticker error",
         }
     }
 }

src/lib.rs

@@ -51,6 +51,7 @@ pub mod search;
 pub mod message;
 pub mod idle;
 pub mod mount;
+mod sticker;
 
 mod proto;
 pub mod client;

src/proto.rs

@@ -162,9 +162,8 @@ pub trait Proto {
         }
     }
 
-    fn read_field<T, E>(&mut self, field: &'static str) -> Result<T>
-        where T: FromStr<Err = E>,
-              ParseError: From<E>
+    fn read_field<T: FromStr>(&mut self, field: &'static str) -> Result<T>
+        where ParseError: From<T::Err>
     {
         let (a, b) = self.read_pair()?;
         self.expect_ok()?;

src/sticker.rs

@@ -0,0 +1,23 @@
+use error::ParseError;
+use std::str::FromStr;
+
+pub struct Sticker {
+    pub name: String,
+    pub value: String,
+}
+
+impl FromStr for Sticker {
+    type Err = ParseError;
+    fn from_str(s: &str) -> Result<Sticker, ParseError> {
+        let mut parts = s.splitn(2, '=');
+        match (parts.next(), parts.next()) {
+            (Some(name), Some(value)) => {
+                Ok(Sticker {
+                    name: name.to_owned(),
+                    value: value.to_owned(),
+                })
+            }
+            _ => Err(ParseError::BadValue(s.to_owned())),
+        }
+    }
+}

tests/data/empty.flac

@@ -12,6 +12,7 @@ struct MpdConfig {
     db_file: PathBuf,
     music_directory: PathBuf,
     playlist_directory: PathBuf,
+    sticker_file: PathBuf,
     config_path: PathBuf,
     sock_path: PathBuf,
 }
@@ -25,6 +26,7 @@ impl MpdConfig {
             db_file: base.join("db"),
             music_directory: base.join("music"),
             playlist_directory: base.join("playlists"),
+            sticker_file: base.join("sticker_file"),
             config_path: base.join("config"),
             sock_path: base.join("sock"),
         }
@@ -36,6 +38,7 @@ db_file "{db_file}"
 log_file "/dev/null"
 music_directory "{music_directory}"
 playlist_directory "{playlist_directory}"
+sticker_file "{sticker_file}"
 bind_to_address "{sock_path}"
 audio_output {{
     type "null"
@@ -45,6 +48,7 @@ audio_output {{
             db_file=self.db_file.display(),
             music_directory=self.music_directory.display(),
             playlist_directory=self.playlist_directory.display(),
+            sticker_file=self.sticker_file.display(),
             sock_path=self.sock_path.display(),
         )
     }
@@ -83,11 +87,20 @@ fn sleep() {
     thread::sleep(ten_millis);
 }
 
+static EMPTY_FLAC_BYTES: &'static [u8] = include_bytes!("../data/empty.flac");
+
 impl Daemon {
     pub fn start() -> Daemon {
         let temp_dir = TempDir::new("mpd-test").unwrap();
         let config = MpdConfig::new(&temp_dir);
         config.generate();
+
+        // TODO: Factor out putting files in the music directory.
+        File::create(config.music_directory.join("empty.flac"))
+            .unwrap()
+            .write_all(EMPTY_FLAC_BYTES)
+            .unwrap();
+
         let process = Command::new("mpd")
             .arg("--no-daemon")
             .arg(&config.config_path)

tests/helpers/daemon.rs

@@ -0,0 +1,17 @@
+extern crate mpd;
+
+mod helpers;
+use helpers::connect;
+
+#[test]
+/// Creating a sticker and then getting that sticker returns the value that was set.
+fn set_sticker() {
+    let mut mpd = connect();
+
+    static VALUE: &'static str = "value";
+
+    mpd.set_sticker("song", "empty.flac", "test_sticker", VALUE).unwrap();
+
+    let sticker = mpd.sticker("song", "empty.flac", "test_sticker").unwrap();
+    assert_eq!(sticker, VALUE);
+}