d_test_stubs.cc 11 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Copyright (C) 2013  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

15
#include <d2/d2_log.h>
16 17 18 19 20 21 22 23
#include <d2/spec_config.h>
#include <d2/tests/d_test_stubs.h>

using namespace asio;

namespace isc {
namespace d2 {

24 25
const char* valid_d2_config = "{ "
                        "\"interface\" : \"eth1\" , "
26 27
                        "\"ip_address\" : \"127.0.0.1\" , "
                        "\"port\" : 5031, "
28 29
                        "\"tsig_keys\": ["
                        "{ \"name\": \"d2_key.tmark.org\" , "
30
                        "   \"algorithm\": \"HMAC-MD5\" ,"
31
                        "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
32
                        "} ],"
33 34
                        "\"forward_ddns\" : {"
                        "\"ddns_domains\": [ "
35
                        "{ \"name\": \"tmark.org.\" , "
36 37 38
                        "  \"key_name\": \"d2_key.tmark.org\" , "
                        "  \"dns_servers\" : [ "
                        "  { \"hostname\": \"one.tmark\" } "
39
                        "] } ] }, "
40 41 42 43 44 45 46 47 48
                        "\"reverse_ddns\" : {"
                        "\"ddns_domains\": [ "
                        "{ \"name\": \" 0.168.192.in.addr.arpa.\" , "
                        "  \"key_name\": \"d2_key.tmark.org\" , "
                        "  \"dns_servers\" : [ "
                        "  { \"ip_address\": \"127.0.0.101\" , "
                        "    \"port\": 100 } ] } "
                        "] } }";

49
// Initialize the static failure flag.
50 51
SimFailure::FailureType SimFailure::failure_type_ = SimFailure::ftNoFailure;

52
// Define custom process command supported by DStubProcess.
53
const char*  DStubProcess::stub_proc_command_("cool_proc_cmd");
54

55
DStubProcess::DStubProcess(const char* name, IOServicePtr io_service)
56
    : DProcessBase(name, io_service, DCfgMgrBasePtr(new DStubCfgMgr())) {
57 58 59 60 61
};

void
DStubProcess::init() {
    if (SimFailure::shouldFailOn(SimFailure::ftProcessInit)) {
62 63
        // Simulates a failure to instantiate the process.
        isc_throw(DProcessBaseError, "DStubProcess simulated init() failure");
64 65 66
    }
};

67
void
68 69 70 71
DStubProcess::run() {
    // Until shut down or an fatal error occurs, wait for and
    // execute a single callback. This is a preliminary implementation
    // that is likely to evolve as development progresses.
72
    // To use run(), the "managing" layer must issue an io_service::stop
73 74 75 76 77 78 79
    // or the call to run will continue to block, and shutdown will not
    // occur.
    IOServicePtr& io_service = getIoService();
    while (!shouldShutdown()) {
        try {
            io_service->run_one();
        } catch (const std::exception& ex) {
80 81
            isc_throw (DProcessBaseError,
                std::string("Process run method failed:") + ex.what());
82 83 84 85
        }
    }
};

86 87
isc::data::ConstElementPtr
DStubProcess::shutdown(isc::data::ConstElementPtr /* args */) {
88 89 90 91
    if (SimFailure::shouldFailOn(SimFailure::ftProcessShutdown)) {
        // Simulates a failure during shutdown process.
        isc_throw(DProcessBaseError, "DStubProcess simulated shutdown failure");
    }
92

93 94 95
    setShutdownFlag(true);
    stopIOService();
    return (isc::config::createAnswer(0, "Shutdown inititiated."));
96
}
97

98
isc::data::ConstElementPtr
99
DStubProcess::configure(isc::data::ConstElementPtr /*config_set*/) {
100
    if (SimFailure::shouldFailOn(SimFailure::ftProcessConfigure)) {
101
        // Simulates a process configure failure.
102 103 104 105 106 107 108
        return (isc::config::createAnswer(1,
                "Simulated process configuration error."));
    }

    return (isc::config::createAnswer(0, "Configuration accepted."));
}

109 110
isc::data::ConstElementPtr
DStubProcess::command(const std::string& command,
111
                      isc::data::ConstElementPtr /* args */) {
112 113
    isc::data::ConstElementPtr answer;
    if (SimFailure::shouldFailOn(SimFailure::ftProcessCommand)) {
114
        // Simulates a process command execution failure.
115 116
        answer = isc::config::createAnswer(COMMAND_ERROR,
                                          "SimFailure::ftProcessCommand");
117
    } else if (command.compare(stub_proc_command_) == 0) {
118 119 120 121 122 123 124 125 126 127 128 129 130 131
        answer = isc::config::createAnswer(COMMAND_SUCCESS, "Command accepted");
    } else {
        answer = isc::config::createAnswer(COMMAND_INVALID,
                                           "Unrecognized command:" + command);
    }

    return (answer);
}

DStubProcess::~DStubProcess() {
};

//************************** DStubController *************************

132
// Define custom controller command supported by DStubController.
133
const char* DStubController::stub_ctl_command_("spiffy");
134 135 136

// Define custom command line option command supported by DStubController.
const char* DStubController::stub_option_x_ = "x";
137

138 139 140 141 142 143
/// @brief Defines the app name used to construct the controller
const char* DStubController::stub_app_name_ = "TestService";

/// @brief Defines the bin name used to construct the controller
const char* DStubController::stub_bin_name_ = "TestBin";

144 145
DControllerBasePtr&
DStubController::instance() {
146
    // If the singleton hasn't been created, do it now.
147
    if (!getController()) {
148 149
        DControllerBasePtr p(new DStubController());
        setController(p);
150 151 152 153 154 155
    }

    return (getController());
}

DStubController::DStubController()
156
    : DControllerBase(stub_app_name_, stub_bin_name_) {
157 158 159

    if (getenv("B10_FROM_BUILD")) {
        setSpecFileName(std::string(getenv("B10_FROM_BUILD")) +
160
            "/src/bin/d2/dhcp-ddns.spec");
161 162 163 164 165 166 167 168
    } else {
        setSpecFileName(D2_SPECFILE_LOCATION);
    }
}

bool
DStubController::customOption(int option, char* /* optarg */)
{
169
    // Check for the custom option supported by DStubController.
170
    if (static_cast<char>(option) == *stub_option_x_) {
171
        return (true);
172
    }
173

174 175 176 177 178
    return (false);
}

DProcessBase* DStubController::createProcess() {
    if (SimFailure::shouldFailOn(SimFailure::ftCreateProcessException)) {
179
        // Simulates a failure to instantiate the process due to exception.
180 181 182 183
        throw std::runtime_error("SimFailure::ftCreateProcess");
    }

    if (SimFailure::shouldFailOn(SimFailure::ftCreateProcessNull)) {
184
        // Simulates a failure to instantiate the process.
185 186 187 188
        return (NULL);
    }

    // This should be a successful instantiation.
189
    return (new DStubProcess(getAppName().c_str(), getIOService()));
190 191 192 193 194 195 196
}

isc::data::ConstElementPtr
DStubController::customControllerCommand(const std::string& command,
                                     isc::data::ConstElementPtr /* args */) {
    isc::data::ConstElementPtr answer;
    if (SimFailure::shouldFailOn(SimFailure::ftControllerCommand)) {
197
        // Simulates command failing to execute.
198 199
        answer = isc::config::createAnswer(COMMAND_ERROR,
                                          "SimFailure::ftControllerCommand");
200
    } else if (command.compare(stub_ctl_command_) == 0) {
201 202 203 204 205 206 207 208 209
        answer = isc::config::createAnswer(COMMAND_SUCCESS, "Command accepted");
    } else {
        answer = isc::config::createAnswer(COMMAND_INVALID,
                                           "Unrecognized command:" + command);
    }

    return (answer);
}

210
const std::string DStubController::getCustomOpts() const {
211 212
    // Return the "list" of custom options supported by DStubController.
    return (std::string(stub_option_x_));
213 214 215 216 217
}

DStubController::~DStubController() {
}

218
// Initialize controller wrapper's static instance getter member.
219 220
DControllerTest::InstanceGetter DControllerTest::instanceGetter_ = NULL;

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
//************************** TestParser *************************

TestParser::TestParser(const std::string& param_name):param_name_(param_name) {
}

TestParser::~TestParser(){
}

void
TestParser::build(isc::data::ConstElementPtr new_config) {
    if (SimFailure::shouldFailOn(SimFailure::ftElementBuild)) {
        // Simulates an error during element data parsing.
        isc_throw (DCfgMgrBaseError, "Simulated build exception");
    }

    value_ = new_config;
}

void
TestParser::commit() {
    if (SimFailure::shouldFailOn(SimFailure::ftElementCommit)) {
        // Simulates an error while committing the parsed element data.
        throw std::runtime_error("Simulated commit exception");
    }
}

//************************** DStubContext *************************

DStubContext::DStubContext(): extra_values_(new isc::dhcp::Uint32Storage()) {
}

DStubContext::~DStubContext() {
}

void
DStubContext::getExtraParam(const std::string& name, uint32_t& value) {
    value = extra_values_->getParam(name);
}

isc::dhcp::Uint32StoragePtr
DStubContext::getExtraStorage() {
    return (extra_values_);
}

265
DCfgContextBasePtr
266
DStubContext::clone() {
267
    return (DCfgContextBasePtr(new DStubContext(*this)));
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
}

DStubContext::DStubContext(const DStubContext& rhs): DCfgContextBase(rhs),
    extra_values_(new isc::dhcp::Uint32Storage(*(rhs.extra_values_))) {
}

//************************** DStubCfgMgr *************************

DStubCfgMgr::DStubCfgMgr()
    : DCfgMgrBase(DCfgContextBasePtr(new DStubContext())) {
}

DStubCfgMgr::~DStubCfgMgr() {
}

isc::dhcp::ParserPtr
DStubCfgMgr::createConfigParser(const std::string& element_id) {
    isc::dhcp::DhcpConfigParser* parser = NULL;
    DStubContextPtr context =
                    boost::dynamic_pointer_cast<DStubContext>(getContext());

    if (element_id == "bool_test") {
        parser = new isc::dhcp::BooleanParser(element_id,
                                              context->getBooleanStorage());
    } else if (element_id == "uint32_test") {
        parser = new isc::dhcp::Uint32Parser(element_id,
                                             context->getUint32Storage());
    } else if (element_id == "string_test") {
        parser = new isc::dhcp::StringParser(element_id,
                                             context->getStringStorage());
    } else if (element_id == "extra_test") {
        parser = new isc::dhcp::Uint32Parser(element_id,
                                             context->getExtraStorage());
    } else {
        // Fail only if SimFailure dictates we should.  This makes it easier
        // to test parse ordering, by permitting a wide range of element ids
        // to "succeed" without specifically supporting them.
        if (SimFailure::shouldFailOn(SimFailure::ftElementUnknown)) {
306
            isc_throw(DCfgMgrBaseError, "Configuration parameter not supported: "
307 308 309 310 311 312 313 314 315 316 317
                      << element_id);
        }

        parsed_order_.push_back(element_id);
        parser = new TestParser(element_id);
    }

    return (isc::dhcp::ParserPtr(parser));
}


318
}; // namespace isc::d2
319
}; // namespace isc