def testDisabledCronJobDoesNotScheduleFlows(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs()
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn1 = cron_manager.ScheduleFlow(cron_args, token=self.token)
cron_job_urn2 = cron_manager.ScheduleFlow(cron_args, token=self.token)
cron_job1 = aff4.FACTORY.Open(cron_job_urn1,
aff4_type="CronJob",
mode="rw",
token=self.token)
cron_job1.Set(cron_job1.Schema.DISABLED(1))
cron_job1.Close()
cron_manager.RunOnce(token=self.token)
cron_job1 = aff4.FACTORY.Open(cron_job_urn1,
aff4_type="CronJob",
token=self.token)
cron_job2 = aff4.FACTORY.Open(cron_job_urn2,
aff4_type="CronJob",
token=self.token)
# Disabled flow shouldn't be running, while not-disabled flow should run
# as usual.
self.assertFalse(cron_job1.IsRunning())
self.assertTrue(cron_job2.IsRunning())
def testFailedFlowUpdatesStats(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(allow_overruns=False,
periodicity="1d")
cron_args.flow_runner_args.flow_name = "FailingFakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
prev_metric_value = stats.STATS.GetMetricValue(
"cron_job_failure", fields=[cron_job_urn.Basename()])
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, token=self.token)
cron_flow_urn = cron_job.Get(cron_job.Schema.CURRENT_FLOW_URN)
for _ in test_lib.TestFlowHelper(cron_flow_urn,
check_flow_errors=False,
token=self.token):
pass
# This RunOnce call should determine that the flow has failed
cron_manager.RunOnce(token=self.token)
# Check that stats got updated
current_metric_value = stats.STATS.GetMetricValue(
"cron_job_failure", fields=[cron_job_urn.Basename()])
self.assertEqual(current_metric_value - prev_metric_value, 1)
def testCronJobStartsFlowAndCreatesSymlinkOnRun(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs()
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
self.assertFalse(cron_job.IsRunning())
# The job never ran, so DueToRun() should return true.
self.assertTrue(cron_job.DueToRun())
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
self.assertTrue(cron_job.IsRunning())
# Check that a link to the flow is created under job object.
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 1)
# Check that the link points to the correct flow.
cron_job_flow = aff4.FACTORY.Open(cron_job_flows[0], token=self.token)
self.assertEqual(cron_job_flow.state.context.args.flow_name, "FakeCronJob")
def testCronJobRunDoesNothingIfCurrentFlowIsRunning(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(allow_overruns=False,
periodicity="1d")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 1)
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 1)
def testReschedulingJobWithFixedNameDoesNotCreateNewObjectVersion(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(allow_overruns=True,
periodicity="1d")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
# Schedule cron job with a fixed name. Check that we have 1 version
# of "TYPE" attribute.
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token,
job_name="TheJob")
cron_job = aff4.FACTORY.Open(cron_job_urn,
age=aff4.ALL_TIMES,
token=self.token)
attr_values = list(cron_job.GetValuesForAttribute(
cron_job.Schema.TYPE))
self.assertTrue(len(attr_values) == 1)
# Reschedule the job. Check that we still have only one "TYPE" version.
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token,
job_name="TheJob")
cron_job = aff4.FACTORY.Open(cron_job_urn,
age=aff4.ALL_TIMES,
token=self.token)
attr_values = list(cron_job.GetValuesForAttribute(
cron_job.Schema.TYPE))
self.assertTrue(len(attr_values) == 1)
def testLatencyStatsAreCorrectlyRecorded(self):
with test_lib.FakeTime(0):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs()
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_args.periodicity = "1w"
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
cron_manager.RunOnce(token=self.token)
prev_metric_value = stats.STATS.GetMetricValue(
"cron_job_latency", fields=[cron_job_urn.Basename()])
# Fast foward one minute
with test_lib.FakeTime(60):
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
cron_flow_urn = cron_job.Get(cron_job.Schema.CURRENT_FLOW_URN)
for _ in test_lib.TestFlowHelper(cron_flow_urn,
check_flow_errors=False,
token=self.token):
pass
# This RunOnce call should determine that the flow has finished
cron_manager.RunOnce(token=self.token)
# Check that stats got updated
current_metric_value = stats.STATS.GetMetricValue(
"cron_job_latency", fields=[cron_job_urn.Basename()])
self.assertEqual(current_metric_value.count - prev_metric_value.count, 1)
self.assertEqual(current_metric_value.sum - prev_metric_value.sum, 60)
def testCronJobPreservesFlowNameAndArguments(self):
"""Testing initialization of a ConfigManager."""
pathspec = rdfvalue.PathSpec(path="/foo",
pathtype=rdfvalue.PathSpec.PathType.TSK)
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(periodicity="1d",
allow_overruns=False)
cron_args.flow_runner_args.flow_name = "GetFile"
cron_args.flow_args.pathspec = pathspec
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
# Check that CronJob definition is saved properly
cron_root = aff4.FACTORY.Open(cron_manager.CRON_JOBS_PATH, token=self.token)
cron_jobs = list(cron_root.ListChildren())
self.assertEqual(len(cron_jobs), 1)
self.assertEqual(cron_jobs[0], cron_job_urn)
cron_job = aff4.FACTORY.Open(cron_jobs[0], token=self.token)
cron_args = cron_job.Get(cron_job.Schema.CRON_ARGS)
self.assertEqual(cron_args.flow_runner_args.flow_name, "GetFile")
self.assertEqual(cron_args.flow_args.pathspec, pathspec)
self.assertEqual(cron_args.periodicity, rdfvalue.Duration("1d"))
self.assertEqual(cron_args.allow_overruns, False)
def testCronJobRunAllowsOverrunsWhenAllowOverrunsIsTrue(self):
with test_lib.FakeTime(0):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(
allow_overruns=True, periodicity="1h")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(
cron_args=cron_args, token=self.token)
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 1)
# Let an hour pass. Frequency is 1h (i.e. cron job iterations are
# supposed to be started every hour), so the new flow should be started
# by RunOnce(). Previous iteration flow hasn't finished yet, but
# allow_overruns is True, so it's ok to start new iteration.
time.time = lambda: 60*60 + 1
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 2)
def testCronJobRunDoesNothingIfDueTimeHasNotComeYet(self):
with test_lib.FakeTime(0):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(
allow_overruns=False, periodicity="1h")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(
cron_args=cron_args, token=self.token)
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 1)
# Let 59 minutes pass. Frequency is 1 hour, so new flow is not
# supposed to start.
time.time = lambda: 59 * 60
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn, aff4_type="CronJob",
token=self.token)
cron_job_flows = list(cron_job.ListChildren())
self.assertEqual(len(cron_job_flows), 1)
def testKillOldFlows(self):
with test_lib.FakeTime(0):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs()
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_args.periodicity = "1w"
cron_args.lifetime = FakeCronJob.lifetime
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertTrue(cron_job.IsRunning())
self.assertFalse(cron_job.KillOldFlows())
prev_timeout_value = stats.STATS.GetMetricValue(
"cron_job_timeout", fields=[cron_job_urn.Basename()])
prev_latency_value = stats.STATS.GetMetricValue(
"cron_job_latency", fields=[cron_job_urn.Basename()])
# Fast foward one day
with test_lib.FakeTime(24 * 60 * 60 + 1):
flow_urn = cron_job.Get(cron_job.Schema.CURRENT_FLOW_URN)
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertFalse(cron_job.IsRunning())
# Check the termination log
log_collection = aff4.FACTORY.Open(urn=flow_urn.Add("Logs"),
token=self.token,
mode="r")
for line in log_collection:
if line.urn == flow_urn:
self.assertTrue(
"lifetime exceeded" in str(line.log_message))
# Check that timeout counter got updated.
current_timeout_value = stats.STATS.GetMetricValue(
"cron_job_timeout", fields=[cron_job_urn.Basename()])
self.assertEqual(current_timeout_value - prev_timeout_value, 1)
# Check that latency stat got updated.
current_latency_value = stats.STATS.GetMetricValue(
"cron_job_latency", fields=[cron_job_urn.Basename()])
self.assertEqual(
current_latency_value.count - prev_latency_value.count, 1)
self.assertEqual(
current_latency_value.sum - prev_latency_value.sum,
24 * 60 * 60 + 1)
def ParseCronParameters(self):
cron_parmeters = forms.SemanticProtoFormRenderer(
rdfvalue.CreateCronJobFlowArgs(), prefix="cron").ParseArgs(
self.request)
cron_parmeters.flow_runner_args.flow_name = "CreateGenericHuntFlow"
cron_parmeters.flow_args.hunt_runner_args = self.ParseHuntRunnerArgs()
cron_parmeters.flow_args.hunt_args = self.ParseHuntArgs()
return cron_parmeters
def Layout(self, request, response):
cron_args = rdfvalue.CreateCronJobFlowArgs()
cron_args.flow_runner_args.flow_name = "CreateGenericHuntFlow"
self.cron_form = forms.SemanticProtoFormRenderer(
cron_args, id=self.id,
supressions=self.cron_suppressions,
prefix="cron").RawHTML(request)
return super(CronConfigureSchedule, self).Layout(request, response)
def testSchedulingJobWithFixedNamePreservesTheName(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(
allow_overruns=True, periodicity="1d")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(
cron_args=cron_args, token=self.token, job_name="TheJob")
self.assertEqual("TheJob", cron_job_urn.Basename())
def ParseCronParameters(self):
params = forms.SemanticProtoFormRenderer(
rdfvalue.CreateCronJobFlowArgs(),
prefix="cron").ParseArgs(self.request)
params.flow_runner_args.flow_name = "CreateAndRunGenericHuntFlow"
params.flow_args.hunt_runner_args = self.ParseHuntRunnerArgs()
params.flow_args.hunt_runner_args.description = ("%s Cron" %
params.description)
params.flow_args.hunt_args = self.ParseHuntArgs()
return params
def testCronJobRunMonitorsRunningFlowState(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(allow_overruns=False,
periodicity="1d")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(cron_args, token=self.token)
# Run() wasn't called, so nothing is supposed to be running
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertFalse(cron_job.IsRunning())
cron_manager.RunOnce(token=self.token)
# Run() was called and flow was started, so the job should be
# considered running.
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertTrue(cron_job.IsRunning())
# Find the flow that is currently running for the job and terminate it.
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertTrue(cron_job.IsRunning())
cron_job_flow_urn = cron_job.Get(cron_job.Schema.CURRENT_FLOW_URN)
self.assertTrue(cron_job_flow_urn is not None)
flow.GRRFlow.TerminateFlow(cron_job_flow_urn, token=self.token)
# Check we're dead
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertFalse(cron_job.IsRunning())
# This will understand that current flow has terminated. New flow won't be
# started, because iterations are supposed to be started once per day
# (frequency=1d).
cron_manager.RunOnce(token=self.token)
# Still dead
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
self.assertFalse(cron_job.IsRunning())
def testCronManagerListJobsDoesNotListDeletedJobs(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs(
allow_overruns=True, periodicity="1d")
cron_args.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn = cron_manager.ScheduleFlow(
cron_args=cron_args, token=self.token)
cron_jobs = list(cron_manager.ListJobs(token=self.token))
self.assertEqual(len(cron_jobs), 1)
cron_manager.DeleteJob(cron_job_urn, token=self.token)
cron_jobs = list(cron_manager.ListJobs(token=self.token))
self.assertEqual(len(cron_jobs), 0)
def testLastRunStatusGetsUpdatedOnEveryRun(self):
cron_manager = cronjobs.CronManager()
cron_args = rdfvalue.CreateCronJobFlowArgs()
cron_args.flow_runner_args.flow_name = "OccasionallyFailingFakeCronJob"
cron_args.periodicity = "30s"
cron_job_urn = cron_manager.ScheduleFlow(cron_args=cron_args,
token=self.token)
for fake_time in [0, 60]:
with test_lib.FakeTime(fake_time):
# This call should start a new cron job flow
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
aff4_type="CronJob",
token=self.token)
cron_flow_urn = cron_job.Get(cron_job.Schema.CURRENT_FLOW_URN)
for _ in test_lib.TestFlowHelper(cron_flow_urn,
check_flow_errors=False,
token=self.token):
pass
# This RunOnce call should determine that the flow has finished
cron_manager.RunOnce(token=self.token)
cron_job = aff4.FACTORY.Open(cron_job_urn,
age=aff4.ALL_TIMES,
token=self.token)
statuses = list(
cron_job.GetValuesForAttribute(cron_job.Schema.LAST_RUN_STATUS))
statuses = sorted(statuses, key=lambda x: x.age)
self.assertEqual(len(statuses), 2)
self.assertEqual(statuses[0].age,
rdfvalue.RDFDatetime().FromSecondsFromEpoch(0))
self.assertEqual(statuses[1].age,
rdfvalue.RDFDatetime().FromSecondsFromEpoch(60))
self.assertEqual(statuses[0].status,
rdfvalue.CronJobRunStatus.Status.OK)
self.assertEqual(statuses[1].status,
rdfvalue.CronJobRunStatus.Status.ERROR)
def testCronJobRespectsStartTime(self):
with test_lib.FakeTime(0):
cron_manager = cronjobs.CronManager()
start_time1 = rdfvalue.RDFDatetime(100 * 1000 * 1000)
cron_args1 = rdfvalue.CreateCronJobFlowArgs(start_time=start_time1)
cron_args1.flow_runner_args.flow_name = "FakeCronJob"
cron_args2 = rdfvalue.CreateCronJobFlowArgs()
cron_args2.flow_runner_args.flow_name = "FakeCronJob"
cron_job_urn1 = cron_manager.ScheduleFlow(cron_args1,
token=self.token)
cron_job_urn2 = cron_manager.ScheduleFlow(cron_args2,
token=self.token)
cron_manager.RunOnce(token=self.token)
cron_job1 = aff4.FACTORY.Open(cron_job_urn1,
aff4_type="CronJob",
token=self.token)
cron_job2 = aff4.FACTORY.Open(cron_job_urn2,
aff4_type="CronJob",
token=self.token)
self.assertEqual(
cron_job1.Get(cron_job1.Schema.CRON_ARGS).start_time,
start_time1)
# Flow without a start time should now be running
self.assertFalse(cron_job1.IsRunning())
self.assertTrue(cron_job2.IsRunning())
# Move the clock past the start time
with test_lib.FakeTime(500):
cron_manager.RunOnce(token=self.token)
cron_job1 = aff4.FACTORY.Open(cron_job_urn1,
aff4_type="CronJob",
token=self.token)
cron_job2 = aff4.FACTORY.Open(cron_job_urn2,
aff4_type="CronJob",
token=self.token)
# Start time should be the same
self.assertEqual(
cron_job1.Get(cron_job1.Schema.CRON_ARGS).start_time,
start_time1)
# Now both should be running
self.assertTrue(cron_job1.IsRunning())
self.assertTrue(cron_job2.IsRunning())
# Check setting a bad flow urn is handled and removed
with aff4.FACTORY.OpenWithLock(cron_job_urn2,
aff4_type="CronJob",
token=self.token) as cron_job2:
cron_job2.Set(
cron_job2.Schema.CURRENT_FLOW_URN("aff4:/does/not/exist"))
self.assertFalse(cron_job2.IsRunning())
cron_job2 = aff4.FACTORY.Open(cron_job_urn2,
aff4_type="CronJob",
token=self.token)
self.assertFalse(cron_job2.Get(cron_job2.Schema.CURRENT_FLOW_URN))
