d_test_stubs.cc 13.7 KB
Newer Older
1
// Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6

7
#include <config.h>
8
#include <asiolink/io_service.h>
9
#include <process/d_log.h>
10 11
#include <process/spec_config.h>
#include <process/testutils/d_test_stubs.h>
12

13
using namespace boost::asio;
14 15

namespace isc {
16
namespace process {
17

18
const char* valid_d2_config = "{ "
19
                        "\"ip-address\" : \"127.0.0.1\" , "
20
                        "\"port\" : 5031, "
21
                        "\"tsig-keys\": ["
22
                        "{ \"name\": \"d2_key.tmark.org\" , "
23
                        "   \"algorithm\": \"HMAC-MD5\" ,"
24
                        "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
25
                        "} ],"
26 27
                        "\"forward-ddns\" : {"
                        "\"ddns-domains\": [ "
28
                        "{ \"name\": \"tmark.org.\" , "
29 30 31
                        "  \"key-name\": \"d2_key.tmark.org\" , "
                        "  \"dns-servers\" : [ "
                        "  { \"ip-address\": \"127.0.0.101\" } "
32
                        "] } ] }, "
33 34
                        "\"reverse-ddns\" : {"
                        "\"ddns-domains\": [ "
35
                        "{ \"name\": \" 0.168.192.in.addr.arpa.\" , "
36 37 38
                        "  \"key-name\": \"d2_key.tmark.org\" , "
                        "  \"dns-servers\" : [ "
                        "  { \"ip-address\": \"127.0.0.101\" , "
39 40 41
                        "    \"port\": 100 } ] } "
                        "] } }";

42
// Initialize the static failure flag.
43 44
SimFailure::FailureType SimFailure::failure_type_ = SimFailure::ftNoFailure;

45
// Define custom process command supported by DStubProcess.
46
const char*  DStubProcess::stub_proc_command_("cool_proc_cmd");
47

48
DStubProcess::DStubProcess(const char* name, asiolink::IOServicePtr io_service)
49
    : DProcessBase(name, io_service, DCfgMgrBasePtr(new DStubCfgMgr())) {
50 51
};

52

53 54 55
void
DStubProcess::init() {
    if (SimFailure::shouldFailOn(SimFailure::ftProcessInit)) {
56 57
        // Simulates a failure to instantiate the process.
        isc_throw(DProcessBaseError, "DStubProcess simulated init() failure");
58 59 60
    }
};

61
void
62 63 64 65
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.
66
    // To use run(), the "managing" layer must issue an io_service::stop
67 68
    // or the call to run will continue to block, and shutdown will not
    // occur.
69
    asiolink::IOServicePtr& io_service = getIoService();
70 71 72 73
    while (!shouldShutdown()) {
        try {
            io_service->run_one();
        } catch (const std::exception& ex) {
74 75
            isc_throw (DProcessBaseError,
                std::string("Process run method failed:") + ex.what());
76 77 78 79
        }
    }
};

80 81
isc::data::ConstElementPtr
DStubProcess::shutdown(isc::data::ConstElementPtr /* args */) {
82 83 84 85
    if (SimFailure::shouldFailOn(SimFailure::ftProcessShutdown)) {
        // Simulates a failure during shutdown process.
        isc_throw(DProcessBaseError, "DStubProcess simulated shutdown failure");
    }
86

87 88 89
    setShutdownFlag(true);
    stopIOService();
    return (isc::config::createAnswer(0, "Shutdown inititiated."));
90
}
91

92
isc::data::ConstElementPtr
93
DStubProcess::configure(isc::data::ConstElementPtr config_set) {
94
    if (SimFailure::shouldFailOn(SimFailure::ftProcessConfigure)) {
95
        // Simulates a process configure failure.
96 97 98 99
        return (isc::config::createAnswer(1,
                "Simulated process configuration error."));
    }

100
    return (getCfgMgr()->parseConfig(config_set));
101 102
}

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

    return (answer);
}

DStubProcess::~DStubProcess() {
};

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

126
// Define custom controller command supported by DStubController.
127
const char* DStubController::stub_ctl_command_("spiffy");
128 129 130

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

132 133 134 135 136 137
/// @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";

138

