summaryrefslogtreecommitdiffstats
path: root/Libraries/Utils/ATFUtils.py
blob: 0afcf2245559be637533e610a0c8998b78a4fb3f (plain)
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
#!/usr/bin/env python

import os
import re
import logging
import ATFLog
import ATFTests
import ATFTestEnv
import ATFSsh
import ATFGlusterd
import ATFGlusterPeer

#########################################################################
## ATFLog.Log Object 
#########################################################################
LogObj = ATFLog.Log()

#########################################################################
## ATFTests.Tests Object 
#########################################################################
TestsObj = ATFTests.Tests()

#########################################################################
## ATFTestEnv.TestEnv Object
#########################################################################
TestEnvObj = ATFTestEnv.TestEnv()

#########################################################################
## ATFSsh.Ssh Object
#########################################################################
SshObj = ATFSsh.Ssh()

#########################################################################
## Logger for 'ATF_LOG' 
#########################################################################
Logger = logging.getLogger('ATF_LOG')

def set_environ(**arguments):
    """
    Description:
        Set the Env Variable 'envvar' to Value 'value'

    Parameters:
        **arguments: key=value pairs. 
            key: Environment Variable name
            value: Value of the Environment Valiable

    Return:
        Success: 1 (Successfully Set the envar to value)
        Failure: 0 (Unable to set the envvar to value)
        
    Example:
        ATFUtils.set_environ(ATF_USER = user1 ,ATF_SERVER = server1)
    """

    envvars = sorted(arguments.keys())

    for var in envvars:
        try:
            os.environ[var] = arguments[var]

        except KeyError as (key):
            Logger.error("Unable to Export Environment Variable '" + key + "'")
            return 1

        else:
            Logger.debug("Exported Environment Variable '" + var + "' = " +
                    arguments[var])

    return 0

def get_environ(envvar, log = 1):
    """
    Description:
        Return the Value of Environment Variable 'envvar'

    Parameters:
        name: Name of the Environment Variable
        log: To keep track of whether to log the error message or not

    Return:
        Success : Value of Environment Variable 'envvar'
        Failure: 1
    """

    try:
        value = os.environ[envvar]

    except KeyError:
        if log == 1:
            Logger.error("Key Error: Environment Variable %s  Not Defined" %
                    envvar)
        value = 1
        
    except OSError as key:
        if log == 1:
            Logger.error("Environment Variable '" + key + "' Not Defined")
        value = 1
        
    else:
        Logger.debug("Returning " + envvar + " = " + value)
        
    return value

def parse_output(stdout, stderr):
    """
    Description:
        Parse the STDOUT and STDERR ChannelFiles

    Parameter:
        stdout: ChannelFile for stdout
        stderr: ChannelFile for stderr

    Return:
        Success: 0 (STDOUT has DATA)
        Failure: 1 (STDERR has DATA)
    """
    
    output = stderr.readlines()

    if len(output) == 0:
        for line in stdout.readlines():
            Logger.debug(line)
        return 0
    else:
        for line in output:
            Logger.error(line)
        return 1

