class TestCaseWithDatabase(unittest.TestCase):
"""TestCase subclass starting with a clean testing database."""
@classmethod
def setUpClass(cls):
assert "fortesting" in str(cms.db.engine), \
"Monkey patching of DB connection string failed"
drop_db()
init_db()
cls.connection = cms.db.engine.connect()
cms.db.metadata.create_all(cls.connection)
@classmethod
def tearDownClass(cls):
drop_db()
cls.connection.close()
cms.db.engine.dispose()
def setUp(self):
self.session = Session()
def tearDown(self):
self.session.rollback()
def delete_data(self):
"""Delete all the data in the DB.
This is useful to call during tear down, for tests that rely on
starting from a clean DB.
"""
for table in itervalues(Base.metadata.tables):
self.session.execute(table.delete())
self.session.commit()
@staticmethod
def add_fsobject(digest, content):
dbbackend = DBBackend()
fobj = dbbackend.create_file(digest)
fobj.write(content)
dbbackend.commit_file(fobj, digest)
@staticmethod
def get_contest(**kwargs):
"""Create a contest"""
args = {
"name": unique_unicode_id(),
"description": unique_unicode_id(),
}
args.update(kwargs)
contest = Contest(**args)
return contest
def add_contest(self, **kwargs):
"""Create a contest and add it to the session"""
contest = self.get_contest(**kwargs)
self.session.add(contest)
return contest
@staticmethod
def get_user(**kwargs):
"""Create a user"""
args = {
"username": unique_unicode_id(),
"password": "",
"first_name": unique_unicode_id(),
"last_name": unique_unicode_id(),
}
args.update(kwargs)
user = User(**args)
return user
def add_user(self, **kwargs):
"""Create a user and add it to the session"""
user = self.get_user(**kwargs)
self.session.add(user)
return user
@staticmethod
def get_participation(user=None, contest=None, **kwargs):
"""Create a participation"""
user = user if user is not None else TestCaseWithDatabase.get_user()
contest = contest \
if contest is not None else TestCaseWithDatabase.get_contest()
args = {
"user": user,
"contest": contest,
}
args.update(kwargs)
participation = Participation(**args)
return participation
def add_participation(self, **kwargs):
"""Create a participation and add it to the session"""
participation = self.get_participation(**kwargs)
self.session.add(participation)
return participation
@staticmethod
def get_task(**kwargs):
"""Create a task"""
args = {
"name": unique_unicode_id(),
"title": unique_unicode_id(),
}
args.update(kwargs)
task = Task(**args)
return task
def add_task(self, **kwargs):
"""Create a task and add it to the session"""
task = self.get_task(**kwargs)
self.session.add(task)
return task
def add_statement(self, task=None, **kwargs):
"""Create a statement and add it to the session"""
task = task if task is not None else self.add_task()
args = {
"task": task,
"digest": unique_digest(),
"language": unique_unicode_id(),
}
args.update(kwargs)
statement = Statement(**args)
self.session.add(statement)
return statement
@staticmethod
def get_dataset(task=None, **kwargs):
"""Create a dataset"""
task = task if task is not None else TestCaseWithDatabase.get_task()
args = {
"task": task,
"description": unique_unicode_id(),
"task_type": "",
# "None" won't work here as the column is defined as non
# nullable. As soon as we'll depend on SQLAlchemy 1.1 we
# will be able to put JSON.NULL here instead.
"task_type_parameters": {},
"score_type": "",
# Same here.
"score_type_parameters": {},
}
args.update(kwargs)
dataset = Dataset(**args)
return dataset
def add_dataset(self, **kwargs):
"""Create a dataset and add it to the session"""
dataset = self.get_dataset(**kwargs)
self.session.add(dataset)
return dataset
def add_testcase(self, dataset=None, **kwargs):
"""Add a testcase."""
dataset = dataset if dataset is not None else self.add_dataset()
args = {
"dataset": dataset,
"codename": unique_unicode_id(),
"input": unique_digest(),
"output": unique_digest(),
}
args.update(kwargs)
testcase = Testcase(**args)
self.session.add(testcase)
return testcase
def add_submission(self, task=None, participation=None, **kwargs):
"""Add a submission."""
if task is None:
task = self.add_task(contest=self.add_contest())
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
submission = Submission(**args)
self.session.add(submission)
return submission
def add_file(self, submission=None, **kwargs):
"""Create a file and add it to the session"""
if submission is None:
submission = self.add_sbubmission()
args = {
"submission": submission,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
file = File(**args)
self.session.add(file)
return file
def add_submission_result(self, submission=None, dataset=None, **kwargs):
"""Add a submission result."""
task = None
task = submission.task if submission is not None else task
task = dataset.task if dataset is not None else task
submission = submission \
if submission is not None else self.add_submission(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert submission.task == dataset.task
args = {
"submission": submission,
"dataset": dataset,
}
args.update(kwargs)
submission_result = SubmissionResult(**args)
self.session.add(submission_result)
return submission_result
def add_executable(self, submission_result=None, **kwargs):
"""Create an executable and add it to the session"""
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result()
args = {
"submission_result": submission_result,
"digest": unique_digest(),
"filename": unique_unicode_id(),
}
args.update(kwargs)
executable = Executable(**args)
self.session.add(executable)
return executable
def add_evaluation(self, submission_result=None, testcase=None, **kwargs):
"""Add an evaluation."""
dataset = None
dataset = submission_result.dataset \
if submission_result is not None else dataset
dataset = testcase.dataset if testcase is not None else dataset
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result(dataset=dataset)
testcase = testcase if testcase is not None else self.add_testcase()
assert submission_result.dataset == testcase.dataset
args = {
"submission_result": submission_result,
"testcase": testcase,
}
args.update(kwargs)
evaluation = Evaluation(**args)
self.session.add(evaluation)
return evaluation
def add_user_test(self, task=None, participation=None, **kwargs):
"""Add a user test."""
if task is None:
task = self.add_task(contest=self.add_contest())
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"input": unique_digest(),
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
user_test = UserTest(**args)
self.session.add(user_test)
return user_test
def add_user_test_result(self, user_test=None, dataset=None, **kwargs):
"""Add a user test result."""
task = None
task = user_test.task if user_test is not None else task
task = dataset.task if dataset is not None else task
user_test = user_test \
if user_test is not None else self.add_user_test(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert user_test.task == dataset.task
args = {
"user_test": user_test,
"dataset": dataset,
}
args.update(kwargs)
user_test_result = UserTestResult(**args)
self.session.add(user_test_result)
return user_test_result
# Other commonly used generation functions.
def add_submission_with_results(self, task, participation,
compilation_outcome=None):
"""Add a submission for the tasks, all of its results, and optionally
the compilation outcome for all results.
"""
submission = self.add_submission(task, participation)
results = [self.add_submission_result(submission, dataset)
for dataset in task.datasets]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return submission, results
def add_user_test_with_results(self, compilation_outcome=None):
"""Add a user_test for the first tasks, all of its results, and
optionally the compilation outcome for all results.
"""
user_test = self.add_user_test(self.tasks[0], self.participation)
results = [self.add_user_test_result(user_test, dataset)
for dataset in self.tasks[0].datasets]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return user_test, results
@staticmethod
def get_team(**kwargs):
"""Create a team"""
args = {
"code": unique_unicode_id(),
"name": unique_unicode_id(),
}
args.update(kwargs)
team = Team(**args)
return team
def add_team(self, **kwargs):
"""Create a team and add it to the session"""
team = self.get_team(**kwargs)
self.session.add(team)
return team
class DatabaseMixin(DatabaseObjectGeneratorMixin):
"""Mixin for tests with database access."""
@classmethod
def setUpClass(cls):
super(DatabaseMixin, cls).setUpClass()
assert "fortesting" in str(cms.db.engine), \
"Monkey patching of DB connection string failed"
drop_db()
init_db()
cls.connection = cms.db.engine.connect()
cms.db.metadata.create_all(cls.connection)
@classmethod
def tearDownClass(cls):
drop_db()
cls.connection.close()
cms.db.engine.dispose()
super(DatabaseMixin, cls).tearDownClass()
def setUp(self):
super(DatabaseMixin, self).setUp()
self.session = Session()
def tearDown(self):
self.session.rollback()
super(DatabaseMixin, self).tearDown()
def delete_data(self):
"""Delete all the data in the DB.
This is useful to call during tear down, for tests that rely on
starting from a clean DB.
"""
for table in itervalues(Base.metadata.tables):
self.session.execute(table.delete())
self.session.commit()
@staticmethod
def add_fsobject(digest, content):
dbbackend = DBBackend()
fobj = dbbackend.create_file(digest)
fobj.write(content)
dbbackend.commit_file(fobj, digest)
def add_contest(self, **kwargs):
"""Create a contest and add it to the session"""
contest = self.get_contest(**kwargs)
self.session.add(contest)
return contest
def add_announcement(self, **kwargs):
"""Create an announcement and add it to the session"""
announcement = self.get_announcement(**kwargs)
self.session.add(announcement)
return announcement
def add_user(self, **kwargs):
"""Create a user and add it to the session"""
user = self.get_user(**kwargs)
self.session.add(user)
return user
def add_participation(self, **kwargs):
"""Create a participation and add it to the session"""
participation = self.get_participation(**kwargs)
self.session.add(participation)
return participation
def add_message(self, **kwargs):
"""Create a message and add it to the session"""
message = self.get_message(**kwargs)
self.session.add(message)
return message
def add_question(self, **kwargs):
"""Create a question and add it to the session"""
question = self.get_question(**kwargs)
self.session.add(question)
return question
def add_task(self, **kwargs):
"""Create a task and add it to the session"""
task = self.get_task(**kwargs)
self.session.add(task)
return task
def add_statement(self, task=None, **kwargs):
"""Create a statement and add it to the session"""
task = task if task is not None else self.add_task()
args = {
"task": task,
"digest": unique_digest(),
"language": unique_unicode_id(),
}
args.update(kwargs)
statement = Statement(**args)
self.session.add(statement)
return statement
def add_dataset(self, **kwargs):
"""Create a dataset and add it to the session"""
dataset = self.get_dataset(**kwargs)
self.session.add(dataset)
return dataset
def add_manager(self, dataset=None, **kwargs):
"""Create a manager and add it to the session."""
manager = self.get_manager(dataset=dataset, **kwargs)
self.session.add(manager)
return manager
def add_testcase(self, dataset=None, **kwargs):
"""Add a testcase."""
dataset = dataset if dataset is not None else self.add_dataset()
args = {
"dataset": dataset,
"codename": unique_unicode_id(),
"input": unique_digest(),
"output": unique_digest(),
}
args.update(kwargs)
testcase = Testcase(**args)
self.session.add(testcase)
return testcase
def add_submission(self, task=None, participation=None, **kwargs):
"""Add a submission."""
submission = self.get_submission(task, participation, **kwargs)
self.session.add(submission)
return submission
def add_file(self, submission=None, **kwargs):
"""Create a file and add it to the session"""
if submission is None:
submission = self.add_submission()
args = {
"submission": submission,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
file_ = File(**args)
self.session.add(file_)
return file_
def add_token(self, submission=None, **kwargs):
"""Create a token and add it to the session"""
token = self.get_token(submission, **kwargs)
self.session.add(token)
return token
def add_submission_result(self, submission=None, dataset=None, **kwargs):
"""Add a submission result."""
submission_result = self.get_submission_result(submission, dataset,
**kwargs)
self.session.add(submission_result)
return submission_result
def add_executable(self, submission_result=None, **kwargs):
"""Create an executable and add it to the session"""
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result()
args = {
"submission_result": submission_result,
"digest": unique_digest(),
"filename": unique_unicode_id(),
}
args.update(kwargs)
executable = Executable(**args)
self.session.add(executable)
return executable
def add_evaluation(self, submission_result=None, testcase=None, **kwargs):
"""Add an evaluation."""
dataset = None
dataset = submission_result.dataset \
if submission_result is not None else dataset
dataset = testcase.dataset if testcase is not None else dataset
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result(dataset=dataset)
testcase = testcase if testcase is not None else self.add_testcase()
assert submission_result.dataset == testcase.dataset
args = {
"submission_result": submission_result,
"testcase": testcase,
}
args.update(kwargs)
evaluation = Evaluation(**args)
self.session.add(evaluation)
return evaluation
def add_user_test(self, task=None, participation=None, **kwargs):
"""Add a user test."""
if task is None:
task = self.add_task(contest=self.add_contest())
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"input": unique_digest(),
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
user_test = UserTest(**args)
self.session.add(user_test)
return user_test
def add_user_test_file(self, user_test=None, **kwargs):
"""Create a user test file and add it to the session"""
if user_test is None:
user_test = self.add_user_test()
args = {
"user_test": user_test,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
user_test_file = UserTestFile(**args)
self.session.add(user_test_file)
return user_test_file
def add_user_test_manager(self, user_test=None, **kwargs):
"""Create a user test manager and add it to the session"""
if user_test is None:
user_test = self.add_user_test()
args = {
"user_test": user_test,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
user_test_manager = UserTestManager(**args)
self.session.add(user_test_manager)
return user_test_manager
def add_user_test_result(self, user_test=None, dataset=None, **kwargs):
"""Add a user test result."""
task = None
task = user_test.task if user_test is not None else task
task = dataset.task if dataset is not None else task
user_test = user_test \
if user_test is not None else self.add_user_test(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert user_test.task == dataset.task
args = {
"user_test": user_test,
"dataset": dataset,
}
args.update(kwargs)
user_test_result = UserTestResult(**args)
self.session.add(user_test_result)
return user_test_result
# Other commonly used generation functions.
def add_submission_with_results(self,
task,
participation,
compilation_outcome=None):
"""Add a submission for the tasks, all of its results, and optionally
the compilation outcome for all results.
"""
submission = self.add_submission(task, participation)
results = [
self.add_submission_result(submission, dataset)
for dataset in task.datasets
]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return submission, results
def add_user_test_with_results(self, compilation_outcome=None):
"""Add a user_test for the first tasks, all of its results, and
optionally the compilation outcome for all results.
"""
user_test = self.add_user_test(self.tasks[0], self.participation)
results = [
self.add_user_test_result(user_test, dataset)
for dataset in self.tasks[0].datasets
]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return user_test, results
def add_team(self, **kwargs):
"""Create a team and add it to the session"""
team = self.get_team(**kwargs)
self.session.add(team)
return team
class TestCaseWithDatabase(unittest.TestCase):
"""TestCase subclass starting with a clean testing database."""
@classmethod
def setUpClass(cls):
cms.db.engine = create_engine(cms.config.database)
drop_db()
init_db()
cls.connection = cms.db.engine.connect()
cms.db.metadata.create_all(cls.connection)
@classmethod
def tearDownClass(cls):
drop_db()
cls.connection.close()
cms.db.engine.dispose()
def setUp(self):
self.session = Session()
def tearDown(self):
self.session.rollback()
def add_contest(self, **kwargs):
"""Add a contest."""
args = {
"name": unique_unicode_id(),
"description": unique_unicode_id(),
}
args.update(kwargs)
contest = Contest(**args)
self.session.add(contest)
return contest
def add_user(self, **kwargs):
"""Add a user."""
args = {
"username": unique_unicode_id(),
"password": "",
"first_name": unique_unicode_id(),
"last_name": unique_unicode_id(),
}
args.update(kwargs)
user = User(**args)
self.session.add(user)
return user
def add_participation(self, user=None, contest=None, **kwargs):
"""Add a participation."""
user = user if user is not None else self.add_user()
contest = contest if contest is not None else self.add_contest()
args = {
"user": user,
"contest": contest,
}
args.update(kwargs)
participation = Participation(**args)
self.session.add(participation)
return participation
def add_task(self, contest=None, **kwargs):
"""Add a task."""
contest = contest if contest is not None else self.add_contest()
args = {
"contest": contest,
"name": unique_unicode_id(),
"title": unique_unicode_id(),
}
args.update(kwargs)
task = Task(**args)
self.session.add(task)
return task
def add_dataset(self, task=None, **kwargs):
"""Add a dataset."""
task = task if task is not None else self.add_task()
args = {
"task": task,
"description": unique_unicode_id(),
"task_type": "",
"task_type_parameters": "",
"score_type": "",
"score_type_parameters": "",
}
args.update(kwargs)
dataset = Dataset(**args)
self.session.add(dataset)
return dataset
def add_testcase(self, dataset=None, **kwargs):
"""Add a testcase."""
dataset = dataset if dataset is not None else self.add_dataset()
args = {
"dataset": dataset,
"codename": unique_unicode_id(),
"input": unique_digest(),
"output": unique_digest(),
}
args.update(kwargs)
testcase = Testcase(**args)
self.session.add(testcase)
return testcase
def add_submission(self, task=None, participation=None, **kwargs):
"""Add a submission."""
task = task if task is not None else self.add_task()
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
submission = Submission(**args)
self.session.add(submission)
return submission
def add_submission_result(self, submission=None, dataset=None, **kwargs):
"""Add a submission result."""
task = None
task = submission.task if submission is not None else task
task = dataset.task if dataset is not None else task
submission = submission \
if submission is not None else self.add_submission(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert submission.task == dataset.task
args = {
"submission": submission,
"dataset": dataset,
}
args.update(kwargs)
submission_result = SubmissionResult(**args)
self.session.add(submission_result)
return submission_result
def add_evaluation(self, submission_result=None, testcase=None, **kwargs):
"""Add an evaluation."""
dataset = None
dataset = submission_result.dataset \
if submission_result is not None else dataset
dataset = testcase.dataset if testcase is not None else dataset
submission_result = submission_result \
if submission_result is not None else self.add_submission_result()
testcase = testcase if testcase is not None else self.add_testcase()
assert submission_result.dataset == testcase.dataset
args = {
"submission_result": submission_result,
"testcase": testcase,
}
args.update(kwargs)
evaluation = Evaluation(**args)
self.session.add(evaluation)
return evaluation
def add_user_test(self, task=None, participation=None, **kwargs):
"""Add a user test."""
task = task if task is not None else self.add_task()
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"input": unique_digest(),
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
user_test = UserTest(**args)
self.session.add(user_test)
return user_test
def add_user_test_result(self, user_test=None, dataset=None, **kwargs):
"""Add a user test result."""
task = None
task = user_test.task if user_test is not None else task
task = dataset.task if dataset is not None else task
user_test = user_test \
if user_test is not None else self.add_user_test(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert user_test.task == dataset.task
args = {
"user_test": user_test,
"dataset": dataset,
}
args.update(kwargs)
user_test_result = UserTestResult(**args)
self.session.add(user_test_result)
return user_test_result
# Other commonly used generation functions.
def add_submission_with_results(self, task, participation,
compilation_outcome=None):
"""Add a submission for the tasks, all of its results, and optionally
the compilation outcome for all results.
"""
submission = self.add_submission(task, participation)
results = [self.add_submission_result(submission, dataset)
for dataset in task.datasets]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return submission, results
def add_user_test_with_results(self, compilation_outcome=None):
"""Add a user_test for the first tasks, all of its results, and
optionally the compilation outcome for all results.
"""
user_test = self.add_user_test(self.tasks[0], self.participation)
results = [self.add_user_test_result(user_test, dataset)
for dataset in self.tasks[0].datasets]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return user_test, results
class TestCaseWithDatabase(unittest.TestCase):
"""TestCase subclass starting with a clean testing database."""
@classmethod
def setUpClass(cls):
assert "fortesting" in str(cms.db.engine), \
"Monkey patching of DB connection string failed"
drop_db()
init_db()
cls.connection = cms.db.engine.connect()
cms.db.metadata.create_all(cls.connection)
@classmethod
def tearDownClass(cls):
drop_db()
cls.connection.close()
cms.db.engine.dispose()
def setUp(self):
self.session = Session()
def tearDown(self):
self.session.rollback()
def delete_data(self):
"""Delete all the data in the DB.
This is useful to call during tear down, for tests that rely on
starting from a clean DB.
"""
for table in itervalues(Base.metadata.tables):
self.session.execute(table.delete())
self.session.commit()
@staticmethod
def add_fsobject(digest, content):
dbbackend = DBBackend()
fobj = dbbackend.create_file(digest)
fobj.write(content)
dbbackend.commit_file(fobj, digest)
@staticmethod
def get_contest(**kwargs):
"""Create a contest"""
args = {
"name": unique_unicode_id(),
"description": unique_unicode_id(),
}
args.update(kwargs)
contest = Contest(**args)
return contest
def add_contest(self, **kwargs):
"""Create a contest and add it to the session"""
contest = self.get_contest(**kwargs)
self.session.add(contest)
return contest
@staticmethod
def get_user(**kwargs):
"""Create a user"""
args = {
"username": unique_unicode_id(),
"password": "",
"first_name": unique_unicode_id(),
"last_name": unique_unicode_id(),
}
args.update(kwargs)
user = User(**args)
return user
def add_user(self, **kwargs):
"""Create a user and add it to the session"""
user = self.get_user(**kwargs)
self.session.add(user)
return user
@staticmethod
def get_participation(user=None, contest=None, **kwargs):
"""Create a participation"""
user = user if user is not None else TestCaseWithDatabase.get_user()
contest = contest \
if contest is not None else TestCaseWithDatabase.get_contest()
args = {
"user": user,
"contest": contest,
}
args.update(kwargs)
participation = Participation(**args)
return participation
def add_participation(self, **kwargs):
"""Create a participation and add it to the session"""
participation = self.get_participation(**kwargs)
self.session.add(participation)
return participation
@staticmethod
def get_task(**kwargs):
"""Create a task"""
args = {
"name": unique_unicode_id(),
"title": unique_unicode_id(),
}
args.update(kwargs)
task = Task(**args)
return task
def add_task(self, **kwargs):
"""Create a task and add it to the session"""
task = self.get_task(**kwargs)
self.session.add(task)
return task
def add_statement(self, task=None, **kwargs):
"""Create a statement and add it to the session"""
task = task if task is not None else self.add_task()
args = {
"task": task,
"digest": unique_digest(),
"language": unique_unicode_id(),
}
args.update(kwargs)
statement = Statement(**args)
self.session.add(statement)
return statement
@staticmethod
def get_dataset(task=None, **kwargs):
"""Create a dataset"""
task = task if task is not None else TestCaseWithDatabase.get_task()
args = {
"task": task,
"description": unique_unicode_id(),
"task_type": "",
# "None" won't work here as the column is defined as non
# nullable. As soon as we'll depend on SQLAlchemy 1.1 we
# will be able to put JSON.NULL here instead.
"task_type_parameters": {},
"score_type": "",
# Same here.
"score_type_parameters": {},
}
args.update(kwargs)
dataset = Dataset(**args)
return dataset
def add_dataset(self, **kwargs):
"""Create a dataset and add it to the session"""
dataset = self.get_dataset(**kwargs)
self.session.add(dataset)
return dataset
def add_testcase(self, dataset=None, **kwargs):
"""Add a testcase."""
dataset = dataset if dataset is not None else self.add_dataset()
args = {
"dataset": dataset,
"codename": unique_unicode_id(),
"input": unique_digest(),
"output": unique_digest(),
}
args.update(kwargs)
testcase = Testcase(**args)
self.session.add(testcase)
return testcase
def add_submission(self, task=None, participation=None, **kwargs):
"""Add a submission."""
if task is None:
task = self.add_task(contest=self.add_contest())
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
submission = Submission(**args)
self.session.add(submission)
return submission
def add_file(self, submission=None, **kwargs):
"""Create a file and add it to the session"""
if submission is None:
submission = self.add_sbubmission()
args = {
"submission": submission,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
file = File(**args)
self.session.add(file)
return file
def add_submission_result(self, submission=None, dataset=None, **kwargs):
"""Add a submission result."""
task = None
task = submission.task if submission is not None else task
task = dataset.task if dataset is not None else task
submission = submission \
if submission is not None else self.add_submission(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert submission.task == dataset.task
args = {
"submission": submission,
"dataset": dataset,
}
args.update(kwargs)
submission_result = SubmissionResult(**args)
self.session.add(submission_result)
return submission_result
def add_executable(self, submission_result=None, **kwargs):
"""Create an executable and add it to the session"""
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result()
args = {
"submission_result": submission_result,
"digest": unique_digest(),
"filename": unique_unicode_id(),
}
args.update(kwargs)
executable = Executable(**args)
self.session.add(executable)
return executable
def add_evaluation(self, submission_result=None, testcase=None, **kwargs):
"""Add an evaluation."""
dataset = None
dataset = submission_result.dataset \
if submission_result is not None else dataset
dataset = testcase.dataset if testcase is not None else dataset
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result(dataset=dataset)
testcase = testcase if testcase is not None else self.add_testcase()
assert submission_result.dataset == testcase.dataset
args = {
"submission_result": submission_result,
"testcase": testcase,
}
args.update(kwargs)
evaluation = Evaluation(**args)
self.session.add(evaluation)
return evaluation
def add_user_test(self, task=None, participation=None, **kwargs):
"""Add a user test."""
if task is None:
task = self.add_task(contest=self.add_contest())
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"input": unique_digest(),
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
user_test = UserTest(**args)
self.session.add(user_test)
return user_test
def add_user_test_result(self, user_test=None, dataset=None, **kwargs):
"""Add a user test result."""
task = None
task = user_test.task if user_test is not None else task
task = dataset.task if dataset is not None else task
user_test = user_test \
if user_test is not None else self.add_user_test(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert user_test.task == dataset.task
args = {
"user_test": user_test,
"dataset": dataset,
}
args.update(kwargs)
user_test_result = UserTestResult(**args)
self.session.add(user_test_result)
return user_test_result
# Other commonly used generation functions.
def add_submission_with_results(self,
task,
participation,
compilation_outcome=None):
"""Add a submission for the tasks, all of its results, and optionally
the compilation outcome for all results.
"""
submission = self.add_submission(task, participation)
results = [
self.add_submission_result(submission, dataset)
for dataset in task.datasets
]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return submission, results
def add_user_test_with_results(self, compilation_outcome=None):
"""Add a user_test for the first tasks, all of its results, and
optionally the compilation outcome for all results.
"""
user_test = self.add_user_test(self.tasks[0], self.participation)
results = [
self.add_user_test_result(user_test, dataset)
for dataset in self.tasks[0].datasets
]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return user_test, results
@staticmethod
def get_team(**kwargs):
"""Create a team"""
args = {
"code": unique_unicode_id(),
"name": unique_unicode_id(),
}
args.update(kwargs)
team = Team(**args)
return team
def add_team(self, **kwargs):
"""Create a team and add it to the session"""
team = self.get_team(**kwargs)
self.session.add(team)
return team
class DatabaseMixin(DatabaseObjectGeneratorMixin):
"""Mixin for tests with database access."""
@classmethod
def setUpClass(cls):
super(DatabaseMixin, cls).setUpClass()
assert "fortesting" in str(engine), \
"Monkey patching of DB connection string failed"
drop_db()
init_db()
@classmethod
def tearDownClass(cls):
drop_db()
super(DatabaseMixin, cls).tearDownClass()
def setUp(self):
super(DatabaseMixin, self).setUp()
self.session = Session()
def tearDown(self):
self.session.rollback()
super(DatabaseMixin, self).tearDown()
def delete_data(self):
"""Delete all the data in the DB.
This is useful to call during tear down, for tests that rely on
starting from a clean DB.
"""
for table in itervalues(metadata.tables):
self.session.execute(table.delete())
self.session.commit()
@staticmethod
def add_fsobject(digest, content):
dbbackend = DBBackend()
fobj = dbbackend.create_file(digest)
fobj.write(content)
dbbackend.commit_file(fobj, digest)
def add_contest(self, **kwargs):
"""Create a contest and add it to the session"""
contest = self.get_contest(**kwargs)
self.session.add(contest)
return contest
def add_announcement(self, **kwargs):
"""Create an announcement and add it to the session"""
announcement = self.get_announcement(**kwargs)
self.session.add(announcement)
return announcement
def add_user(self, **kwargs):
"""Create a user and add it to the session"""
user = self.get_user(**kwargs)
self.session.add(user)
return user
def add_participation(self, **kwargs):
"""Create a participation and add it to the session"""
participation = self.get_participation(**kwargs)
self.session.add(participation)
return participation
def add_message(self, **kwargs):
"""Create a message and add it to the session"""
message = self.get_message(**kwargs)
self.session.add(message)
return message
def add_question(self, **kwargs):
"""Create a question and add it to the session"""
question = self.get_question(**kwargs)
self.session.add(question)
return question
def add_task(self, **kwargs):
"""Create a task and add it to the session"""
task = self.get_task(**kwargs)
self.session.add(task)
return task
def add_statement(self, task=None, **kwargs):
"""Create a statement and add it to the session"""
task = task if task is not None else self.add_task()
args = {
"task": task,
"digest": unique_digest(),
"language": unique_unicode_id(),
}
args.update(kwargs)
statement = Statement(**args)
self.session.add(statement)
return statement
def add_dataset(self, **kwargs):
"""Create a dataset and add it to the session"""
dataset = self.get_dataset(**kwargs)
self.session.add(dataset)
return dataset
def add_manager(self, dataset=None, **kwargs):
"""Create a manager and add it to the session."""
manager = self.get_manager(dataset=dataset, **kwargs)
self.session.add(manager)
return manager
def add_testcase(self, dataset=None, **kwargs):
"""Add a testcase."""
dataset = dataset if dataset is not None else self.add_dataset()
args = {
"dataset": dataset,
"codename": unique_unicode_id(),
"input": unique_digest(),
"output": unique_digest(),
}
args.update(kwargs)
testcase = Testcase(**args)
self.session.add(testcase)
return testcase
def add_submission(self, task=None, participation=None, **kwargs):
"""Add a submission."""
submission = self.get_submission(task, participation, **kwargs)
self.session.add(submission)
return submission
def add_file(self, submission=None, **kwargs):
"""Create a file and add it to the session"""
if submission is None:
submission = self.add_submission()
args = {
"submission": submission,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
file_ = File(**args)
self.session.add(file_)
return file_
def add_token(self, submission=None, **kwargs):
"""Create a token and add it to the session"""
token = self.get_token(submission, **kwargs)
self.session.add(token)
return token
def add_submission_result(self, submission=None, dataset=None, **kwargs):
"""Add a submission result."""
submission_result = self.get_submission_result(
submission, dataset, **kwargs)
self.session.add(submission_result)
return submission_result
def add_executable(self, submission_result=None, **kwargs):
"""Create an executable and add it to the session"""
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result()
args = {
"submission_result": submission_result,
"digest": unique_digest(),
"filename": unique_unicode_id(),
}
args.update(kwargs)
executable = Executable(**args)
self.session.add(executable)
return executable
def add_evaluation(self, submission_result=None, testcase=None, **kwargs):
"""Add an evaluation."""
dataset = None
dataset = submission_result.dataset \
if submission_result is not None else dataset
dataset = testcase.dataset if testcase is not None else dataset
submission_result = submission_result \
if submission_result is not None \
else self.add_submission_result(dataset=dataset)
testcase = testcase if testcase is not None else self.add_testcase()
assert submission_result.dataset == testcase.dataset
args = {
"submission_result": submission_result,
"testcase": testcase,
}
args.update(kwargs)
evaluation = Evaluation(**args)
self.session.add(evaluation)
return evaluation
def add_user_test(self, task=None, participation=None, **kwargs):
"""Add a user test."""
if task is None:
task = self.add_task(contest=self.add_contest())
participation = participation \
if participation is not None \
else self.add_participation(contest=task.contest)
assert task.contest == participation.contest
args = {
"task": task,
"participation": participation,
"input": unique_digest(),
"timestamp": (task.contest.start + timedelta(0, unique_long_id())),
}
args.update(kwargs)
user_test = UserTest(**args)
self.session.add(user_test)
return user_test
def add_user_test_file(self, user_test=None, **kwargs):
"""Create a user test file and add it to the session"""
if user_test is None:
user_test = self.add_user_test()
args = {
"user_test": user_test,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
user_test_file = UserTestFile(**args)
self.session.add(user_test_file)
return user_test_file
def add_user_test_manager(self, user_test=None, **kwargs):
"""Create a user test manager and add it to the session"""
if user_test is None:
user_test = self.add_user_test()
args = {
"user_test": user_test,
"filename": unique_unicode_id(),
"digest": unique_digest(),
}
args.update(kwargs)
user_test_manager = UserTestManager(**args)
self.session.add(user_test_manager)
return user_test_manager
def add_user_test_result(self, user_test=None, dataset=None, **kwargs):
"""Add a user test result."""
task = None
task = user_test.task if user_test is not None else task
task = dataset.task if dataset is not None else task
user_test = user_test \
if user_test is not None else self.add_user_test(task=task)
dataset = dataset \
if dataset is not None else self.add_dataset(task=task)
assert user_test.task == dataset.task
args = {
"user_test": user_test,
"dataset": dataset,
}
args.update(kwargs)
user_test_result = UserTestResult(**args)
self.session.add(user_test_result)
return user_test_result
# Other commonly used generation functions.
def add_submission_with_results(self, task, participation,
compilation_outcome=None):
"""Add a submission for the tasks, all of its results, and optionally
the compilation outcome for all results.
"""
submission = self.add_submission(task, participation)
results = [self.add_submission_result(submission, dataset)
for dataset in task.datasets]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return submission, results
def add_user_test_with_results(self, compilation_outcome=None):
"""Add a user_test for the first tasks, all of its results, and
optionally the compilation outcome for all results.
"""
user_test = self.add_user_test(self.tasks[0], self.participation)
results = [self.add_user_test_result(user_test, dataset)
for dataset in self.tasks[0].datasets]
if compilation_outcome is not None:
for result in results:
result.set_compilation_outcome(compilation_outcome)
return user_test, results
def add_team(self, **kwargs):
"""Create a team and add it to the session"""
team = self.get_team(**kwargs)
self.session.add(team)
return team