File: TestKillCmd.cpp

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (155 lines) | stat: -rw-r--r-- 6,113 bytes parent folder | download
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
144
145
146
147
148
149
150
151
152
153
154
155
/*
 * Copyright 2009- ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation
 * nor does it submit to any jurisdiction.
 */

#include <iostream>

#include <boost/test/unit_test.hpp>

#include "ServerTestHarness.hpp"
#include "TestFixture.hpp"
#include "ecflow/attribute/VerifyAttr.hpp"
#include "ecflow/base/cts/ClientToServerCmd.hpp"
#include "ecflow/core/AssertTimer.hpp"
#include "ecflow/core/File.hpp"
#include "ecflow/core/PrintStyle.hpp"
#include "ecflow/core/Timer.hpp"
#include "ecflow/node/Defs.hpp"
#include "ecflow/node/Family.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/Task.hpp"
#include "ecflow/node/formatter/DefsWriter.hpp"
#include "ecflow/test/scaffold/Naming.hpp"

using namespace std;
using namespace ecf;

///
/// \note This is used to INVOKE a SINGLE test. Easier for debugging
///

BOOST_AUTO_TEST_SUITE(S_Test)

BOOST_AUTO_TEST_SUITE(T_KillCmd)

// forward declare functions
static bool kill_cmd(bool kill_task);
static bool waitForTaskState(NState::State state, int max_time_to_wait);

// test:: test the kill command. Create a task that runs a long time
// The associated job is then killed. This should leave task in aborted state
BOOST_AUTO_TEST_CASE(test_kill_cmd) {
    ECF_NAME_THIS_TEST();

    DurationTimer timer;
    TestClean clean_at_start_and_end;
    BOOST_REQUIRE_MESSAGE(kill_cmd(true), " kill of task '/test_kill_cmd/family/t0' failed");
    cout << timer.duration() << "\n";
}

BOOST_AUTO_TEST_CASE(test_hierarchical_kill_cmd) {
    ECF_NAME_THIS_TEST();

    DurationTimer timer;
    TestClean clean_at_start_and_end;
    BOOST_REQUIRE_MESSAGE(kill_cmd(false), "kill of suite '/test_kill_cmd' failed");
    cout << timer.duration() << "\n";
}

static bool kill_cmd(bool kill_task) {
    /// Create dir location for log file.
    std::string defs_location = ServerTestHarness::testDataDefsLocation("test_kill_cmd.def");
    fs::path new_path         = defs_location;
    if (!fs::exists(new_path.parent_path())) {
        File::createMissingDirectories(new_path.parent_path().string());
    }

    Defs theDefs;
    std::string kill_path;
    {
        suite_ptr suite;
        if (kill_task) {
            suite = theDefs.add_suite("test_kill_task");
        }
        else {
            suite = theDefs.add_suite("test_kill_suite");
        }
        suite->addVariable(Variable("ECF_TRIES", "1")); // do not try again
        family_ptr fam = suite->add_family("family");
        task_ptr task  = fam->add_task("t0");
        task->addMeter(Meter("meter", 0, 200, 100)); // Make sure it run long enough, to receive kill, on slow systems
        task->addVerify(VerifyAttr(NState::ABORTED, 1)); // task should abort 1 times
        if (kill_task) {
            kill_path = task->absNodePath();
        }
        else {
            kill_path = suite->absNodePath();
        }
    }

    // *******************************************************************
    // Important: The following will *not* work:
    //    theDefs.set_server().add_or_update_variables("ECF_TRIES","1");                     // Override ECF_TRIES so
    //    don't try to restart aborted jobs theDefs.set_server().add_or_update_variables("ECF_KILL_CMD","kill -15
    //    %ECF_RID%"); // Provide a mechanism to kill the running job
    // Since calling the begin command in the server,
    // will update the defs with the server environment, and hence overriding
    // any env variable of the same name, set here. Hence just use addVariable as above.
    // *************************************************************************

    // The test harness will create corresponding directory structure & default ecf file
    ServerTestHarness serverTestHarness;
    serverTestHarness.run(theDefs, defs_location, 1 /*timeout*/, false /* don't wait for test to finish */);

    // cout << "test_kill_cmd Waiting for task to become active\n";
    TestFixture::client().set_throw_on_error(false);
    (void)waitForTaskState(NState::ACTIVE, 10);

    // cout << "test_kill_cmd Now kill the active jobs\n";
    BOOST_REQUIRE_MESSAGE(TestFixture::client().kill(kill_path) == 0,
                          CtsApi::to_string(CtsApi::kill(kill_path)) << " failed should return 0.\n"
                                                                     << TestFixture::client().errorMsg());

    // cout << "test_kill_cmd Wait for the task to be aborted\n";
    return waitForTaskState(NState::ABORTED, 20);
}

static bool waitForTaskState(NState::State state, int max_time_to_wait) {
    AssertTimer assertTimer(max_time_to_wait, false); // Bomb out after n seconds, fall back if test fail
    while (1) {
        BOOST_REQUIRE_MESSAGE(TestFixture::client().sync_local() == 0,
                              "sync_local failed should return 0\n"
                                  << TestFixture::client().errorMsg());
        defs_ptr defs = TestFixture::client().defs();
        vector<Task*> tasks;
        defs->getAllTasks(tasks);
        for (Task* task : tasks) {
            if (task->state() == state) {
                return true;
            }
        }

        // make sure test does not take too long.
        if (assertTimer.duration() >= assertTimer.timeConstraint()) {
            BOOST_REQUIRE_MESSAGE(assertTimer.duration() < assertTimer.timeConstraint(),
                                  "waitForTaskState "
                                      << NState::toString(state) << " Test wait " << assertTimer.duration()
                                      << " taking longer than time constraint of " << assertTimer.timeConstraint()
                                      << " aborting\n"
                                      << ecf::as_string(*defs, PrintStyle::DEFS));
            break;
        }
        sleep(2);
    }
    return false;
}

BOOST_AUTO_TEST_SUITE_END()

BOOST_AUTO_TEST_SUITE_END()