def execute_command(command, **arguments):
    """
    Description:

    Parameter:
        command: Command to be executed
        **arguments: key=value pair for specifying server, host, user

    Returns:
        Success: 0
        Failure: 1
    """

    output = [1, 0, 0, 0]
    ip_string = '(?:[\d]{1,3})\.(?:[\d]{1,3})\.(?:[\d]{1,3})\.(?:[\d]{1,3})'
    serverkey = hostkey = userkey =  ''
    serverkeyfound = hostkeyfound = 0
    
    if arguments.has_key('server'):              
        serverkey = arguments['server']
        serverkeyfound = 1
    elif arguments.has_key('host'):             
        hostkey = arguments['host']
        hostkeyfound = 1
    else:
        serverkey = get_environ('ATF_SERVER', log = 0)

        if serverkey == 1:
            serverkeyfound = 0
            hostkey = get_environ('ATF_HOST')

            if hostkey == 1:
                Logger.error("Server/Host not defined for command execution")
                return output
            else:
                hostkeyfound = 1
        else:
            serverkeyfound = 1

    if serverkeyfound == 1:
        host, user = TestEnvObj.get_server(serverkey)

        if host == '' or user == '':
             Logger.error("Server: " + serverkey + 
                        "Not Defined in GlobalParam File")
             return output
    elif hostkey != '':
        if re.match(ip_string, hostkey):
            host = hostkey
        else :
            host = TestEnvObj.get_host(hostkey)
            if host == '':
                Logger.error("Host: " + hostkey + 
                        "Not Defined in GlobalParam File")
                return output

    if arguments.has_key('user'):
        userkey = arguments['user']
    else:
        userkey = get_environ('ATF_USER')
        if userkey == 1:
            Logger.error(
                    "Ignoring KeyError: Environment Variable ATF_USER Not " + 
                    "Defined for command execution")
            return output

    if userkey != 'root':
        user = TestEnvObj.get_user(userkey, log = 0)
        if user == '':
            Logger.error("User: " + userkey + 
                    "Not Defined in GlobalParam File")
            return output
    else:
        user = 'root'

    Logger.info("Executing Command:  " + command + " - " + user + "@" + host)
    status, stdin, stdout, stderr = SshObj.executecommand(command, host, user)
    output = [status, stdin, stdout, stderr]
    return output
    
def sshservers():
    """
    Description: 
        SSH to all Servers in the ServersList

    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """

    for server in TestEnvObj.get_serverslist():
        host = server['host']
        user = server['user']
    
        if SshObj.connect(host, user):
            return 1
        else:
            continue

    return 0

def sshclients():
    """
    Description: 
        SSH to all Clients in the ClientsList

    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """

    for client in TestEnvObj.get_clientslist():
        host = client['host']
        user = client['user']      
    
        if SshObj.connect(host, user):
            return 1
        else:
            continue
        
    return 0       

def cleanupserversglusterd():
    """
    Descriptions:
        Cleanup glusterd directory on all Servers in ServersList

    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """

    for host in TestEnvObj.get_servershostlist():
        if ATFGlusterd.cleanup_glusterd(host = host):
            return 1
        else:
            continue

    return 0

def cleanupclientsglusterd():
    """
    Description: 
        Cleanup Glusted directory on all the Clients in ClientsList

    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """

    for host in TestEnvObj.get_clientshostlist():
        if ATFGlusterd.cleanup_glusterd(host = host):
            return 1
        else:
            continue
        
    return 0

def stopserversglusterd():
    """
    Description:
        Stop Glusterd on all the Servers in ServersList

    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """
    
    for host in TestEnvObj.get_servershostlist():
        if ATFGlusterd.stop_glusterd(host = host):
            return 1
        else:
            continue
        
    return 0  

def stopclientsglusterd():
    """
    Description: 
        Stop Glusted on all the Clients in ClientsList

    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """
    
    for host in TestEnvObj.get_clientshostlist():
        if ATFGlusterd.stop_glusterd(host = host):
            return 1
        else:
            continue

    return 0

def startserversglusterd():
    """
    Description:
        Start Glusterd on all the Servers in ServersList
    
    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1 
    """
    
    for host in TestEnvObj.get_servershostlist():
        if ATFGlusterd.start_glusterd(host = host):
            return 1
        else:
            continue
        
    return 0

def startclientsglusterd():
    """
    Description: 
        Start GLusterd on all Clients in ClientsList
    
    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """
    
    for host in TestEnvObj.get_clientshostlist():
        if ATFGlusterd.start_glusterd(host = host):
            return 1
        else:
            continue

    return 0

def peerprobe():
    """
    Description: 
        PeerProbe to all Servers in ServerList from one of the server 
        in the ServerList
    
    Parameters:
        None

    Returns:
        Success: 0
        Failure: 1
    """
    
    if ATFGlusterPeer.probe():
        return 1
    else:
        return 0