Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

# This file is part of ctrl_mpexec. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <https://www.gnu.org/licenses/>. 

 

"""Simple unit test for cmdLineFwk module. 

""" 

 

import argparse 

import contextlib 

import logging 

import os 

import pickle 

import tempfile 

import unittest 

 

from lsst.ctrl.mpexec.cmdLineFwk import CmdLineFwk 

from lsst.ctrl.mpexec.cmdLineParser import (_ACTION_ADD_TASK, _ACTION_CONFIG, 

_ACTION_CONFIG_FILE, _ACTION_ADD_INSTRUMENT) 

from lsst.daf.butler import Quantum, Config 

import lsst.pex.config as pexConfig 

from lsst.pipe.base import (Pipeline, PipelineTask, PipelineTaskConfig, 

QuantumGraph, QuantumGraphTaskNodes, 

TaskDef, TaskFactory, PipelineTaskConnections) 

import lsst.pipe.base.connectionTypes as cT 

import lsst.utils.tests 

from testUtil import (AddTask, AddTaskFactoryMock, makeSimpleQGraph) 

 

 

logging.basicConfig(level=logging.INFO) 

 

 

@contextlib.contextmanager 

def makeTmpFile(contents=None): 

"""Context manager for generating temporary file name. 

 

Temporary file is deleted on exiting context. 

 

Parameters 

---------- 

contents : `bytes` 

Data to write into a file. 

""" 

fd, tmpname = tempfile.mkstemp() 

if contents: 

os.write(fd, contents) 

os.close(fd) 

yield tmpname 

with contextlib.suppress(OSError): 

os.remove(tmpname) 

 

 

class SimpleConnections(PipelineTaskConnections, dimensions=(), 

defaultTemplates={"template": "simple"}): 

schema = cT.InitInput(doc="Schema", 

name="{template}schema", 

storageClass="SourceCatalog") 

 

 

class SimpleConfig(PipelineTaskConfig, pipelineConnections=SimpleConnections): 

field = pexConfig.Field(dtype=str, doc="arbitrary string") 

 

def setDefaults(self): 

PipelineTaskConfig.setDefaults(self) 

 

 

class TaskOne(PipelineTask): 

ConfigClass = SimpleConfig 

_DefaultName = "taskOne" 

 

 

class TaskTwo(PipelineTask): 

ConfigClass = SimpleConfig 

_DefaultName = "taskTwo" 

 

 

class TaskFactoryMock(TaskFactory): 

def loadTaskClass(self, taskName): 

if taskName == "TaskOne": 

return TaskOne, "TaskOne" 

elif taskName == "TaskTwo": 

return TaskTwo, "TaskTwo" 

 

def makeTask(self, taskClass, config, overrides, butler): 

if config is None: 

config = taskClass.ConfigClass() 

if overrides: 

overrides.applyTo(config) 

return taskClass(config=config, butler=butler) 

 

 

def _makeArgs(pipeline=None, qgraph=None, pipeline_actions=(), order_pipeline=False, 

save_pipeline="", save_qgraph="", save_single_quanta="", pipeline_dot="", qgraph_dot=""): 

"""Return parsed command line arguments. 

 

Parameters 

---------- 

pipeline : `str`, optional 

Name of the YAML file with pipeline. 

qgraph : `str`, optional 

Name of the pickle file with QGraph. 

pipeline_actions : itrable of `cmdLinePArser._PipelineAction`, optional 

order_pipeline : `bool` 

save_pipeline : `str` 

Name of the YAML file to store pipeline. 

save_qgraph : `str` 

Name of the pickle file to store QGraph. 

save_single_quanta : `str` 

Name of the pickle file pattern to store individual QGraph. 

pipeline_dot : `str` 

Name of the DOT file to write pipeline graph. 

qgraph_dot : `str` 

Name of the DOT file to write QGraph representation. 

""" 

args = argparse.Namespace() 

args.butler_config = Config() 

# The default datastore has a relocatable root, so we need to specify 

# some root here for it to use 

args.butler_config.configFile = "." 

args.pipeline = pipeline 

args.qgraph = qgraph 

args.pipeline_actions = pipeline_actions 

args.order_pipeline = order_pipeline 

args.save_pipeline = save_pipeline 

args.save_qgraph = save_qgraph 

args.save_single_quanta = save_single_quanta 

args.pipeline_dot = pipeline_dot 

args.qgraph_dot = qgraph_dot 

args.output = {} 

args.register_dataset_types = False 

args.skip_init_writes = False 

args.skip_existing = False 

args.clobber_output = False 

args.init_only = False 

args.processes = 1 

args.profile = None 

return args 

 

 

def _makeQGraph(): 

