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.
30 from ganeti import utils
47 """Initializes the colour constants.
50 global _INFO_SEQ, _WARNING_SEQ, _ERROR_SEQ, _RESET_SEQ
52 # Don't use colours if stdout isn't a terminal
53 if not sys.stdout.isatty():
59 # Don't use colours if curses module can't be imported
64 _RESET_SEQ = curses.tigetstr("op")
66 setaf = curses.tigetstr("setaf")
67 _INFO_SEQ = curses.tparm(setaf, curses.COLOR_GREEN)
68 _WARNING_SEQ = curses.tparm(setaf, curses.COLOR_YELLOW)
69 _ERROR_SEQ = curses.tparm(setaf, curses.COLOR_RED)
75 def AssertEqual(first, second):
76 """Raises an error when values aren't equal.
79 if not first == second:
80 raise qa_error.Error('%r == %r' % (first, second))
83 def AssertNotEqual(first, second):
84 """Raises an error when values are equal.
87 if not first != second:
88 raise qa_error.Error('%r != %r' % (first, second))
91 def GetSSHCommand(node, cmd, strict=True):
92 """Builds SSH command to be executed.
95 - node: Node the command should run on
96 - cmd: Command to be executed as a list with all parameters
97 - strict: Whether to enable strict host key checking
100 args = [ 'ssh', '-oEscapeChar=none', '-oBatchMode=yes', '-l', 'root' ]
106 args.append('-oStrictHostKeyChecking=%s' % tmp)
107 args.append('-oClearAllForwardings=yes')
108 args.append('-oForwardAgent=yes')
111 if qa_config.options.dry_run:
116 args.append(prefix + cmd)
118 print 'SSH:', utils.ShellQuoteArgs(args)
123 def StartSSH(node, cmd, strict=True):
127 return subprocess.Popen(GetSSHCommand(node, cmd, strict=strict),
131 def GetCommandOutput(node, cmd):
132 """Returns the output of a command executed on the given node.
135 p = subprocess.Popen(GetSSHCommand(node, cmd),
136 shell=False, stdout=subprocess.PIPE)
137 AssertEqual(p.wait(), 0)
138 return p.stdout.read()
141 def UploadFile(node, src):
142 """Uploads a file to a node and returns the filename.
144 Caller needs to remove the returned file on the node when it's not needed
147 # Make sure nobody else has access to it while preserving local permissions
148 mode = os.stat(src).st_mode & 0700
150 cmd = ('tmp=$(tempfile --mode %o --prefix gnt) && '
151 '[[ -f "${tmp}" ]] && '
153 'echo "${tmp}"') % mode
157 p = subprocess.Popen(GetSSHCommand(node, cmd), shell=False, stdin=f,
158 stdout=subprocess.PIPE)
159 AssertEqual(p.wait(), 0)
161 # Return temporary filename
162 return p.stdout.read().strip()
167 def _ResolveName(cmd, key):
171 master = qa_config.GetMasterNode()
173 output = GetCommandOutput(master['primary'], utils.ShellQuoteArgs(cmd))
174 for line in output.splitlines():
175 (lkey, lvalue) = line.split(':', 1)
177 return lvalue.lstrip()
178 raise KeyError("Key not found")
181 def ResolveInstanceName(instance):
182 """Gets the full name of an instance.
185 return _ResolveName(['gnt-instance', 'info', instance['name']],
189 def ResolveNodeName(node):
190 """Gets the full name of a node.
193 return _ResolveName(['gnt-node', 'info', node['primary']],
197 def GetNodeInstances(node, secondaries=False):
198 """Gets a list of instances on a node.
201 master = qa_config.GetMasterNode()
202 node_name = ResolveNodeName(node)
204 # Get list of all instances
205 cmd = ['gnt-instance', 'list', '--separator=:', '--no-headers',
206 '--output=name,pnode,snodes']
207 output = GetCommandOutput(master['primary'], utils.ShellQuoteArgs(cmd))
210 for line in output.splitlines():
211 (name, pnode, snodes) = line.split(':', 2)
212 if ((not secondaries and pnode == node_name) or
213 (secondaries and node_name in snodes.split(','))):
214 instances.append(name)
219 def _FormatWithColor(text, seq):
222 return "%s%s%s" % (seq, text, _RESET_SEQ)
225 FormatWarning = lambda text: _FormatWithColor(text, _WARNING_SEQ)
226 FormatError = lambda text: _FormatWithColor(text, _ERROR_SEQ)
227 FormatInfo = lambda text: _FormatWithColor(text, _INFO_SEQ)
231 """Load all QA hooks.
234 hooks_dir = qa_config.get('options', {}).get('hooks-dir', None)
237 if hooks_dir not in sys.path:
238 sys.path.insert(0, hooks_dir)
239 for name in utils.ListVisibleFiles(hooks_dir):
240 if name.endswith('.py'):
241 # Load and instanciate hook
242 print "Loading hook %s" % name
243 _hooks.append(__import__(name[:-3], None, None, ['']).hook())
247 """Definition of context passed to hooks.
258 """Calls all hooks with the given context.
264 name = "%s-%s" % (ctx.phase, ctx.name)
265 if ctx.success is not None:
266 msg = "%s (success=%s)" % (name, ctx.success)
269 print FormatInfo("Begin %s" % msg)
272 print FormatInfo("End %s" % name)
275 def DefineHook(name):
276 """Wraps a function with calls to hooks.
278 Usage: prefix function with @qa_utils.DefineHook(...)
280 This is based on PEP 318, "Decorators for Functions and Methods".
284 def new_f(*args, **kwargs):
286 ctx = QaHookContext()
298 return fn(*args, **kwargs)
305 # Override function metadata
306 new_f.func_name = fn.func_name
307 new_f.func_doc = fn.func_doc