aboutsummaryrefslogtreecommitdiffstats
path: root/storage/src/tests/persistence/provider_error_wrapper_test.cpp
blob: b6b87b33666334b26d3384b3a2e8468abe4c5b10 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/vdstestlib/cppunit/macros.h>
#include <vespa/persistence/spi/test.h>
#include <tests/persistence/persistencetestutils.h>
#include <tests/persistence/common/persistenceproviderwrapper.h>

using storage::spi::test::makeSpiBucket;

namespace storage {

class ProviderErrorWrapperTest : public SingleDiskPersistenceTestUtils {
public:
    CPPUNIT_TEST_SUITE(ProviderErrorWrapperTest);
    CPPUNIT_TEST(fatal_error_invokes_listener);
    CPPUNIT_TEST(resource_exhaustion_error_invokes_listener);
    CPPUNIT_TEST(listener_not_invoked_on_success);
    CPPUNIT_TEST(listener_not_invoked_on_regular_errors);
    CPPUNIT_TEST(multiple_listeners_can_be_registered);
    CPPUNIT_TEST_SUITE_END();

    void fatal_error_invokes_listener();
    void resource_exhaustion_error_invokes_listener();
    void listener_not_invoked_on_success();
    void listener_not_invoked_on_regular_errors();
    void multiple_listeners_can_be_registered();
};

CPPUNIT_TEST_SUITE_REGISTRATION(ProviderErrorWrapperTest);

namespace {

struct MockErrorListener : ProviderErrorListener {
    void on_fatal_error(vespalib::stringref message) override {
        _seen_fatal_error = true;
        _fatal_error = message;
    }
    void on_resource_exhaustion_error(vespalib::stringref message) override {
        _seen_resource_exhaustion_error = true;
        _resource_exhaustion_error = message;
    }

    vespalib::string _fatal_error;
    vespalib::string _resource_exhaustion_error;
    bool _seen_fatal_error{false};
    bool _seen_resource_exhaustion_error{false};
};

struct Fixture {
    // We wrap the wrapper. It's turtles all the way down!
    PersistenceProviderWrapper providerWrapper;
    TestServiceLayerApp app;
    ServiceLayerComponent component;
    ProviderErrorWrapper errorWrapper;

    Fixture(spi::PersistenceProvider& provider)
        : providerWrapper(provider),
          app(),
          component(app.getComponentRegister(), "dummy"),
          errorWrapper(providerWrapper)
    {
        providerWrapper.setFailureMask(PersistenceProviderWrapper::FAIL_ALL_OPERATIONS);
    }
    ~Fixture() {}

    void perform_spi_operation() {
        errorWrapper.getBucketInfo(makeSpiBucket(document::BucketId(16, 1234)));
    }

    void check_no_listener_invoked_for_error(MockErrorListener& listener, spi::Result::ErrorType error) {
        providerWrapper.setResult(spi::Result(error, "beep boop"));
        perform_spi_operation();
        CPPUNIT_ASSERT(!listener._seen_fatal_error);
        CPPUNIT_ASSERT(!listener._seen_resource_exhaustion_error);
    }
};

}

void ProviderErrorWrapperTest::fatal_error_invokes_listener() {
    Fixture f(getPersistenceProvider());
    auto listener = std::make_shared<MockErrorListener>();
    f.errorWrapper.register_error_listener(listener);
    f.providerWrapper.setResult(spi::Result(spi::Result::FATAL_ERROR, "eject! eject!"));

    CPPUNIT_ASSERT(!listener->_seen_fatal_error);
    f.perform_spi_operation();

    CPPUNIT_ASSERT(!listener->_seen_resource_exhaustion_error);
    CPPUNIT_ASSERT(listener->_seen_fatal_error);
    CPPUNIT_ASSERT_EQUAL(vespalib::string("eject! eject!"), listener->_fatal_error);
}

void ProviderErrorWrapperTest::resource_exhaustion_error_invokes_listener() {
    Fixture f(getPersistenceProvider());
    auto listener = std::make_shared<MockErrorListener>();
    f.errorWrapper.register_error_listener(listener);
    f.providerWrapper.setResult(spi::Result(spi::Result::RESOURCE_EXHAUSTED, "out of juice"));

    CPPUNIT_ASSERT(!listener->_seen_resource_exhaustion_error);
    f.perform_spi_operation();

    CPPUNIT_ASSERT(!listener->_seen_fatal_error);
    CPPUNIT_ASSERT(listener->_seen_resource_exhaustion_error);
    CPPUNIT_ASSERT_EQUAL(vespalib::string("out of juice"), listener->_resource_exhaustion_error);
}

void ProviderErrorWrapperTest::listener_not_invoked_on_success() {
    Fixture f(getPersistenceProvider());
    auto listener = std::make_shared<MockErrorListener>();
    f.errorWrapper.register_error_listener(listener);
    f.perform_spi_operation();

    CPPUNIT_ASSERT(!listener->_seen_fatal_error);
    CPPUNIT_ASSERT(!listener->_seen_resource_exhaustion_error);
}

void ProviderErrorWrapperTest::listener_not_invoked_on_regular_errors() {
    Fixture f(getPersistenceProvider());
    auto listener = std::make_shared<MockErrorListener>();
    f.errorWrapper.register_error_listener(listener);

    f.check_no_listener_invoked_for_error(*listener, spi::Result::TRANSIENT_ERROR);
    f.check_no_listener_invoked_for_error(*listener, spi::Result::PERMANENT_ERROR);
}

void ProviderErrorWrapperTest::multiple_listeners_can_be_registered() {
    Fixture f(getPersistenceProvider());
    auto listener1 = std::make_shared<MockErrorListener>();
    auto listener2 = std::make_shared<MockErrorListener>();
    f.errorWrapper.register_error_listener(listener1);
    f.errorWrapper.register_error_listener(listener2);

    f.providerWrapper.setResult(spi::Result(spi::Result::RESOURCE_EXHAUSTED, "out of juice"));
    f.perform_spi_operation();

    CPPUNIT_ASSERT(listener1->_seen_resource_exhaustion_error);
    CPPUNIT_ASSERT(listener2->_seen_resource_exhaustion_error);
}

} // ns storage