"""Make a trivial QuantumGraph with one quantum. 

 

The only thing that we need to do with this quantum graph is to pickle 

it, the quanta in this graph are not usable for anything else. 

 

Returns 

------- 

qgraph : `~lsst.pipe.base.QuantumGraph` 

""" 

taskDef = TaskDef(taskName="taskOne", config=SimpleConfig()) 

quanta = [Quantum()] 

taskNodes = QuantumGraphTaskNodes(taskDef=taskDef, quanta=quanta, initInputs={}, initOutputs={}) 

qgraph = QuantumGraph([taskNodes]) 

return qgraph 

 

 

class CmdLineFwkTestCase(unittest.TestCase): 

"""A test case for CmdLineFwk 

""" 

 

def testMakePipeline(self): 

"""Tests for CmdLineFwk.makePipeline method 

""" 

fwk = CmdLineFwk() 

 

# make empty pipeline 

args = _makeArgs() 

pipeline = fwk.makePipeline(args) 

self.assertIsInstance(pipeline, Pipeline) 

self.assertEqual(len(pipeline), 0) 

 

# few tests with serialization 

with makeTmpFile() as tmpname: 

# make empty pipeline and store it in a file 

args = _makeArgs(save_pipeline=tmpname) 

pipeline = fwk.makePipeline(args) 

self.assertIsInstance(pipeline, Pipeline) 

 

# read pipeline from a file 

args = _makeArgs(pipeline=tmpname) 

pipeline = fwk.makePipeline(args) 

self.assertIsInstance(pipeline, Pipeline) 

self.assertEqual(len(pipeline), 0) 

 

# single task pipeline 

actions = [ 

_ACTION_ADD_TASK("TaskOne:task1") 

] 

args = _makeArgs(pipeline_actions=actions) 

pipeline = fwk.makePipeline(args) 

self.assertIsInstance(pipeline, Pipeline) 

self.assertEqual(len(pipeline), 1) 

 

# many task pipeline 

actions = [ 

_ACTION_ADD_TASK("TaskOne:task1a"), 

_ACTION_ADD_TASK("TaskTwo:task2"), 

_ACTION_ADD_TASK("TaskOne:task1b") 

] 

args = _makeArgs(pipeline_actions=actions) 

pipeline = fwk.makePipeline(args) 

self.assertIsInstance(pipeline, Pipeline) 

self.assertEqual(len(pipeline), 3) 

 

# single task pipeline with config overrides, cannot use TaskOne, need 

# something that can be imported with `doImport()` 

actions = [ 

_ACTION_ADD_TASK("testUtil.AddTask:task"), 

_ACTION_CONFIG("task:addend=100") 

] 

args = _makeArgs(pipeline_actions=actions) 

pipeline = fwk.makePipeline(args) 

taskDefs = list(pipeline.toExpandedPipeline()) 

self.assertEqual(len(taskDefs), 1) 

self.assertEqual(taskDefs[0].config.addend, 100) 

 

overrides = b"config.addend = 1000\n" 

with makeTmpFile(overrides) as tmpname: 

actions = [ 

_ACTION_ADD_TASK("testUtil.AddTask:task"), 

_ACTION_CONFIG_FILE("task:" + tmpname) 

] 

args = _makeArgs(pipeline_actions=actions) 

pipeline = fwk.makePipeline(args) 

taskDefs = list(pipeline.toExpandedPipeline()) 

self.assertEqual(len(taskDefs), 1) 

self.assertEqual(taskDefs[0].config.addend, 1000) 

 

# Check --instrument option, for now it only checks that it does not crash 

actions = [ 

_ACTION_ADD_TASK("testUtil.AddTask:task"), 

_ACTION_ADD_INSTRUMENT("Instrument") 

] 

args = _makeArgs(pipeline_actions=actions) 

pipeline = fwk.makePipeline(args) 

 

def testMakeGraphFromPickle(self): 

"""Tests for CmdLineFwk.makeGraph method. 

 

Only most trivial case is tested that does not do actual graph 

building. 

""" 

fwk = CmdLineFwk() 

 

with makeTmpFile() as tmpname: 

 

# make non-empty graph and store it in a file 

qgraph = _makeQGraph() 

with open(tmpname, "wb") as pickleFile: 

pickle.dump(qgraph, pickleFile) 

args = _makeArgs(qgraph=tmpname) 

qgraph = fwk.makeGraph(None, args) 

self.assertIsInstance(qgraph, QuantumGraph) 

self.assertEqual(len(qgraph), 1) 

 

# pickle with wrong object type 

with open(tmpname, "wb") as pickleFile: 

pickle.dump({}, pickleFile) 

args = _makeArgs(qgraph=tmpname) 

with self.assertRaises(TypeError): 

fwk.makeGraph(None, args) 

 

# reading empty graph from pickle should return None 

qgraph = QuantumGraph() 

