1 /*
2   Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
3 
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License, version 2.0,
6   as published by the Free Software Foundation.
7 
8   This program is also distributed with certain software (including
9   but not limited to OpenSSL) that is licensed under separate terms,
10   as designated in a particular file or component or in included license
11   documentation.  The authors of MySQL hereby grant you an additional
12   permission to link the program and your derivative works with the
13   separately licensed software that they have included with MySQL.
14 
15   This program is distributed in the hope that it will be useful,
16   but WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18   GNU General Public License for more details.
19 
20   You should have received a copy of the GNU General Public License
21   along with this program; if not, write to the Free Software
22   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
23 */
24 
25 #ifndef MYSQLD_MOCK_MOCK_SESSION_INCLUDED
26 #define MYSQLD_MOCK_MOCK_SESSION_INCLUDED
27 
28 #include "statement_reader.h"
29 
30 namespace server_mock {
31 
32 class MySQLServerMockSession {
33  public:
34   MySQLServerMockSession(
35       const socket_t client_sock,
36       std::unique_ptr<StatementReaderBase> statement_processor,
37       const bool debug_mode);
38 
39   // factory method
40   // throws std::runtime_error
41   static std::unique_ptr<MySQLServerMockSession> create_session(
42       const std::string &protocol, const socket_t client_socket,
43       std::unique_ptr<StatementReaderBase> statement_processor,
44       bool debug_mode);
45 
46   virtual ~MySQLServerMockSession();
47 
48   /**
49    * process the handshake of the current connection.
50    *
51    * @throws std::system_error
52    * @returns handshake-success
53    * @retval true handshake succeeded
54    * @retval false handshake failed, close connection
55    */
56   virtual bool process_handshake() = 0;
57 
58   /**
59    * process the statements of the current connection.
60    *
61    * @pre connection must be authenticated with process_handshake() first
62    *
63    * @throws std::system_error, std::runtime_error
64    * @returns handshake-success
65    * @retval true handshake succeeded
66    * @retval false handshake failed, close connection
67    */
68   virtual bool process_statements() = 0;
69 
70   // throws std::system_error
71   virtual void send_error(const uint16_t error_code,
72                           const std::string &error_msg,
73                           const std::string &sql_state = "HY000") = 0;
74 
75   // throws std::system_error
76   virtual void send_ok(const uint64_t affected_rows = 0,
77                        const uint64_t last_insert_id = 0,
78                        const uint16_t server_status = 0,
79                        const uint16_t warning_count = 0) = 0;
80 
81   // throws std::system_error
82   virtual void send_resultset(const ResultsetResponse &response,
83                               const std::chrono::microseconds delay_ms) = 0;
84 
85   // throws std::system_error, std::runtime_error
86   void run();
87 
kill()88   void kill() noexcept { killed_ = true; }
89 
90  protected:
91   // throws std::system_error, std::runtime_error
92   virtual void handle_statement(const StatementResponse &statement);
93 
94   bool killed_{false};
95   socket_t client_socket_;
96   std::unique_ptr<StatementReaderBase> json_reader_;
97   bool debug_mode_;
98 };
99 
100 }  // namespace server_mock
101 
102 #endif  // MYSQLD_MOCK_MOCK_SESSION_INCLUDED
103