mirror of
https://github.com/boostorg/mysql.git
synced 2025-05-12 14:11:41 +00:00
fb87e840f0
Separate error categories for common, mysql and mariadb codes. DB "flavor" detection. CI mechanism to run db-specific integration tests. Recovered PCHs in cmake and made them more sane. close #108
307 lines
11 KiB
Python
Executable File
307 lines
11 KiB
Python
Executable File
#!/usr/bin/python3
|
|
#
|
|
# Copyright (c) 2019-2023 Ruben Perez Hidalgo (rubenperez038 at gmail dot com)
|
|
#
|
|
# Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
#
|
|
|
|
# This scripts generates files containing the server defined error codes,
|
|
# and code to convert from error codes to strings. This is complex because:
|
|
# - There are *a lot* of error codes.
|
|
# - There are common error codes and MariaDB/MySQL specific ones.
|
|
# - Some codes have been repurposed, renamed or removed from MySQL 5.x to MySQL 8.x and MariaDB.
|
|
# To generate precise output, we need the mysqld_error.h header for MySQL 5.x, 8.x and MariaDB.
|
|
|
|
import pandas as pd
|
|
from os import path
|
|
from pathlib import Path
|
|
from typing import Tuple, Literal, List, Optional, cast
|
|
from subprocess import run
|
|
|
|
REPO_BASE = Path(path.abspath(path.join(path.dirname(path.realpath(__file__)), '..', '..')))
|
|
|
|
# All server errors range between 1000 and 4999. Errors between 2000 and 2999
|
|
# are reserved for the client and are not used. In theory, codes between COMMON_ERROR_FIRST
|
|
# and COMMON_ERROR_LAST are shared between MySQL and MariaDB. However, some exceptions apply -
|
|
# some codes were not used originally by MySQL and are now used only by MariaDB, some have been renamed,
|
|
# etc. All codes >= COMMON_ERROR_LAST are server-specific. Codes between [COMMON_ERROR_FIRST, COMMON_ERROR_LAST)
|
|
# may be euther common or server-specific.
|
|
COMMON_ERROR_FIRST = 1000
|
|
COMMON_ERROR_LAST = 1880
|
|
SERVER_ERROR_LAST = 5000
|
|
|
|
COMMON_SERVER_ERRC_ENTRY = '''
|
|
/// Common server error. Error number: {number}, symbol:
|
|
/// <a href="https://dev.mysql.com/doc/mysql-errors/8.0/en/server-error-reference.html#error_{symbol_lower}">{symbol_upper}</a>.
|
|
{symbol_lower} = {number},
|
|
'''
|
|
|
|
COMMON_SERVER_ERRC_TEMPLATE = '''
|
|
#ifndef BOOST_MYSQL_COMMON_SERVER_ERRC_HPP
|
|
#define BOOST_MYSQL_COMMON_SERVER_ERRC_HPP
|
|
|
|
// This file was generated by server_errors.py - do not edit directly.
|
|
|
|
#include <boost/mysql/error_code.hpp>
|
|
|
|
#include <ostream>
|
|
|
|
namespace boost {{
|
|
namespace mysql {{
|
|
|
|
/**
|
|
* \\brief Server-defined error codes, shared between MySQL and MariaDB.
|
|
* \\details The numeric value and semantics match the ones described in the MySQL documentation.
|
|
* For more info, consult the error reference for
|
|
* <a href="https://dev.mysql.com/doc/mysql-errors/8.0/en/server-error-reference.html">MySQL 8.0</a>,
|
|
* <a href="https://dev.mysql.com/doc/mysql-errors/5.7/en/server-error-reference.html">MySQL 5.7</a>,
|
|
* <a href="https://mariadb.com/kb/en/mariadb-error-codes/">MariaDB</a>.
|
|
*/
|
|
enum class common_server_errc : int
|
|
{{
|
|
{}
|
|
}};
|
|
|
|
/// Creates an \\ref error_code from a \\ref common_server_errc.
|
|
inline error_code make_error_code(common_server_errc error);
|
|
|
|
}} // namespace mysql
|
|
}} // namespace boost
|
|
|
|
#include <boost/mysql/impl/error_categories.hpp>
|
|
|
|
#endif
|
|
'''
|
|
|
|
# Render the enumeration with common codes
|
|
def render_common_server_errc(df_common: pd.DataFrame) -> str:
|
|
entries = ''.join(COMMON_SERVER_ERRC_ENTRY.format(
|
|
number=r.numbr,
|
|
symbol_upper=r.symbol,
|
|
symbol_lower=r.symbol.lower()
|
|
) for r in df_common.itertuples())
|
|
return COMMON_SERVER_ERRC_TEMPLATE.format(entries)
|
|
|
|
|
|
SPECIFIC_SERVER_ERRC_ENTRY = '''
|
|
/// Server error specific to {flavor}. Error number: {number}, symbol: {symbol_upper}.
|
|
constexpr int {symbol_lower} = {number};
|
|
'''
|
|
|
|
SPECIFIC_SERVER_ERRC_TEMPLATE = '''
|
|
#ifndef BOOST_MYSQL_{flavor}_SERVER_ERRC_HPP
|
|
#define BOOST_MYSQL_{flavor}_SERVER_ERRC_HPP
|
|
|
|
// This file was generated by server_errors.py - do not edit directly.
|
|
|
|
#include <boost/system/error_category.hpp>
|
|
|
|
namespace boost {{
|
|
namespace mysql {{
|
|
|
|
namespace {flavor}_server_errc {{
|
|
{entries}
|
|
}} // namespace {flavor}_server_errc
|
|
|
|
}} // namespace mysql
|
|
}} // namespace boost
|
|
|
|
#include <boost/mysql/impl/error_categories.hpp>
|
|
|
|
#endif
|
|
'''
|
|
|
|
# Render error codes specific to a server
|
|
def render_server_specific_errc(flavor: Literal['mysql', 'mariadb'], df_db: pd.DataFrame):
|
|
entries = ''.join(SPECIFIC_SERVER_ERRC_ENTRY.format(
|
|
number=r.numbr,
|
|
symbol_upper=r.symbol,
|
|
symbol_lower=r.symbol.lower(),
|
|
flavor=flavor
|
|
) for r in df_db.itertuples())
|
|
return SPECIFIC_SERVER_ERRC_TEMPLATE.format(entries=entries, flavor=flavor)
|
|
|
|
SERVER_STRINGS_TEMPLATE_ENTRY=' case {number}: return "{symbol_lower}";\n'
|
|
|
|
SERVER_STRINGS_TEMPLATE='''
|
|
#ifndef BOOST_MYSQL_DETAIL_AUXILIAR_SERVER_ERRC_STRINGS_HPP
|
|
#define BOOST_MYSQL_DETAIL_AUXILIAR_SERVER_ERRC_STRINGS_HPP
|
|
|
|
// This file was generated by server_errors.py - do not edit directly.
|
|
|
|
namespace boost {{
|
|
namespace mysql {{
|
|
namespace detail {{
|
|
|
|
constexpr const char* common_error_messages[] = {{
|
|
{common_entries}
|
|
}};
|
|
|
|
inline const char* mysql_specific_error_to_string(int v) noexcept
|
|
{{
|
|
switch (v)
|
|
{{
|
|
{mysql_entries}
|
|
default: return "<unknown MySQL-specific server error>";
|
|
}}
|
|
}}
|
|
|
|
inline const char* mariadb_specific_error_to_string(int v) noexcept
|
|
{{
|
|
switch (v)
|
|
{{
|
|
{mariadb_entries}
|
|
default: return "<unknown MariaDB-specific server error>";
|
|
}}
|
|
}}
|
|
|
|
inline const char* get_common_error_message(int v) noexcept
|
|
{{
|
|
constexpr int first = {common_error_first};
|
|
constexpr int last = first + sizeof(common_error_messages) / sizeof(const char*);
|
|
return (v >= first && v < last) ? common_error_messages[v - first] : nullptr;
|
|
}}
|
|
|
|
}} // namespace detail
|
|
}} // namespace mysql
|
|
}} // namespace boost
|
|
|
|
#endif
|
|
'''
|
|
|
|
# Render the header to transform from codes to strings
|
|
def render_server_errc_strings(df_common: pd.DataFrame, df_mysql: pd.DataFrame, df_mariadb: pd.DataFrame) -> str:
|
|
# Common entries. We need to include non-present entries here, too (as nullptr's)
|
|
number_to_symbol = df_common.set_index('numbr')['symbol']
|
|
symbols = [cast(Optional[str], number_to_symbol.get(i)) for i in range(COMMON_ERROR_FIRST, COMMON_ERROR_LAST)]
|
|
common_entries_list = [f'"{elm.lower()}"' if elm is not None else 'nullptr' for elm in symbols]
|
|
common_entries = ''.join(f' {elm},\n' for elm in common_entries_list)
|
|
|
|
# DB specific entries
|
|
def _gen_specific_entries(df_db: pd.DataFrame) -> str:
|
|
return ''.join(SERVER_STRINGS_TEMPLATE_ENTRY.format(
|
|
number=r.numbr,
|
|
symbol_lower=r.symbol.lower()
|
|
) for r in df_db.itertuples())
|
|
mysql_entries = _gen_specific_entries(df_mysql)
|
|
mariadb_entries = _gen_specific_entries(df_mariadb)
|
|
|
|
return SERVER_STRINGS_TEMPLATE.format(
|
|
common_error_first=COMMON_ERROR_FIRST, # TODO: rename this
|
|
common_entries=common_entries,
|
|
mysql_entries=mysql_entries,
|
|
mariadb_entries=mariadb_entries
|
|
)
|
|
|
|
|
|
# Parse a header into a dataframe of (number, symbol) pairs
|
|
def parse_err_header(fname: Path) -> pd.DataFrame:
|
|
with open(fname, 'rt') as f:
|
|
lines = f.read().split('\n')
|
|
v = [elm for elm in lines if elm.startswith('#define')]
|
|
v = [elm.split(' ')[1:] for elm in v]
|
|
df = pd.DataFrame(v, columns=['symbol', 'numbr'])
|
|
df = df[~df['numbr'].isna()]
|
|
df['numbr'] = df['numbr'].astype(int)
|
|
df = df[df['numbr'] < SERVER_ERROR_LAST]
|
|
# Discard pseudo error codes that some header have
|
|
df = df[df['symbol'].map(lambda x: not (
|
|
x.startswith('ER_ERROR_FIRST') or
|
|
x.startswith('ER_ERROR_LAST') or
|
|
x == 'ER_LAST_MYSQL_ERROR_MESSAGE' or
|
|
x.startswith('ER_UNUSED')
|
|
))]
|
|
return df
|
|
|
|
|
|
# MySQL 5.x and 8.x don't fully agree on error names. Some names have been
|
|
# removed, others have been added and others have been renamed. We merge
|
|
# both so the library can be used with both systems. In case of conflict, pick the 8.x name
|
|
# (they generally add a _UNUSED suffix for the codes they no longer use).
|
|
# Some symbols appear both in 5.x and 8.x but with different values - we pick the 8.x in
|
|
# case of conflict.
|
|
def merge_mysql_errors(df_mysql5: pd.DataFrame, df_mysql8: pd.DataFrame) -> pd.DataFrame:
|
|
def resolve_symbol(r):
|
|
s5 = r['symbol_5']
|
|
s8 = r['symbol_8']
|
|
if not pd.isna(s5) and pd.isna(s8):
|
|
symbol, dbver = s5, 5
|
|
else:
|
|
symbol, dbver = s8, 8
|
|
return pd.Series(dict(numbr=r['numbr'], symbol=symbol, dbver=dbver))
|
|
|
|
return df_mysql5 \
|
|
.join(df_mysql8.set_index('numbr'), how='outer', on='numbr', lsuffix='_5', rsuffix='_8') \
|
|
.apply(resolve_symbol, axis=1) \
|
|
.sort_values(by='dbver') \
|
|
.drop_duplicates(['symbol'], keep='last') \
|
|
.drop(columns=['dbver'])
|
|
|
|
|
|
# Split between common and specific codes
|
|
def generate_error_ranges(df_mysql: pd.DataFrame, df_mariadb: pd.DataFrame) -> Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]:
|
|
# Join
|
|
joined = df_mysql.join(df_mariadb.set_index('numbr'), how='outer', on='numbr', lsuffix='_mysql', rsuffix='_mariadb')
|
|
joined = joined[joined['numbr'] < COMMON_ERROR_LAST]
|
|
|
|
# Common range
|
|
res_common = joined[joined['symbol_mysql'] == joined['symbol_mariadb']]
|
|
res_common = res_common.rename(columns={'symbol_mysql': 'symbol'}).drop(columns=['symbol_mariadb'])
|
|
|
|
# Values in the common range that differ between mysql and mariadb
|
|
joined_different = joined[joined['symbol_mysql'] != joined['symbol_mariadb']]
|
|
res_mysql_1 = joined_different[joined_different['symbol_mysql'].notna()].rename(columns={'symbol_mysql': 'symbol'}).drop(columns=['symbol_mariadb'])
|
|
res_mariadb_1 = joined_different[joined_different['symbol_mariadb'].notna()].rename(columns={'symbol_mariadb': 'symbol'}).drop(columns=['symbol_mysql'])
|
|
|
|
# Values that are outside the common range
|
|
res_mysql_2 = df_mysql[df_mysql['numbr'] >= COMMON_ERROR_LAST]
|
|
res_mariadb_2 = df_mariadb[df_mariadb['numbr'] >= COMMON_ERROR_LAST]
|
|
|
|
return (
|
|
res_common.sort_values(by='numbr'),
|
|
pd.concat([res_mysql_1, res_mysql_2]).sort_values(by='numbr'),
|
|
pd.concat([res_mariadb_1, res_mariadb_2]).sort_values(by='numbr')
|
|
)
|
|
|
|
|
|
# Actually perform the generation
|
|
def write_headers(df_common: pd.DataFrame, df_mysql: pd.DataFrame, df_mariadb: pd.DataFrame) -> None:
|
|
def header_path(p: List[str]) -> Path:
|
|
return REPO_BASE.joinpath('include', 'boost', 'mysql', *p)
|
|
|
|
# common_server_errc.hpp
|
|
with open(header_path(['common_server_errc.hpp']), 'wt') as f:
|
|
f.write(render_common_server_errc(df_common))
|
|
|
|
# mysql_server_errc.hpp
|
|
with open(header_path(['mysql_server_errc.hpp']), 'wt') as f:
|
|
f.write(render_server_specific_errc('mysql', df_mysql))
|
|
|
|
# mariadb_server_errc.hpp
|
|
with open(header_path(['mariadb_server_errc.hpp']), 'wt') as f:
|
|
f.write(render_server_specific_errc('mariadb', df_mariadb))
|
|
|
|
# detail/auxiliar/server_errc_strings.hpp
|
|
with open(header_path(['detail', 'auxiliar', 'server_errc_strings.hpp']), 'wt') as f:
|
|
f.write(render_server_errc_strings(df_common, df_mysql, df_mariadb))
|
|
|
|
|
|
# We need to run file_headers.py to set copyrights and headers
|
|
def invoke_file_headers() -> None:
|
|
run(['python', str(REPO_BASE.joinpath('tools', 'scripts', 'file_headers.py'))])
|
|
|
|
|
|
def main():
|
|
df_mysql8_header = parse_err_header(REPO_BASE.joinpath('private', 'mysqld_error.h'))
|
|
df_mysql5_header = parse_err_header(REPO_BASE.joinpath('private', 'mysql5_error.h'))
|
|
df_mariadb_header = parse_err_header(REPO_BASE.joinpath('private', 'mariadb_error.h'))
|
|
df_mysql_header = merge_mysql_errors(df_mysql5_header, df_mysql8_header)
|
|
df_common, df_mysql, df_mariadb = generate_error_ranges(df_mysql_header, df_mariadb_header)
|
|
write_headers(df_common, df_mysql, df_mariadb)
|
|
invoke_file_headers()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|