with open(tmpname, "wb") as pickleFile: 

pickle.dump(qgraph, pickleFile) 

args = _makeArgs(qgraph=tmpname) 

with self.assertWarnsRegex(UserWarning, "QuantumGraph is empty"): 

# this also tests that warning is generated for empty graph 

qgraph = fwk.makeGraph(None, args) 

self.assertIs(qgraph, None) 

 

def testSimpleQGraph(self): 

"""Test successfull execution of trivial quantum graph. 

""" 

 

nQuanta = 5 

butler, qgraph = makeSimpleQGraph(nQuanta) 

 

# should have one task and number of quanta 

self.assertEqual(len(qgraph), 1) 

self.assertEqual(len(list(qgraph.quanta())), nQuanta) 

 

args = _makeArgs() 

fwk = CmdLineFwk() 

taskFactory = AddTaskFactoryMock() 

 

# run whole thing 

AddTask.countExec = 0 

fwk.runPipeline(qgraph, taskFactory, args, butler=butler) 

self.assertEqual(AddTask.countExec, nQuanta) 

 

def testSimpleQGraphSkipExisting(self): 

"""Test continuing execution of trivial quantum graph with --skip-existing. 

""" 

 

nQuanta = 5 

butler, qgraph = makeSimpleQGraph(nQuanta) 

 

# should have one task and number of quanta 

self.assertEqual(len(qgraph), 1) 

self.assertEqual(len(list(qgraph.quanta())), nQuanta) 

 

args = _makeArgs() 

fwk = CmdLineFwk() 

taskFactory = AddTaskFactoryMock() 

 

# run whole thing 

AddTask.countExec = 0 

AddTask.stopAt = 3 

with self.assertRaises(RuntimeError): 

fwk.runPipeline(qgraph, taskFactory, args, butler=butler) 

self.assertEqual(AddTask.countExec, 3) 

 

AddTask.stopAt = -1 

args.skip_existing = True 

fwk.runPipeline(qgraph, taskFactory, args, butler=butler) 

self.assertEqual(AddTask.countExec, nQuanta) 

 

def testSimpleQGraphClobberOutput(self): 

"""Test re-execution of trivial quantum graph with --clobber-output. 

""" 

 

nQuanta = 5 

butler, qgraph = makeSimpleQGraph(nQuanta) 

 

# should have one task and number of quanta 

self.assertEqual(len(qgraph), 1) 

self.assertEqual(qgraph.countQuanta(), nQuanta) 

 

args = _makeArgs() 

fwk = CmdLineFwk() 

taskFactory = AddTaskFactoryMock() 

 

# run whole thing 

AddTask.stopAt = -1 

AddTask.countExec = 0 

fwk.runPipeline(qgraph, taskFactory, args, butler=butler) 

self.assertEqual(AddTask.countExec, nQuanta) 

 

# and repeat 

args.clobber_output = True 

fwk.runPipeline(qgraph, taskFactory, args, butler=butler) 

self.assertEqual(AddTask.countExec, 2*nQuanta) 

 

# rebuild graph with clobber option, should make same graph 

butler, qgraph = makeSimpleQGraph(nQuanta, butler=butler, clobberExisting=True) 

self.assertEqual(len(qgraph), 1) 

self.assertEqual(qgraph.countQuanta(), nQuanta) 

 

def testShowPipeline(self): 

"""Test for --show options for pipeline. 

""" 

fwk = CmdLineFwk() 

 

actions = [ 

_ACTION_ADD_TASK("testUtil.AddTask:task"), 

_ACTION_CONFIG("task:addend=100") 

] 

args = _makeArgs(pipeline_actions=actions) 

pipeline = fwk.makePipeline(args) 

 

args.show = ["pipeline"] 

fwk.showInfo(args, pipeline) 

args.show = ["config"] 

fwk.showInfo(args, pipeline) 

args.show = ["history=task::addend"] 

fwk.showInfo(args, pipeline) 

args.show = ["tasks"] 

fwk.showInfo(args, pipeline) 

 

def testShowGraph(self): 

"""Test for --show options for quantum graph. 

""" 

fwk = CmdLineFwk() 

 

nQuanta = 2 

butler, qgraph = makeSimpleQGraph(nQuanta) 

 

args = _makeArgs() 

args.show = ["graph"] 

fwk.showInfo(args, pipeline=None, graph=qgraph) 

# TODO: cannot test "workflow" option presently, it instanciates 

# butler from command line options and there is no way to pass butler 

# mock to that code. 

 

 

class MyMemoryTestCase(lsst.utils.tests.MemoryTestCase): 

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

412 ↛ 413line 412 didn't jump to line 413, because the condition on line 412 was never trueif __name__ == "__main__": 

lsst.utils.tests.init() 

unittest.main()