def testByOptions(self, getStubMock):
jobId = 'A0000000-0000-0000-0000-000000000000'
stubMock = mock.Mock()
getStubMock.return_value = stubMock
opencue.search.JobSearch.byOptions(show=['pipe'], match=['v6'])
stubMock.GetJobs.assert_called_with(job_pb2.JobGetJobsRequest(
r=job_pb2.JobSearchCriteria(shows=['pipe'], substr=['v6'])),
timeout=mock.ANY)
opencue.search.JobSearch.byOptions(id=[jobId])
stubMock.GetJobs.assert_called_with(job_pb2.JobGetJobsRequest(
r=job_pb2.JobSearchCriteria(ids=[jobId])),
timeout=mock.ANY)
def getJobs(**options):
"""
Returns an array of Job objects using
optional search criteria. Search criteria is
supplied as a variable list of arguments.
For example::
# returns only pipe jobs.
getJobs(show=["pipe"])
Possible args:
- job: job names - list
- match: job name substring match - str
- regex: a job name search by regular expression - str
- id: a job search by unique id - str
- show: show names - list
- shot: shot names - list
- user: user names - list
:rtype: list
:return: a list of Job objects
"""
criteria = search.JobSearch.criteriaFromOptions(**options)
jobSeq = Cuebot.getStub('job').GetJobs(
job_pb2.JobGetJobsRequest(r=criteria), timeout=Cuebot.Timeout).jobs
return [Job(j) for j in jobSeq.jobs]
def testBaseSearchJob(self, getStubMock):
stubMock = mock.Mock()
getStubMock.return_value = stubMock
jobSearch = opencue.search.JobSearch(show=['pipe'], match=['v6'])
jobSearch.search()
stubMock.GetJobs.assert_called_with(job_pb2.JobGetJobsRequest(
r=job_pb2.JobSearchCriteria(shows=['pipe'], substr=['v6'])),
timeout=mock.ANY)
def testGetJobs(self, getStubMock):
stubMock = mock.Mock()
stubMock.GetJobs.return_value = job_pb2.JobGetJobsResponse(
jobs=job_pb2.JobSeq(jobs=[job_pb2.Job(name=TEST_JOB_NAME)]))
getStubMock.return_value = stubMock
jobsByShow = opencue.api.getJobs(show=[TEST_SHOW_NAME], all=True)
stubMock.GetJobs.assert_called_with(
job_pb2.JobGetJobsRequest(
r=job_pb2.JobSearchCriteria(shows=[TEST_SHOW_NAME])), timeout=mock.ANY)
self.assertEqual(1, len(jobsByShow))
self.assertEqual(TEST_JOB_NAME, jobsByShow[0].name())
jobsByName = opencue.api.getJobs(name=[TEST_JOB_NAME], show=[TEST_SHOW_NAME])
stubMock.GetJobs.assert_called_with(
job_pb2.JobGetJobsRequest(
r=job_pb2.JobSearchCriteria(
jobs=[TEST_JOB_NAME], shows=[TEST_SHOW_NAME])), timeout=mock.ANY)
self.assertEqual(1, len(jobsByName))
self.assertEqual(TEST_JOB_NAME, jobsByName[0].name())
def byOptions(cls, **options):
criteria = cls.criteriaFromOptions(**options)
return Cuebot.getStub('job').GetJobs(
job_pb2.JobGetJobsRequest(r=criteria), timeout=Cuebot.Timeout)
