4 # Copyright (C) 2007 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Utilities for QA tests.
31 from ganeti import utils
44 """Initializes the colour constants.
47 global _INFO_SEQ, _WARNING_SEQ, _ERROR_SEQ, _RESET_SEQ
49 # Don't use colours if stdout isn't a terminal
50 if not sys.stdout.isatty():
56 # Don't use colours if curses module can't be imported
61 _RESET_SEQ = curses.tigetstr("op")
63 setaf = curses.tigetstr("setaf")
64 _INFO_SEQ = curses.tparm(setaf, curses.COLOR_GREEN)
65 _WARNING_SEQ = curses.tparm(setaf, curses.COLOR_YELLOW)
66 _ERROR_SEQ = curses.tparm(setaf, curses.COLOR_RED)
72 def AssertIn(item, sequence):
73 """Raises an error when item is not in sequence.
76 if item not in sequence:
77 raise qa_error.Error('%r not in %r' % (item, sequence))
80 def AssertEqual(first, second):
81 """Raises an error when values aren't equal.
84 if not first == second:
85 raise qa_error.Error('%r == %r' % (first, second))
88 def AssertNotEqual(first, second):
89 """Raises an error when values are equal.
92 if not first != second:
93 raise qa_error.Error('%r != %r' % (first, second))
96 def AssertMatch(string, pattern):
97 """Raises an error when string doesn't match regexp pattern.
100 if not re.match(pattern, string):
101 raise qa_error.Error("%r doesn't match /%r/" % (string, pattern))
104 def GetSSHCommand(node, cmd, strict=True):
105 """Builds SSH command to be executed.
108 - node: Node the command should run on
109 - cmd: Command to be executed as a list with all parameters
110 - strict: Whether to enable strict host key checking
113 args = [ 'ssh', '-oEscapeChar=none', '-oBatchMode=yes', '-l', 'root', '-t' ]
119 args.append('-oStrictHostKeyChecking=%s' % tmp)
120 args.append('-oClearAllForwardings=yes')
121 args.append('-oForwardAgent=yes')
128 def StartLocalCommand(cmd, **kwargs):
129 """Starts a local command.
132 print "Command: %s" % utils.ShellQuoteArgs(cmd)
133 return subprocess.Popen(cmd, shell=False, **kwargs)
136 def StartSSH(node, cmd, strict=True):
140 return StartLocalCommand(GetSSHCommand(node, cmd, strict=strict))
143 def GetCommandOutput(node, cmd):
144 """Returns the output of a command executed on the given node.
147 p = StartLocalCommand(GetSSHCommand(node, cmd), stdout=subprocess.PIPE)
148 AssertEqual(p.wait(), 0)
149 return p.stdout.read()
152 def UploadFile(node, src):
153 """Uploads a file to a node and returns the filename.
155 Caller needs to remove the returned file on the node when it's not needed
159 # Make sure nobody else has access to it while preserving local permissions
160 mode = os.stat(src).st_mode & 0700
162 cmd = ('tmp=$(tempfile --mode %o --prefix gnt) && '
163 '[[ -f "${tmp}" ]] && '
165 'echo "${tmp}"') % mode
169 p = subprocess.Popen(GetSSHCommand(node, cmd), shell=False, stdin=f,
170 stdout=subprocess.PIPE)
171 AssertEqual(p.wait(), 0)
173 # Return temporary filename
174 return p.stdout.read().strip()
179 def BackupFile(node, path):
180 """Creates a backup of a file on the node and returns the filename.
182 Caller needs to remove the returned file on the node when it's not needed
186 cmd = ("tmp=$(tempfile --prefix .gnt --directory=$(dirname %s)) && "
187 "[[ -f \"$tmp\" ]] && "
189 "echo $tmp") % (utils.ShellQuote(path), utils.ShellQuote(path))
191 # Return temporary filename
192 return GetCommandOutput(node, cmd).strip()
195 def _ResolveName(cmd, key):
199 master = qa_config.GetMasterNode()
201 output = GetCommandOutput(master['primary'], utils.ShellQuoteArgs(cmd))
202 for line in output.splitlines():
203 (lkey, lvalue) = line.split(':', 1)
205 return lvalue.lstrip()
206 raise KeyError("Key not found")
209 def ResolveInstanceName(instance):
210 """Gets the full name of an instance.
213 return _ResolveName(['gnt-instance', 'info', instance['name']],
217 def ResolveNodeName(node):
218 """Gets the full name of a node.
221 return _ResolveName(['gnt-node', 'info', node['primary']],
225 def GetNodeInstances(node, secondaries=False):
226 """Gets a list of instances on a node.
229 master = qa_config.GetMasterNode()
230 node_name = ResolveNodeName(node)
232 # Get list of all instances
233 cmd = ['gnt-instance', 'list', '--separator=:', '--no-headers',
234 '--output=name,pnode,snodes']
235 output = GetCommandOutput(master['primary'], utils.ShellQuoteArgs(cmd))
238 for line in output.splitlines():
239 (name, pnode, snodes) = line.split(':', 2)
240 if ((not secondaries and pnode == node_name) or
241 (secondaries and node_name in snodes.split(','))):
242 instances.append(name)
247 def _FormatWithColor(text, seq):
250 return "%s%s%s" % (seq, text, _RESET_SEQ)
253 FormatWarning = lambda text: _FormatWithColor(text, _WARNING_SEQ)
254 FormatError = lambda text: _FormatWithColor(text, _ERROR_SEQ)
255 FormatInfo = lambda text: _FormatWithColor(text, _INFO_SEQ)