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
43 """Initializes the colour constants.
46 global _INFO_SEQ, _WARNING_SEQ, _ERROR_SEQ, _RESET_SEQ
48 # Don't use colours if stdout isn't a terminal
49 if not sys.stdout.isatty():
55 # Don't use colours if curses module can't be imported
60 _RESET_SEQ = curses.tigetstr("op")
62 setaf = curses.tigetstr("setaf")
63 _INFO_SEQ = curses.tparm(setaf, curses.COLOR_GREEN)
64 _WARNING_SEQ = curses.tparm(setaf, curses.COLOR_YELLOW)
65 _ERROR_SEQ = curses.tparm(setaf, curses.COLOR_RED)
71 def AssertEqual(first, second):
72 """Raises an error when values aren't equal.
75 if not first == second:
76 raise qa_error.Error('%r == %r' % (first, second))
79 def AssertNotEqual(first, second):
80 """Raises an error when values are equal.
83 if not first != second:
84 raise qa_error.Error('%r != %r' % (first, second))
87 def GetSSHCommand(node, cmd, strict=True):
88 """Builds SSH command to be executed.
91 - node: Node the command should run on
92 - cmd: Command to be executed as a list with all parameters
93 - strict: Whether to enable strict host key checking
96 args = [ 'ssh', '-oEscapeChar=none', '-oBatchMode=yes', '-l', 'root' ]
102 args.append('-oStrictHostKeyChecking=%s' % tmp)
103 args.append('-oClearAllForwardings=yes')
104 args.append('-oForwardAgent=yes')
107 if qa_config.options.dry_run:
112 args.append(prefix + cmd)
114 print 'SSH:', utils.ShellQuoteArgs(args)
119 def StartSSH(node, cmd, strict=True):
123 return subprocess.Popen(GetSSHCommand(node, cmd, strict=strict),
127 def GetCommandOutput(node, cmd):
128 """Returns the output of a command executed on the given node.
131 p = subprocess.Popen(GetSSHCommand(node, cmd),
132 shell=False, stdout=subprocess.PIPE)
133 AssertEqual(p.wait(), 0)
134 return p.stdout.read()
137 def UploadFile(node, src):
138 """Uploads a file to a node and returns the filename.
140 Caller needs to remove the returned file on the node when it's not needed
143 # Make sure nobody else has access to it while preserving local permissions
144 mode = os.stat(src).st_mode & 0700
146 cmd = ('tmp=$(tempfile --mode %o --prefix gnt) && '
147 '[[ -f "${tmp}" ]] && '
149 'echo "${tmp}"') % mode
153 p = subprocess.Popen(GetSSHCommand(node, cmd), shell=False, stdin=f,
154 stdout=subprocess.PIPE)
155 AssertEqual(p.wait(), 0)
157 # Return temporary filename
158 return p.stdout.read().strip()
163 def _ResolveName(cmd, key):
167 master = qa_config.GetMasterNode()
169 output = GetCommandOutput(master['primary'], utils.ShellQuoteArgs(cmd))
170 for line in output.splitlines():
171 (lkey, lvalue) = line.split(':', 1)
173 return lvalue.lstrip()
174 raise KeyError("Key not found")
177 def ResolveInstanceName(instance):
178 """Gets the full name of an instance.
181 return _ResolveName(['gnt-instance', 'info', instance['name']],
185 def ResolveNodeName(node):
186 """Gets the full name of a node.
189 return _ResolveName(['gnt-node', 'info', node['primary']],
193 def GetNodeInstances(node, secondaries=False):
194 """Gets a list of instances on a node.
197 master = qa_config.GetMasterNode()
198 node_name = ResolveNodeName(node)
200 # Get list of all instances
201 cmd = ['gnt-instance', 'list', '--separator=:', '--no-headers',
202 '--output=name,pnode,snodes']
203 output = GetCommandOutput(master['primary'], utils.ShellQuoteArgs(cmd))
206 for line in output.splitlines():
207 (name, pnode, snodes) = line.split(':', 2)
208 if ((not secondaries and pnode == node_name) or
209 (secondaries and node_name in snodes.split(','))):
210 instances.append(name)
215 def _FormatWithColor(text, seq):
218 return "%s%s%s" % (seq, text, _RESET_SEQ)
221 FormatWarning = lambda text: _FormatWithColor(text, _WARNING_SEQ)
222 FormatError = lambda text: _FormatWithColor(text, _ERROR_SEQ)
223 FormatInfo = lambda text: _FormatWithColor(text, _INFO_SEQ)