File: test_nodes.py

package info (click to toggle)
python-jenkinsapi 0.3.17-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,500 kB
  • sloc: python: 10,001; xml: 50; makefile: 31; sh: 26
file content (318 lines) | stat: -rw-r--r-- 8,931 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
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
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
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
306
307
308
309
310
311
312
313
314
315
316
317
318
"""
System tests for `jenkinsapi.jenkins` module.
"""

import logging
import pytest
from jenkinsapi.node import Node
from jenkinsapi.credential import SSHKeyCredential
from jenkinsapi_tests.test_utils.random_strings import random_string

log = logging.getLogger(__name__)

TOOL_KEY = "hudson.tasks.Maven$MavenInstallation$DescriptorImpl@Maven 3.0.5"


def test_online_offline(jenkins):
    """
    Can we flip the online / offline state of the master node.
    """
    # Master node name should be case insensitive
    # mn0 = jenkins.get_node('MaStEr')
    mn = jenkins.get_node("Built-In Node")
    # self.assertEqual(mn, mn0)

    mn.set_online()  # It should already be online, hence no-op
    assert mn.is_online() is True

    mn.set_offline()  # We switch that suckah off
    mn.set_offline()  # This should be a no-op
    assert mn.is_online() is False

    mn.set_online()  # Switch it back on
    assert mn.is_online() is True


def test_create_jnlp_node(jenkins):
    node_name = random_string()
    node_dict = {
        "num_executors": 1,
        "node_description": "Test JNLP Node",
        "remote_fs": "/tmp",
        "labels": "systest_jnlp",
        "exclusive": True,
        "tool_location": [
            {
                "key": TOOL_KEY,
                "home": "/home/apache-maven-3.0.5/",
            },
        ],
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    assert isinstance(node, Node) is True

    del jenkins.nodes[node_name]


def test_create_ssh_node(jenkins):
    node_name = random_string()
    creds = jenkins.get_credentials()

    cred_descr = random_string()
    cred_dict = {
        "description": cred_descr,
        "userName": "username",
        "passphrase": "",
        "private_key": "-----BEGIN RSA PRIVATE KEY-----",
    }
    creds[cred_descr] = SSHKeyCredential(cred_dict)
    node_dict = {
        "num_executors": 1,
        "node_description": "Description %s" % node_name,
        "remote_fs": "/tmp",
        "labels": node_name,
        "exclusive": False,
        "host": "127.0.0.1",
        "port": 22,
        "credential_description": cred_descr,
        "jvm_options": "",
        "java_path": "",
        "prefix_start_slave_cmd": "",
        "suffix_start_slave_cmd": "",
        "retention": "ondemand",
        "ondemand_delay": 0,
        "ondemand_idle_delay": 5,
        "tool_location": [
            {
                "key": TOOL_KEY,
                "home": "/home/apache-maven-3.0.5/",
            },
        ],
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    assert isinstance(node, Node) is True
    del jenkins.nodes[node_name]

    jenkins.nodes[node_name] = node_dict
    assert isinstance(jenkins.nodes[node_name], Node) is True
    del jenkins.nodes[node_name]


def test_delete_node(jenkins):
    node_name = random_string()
    node_dict = {
        "num_executors": 1,
        "node_description": "Test JNLP Node",
        "remote_fs": "/tmp",
        "labels": "systest_jnlp",
        "exclusive": True,
    }
    jenkins.nodes.create_node(node_name, node_dict)
    del jenkins.nodes[node_name]

    with pytest.raises(KeyError):
        jenkins.nodes[node_name]

    with pytest.raises(KeyError):
        del jenkins.nodes["not_exist"]


def test_delete_all_nodes(jenkins):
    nodes = jenkins.nodes

    for name in nodes.keys():
        del nodes[name]

    assert len(jenkins.nodes) == 1


def test_get_node_labels(jenkins):
    node_name = random_string()
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    assert node.get_labels() == node_labels

    del jenkins.nodes[node_name]


def test_add_node_labels(jenkins):
    node_name = random_string()
    extra_label = random_string()
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    node.add_labels(extra_label)
    assert node.get_labels() == " ".join([node_labels, extra_label])

    del jenkins.nodes[node_name]


def test_add_list_node_labels(jenkins):
    node_name = random_string()
    extra_labels = [random_string(), random_string()]
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    node.add_labels(extra_labels)
    labels_on_node = node.get_labels().split(" ")
    assert set(extra_labels + node_labels.split(" ")) == set(labels_on_node)

    del jenkins.nodes[node_name]


def test_modify_node_labels(jenkins):
    node_name = random_string()
    extra_label = random_string()
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    node.modify_labels(extra_label)
    assert node.get_labels() == extra_label

    del jenkins.nodes[node_name]


def test_delete_list_node_labels(jenkins):
    node_name = random_string()
    extra_labels = [random_string(), random_string()]
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    node.add_labels(extra_labels)
    labels_on_node = node.get_labels().split(" ")

    assert set(extra_labels + node_labels.split(" ")) == set(labels_on_node)
    node.delete_labels(extra_labels)

    labels_on_node = node.get_labels().split(" ")
    assert set(node_labels.split(" ")) == set(labels_on_node)

    del jenkins.nodes[node_name]


def test_dryrun_delete_list_node_labels(jenkins):
    node_name = random_string()
    extra_labels = [random_string(), random_string()]
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)
    node.add_labels(extra_labels)
    labels_on_node = node.get_labels().split(" ")

    assert set(extra_labels + node_labels.split(" ")) == set(labels_on_node)
    node.delete_labels(extra_labels, dryRun=True)

    labels_on_node = node.get_labels().split(" ")
    assert set(extra_labels + node_labels.split(" ")) == set(labels_on_node)

    del jenkins.nodes[node_name]


def test_get_executors(jenkins):
    node_name = random_string()
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)

    with pytest.raises(AttributeError):
        assert node.get_config_element("executors") == "1"

    assert node.get_config_element("numExecutors") == "1"

    del jenkins.nodes[node_name]


def test_set_executors(jenkins):
    node_name = random_string()
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)

    assert node.set_config_element("numExecutors", "5") is None

    assert node.get_config_element("numExecutors") == "5"

    del jenkins.nodes[node_name]


def test_set_master_executors(jenkins):
    node = jenkins.nodes["Built-In Node"]

    assert node.get_num_executors() == 2

    node.set_num_executors(5)
    assert node.get_num_executors() == 5

    node.set_num_executors(2)


def test_offline_reason(jenkins):
    node_name = random_string()
    node_labels = "LABEL1 LABEL2"
    node_dict = {
        "num_executors": 1,
        "node_description": "Test Node with Labels",
        "remote_fs": "/tmp",
        "labels": node_labels,
        "exclusive": True,
    }
    node = jenkins.nodes.create_node(node_name, node_dict)

    node.toggle_temporarily_offline("test1")
    node.poll()
    assert node.offline_reason() == "test1"

    node.update_offline_reason("test2")
    node.poll()
    assert node.offline_reason() == "test2"

    del jenkins.nodes[node_name]