139 140
DControllerBasePtr&
DStubController::instance() {
141
    // If the singleton hasn't been created, do it now.
142
    if (!getController()) {
143 144
        DControllerBasePtr p(new DStubController());
        setController(p);
145 146 147 148 149 150
    }

    return (getController());
}

DStubController::DStubController()
151 152
    : DControllerBase(stub_app_name_, stub_bin_name_),
      processed_signals_(), record_signal_only_(false) {
153

Tomek Mrugalski's avatar
Tomek Mrugalski committed
154 155
    if (getenv("KEA_FROM_BUILD")) {
        setSpecFileName(std::string(getenv("KEA_FROM_BUILD")) +
156
            "/src/bin/d2/dhcp-ddns.spec");
157 158 159 160 161 162 163 164
    } else {
        setSpecFileName(D2_SPECFILE_LOCATION);
    }
}

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

170 171 172 173 174
    return (false);
}

DProcessBase* DStubController::createProcess() {
    if (SimFailure::shouldFailOn(SimFailure::ftCreateProcessException)) {
175
        // Simulates a failure to instantiate the process due to exception.
176 177 178 179
        throw std::runtime_error("SimFailure::ftCreateProcess");
    }

    if (SimFailure::shouldFailOn(SimFailure::ftCreateProcessNull)) {
180
        // Simulates a failure to instantiate the process.
181 182 183 184
        return (NULL);
    }

    // This should be a successful instantiation.
185
    return (new DStubProcess(getAppName().c_str(), getIOService()));
186 187 188 189 190 191 192
}

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

    return (answer);
}

206
const std::string DStubController::getCustomOpts() const {
207 208
    // Return the "list" of custom options supported by DStubController.
    return (std::string(stub_option_x_));
209 210
}

211 212 213 214 215 216 217 218 219 220
void
DStubController::processSignal(int signum){
    processed_signals_.push_back(signum);
    if (record_signal_only_) {
        return;
    }

    DControllerBase::processSignal(signum);
}

221 222 223
DStubController::~DStubController() {
}

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 265 266 267 268
//************************** DControllerTest *************************

void
DControllerTest::writeFile(const std::string& content,
                           const std::string& module_name) {
    std::ofstream out(CFG_TEST_FILE, std::ios::trunc);
    ASSERT_TRUE(out.is_open());

    out << "{ \"" << (!module_name.empty() ? module_name
                      : getController()->getAppName())
        << "\": " << std::endl;

    out << content;
    out << " } " << std::endl;
    out.close();
}

void
DControllerTest::timedWriteCallback() {
    writeFile(new_cfg_content_);
}

void
DControllerTest::scheduleTimedWrite(const std::string& config,
                                    int write_time_ms) {
    new_cfg_content_ = config;
    write_timer_.reset(new asiolink::IntervalTimer(*getIOService()));
    write_timer_->setup(boost::bind(&DControllerTest::timedWriteCallback, this),
                        write_time_ms, asiolink::IntervalTimer::ONE_SHOT);
}

void
DControllerTest::runWithConfig(const std::string& config, int run_time_ms,
                               time_duration& elapsed_time) {
    // Create the config file.
    writeFile(config);

    // Shutdown (without error) after runtime.
    isc::asiolink::IntervalTimer timer(*getIOService());
    timer.setup(genShutdownCallback, run_time_ms);

    // Record start time, and invoke launch().
    // We catch and rethrow to allow testing error scenarios.
    ptime start = microsec_clock::universal_time();
    try  {
269 270 271 272
        // Set up valid command line arguments
        char* argv[] = { const_cast<char*>("progName"),
                         const_cast<char*>("-c"),
                         const_cast<char*>(DControllerTest::CFG_TEST_FILE),
273
                         const_cast<char*>("-d") };
274
        launch(4, argv);
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 306 307 308 309 310 311 312
    } catch (...) {
        // calculate elasped time, then rethrow it
        elapsed_time = microsec_clock::universal_time() - start;
        throw;
    }

    elapsed_time = microsec_clock::universal_time() - start;
}

DProcessBasePtr
DControllerTest:: getProcess() {
    DProcessBasePtr p;
    if (getController()) {
        p = getController()->getProcess();
    }
    return (p);
}

