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
use std::io::{BufRead, BufReader, Write};
use std::sync::mpsc::{Sender, TryRecvError, channel};
use std::sync::{Arc, Barrier};
use std::time::Duration;
use std::thread::{self, JoinHandle};
use std::net::TcpListener;

use runner::CommandRunner;

use event::request::Request;

use serde_json;

/// The interface between an external Gherkin parser and internal [Cucumber
/// state](../state/struct.Cucumber.html)
///
/// Provided with a [CommandRunner](../runner/trait.CommandRunner.html),
/// typically a
/// [WorldRunner](../runner/struct.WorldRunner.html), this struct cna be
/// started and will monitor for
/// incoming Cucumber Wire Protocol traffic. This should not need to be
/// instantiated directly in
/// most cases, as [the start function](../fn.start.html) addresses the typical
/// use-case.
///
/// # Example
///
/// ```no_run
///
/// use cucumber::WorldRunner;
/// use cucumber::Server;
///
/// fn main() {
///   let world: u32 = 0;
///   let mut runner = WorldRunner::new(world);
///   let server = Server::new(runner);
///   let (handle, stop_rx) = server.start(None);
///
///   /*
///    * Execute remote gherkin parser
///    */
///
///   stop_rx.send(()).unwrap();
///   handle.join().unwrap();
/// }
/// ```
#[allow(dead_code)]
pub struct Server<R: CommandRunner + Send> {
  runner: R,
}

/// An "unplugged" return value from server start, for compiler reasons
///
/// The "correct" return value for
/// [Server#start](./struct.Server.html#method.start) is this server handle.
/// However, it yields a weird linker error on stable when methods are
/// invoked on it when the crate is imported (so not on local tests).
/// Therefore, we're currently returning the components of this structure as
/// a tuple for now.
///
/// See build: https://travis-ci.org/acmcarther/cucumber/jobs/116256537
/// Example Error
/// ```
/// /home/travis/build/acmcarther/cucumber-rs/examples/calculator/features/cuke.
/// rs:31: undefined reference to
/// `server::ServerHandle::wait::hd35f2fdfe2f62e1dyv
/// ```
///
pub struct ServerHandle {
  kill_sender: Sender<()>,
  handle: JoinHandle<()>,
}

impl ServerHandle {
  #[allow(dead_code)]
  pub fn stop(&mut self) {
    let _ = self.kill_sender.send(()).unwrap();
  }

  #[allow(dead_code)]
  pub fn wait(self) {
    self.handle.join().unwrap();
  }
}

impl<R: CommandRunner + Send> Server<R> {
  #[allow(dead_code)]
  pub fn new(runner: R) -> Server<R> {
    Server { runner: runner }
  }

  #[allow(dead_code)]
  pub fn start(mut self, addr: Option<&'static str>) -> (JoinHandle<()>, Sender<()>)
    where R: 'static
  {
    let addr = addr.unwrap_or("127.0.0.1:7878");
    let (stop_tx, stop_rx) = channel();
    let main_barrier = Arc::new(Barrier::new(2));
    let tcp_barrier = main_barrier.clone();

    let handle = thread::spawn(move || {
      let listener = TcpListener::bind(addr).unwrap();

      // Let the main thread know we're ready
      tcp_barrier.wait();

      // Configure tcp stream
      let (mut stream, _) = listener.accept().unwrap();
      stream.set_read_timeout(Some(Duration::new(1, 0))).unwrap();
      let mut buffered_reader = BufReader::new(stream.try_clone().unwrap());

      let mut running = true;
      while running {
        // Check for recv stop signal
        match stop_rx.try_recv() {
          Ok(()) |
          Err(TryRecvError::Disconnected) => running = false,
          _ => {
            // Read request from wire
            let mut body = String::new();
            let _ = buffered_reader.read_line(&mut body).map(|size| {
              if size == 0 {
                running = false
              } else {
                let request = serde_json::from_str::<Request>(&body);

                match request {
                  Ok(req_body) => {
                    let response = self.runner.execute_cmd(req_body);
                    let _ =
                      stream.write(format!("{}\n", serde_json::to_string(&response).unwrap())
                        .as_bytes());
                  },
                  _ => {},
                }
              }
            });
          },
        }
      }
    });

    // Wait for the server thread to have started the TcpListener
    main_barrier.wait();

    (handle, stop_tx)
  }
}

#[cfg(test)]
mod test {
  use super::*;

  use std::net::TcpStream;
  use std::io::Write;
  use std::io::BufReader;
  use std::io::BufRead;

  use event::request::Request;
  use event::response::{InvokeResponse, Response, StepMatchesResponse};

  #[test]
  fn it_makes_a_server() {
    let server = Server::new(|_| Response::BeginScenario);
    let (handle, stop_tx) = server.start(Some("127.0.0.1:1234"));
    let _ = TcpStream::connect("127.0.0.1:1234").unwrap();

    stop_tx.send(()).unwrap();
    handle.join().unwrap();
  }

  #[test]
  fn it_relays_commands_to_the_runner() {
    let server = Server::new(|req| {
      match req {
        Request::BeginScenario(_) => Response::BeginScenario,
        Request::Invoke(_) => Response::Invoke(InvokeResponse::Success),
        Request::StepMatches(_) => Response::StepMatches(StepMatchesResponse::NoMatch),
        Request::EndScenario(_) => Response::EndScenario,
        Request::SnippetText(_) => Response::SnippetText("Snippet".to_owned()),
      }
    });
    let (handle, stop_tx) = server.start(Some("127.0.0.1:1235"));
    let mut stream = TcpStream::connect("127.0.0.1:1235").unwrap();

    {
      stream.write(b"[\"begin_scenario\"]\n").unwrap();
      let mut buffered_reader = BufReader::new(stream.try_clone().unwrap());
      let mut body = String::new();
      buffered_reader.read_line(&mut body).unwrap();
      assert_eq!(body, "[\"success\"]\n");
    }

    {
      stream.write(b"[\"end_scenario\"]\n").unwrap();
      let mut buffered_reader = BufReader::new(stream.try_clone().unwrap());
      let mut body = String::new();
      buffered_reader.read_line(&mut body).unwrap();
      assert_eq!(body, "[\"success\"]\n");
    }

    {
      stream.write(b"[\"invoke\", {\"id\": \"1\", \"args\": []}]\n").unwrap();
      let mut buffered_reader = BufReader::new(stream.try_clone().unwrap());
      let mut body = String::new();
      buffered_reader.read_line(&mut body).unwrap();
      assert_eq!(body, "[\"success\"]\n");
    }

    {
      stream.write(b"[\"step_matches\", {\"name_to_match\": \"test\"}]\n").unwrap();
      let mut buffered_reader = BufReader::new(stream.try_clone().unwrap());
      let mut body = String::new();
      buffered_reader.read_line(&mut body).unwrap();
      assert_eq!(body, "[\"success\",[]]\n");
    }

    {
      stream.write(b"[\"snippet_text\", {\"step_keyword\": \"Given\", \"multiline_arg_class\": \"\", \"step_name\": \"test\"}]\n").unwrap();
      let mut buffered_reader = BufReader::new(stream.try_clone().unwrap());
      let mut body = String::new();
      buffered_reader.read_line(&mut body).unwrap();
      assert_eq!(body, "[\"success\",\"Snippet\"]\n");
    }

    stop_tx.send(()).unwrap();
    handle.join().unwrap();
  }
}