Files
scylladb/tests/vint_serialization_test.cc
Jesse Haber-Kucharsky 91dab1d998 CQL native protocol: Add support for vint serialization
Version 5 of the native protocol for CQL [1] adds the `vint` and `unsigned vint`
types.

An unsigned integer encoded as a `vint` has a variable size based on the
magnitude of the value. The first byte indicates the total number of bytes.

For signed integers, a "zig-zag" encoding scheme ensures that small negative
values are encoded as short-length `vint`s (0 -> 0, -1 -> 1, 1 -> 2, 2 -> 3, -2
-> 4, etc).

[1] https://github.com/apache/cassandra/blob/trunk/doc/native_protocol_v5.spec
2017-08-10 14:11:30 -04:00

148 lines
4.4 KiB
C++

/*
* Copyright (C) 2017 ScyllaDB
*/
/*
* This file is part of Scylla.
*
* Scylla is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Scylla 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with Scylla. If not, see <http://www.gnu.org/licenses/>.
*/
#define BOOST_TEST_MODULE core
#include "vint-serialization.hh"
#include "bytes.hh"
#include "disk-error-handler.hh"
#include <boost/test/unit_test.hpp>
#include <array>
#include <cstdint>
#include <random>
thread_local disk_error_signal_type commit_error;
thread_local disk_error_signal_type general_disk_error;
using namespace seastar;
namespace {
typename bytes::value_type operator "" _b(unsigned long long value) {
return static_cast<bytes::value_type>(value);
}
// Check that the encoded value decodes back to the value. Also allows inspecting the encoded bytes.
template <class Vint, class BytesInspector>
void check_bytes_and_roundtrip(typename Vint::value_type value, BytesInspector&& f) {
static std::array<int8_t, 9> encoding_buffer({});
const auto size = Vint::serialize(value, encoding_buffer.begin());
const auto view = bytes_view(encoding_buffer.data(), size);
f(view);
const auto deserialized = Vint::deserialize(view);
BOOST_REQUIRE_EQUAL(deserialized.value, value);
BOOST_REQUIRE_EQUAL(deserialized.size, size);
};
// Check that the encoded value decodes back to the value.
template <class Vint>
void check_roundtrip(typename Vint::value_type value) {
check_bytes_and_roundtrip<Vint>(value, [](const bytes_view&) {});
}
template <class Integer, class RandomEngine, class Callback>
void with_random_samples(RandomEngine& rng, std::size_t count, Callback&& f) {
std::uniform_int_distribution<Integer> distribution;
for (std::size_t i = 0; i < count; ++i) {
f(distribution(rng));
}
}
template <class Vint, class RandomEngine>
void check_roundtrip_sweep(std::size_t count, RandomEngine& rng) {
with_random_samples<typename Vint::value_type>(rng, count, &check_roundtrip<Vint>);
};
auto& random_engine() {
static std::random_device rd;
static std::mt19937 rng(rd());
return rng;
}
}
BOOST_AUTO_TEST_CASE(sanity_unsigned_examples) {
using vint = unsigned_vint;
check_bytes_and_roundtrip<vint>(0, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0_b}));
});
check_bytes_and_roundtrip<vint>(5, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b0000'0101_b}));
});
check_bytes_and_roundtrip<vint>(1111, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b1000'0100_b, 0b0101'0111_b}));
});
check_bytes_and_roundtrip<vint>(256'000, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b1100'0011_b, 0b1110'1000_b, 0b0000'0000_b}));
});
check_bytes_and_roundtrip<vint>(0xff'ee'dd'cc'bb'aa'99'88, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0xff_b, 0xff_b, 0xee_b, 0xdd_b, 0xcc_b, 0xbb_b, 0xaa_b, 0x99_b, 0x88_b}));
});
}
BOOST_AUTO_TEST_CASE(sanity_unsigned_sweep) {
check_roundtrip_sweep<unsigned_vint>(100'000, random_engine());
}
BOOST_AUTO_TEST_CASE(sanity_signed_examples) {
using vint = signed_vint;
check_bytes_and_roundtrip<vint>(0, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0_b}));
});
check_bytes_and_roundtrip<vint>(-1, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b0000'0001_b}));
});
check_bytes_and_roundtrip<vint>(1, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b0000'0010_b}));
});
check_bytes_and_roundtrip<vint>(-2, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b0000'0011_b}));
});
check_bytes_and_roundtrip<vint>(2, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b0000'0100_b}));
});
check_bytes_and_roundtrip<vint>(-256'000, [](bytes_view v) {
BOOST_REQUIRE_EQUAL(v, (bytes{0b1100'0111_b, 0b1100'1111_b, 0b1111'1111_b}));
});
}
BOOST_AUTO_TEST_CASE(sanity_signed_sweep) {
check_roundtrip_sweep<signed_vint>(100'000, random_engine());
}