DCfgMgrBasePtr
DControllerTest::getCfgMgr() {
    DCfgMgrBasePtr p;
    if (getProcess()) {
        p = getProcess()->getCfgMgr();
    }

    return (p);
}

DCfgContextBasePtr
DControllerTest::getContext() {
    DCfgContextBasePtr p;
    if (getCfgMgr()) {
        p = getCfgMgr()->getContext();
    }

    return (p);
}

313
// Initialize controller wrapper's static instance getter member.
314 315
DControllerTest::InstanceGetter DControllerTest::instanceGetter_ = NULL;

316 317 318
/// @brief Defines the name of the configuration file to use
const char* DControllerTest::CFG_TEST_FILE = "d2-test-config.json";

319
//************************** ObjectParser *************************
320

321 322 323
ObjectParser::ObjectParser(const std::string& param_name,
                       ObjectStoragePtr& object_values)
    : param_name_(param_name), object_values_(object_values) {
324 325
}

326
ObjectParser::~ObjectParser(){
327 328 329
}

void
330
ObjectParser::build(isc::data::ConstElementPtr new_config) {
331 332 333 334 335 336 337 338 339
    if (SimFailure::shouldFailOn(SimFailure::ftElementBuild)) {
        // Simulates an error during element data parsing.
        isc_throw (DCfgMgrBaseError, "Simulated build exception");
    }

    value_ = new_config;
}

void
340
ObjectParser::commit() {
341 342 343 344
    if (SimFailure::shouldFailOn(SimFailure::ftElementCommit)) {
        // Simulates an error while committing the parsed element data.
        throw std::runtime_error("Simulated commit exception");
    }
345 346 347

    object_values_->setParam(param_name_, value_,
                             isc::data::Element::Position());
348 349 350 351
}

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

352
DStubContext::DStubContext(): object_values_(new ObjectStorage()) {
353 354 355 356 357 358
}

DStubContext::~DStubContext() {
}

void
359 360 361
DStubContext::getObjectParam(const std::string& name,
                             isc::data::ConstElementPtr& value) {
    value = object_values_->getParam(name);
362 363
}

364 365 366
ObjectStoragePtr&
DStubContext::getObjectStorage() {
    return (object_values_);
367 368
}

369
DCfgContextBasePtr
370
DStubContext::clone() {
371
    return (DCfgContextBasePtr(new DStubContext(*this)));
372 373 374
}

DStubContext::DStubContext(const DStubContext& rhs): DCfgContextBase(rhs),
375
    object_values_(new ObjectStorage(*(rhs.object_values_))) {
376 377 378 379 380 381 382 383 384 385 386
}

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

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

DStubCfgMgr::~DStubCfgMgr() {
}

387
DCfgContextBasePtr
388 389 390 391
DStubCfgMgr::createNewContext() {
    return (DCfgContextBasePtr (new DStubContext()));
}

392
isc::dhcp::ParserPtr
393 394
DStubCfgMgr::createConfigParser(const std::string& element_id,
                                const isc::data::Element::Position& pos) {
395 396 397
    isc::dhcp::ParserPtr parser;
    DStubContextPtr context
        = boost::dynamic_pointer_cast<DStubContext>(getContext());
398
    if (element_id == "bool_test") {
399 400 401
        parser.reset(new isc::dhcp::
                         BooleanParser(element_id,
                                       context->getBooleanStorage()));
402
    } else if (element_id == "uint32_test") {
403 404
        parser.reset(new isc::dhcp::Uint32Parser(element_id,
                                                 context->getUint32Storage()));
405
    } else if (element_id == "string_test") {
406 407
        parser.reset(new isc::dhcp::StringParser(element_id,
                                                 context->getStringStorage()));
408 409 410 411 412
    } 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)) {
413
            isc_throw(DCfgMgrBaseError,
414 415
                      "Configuration parameter not supported: " << element_id
                      << pos);
416 417
        }

418 419
        // Going to assume anything else is an object element.
        parser.reset(new ObjectParser(element_id, context->getObjectStorage()));
420 421
    }

422 423
    parsed_order_.push_back(element_id);
    return (parser);
424 425
}

426
}; // namespace isc::process
427
}; // namespace isc