src/virtualization/tests/test_serial.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_VIRTUALIZATION_TESTS_TEST_SERIAL_H_
#define SRC_VIRTUALIZATION_TESTS_TEST_SERIAL_H_

#include <lib/zx/socket.h>

#include <string>

class TestSerial {
 public:
  zx_status_t Start(zx::socket socket);

  // Executes a command and waits for a response. Uses a header and a footer to
  // ensure the command finished executing and to capture output. Blocks on the
  // serial socket being writable and readable at various points and on the
  // command completing.
  zx_status_t ExecuteBlocking(const std::string& command,
                              const std::string& prompt,
                              std::string* result = nullptr);

 private:
  // Sends a message to the guest's serial. Blocks until the entire message is
  // written to the socket but doesn't wait for a response.
  zx_status_t SendBlocking(const std::string& message);

  // Waits for a marker string to be read from the guest's serial. Optionally
  // fills |result| with everything read.
  zx_status_t WaitForMarker(const std::string& marker,
                            std::string* result = nullptr);

  zx_status_t WaitForAny();

  zx_status_t Drain();

  zx::socket socket_;
  std::string buffer_;
};

#endif  // SRC_VIRTUALIZATION_TESTS_TEST_SERIAL_H_