#!/usr/bin/env python # smoke.py: run some mongo tests. # Bugs, TODOs: # 0 Some tests hard-code pathnames relative to the mongo repository, # so the smoke.py process and all its children must be run with the # mongo repo as current working directory. That's kinda icky. # 1 The tests that are implemented as standalone executables ("test", # "perftest"), don't take arguments for the dbpath, but # unconditionally use "/tmp/unittest". # 2 mongod output gets intermingled with mongo output, and it's often # hard to find error messages in the slop. Maybe have smoke.py do # some fancier wrangling of child process output? # 3 Some test suites run their own mongods, and so don't need us to # run any mongods around their execution. (It's harmless to do so, # but adds noise in the output.) # 4 Running a separate mongo shell for each js file is slower than # loading js files into one mongo shell process. Maybe have runTest # queue up all filenames ending in ".js" and run them in one mongo # shell at the "end" of testing? # 5 Right now small-oplog implies master/slave replication. Maybe # running with replication should be an orthogonal concern. (And # maybe test replica set replication, too.) # 6 We use cleanbb.py to clear out the dbpath, but cleanbb.py kills # off all mongods on a box, which means you can't run two smoke.py # jobs on the same host at once. So something's gotta change. from __future__ import with_statement import glob from optparse import OptionParser import os import parser import re import shutil import socket from subprocess import (Popen, PIPE, call) import sys import time from pymongo import Connection import utils # TODO clean this up so we don't need globals... mongo_repo = os.getcwd() #'./' test_path = None mongod_executable = None mongod_port = None shell_executable = None continue_on_failure = None tests = [] winners = [] losers = {} # For replication hash checking replicated_collections = [] lost_in_slave = [] lost_in_master = [] screwy_in_slave = {} smoke_db_prefix = '' small_oplog = False # This class just implements the with statement API, for a sneaky # purpose below. class Nothing(object): def __enter__(self): return self def __exit__(self, type, value, traceback): return not isinstance(value, Exception) class mongod(object): def __init__(self, **kwargs): self.kwargs = kwargs self.proc = None def __enter__(self): self.start() return self def __exit__(self, type, value, traceback): try: self.stop() except Exception, e: print >> sys.stderr, "error shutting down mongod" print >> sys.stderr, e return not isinstance(value, Exception) def ensure_test_dirs(self): utils.ensureDir(smoke_db_prefix + "/tmp/unittest/") utils.ensureDir(smoke_db_prefix + "/data/") utils.ensureDir(smoke_db_prefix + "/data/db/") def check_mongo_port(self, port=27017): sock = socket.socket() sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1) sock.settimeout(1) sock.connect(("localhost", int(port))) sock.close() def did_mongod_start(self, port=mongod_port, timeout=20): while timeout > 0: time.sleep(1) try: self.check_mongo_port(int(port)) return True except Exception,e: print >> sys.stderr, e timeout = timeout - 1 return False def start(self): global mongod_port global mongod if self.proc: print >> sys.stderr, "probable bug: self.proc already set in start()" return self.ensure_test_dirs() dir_name = smoke_db_prefix + "/data/db/sconsTests/" self.port = int(mongod_port) self.slave = False if 'slave' in self.kwargs: dir_name = smoke_db_prefix + '/data/db/sconsTestsSlave/' srcport = mongod_port self.port += 1 self.slave = True if os.path.exists(dir_name): if 'slave' in self.kwargs: argv = ["python", "buildscripts/cleanbb.py", '--nokill', dir_name] else: argv = ["python", "buildscripts/cleanbb.py", dir_name] call(argv) utils.ensureDir(dir_name) argv = [mongod_executable, "--port", str(self.port), "--dbpath", dir_name] if self.kwargs.get('small_oplog'): argv += ["--master", "--oplogSize", "100"] if self.slave: argv += ['--slave', '--source', 'localhost:' + str(srcport)] print "running " + " ".join(argv) self.proc = Popen(argv) if not self.did_mongod_start(self.port): raise Exception("Failed to start mongod") if self.slave: local = Connection(port=self.port, slave_okay=True).local synced = False while not synced: synced = True for source in local.sources.find(fields=["syncedTo"]): synced = synced and "syncedTo" in source and source["syncedTo"] def stop(self): if not self.proc: print >> sys.stderr, "probable bug: self.proc unset in stop()" return try: # This function not available in Python 2.5 self.proc.terminate() except AttributeError: if os.sys.platform == "win32": import win32process win32process.TerminateProcess(self.proc._handle, -1) else: from os import kill kill(self.proc.pid, 15) self.proc.wait() sys.stderr.flush() sys.stdout.flush() def wait_for_repl(self): Connection(port=self.port).test.smokeWait.insert({}, w=2, wtimeout=5*60*1000) class Bug(Exception): def __str__(self): return 'bug in smoke.py: ' + super(Bug, self).__str__() class TestFailure(Exception): pass class TestExitFailure(TestFailure): def __init__(self, *args): self.path = args[0] self.status=args[1] def __str__(self): return "test %s exited with status %d" % (self.path, self.status) class TestServerFailure(TestFailure): def __init__(self, *args): self.path = args[0] self.status = -1 # this is meaningless as an exit code, but # that's the point. def __str__(self): return 'mongod not running after executing test %s' % self.path def check_db_hashes(master, slave): # Need to pause a bit so a slave might catch up... if not slave.slave: raise(Bug("slave instance doesn't have slave attribute set")) print "waiting for slave to catch up" master.wait_for_repl() print "caught up!" # FIXME: maybe make this run dbhash on all databases? for mongod in [master, slave]: print( mongod.port ) mongod.dbhash = Connection(port=mongod.port, slave_okay=True).test.command("dbhash") mongod.dict = mongod.dbhash["collections"] print( mongod.dbhash ) global lost_in_slave, lost_in_master, screwy_in_slave, replicated_collections replicated_collections += master.dict.keys() print( "a: " + str( master.dict.keys() ) ) print( "b: " + str( slave.dict.keys() ) ) for db in replicated_collections: if db not in slave.dict: lost_in_slave.append(db) mhash = master.dict[db] shash = slave.dict[db] if mhash != shash: screwy_in_slave[db] = mhash + "/" + shash for db in slave.dict.keys(): if db not in master.dict: lost_in_master.append(db) # Blech. def skipTest(path): if small_oplog: if os.path.basename(path) in ["cursor8.js", "indexh.js"]: return True return False def runTest(test): (path, usedb) = test (ignore, ext) = os.path.splitext(path) if skipTest(path): print "skipping " + path return if ext == ".js": argv = [shell_executable, "--port", mongod_port] if not usedb: argv += ["--nodb"] if small_oplog: argv += ["--eval", 'testingReplication = true;'] argv += [path] elif ext in ["", ".exe"]: # Blech. if os.path.basename(path) in ["test", "test.exe", "perftest", "perftest.exe"]: argv = [path] # more blech elif os.path.basename(path) == 'mongos': argv = [path, "--test"] else: argv = [test_path and os.path.abspath(os.path.join(test_path, path)) or path, "--port", mongod_port] else: raise Bug("fell off in extenstion case: %s" % path) print " *******************************************" print " Test : " + os.path.basename(path) + " ..." t1 = time.time() # FIXME: we don't handle the case where the subprocess # hangs... that's bad. r = call(argv, cwd=test_path) t2 = time.time() print " " + str((t2 - t1) * 1000) + "ms" if r != 0: raise TestExitFailure(path, r) if Popen([mongod_executable, "msg", "ping", mongod_port], stdout=PIPE).communicate()[0].count( "****ok") == 0: raise TestServerFailure(path) if call([mongod_executable, "msg", "ping", mongod_port]) != 0: raise TestServerFailure(path) print "" def run_tests(tests): # FIXME: some suites of tests start their own mongod, so don't # need this. (So long as there are no conflicts with port, # dbpath, etc., and so long as we shut ours down properly, # starting this mongod shouldn't break anything, though.) # The reason we use with is so that we get __exit__ semantics with mongod(small_oplog=small_oplog) as master: with mongod(slave=True) if small_oplog else Nothing() as slave: if small_oplog: master.wait_for_repl() for test in tests: try: runTest(test) winners.append(test) except TestFailure, f: try: print f # Record the failing test and re-raise. losers[f.path] = f.status raise f except TestServerFailure, f: return 2 except TestFailure, f: if not continue_on_failure: return 1 if isinstance(slave, mongod): check_db_hashes(master, slave) return 0 def report(): print "%d test%s succeeded" % (len(winners), '' if len(winners) == 1 else 's') num_missed = len(tests) - (len(winners) + len(losers.keys())) if num_missed: print "%d tests didn't get run" % num_missed if losers: print "The following tests failed (with exit code):" for loser in losers: print "%s\t%d" % (loser, losers[loser]) def missing(lst, src, dst): if lst: print """The following collections were present in the %s but not the %s at the end of testing:""" % (src, dst) for db in lst: print db missing(lost_in_slave, "master", "slave") missing(lost_in_master, "slave", "master") if screwy_in_slave: print """The following collections has different hashes in master and slave at the end of testing:""" for db in screwy_in_slave.keys(): print "%s\t %s" % (db, screwy_in_slave[db]) if small_oplog and not (lost_in_master or lost_in_slave or screwy_in_slave): print "replication ok for %d collections" % (len(replicated_collections)) if losers or lost_in_slave or lost_in_master or screwy_in_slave: raise Exception("Test failures") def expand_suites(suites): globstr = None tests = [] for suite in suites: if suite == 'all': return expand_suites(['test', 'perf', 'client', 'js', 'jsPerf', 'jsSlowNightly', 'jsSlowWeekly', 'parallel', 'clone', 'parallel', 'repl', 'auth', 'sharding', 'tool']) if suite == 'test': if os.sys.platform == "win32": program = 'test.exe' else: program = 'test' (globstr, usedb) = (program, False) elif suite == 'perf': if os.sys.platform == "win32": program = 'perftest.exe' else: program = 'perftest' (globstr, usedb) = (program, False) elif suite == 'client': paths = ["firstExample", "secondExample", "whereExample", "authTest", "clientTest", "httpClientTest"] if os.sys.platform == "win32": paths = [path + '.exe' for path in paths] # hack tests += [(test_path and path or os.path.join(mongo_repo, path), False) for path in paths] elif suite == 'mongosTest': if os.sys.platform == "win32": program = 'mongos.exe' else: program = 'mongos' tests += [(os.path.join(mongo_repo, program), False)] elif os.path.exists( suite ): tests += [ ( os.path.join( mongo_repo , suite ) , True ) ] else: try: globstr, usedb = {"js": ("[!_]*.js", True), "quota": ("quota/*.js", True), "jsPerf": ("perf/*.js", True), "disk": ("disk/*.js", True), "jsSlowNightly": ("slowNightly/*.js", True), "jsSlowWeekly": ("slowWeekly/*.js", True), "parallel": ("parallel/*.js", True), "clone": ("clone/*.js", False), "repl": ("repl/*.js", False), "replSets": ("replsets/*.js", False), "auth": ("auth/*.js", False), "sharding": ("sharding/*.js", False), "tool": ("tool/*.js", False)}[suite] except KeyError: raise Exception('unknown test suite %s' % suite) if globstr: globstr = os.path.join(mongo_repo, (os.path.join(('jstests/' if globstr.endswith('.js') else ''), globstr))) paths = glob.glob(globstr) paths.sort() tests += [(path, usedb) for path in paths] return tests def main(): global mongod_executable, mongod_port, shell_executable, continue_on_failure, small_oplog, smoke_db_prefix, test_path parser = OptionParser(usage="usage: smoke.py [OPTIONS] ARGS*") parser.add_option('--mode', dest='mode', default='suite', help='If "files", ARGS are filenames; if "suite", ARGS are sets of tests (%default)') # Some of our tests hard-code pathnames e.g., to execute, so until # that changes we don't have the freedom to run from anyplace. # parser.add_option('--mongo-repo', dest='mongo_repo', default=None, parser.add_option('--test-path', dest='test_path', default=None, help="Path to the test executables to run, " "currently only used for 'client' (%default)") parser.add_option('--mongod', dest='mongod_executable', default=os.path.join(mongo_repo, 'mongod'), help='Path to mongod to run (%default)') parser.add_option('--port', dest='mongod_port', default="32000", help='Port the mongod will bind to (%default)') parser.add_option('--mongo', dest='shell_executable', default=os.path.join(mongo_repo, 'mongo'), help='Path to mongo, for .js test files (%default)') parser.add_option('--continue-on-failure', dest='continue_on_failure', action="store_true", default=False, help='If supplied, continue testing even after a test fails') parser.add_option('--from-file', dest='File', help="Run tests/suites named in FILE, one test per line, '-' means stdin") parser.add_option('--smoke-db-prefix', dest='smoke_db_prefix', default=smoke_db_prefix, help="Prefix to use for the mongods' dbpaths ('%default')") parser.add_option('--small-oplog', dest='small_oplog', default=False, action="store_true", help='Run tests with master/slave replication & use a small oplog') global tests (options, tests) = parser.parse_args() print tests test_path = options.test_path mongod_executable = options.mongod_executable if not os.path.exists(mongod_executable): print "ERROR: no mongod found in this directory." return mongod_port = options.mongod_port shell_executable = options.shell_executable if not os.path.exists(shell_executable): print "ERROR: no mongo shell found in this directory." return continue_on_failure = options.continue_on_failure smoke_db_prefix = options.smoke_db_prefix small_oplog = options.small_oplog if options.File: if options.File == '-': tests = sys.stdin.readlines() else: with open(options.File) as f: tests = f.readlines() tests = [t.rstrip('\n') for t in tests] # If we're in suite mode, tests is a list of names of sets of tests. if options.mode == 'suite': tests = expand_suites(tests) elif options.mode == 'files': tests = [(os.path.abspath(test), True) for test in tests] if not tests: raise Exception( "no tests specified" ) try: run_tests(tests) finally: report() if __name__ == "__main__": main()