expected_errors.h

Go to the documentation of this file.

#ifndef EXPECTED_ERRORS_INCLUDED
#define EXPECTED_ERRORS_INCLUDED
 
// Copyright (c) 2018, 2024, Oracle and/or its affiliates.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
//
// This program is designed to work with certain software (including
// but not limited to OpenSSL) that is licensed under separate terms,
// as designated in a particular file or component or in included license
// documentation.  The authors of MySQL hereby grant you an additional
// permission to link the program and your derivative works with the
// separately licensed software that they have either included with
// the program or referenced in the documentation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License, version 2.0, for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
 
#include "client/mysqltest/error.h"
 
#include <memory>
#include <string>
#include <vector>
 
#define MAX_ERROR_COUNT 20
 
/// Class representing a list of error codes passed as argument to
/// mysqltest command <code>--error</code>.
class Expected_errors {
 public:
  typedef std::vector<std::unique_ptr<Error>>::iterator iterator;
 
  Expected_errors() = default;
  ~Expected_errors() = default;
 
  iterator begin() { return m_errors.begin(); }
  iterator end() { return m_errors.end(); }
 
  /// Return a sqlstate of the first error in the list.
  ///
  /// @retval SQLSTATE string
  const char *sqlstate() { return m_errors[0]->sqlstate(); }
 
  /// Return an error type of the first error in the list.
  ///
  /// @retval Error type (ERR_ERRNO or ERR_SQLSTATE)
  error_type type() { return m_errors[0]->type(); }
 
  /// Return length of the list containing errors.
  ///
  /// @retval Length value
  std::size_t count() { return m_errors.size(); }
 
  /// Return list of error codes
  ///
  /// @retval List of error codes
  std::string error_list();
 
  /// Return list of error codes in the list
  ///
  /// @retval List of error codes
  std::vector<std::uint32_t> errors();
 
  /// Return an error code of the first error in the list.
  ///
  /// @retval Error code
  unsigned int error_code() { return m_errors[0]->error_code(); }
 
  /// Add a new error to the existing list of errors.
  ///
  /// @param sqlstate SQLSTATE string
  /// @param type     Error type
  void add_error(const char *sqlstate, error_type type);
 
  /// Add a new error to the existing list of errors.
  ///
  /// @param error_code Error number
  /// @param type       Error type
  void add_error(std::uint32_t error_code, error_type type);
 
  /// Delete all errors from the vector.
  void clear_list() { m_errors.clear(); }
 
 private:
  // List containing expected errors
  std::vector<std::unique_ptr<Error>> m_errors;
};
 
#endif  // EXPECTED_ERRORS_INCLUDED