Skip to content

A
abseil-cpp
Commit a3027054 by Justin Bassett Committed by Copybara-Service
Options

Delete UnvalidatedMockingBitGen 

See some relevant context on this project in https://github.com/abseil/abseil-cpp/commit/254b3a5326932026fd23923fd367619d2837f0ad. This type existed to support the incremental migration of added validation to MockingBitGen, validating that the returned value from absl::Uniform() is in bounds. All known cases where an out-of-bounds value was returned have been fixed and migrated to use MockingBitGen.

PiperOrigin-RevId: 693836317
Change-Id: I04f54b7b4856f4280580b294194ce2c25a18e9b1
parent 78ed38cf
Showing with 58 additions and 83 deletions
absl/random/internal/mock_overload_set.h
...@@ -51,9 +51,7 @@ struct MockSingleOverload<DistrT, ValidatorT, Ret(MockingBitGen&, Args...)> { ...@@ -51,9 +51,7 @@ struct MockSingleOverload<DistrT, ValidatorT, Ret(MockingBitGen&, Args...)> {
auto gmock_Call(MockURBG& gen, const ::testing::Matcher<Args>&... matchers) auto gmock_Call(MockURBG& gen, const ::testing::Matcher<Args>&... matchers)
-> decltype(MockHelpers::MockFor<KeyT>(gen, ValidatorT()) -> decltype(MockHelpers::MockFor<KeyT>(gen, ValidatorT())
.gmock_Call(matchers...)) { .gmock_Call(matchers...)) {
static_assert( static_assert(std::is_base_of<MockingBitGen, MockURBG>::value,
std::is_base_of<MockingBitGenImpl<true>, MockURBG>::value ||
std::is_base_of<MockingBitGenImpl<false>, MockURBG>::value,
"Mocking requires an absl::MockingBitGen"); "Mocking requires an absl::MockingBitGen");
return MockHelpers::MockFor<KeyT>(gen, ValidatorT()) return MockHelpers::MockFor<KeyT>(gen, ValidatorT())
.gmock_Call(matchers...); .gmock_Call(matchers...);
...@@ -74,9 +72,7 @@ struct MockSingleOverload<DistrT, ValidatorT, ...@@ -74,9 +72,7 @@ struct MockSingleOverload<DistrT, ValidatorT,
const ::testing::Matcher<Args>&... matchers) const ::testing::Matcher<Args>&... matchers)
-> decltype(MockHelpers::MockFor<KeyT>(gen, ValidatorT()) -> decltype(MockHelpers::MockFor<KeyT>(gen, ValidatorT())
.gmock_Call(matcher, matchers...)) { .gmock_Call(matcher, matchers...)) {
static_assert( static_assert(std::is_base_of<MockingBitGen, MockURBG>::value,
std::is_base_of<MockingBitGenImpl<true>, MockURBG>::value ||
std::is_base_of<MockingBitGenImpl<false>, MockURBG>::value,
"Mocking requires an absl::MockingBitGen"); "Mocking requires an absl::MockingBitGen");
return MockHelpers::MockFor<KeyT>(gen, ValidatorT()) return MockHelpers::MockFor<KeyT>(gen, ValidatorT())
.gmock_Call(matcher, matchers...); .gmock_Call(matcher, matchers...);
......
absl/random/mock_distributions_test.cc
...@@ -75,14 +75,7 @@ TEST(MockDistributions, Examples) { ...@@ -75,14 +75,7 @@ TEST(MockDistributions, Examples) {
EXPECT_EQ(absl::LogUniform<int>(gen, 0, 1000000, 2), 2040); EXPECT_EQ(absl::LogUniform<int>(gen, 0, 1000000, 2), 2040);
} }
TEST(MockUniform, OutOfBoundsIsAllowed) { TEST(MockDistributions, UniformUInt128BoundariesAreAllowed) {
absl::UnvalidatedMockingBitGen gen;
EXPECT_CALL(absl::MockUniform<int>(), Call(gen, 1, 100)).WillOnce(Return(0));
EXPECT_EQ(absl::Uniform<int>(gen, 1, 100), 0);
}
TEST(ValidatedMockDistributions, UniformUInt128Works) {
absl::MockingBitGen gen; absl::MockingBitGen gen;
EXPECT_CALL(absl::MockUniform<absl::uint128>(), Call(gen)) EXPECT_CALL(absl::MockUniform<absl::uint128>(), Call(gen))
...@@ -90,7 +83,7 @@ TEST(ValidatedMockDistributions, UniformUInt128Works) { ...@@ -90,7 +83,7 @@ TEST(ValidatedMockDistributions, UniformUInt128Works) {
EXPECT_EQ(absl::Uniform<absl::uint128>(gen), absl::Uint128Max()); EXPECT_EQ(absl::Uniform<absl::uint128>(gen), absl::Uint128Max());
} }
TEST(ValidatedMockDistributions, UniformDoubleBoundaryCases) { TEST(MockDistributions, UniformDoubleBoundaryCasesAreAllowed) {
absl::MockingBitGen gen; absl::MockingBitGen gen;
EXPECT_CALL(absl::MockUniform<double>(), Call(gen, 1.0, 10.0)) EXPECT_CALL(absl::MockUniform<double>(), Call(gen, 1.0, 10.0))
...@@ -114,7 +107,7 @@ TEST(ValidatedMockDistributions, UniformDoubleBoundaryCases) { ...@@ -114,7 +107,7 @@ TEST(ValidatedMockDistributions, UniformDoubleBoundaryCases) {
std::nextafter(1.0, std::numeric_limits<double>::infinity())); std::nextafter(1.0, std::numeric_limits<double>::infinity()));
} }
TEST(ValidatedMockDistributions, UniformDoubleEmptyRangeCases) { TEST(MockDistributions, UniformDoubleEmptyRangesAllowTheBoundary) {
absl::MockingBitGen gen; absl::MockingBitGen gen;
ON_CALL(absl::MockUniform<double>(), Call(absl::IntervalOpen, gen, 1.0, 1.0)) ON_CALL(absl::MockUniform<double>(), Call(absl::IntervalOpen, gen, 1.0, 1.0))
...@@ -134,7 +127,7 @@ TEST(ValidatedMockDistributions, UniformDoubleEmptyRangeCases) { ...@@ -134,7 +127,7 @@ TEST(ValidatedMockDistributions, UniformDoubleEmptyRangeCases) {
1.0); 1.0);
} }
TEST(ValidatedMockDistributions, UniformIntEmptyRangeCases) { TEST(MockDistributions, UniformIntEmptyRangeCasesAllowTheBoundary) {
absl::MockingBitGen gen; absl::MockingBitGen gen;
ON_CALL(absl::MockUniform<int>(), Call(absl::IntervalOpen, gen, 1, 1)) ON_CALL(absl::MockUniform<int>(), Call(absl::IntervalOpen, gen, 1, 1))
...@@ -150,7 +143,7 @@ TEST(ValidatedMockDistributions, UniformIntEmptyRangeCases) { ...@@ -150,7 +143,7 @@ TEST(ValidatedMockDistributions, UniformIntEmptyRangeCases) {
EXPECT_EQ(absl::Uniform<int>(absl::IntervalClosedOpen, gen, 1, 1), 1); EXPECT_EQ(absl::Uniform<int>(absl::IntervalClosedOpen, gen, 1, 1), 1);
} }
TEST(ValidatedMockUniformDeathTest, Examples) { TEST(MockUniformDeathTest, OutOfBoundsValuesAreRejected) {
absl::MockingBitGen gen; absl::MockingBitGen gen;
EXPECT_DEATH_IF_SUPPORTED( EXPECT_DEATH_IF_SUPPORTED(
...@@ -252,7 +245,7 @@ TEST(ValidatedMockUniformDeathTest, Examples) { ...@@ -252,7 +245,7 @@ TEST(ValidatedMockUniformDeathTest, Examples) {
" 101 is not in \\[1, 100\\]"); " 101 is not in \\[1, 100\\]");
} }
TEST(ValidatedMockUniformDeathTest, DoubleBoundaryCases) { TEST(MockUniformDeathTest, OutOfBoundsDoublesAreRejected) {
absl::MockingBitGen gen; absl::MockingBitGen gen;
EXPECT_DEATH_IF_SUPPORTED( EXPECT_DEATH_IF_SUPPORTED(
......
absl/random/mocking_bit_gen.h
...@@ -52,13 +52,53 @@ namespace random_internal { ...@@ -52,13 +52,53 @@ namespace random_internal {
template <typename> template <typename>
struct DistributionCaller; struct DistributionCaller;
class MockHelpers; class MockHelpers;
} // namespace random_internal
// Implements MockingBitGen with an option to turn on extra validation. // MockingBitGen
template <bool EnableValidation> //
class MockingBitGenImpl { // `absl::MockingBitGen` is a mock Uniform Random Bit Generator (URBG) class
// which can act in place of an `absl::BitGen` URBG within tests using the
// Googletest testing framework.
//
// Usage:
//
// Use an `absl::MockingBitGen` along with a mock distribution object (within
// mock_distributions.h) inside Googletest constructs such as ON_CALL(),
// EXPECT_TRUE(), etc. to produce deterministic results conforming to the
// distribution's API contract.
//
// Example:
//
// // Mock a call to an `absl::Bernoulli` distribution using Googletest
// absl::MockingBitGen bitgen;
//
// ON_CALL(absl::MockBernoulli(), Call(bitgen, 0.5))
// .WillByDefault(testing::Return(true));
// EXPECT_TRUE(absl::Bernoulli(bitgen, 0.5));
//
// // Mock a call to an `absl::Uniform` distribution within Googletest
// absl::MockingBitGen bitgen;
//
// ON_CALL(absl::MockUniform<int>(), Call(bitgen, testing::_, testing::_))
// .WillByDefault([] (int low, int high) {
// return low + (high - low) / 2;
// });
//
// EXPECT_EQ(absl::Uniform<int>(gen, 0, 10), 5);
// EXPECT_EQ(absl::Uniform<int>(gen, 30, 40), 35);
//
// At this time, only mock distributions supplied within the Abseil random
// library are officially supported.
//
// EXPECT_CALL and ON_CALL need to be made within the same DLL component as
// the call to absl::Uniform and related methods, otherwise mocking will fail
// since the underlying implementation creates a type-specific pointer which
// will be distinct across different DLL boundaries.
//
class MockingBitGen {
public: public:
MockingBitGenImpl() = default; MockingBitGen() = default;
~MockingBitGenImpl() = default; ~MockingBitGen() = default;
// URBG interface // URBG interface
using result_type = absl::BitGen::result_type; using result_type = absl::BitGen::result_type;
...@@ -138,25 +178,23 @@ class MockingBitGenImpl { ...@@ -138,25 +178,23 @@ class MockingBitGenImpl {
typename ValidatorT> typename ValidatorT>
auto RegisterMock(SelfT&, base_internal::FastTypeIdType type, ValidatorT) auto RegisterMock(SelfT&, base_internal::FastTypeIdType type, ValidatorT)
-> decltype(GetMockFnType(std::declval<ResultT>(), -> decltype(GetMockFnType(std::declval<ResultT>(),
std::declval<ArgTupleT>()))& { std::declval<ArgTupleT>())) & {
using ActualValidatorT =
std::conditional_t<EnableValidation, ValidatorT, NoOpValidator>;
using MockFnType = decltype(GetMockFnType(std::declval<ResultT>(), using MockFnType = decltype(GetMockFnType(std::declval<ResultT>(),
std::declval<ArgTupleT>())); std::declval<ArgTupleT>()));
using WrappedFnType = absl::conditional_t< using WrappedFnType = absl::conditional_t<
std::is_same<SelfT, ::testing::NiceMock<MockingBitGenImpl>>::value, std::is_same<SelfT, ::testing::NiceMock<MockingBitGen>>::value,
::testing::NiceMock<MockFnType>, ::testing::NiceMock<MockFnType>,
absl::conditional_t< absl::conditional_t<
std::is_same<SelfT, ::testing::NaggyMock<MockingBitGenImpl>>::value, std::is_same<SelfT, ::testing::NaggyMock<MockingBitGen>>::value,
::testing::NaggyMock<MockFnType>, ::testing::NaggyMock<MockFnType>,
absl::conditional_t< absl::conditional_t<
std::is_same<SelfT, std::is_same<SelfT,
::testing::StrictMock<MockingBitGenImpl>>::value, ::testing::StrictMock<MockingBitGen>>::value,
::testing::StrictMock<MockFnType>, MockFnType>>>; ::testing::StrictMock<MockFnType>, MockFnType>>>;
using ImplT = using ImplT =
FunctionHolderImpl<WrappedFnType, ActualValidatorT, ResultT, ArgTupleT>; FunctionHolderImpl<WrappedFnType, ValidatorT, ResultT, ArgTupleT>;
auto& mock = mocks_[type]; auto& mock = mocks_[type];
if (!mock) { if (!mock) {
mock = absl::make_unique<ImplT>(); mock = absl::make_unique<ImplT>();
...@@ -196,58 +234,6 @@ class MockingBitGenImpl { ...@@ -196,58 +234,6 @@ class MockingBitGenImpl {
// InvokeMock // InvokeMock
}; };
} // namespace random_internal
// MockingBitGen
//
// `absl::MockingBitGen` is a mock Uniform Random Bit Generator (URBG) class
// which can act in place of an `absl::BitGen` URBG within tests using the
// Googletest testing framework.
//
// Usage:
//
// Use an `absl::MockingBitGen` along with a mock distribution object (within
// mock_distributions.h) inside Googletest constructs such as ON_CALL(),
// EXPECT_TRUE(), etc. to produce deterministic results conforming to the
// distribution's API contract.
//
// Example:
//
// // Mock a call to an `absl::Bernoulli` distribution using Googletest
// absl::MockingBitGen bitgen;
//
// ON_CALL(absl::MockBernoulli(), Call(bitgen, 0.5))
// .WillByDefault(testing::Return(true));
// EXPECT_TRUE(absl::Bernoulli(bitgen, 0.5));
//
// // Mock a call to an `absl::Uniform` distribution within Googletest
// absl::MockingBitGen bitgen;
//
// ON_CALL(absl::MockUniform<int>(), Call(bitgen, testing::_, testing::_))
// .WillByDefault([] (int low, int high) {
// return low + (high - low) / 2;
// });
//
// EXPECT_EQ(absl::Uniform<int>(gen, 0, 10), 5);
// EXPECT_EQ(absl::Uniform<int>(gen, 30, 40), 35);
//
// At this time, only mock distributions supplied within the Abseil random
// library are officially supported.
//
// EXPECT_CALL and ON_CALL need to be made within the same DLL component as
// the call to absl::Uniform and related methods, otherwise mocking will fail
// since the underlying implementation creates a type-specific pointer which
// will be distinct across different DLL boundaries.
//
using MockingBitGen = random_internal::MockingBitGenImpl<true>;
// UnvalidatedMockingBitGen
//
// UnvalidatedMockingBitGen is a variant of MockingBitGen which does no extra
// validation.
using UnvalidatedMockingBitGen ABSL_DEPRECATED("Use MockingBitGen instead") =
random_internal::MockingBitGenImpl<false>;
ABSL_NAMESPACE_END ABSL_NAMESPACE_END
} // namespace absl } // namespace absl
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment