1// Copyright 2010 The Kyua Authors.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9//   notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright
11//   notice, this list of conditions and the following disclaimer in the
12//   documentation and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors
14//   may be used to endorse or promote products derived from this software
15//   without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29/// \file utils/cmdline/ui_mock.hpp
30/// Provides the utils::cmdline::ui_mock class.
31///
32/// This file is only supposed to be included from test program, never from
33/// production code.
34
35#if !defined(UTILS_CMDLINE_UI_MOCK_HPP)
36#define UTILS_CMDLINE_UI_MOCK_HPP
37
38#include <cstddef>
39#include <string>
40#include <vector>
41
42#include "utils/cmdline/ui.hpp"
43
44namespace utils {
45namespace cmdline {
46
47
48/// Testable interface to interact with the CLI.
49///
50/// This class records all writes to stdout and stderr to allow further
51/// inspection for testing purposes.
52class ui_mock : public ui {
53    /// Fake width of the screen; if 0, represents none.
54    std::size_t _screen_width;
55
56    /// Messages sent to stderr.
57    std::vector< std::string > _err_log;
58
59    /// Messages sent to stdout.
60    std::vector< std::string > _out_log;
61
62public:
63    ui_mock(const std::size_t = 0);
64
65    void err(const std::string&, const bool = true);
66    void out(const std::string&, const bool = true);
67    optional< std::size_t > screen_width(void) const;
68
69    const std::vector< std::string >& err_log(void) const;
70    const std::vector< std::string >& out_log(void) const;
71};
72
73
74}  // namespace cmdline
75}  // namespace utils
76
77
78#endif  // !defined(UTILS_CMDLINE_UI_MOCK_HPP)
79