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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
#
# 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.
#
# This test ensures the Task API works as expected.
import time
import os
import pwd
import sys # determine python version
from datetime import datetime
import shutil # used to remove directory tree
from ecflow import Defs, Clock, DState, Event, Style, State, PrintStyle, File, Client, SState, File, debug_build
import ecflow_test_util as Test
def ecf_includes(): return File.source_dir() + "/libs/pyext/test/data/python_includes"
def create_defs(name, port, protocol):
defs = Defs()
suite_name = name
if len(suite_name) == 0: suite_name = "s1"
suite = defs.add_suite(suite_name);
ecfhome = Test.ecf_home(port);
suite.add_variable("ECF_HOME", ecfhome);
suite.add_variable("ECF_INCLUDE", ecf_includes());
protocol_option = "True" if protocol == Test.Protocol.HTTP else "False"
suite.add_variable("ECF_USING_HTTP_BACKEND", protocol_option);
prefix_job_cmd = ""
if 'PYTHONPATH' in os.environ:
prefix_job_cmd = "export PYTHONPATH=" + os.environ['PYTHONPATH'] + ";"
if 'LD_LIBRARY_PATH' in os.environ:
prefix_job_cmd += "export LD_LIBRARY_PATH=" + os.environ['LD_LIBRARY_PATH'] + ";"
# sys.version_info is a tuple containing (major,minor,micro,releaselevel,serial)
# releaselevel = alpha beta candidate final
if (sys.version_info > (3, 0)):
suite.add_variable("ECF_JOB_CMD", prefix_job_cmd + "python3 %ECF_JOB% 1> %ECF_JOBOUT% 2>&1")
else:
suite.add_variable("ECF_JOB_CMD", prefix_job_cmd + "python %ECF_JOB% 1> %ECF_JOBOUT% 2>&1")
family = suite.add_family("f1")
t1 = family.add_task("t1")
t1.add_event("event_fred")
t1.add(Event("event_set", True)) # ECFLOW-1526
t1.add_meter("meter", 0, 100)
t1.add_label("label_name", "value")
t1.add_queue("q1", ["1", "2", "3"])
family.add_task("t2") # test wait
family.add_task("t3").add_trigger(
"t1:q1 >= 3 and t1:event_fred and t1:event_set == clear") # wait on queue q1 and events
family.add_task("t4").add_trigger(
"t1:name1 == 1 and t1:name2 == 2 and t1:name3 == 3 and t1:name4 == 4") # test ECFLOW-1573
defs.auto_add_externs(
True) # because variable name1,name2,name3,name4 are not added until t1 is active.(i.e. runtime)
return defs;
def wait_for_suite_to_complete(ci, suite_name):
count = 0
while 1:
count += 1
ci.sync_local() # get the changes, synced with local defs
suite = ci.get_defs().find_suite(suite_name)
assert suite is not None, " Expected to find suite " + suite_name + ":\n" + str(ci.get_defs())
if suite.get_state() == State.complete:
break;
if suite.get_state() == State.aborted:
print(ci.get_defs());
assert False, " Suite aborted \n"
time.sleep(2)
if count > 20:
assert False, suite_name + " aborted after " + str(count) + " loops, printing defs:\n" + str(ci.get_defs())
ci.log_msg("Looped " + str(count) + " times")
def test_python_child_api(ci, protocol):
suite_name = "test_python_child_api"
print("\n" + suite_name + " " + ci.get_host() + ":" + str(ci.get_port()))
print(" ECF_HOME(" + Test.ecf_home(ci.get_port()) + ")")
print(" ECF_INCLUDES(" + ecf_includes() + ")")
ci.delete_all(True)
defs = create_defs(suite_name, ci.get_port(), protocol)
suite = defs.find_suite(suite_name)
suite.add_defstatus(DState.suspended)
# create the ecf file /test_python_child_api/f1/t1
ecf_home = Test.ecf_home(ci.get_port())
test_home = ecf_home + "/" + suite_name
dir = test_home + "/f1"
# on cray creating recursive directories can fail, try again. yuk
try:
if not os.path.exists(dir): os.makedirs(dir)
except:
try:
if not os.path.exists(dir): os.makedirs(dir)
except:
# try breaking down
if not os.path.exists(ecf_home): os.makedirs(ecf_home)
new_dir = ecf_home + "/test_python_child_api"
if not os.path.exists(new_dir): os.makedirs(new_dir)
new_dir = ecf_home + "/test_python_child_api/f1"
if not os.path.exists(new_dir): os.makedirs(new_dir)
if not os.path.exists(dir): os.makedirs(dir)
# record the log file with the test
ci.new_log(test_home + "/" + suite_name + ".log")
server_version = ci.server_version()
file = dir + "/t1.ecf"
contents = "%include <head.py>\n\n"
contents += "with Client(True) as ci:\n" # Here True means add variables durint init and remove them on complete ECFLOW-1573
if protocol == Test.Protocol.HTTP:
contents += " ci.enable_http()\n"
contents += " print(' doing some work: t1.ecf')\n"
contents += " if ci.version() != '" + server_version + "':\n"
contents += " assert False, 'Client and server versions different'\n"
contents += " ci.child_event('event_fred') # set the event\n"
contents += " ci.child_event('event_set',False) # clear the event ECFLOW-1526\n"
contents += " ci.child_meter('meter',100)\n"
contents += " ci.child_label('label_name','100')\n"
contents += " step = ci.child_queue('q1','active')\n"
contents += " assert step == '1','expected first step to be 1'\n"
contents += " step = ci.child_queue('q1','complete',step)\n"
contents += " step = ci.child_queue('q1','active')\n"
contents += " assert step == '2','expected second step to be 2'\n"
contents += " step = ci.child_queue('q1','complete',step)\n"
contents += " step = ci.child_queue('q1','active')\n"
contents += " assert step == '3','expected third step to be 3'\n"
contents += " step = ci.child_queue('q1','complete',step)\n"
contents += " step = ci.child_queue('q1','active')\n"
contents += " assert step == '<NULL>','expected <NULL? for end of queue'\n"
contents += " print(' Finished event,meter,label and queue child commands')\n"
open(file, 'w').write(contents)
print(" Created file " + file)
# create the ecf file /test_python_child_api/f1/t2
file = dir + "/t2.ecf"
contents = "%include <head.py>\n\n"
contents += "with Client() as ci:\n"
if protocol == Test.Protocol.HTTP:
contents += " ci.enable_http()\n"
contents += " print(' Waiting for /test_python_child_api/f1/t1 == complete')\n"
contents += " ci.child_wait('/test_python_child_api/f1/t1 == complete')\n"
contents += " print(' Finished waiting')\n"
open(file, 'w').write(contents)
print(" Created file " + file)
# create the ecf file /test_python_child_api/f1/t3
file = dir + "/t3.ecf"
contents = "%include <head.py>\n\n"
contents += "with Client() as ci:\n"
if protocol == Test.Protocol.HTTP:
contents += " ci.enable_http()\n"
contents += " print(' Running t3.ecf')\n"
open(file, 'w').write(contents)
print(" Created file " + file)
# create the ecf file /test_python_child_api/f1/t4
file = dir + "/t4.ecf"
contents = "%include <head.py>\n\n"
contents += "with Client() as ci:\n"
if protocol == Test.Protocol.HTTP:
contents += " ci.enable_http()\n"
contents += " print(' Running t4.ecf')\n"
open(file, 'w').write(contents)
print(" Created file " + file)
ci.restart_server()
ci.load(defs)
ci.begin_all_suites()
print(" Running the test, wait for suite to complete ...")
ci.run("/test_python_child_api", False)
wait_for_suite_to_complete(ci, suite_name);
defs.save_as_defs(os.path.join(ecf_home, suite_name, suite_name + ".def"))
if not Test.debugging():
print(" Test OK: removing directory ", test_home)
shutil.rmtree(test_home, ignore_errors=True)
def launch_tests(ci, protocol):
server_version = ci.server_version();
print("Running ecflow server version " + server_version)
print("Running ecflow client version " + ci.version())
assert ci.version() == server_version, "Client version not same as server version"
PrintStyle.set_style(Style.STATE) # show node state
test_python_child_api(ci, protocol)
print("\nAll Tests pass ======================================================================")
if __name__ == "__main__":
Test.print_test_start(os.path.basename(__file__))
# Run tests using ecFlow server (using custom TCP/IP protocol)
with Test.Server(Test.Protocol.CUSTOM) as ctx:
ci = ctx[0]
protocol = ctx[1]
launch_tests(ci, protocol)
# Run tests using ecFlow server (using HTTP protocol)
with Test.Server(Test.Protocol.HTTP) as ctx:
ci = ctx[0]
protocol = ctx[1]
launch_tests(ci, protocol)
|
