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

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

# 

# LSST Data Management System 

# 

# This product includes software developed by the 

# LSST Project (http://www.lsst.org/). 

# 

# See COPYRIGHT file at the top of the source tree. 

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <https://www.lsstcorp.org/LegalNotices/>. 

# 

from __future__ import print_function, division 

 

from collections import OrderedDict 

import os 

import unittest 

try: 

from StringIO import StringIO 

except ImportError: 

# Python 3 

from io import StringIO 

 

import astropy.units as u 

 

from lsst.verify.errors import SpecificationResolutionError 

from lsst.verify.naming import Name 

from lsst.verify.specset import SpecificationSet, SpecificationPartial 

from lsst.verify.spec import ThresholdSpecification 

from lsst.verify.yamlutils import load_ordered_yaml 

 

 

class TestSpecificationSet(unittest.TestCase): 

"""Tests for SpecificationSet basic usage.""" 

 

def setUp(self): 

self.spec_PA1_design = ThresholdSpecification( 

'validate_drp.PA1.design', 5. * u.mmag, '<') 

self.spec_PA1_stretch = ThresholdSpecification( 

'validate_drp.PA1.stretch', 3. * u.mmag, '<') 

self.spec_PA2_design = ThresholdSpecification( 

'validate_drp.PA2_design_gri.srd', 15. * u.mmag, '<=') 

 

specs = [self.spec_PA1_design, 

self.spec_PA1_stretch, 

self.spec_PA2_design] 

 

partial_PA1_doc = OrderedDict([ 

('id', 'validate_drp.LPM-17-PA1#PA1-Base'), 

('threshold', OrderedDict([ 

('unit', 'mag') 

])) 

]) 

partial_PA1 = SpecificationPartial(partial_PA1_doc) 

 

self.spec_set = SpecificationSet(specifications=specs, 

partials=[partial_PA1]) 

 

def test_len(self): 

self.assertEqual(len(self.spec_set), 3) 

 

def test_contains(self): 

self.assertTrue(self.spec_PA1_design.name in self.spec_set) 

self.assertTrue('validate_drp.PA1.design' in self.spec_set) 

self.assertFalse( 

Name('validate_drp.WeirdMetric.design') in self.spec_set) 

 

# Metric, not specification 

self.assertFalse( 

'validate_drp.PA1' in self.spec_set) 

self.assertFalse( 

Name('validate_drp.PA1') in self.spec_set) 

 

def test_getitem(self): 

# get Specifications when given a specification name 

self.assertEqual( 

self.spec_set['validate_drp.PA1.design'], 

self.spec_PA1_design 

) 

 

# KeyError when requesting a metric (anything not a specification 

with self.assertRaises(KeyError): 

self.spec_set['validate_drp.PA1'] 

 

def test_iter(self): 

"""Test SpecificationSet key iteration.""" 

names = [n for n in self.spec_set] 

self.assertEqual(len(names), len(self.spec_set)) 

for name in names: 

self.assertTrue(isinstance(name, Name)) 

 

def test_iadd(self): 

"""Test SpecifcationSet.__iadd__.""" 

set1 = SpecificationSet([self.spec_PA1_design, self.spec_PA1_stretch]) 

set2 = SpecificationSet([self.spec_PA1_design, self.spec_PA2_design]) 

 

set1 += set2 

 

self.assertIn('validate_drp.PA1.design', set1) 

self.assertIn('validate_drp.PA1.stretch', set1) 

self.assertIn('validate_drp.PA2_design_gri.srd', set1) 

self.assertEqual(len(set1), 3) 

 

def test_update(self): 

"""Test SpecificationSet.update().""" 

set1 = SpecificationSet([self.spec_PA1_design, self.spec_PA1_stretch]) 

set2 = SpecificationSet([self.spec_PA1_design, self.spec_PA2_design]) 

 

set1.update(set2) 

 

self.assertIn('validate_drp.PA1.design', set1) 

self.assertIn('validate_drp.PA1.stretch', set1) 

self.assertIn('validate_drp.PA2_design_gri.srd', set1) 

self.assertEqual(len(set1), 3) 

 

def test_resolve_document(self): 

"""Test specification document inheritance resolution.""" 

new_spec_doc = OrderedDict([ 

('name', 'PA1.relaxed'), 

('base', ['PA1.design', 'validate_drp.LPM-17-PA1#PA1-Base']), 

('package', 'validate_drp'), 

('threshold', OrderedDict([ 

('value', 1) 

])) 

]) 

 

resolved_doc = self.spec_set.resolve_document(new_spec_doc) 

 

self.assertEqual(resolved_doc['name'], 'PA1.relaxed') 

self.assertEqual(resolved_doc['threshold']['unit'], 'mag') 

self.assertEqual(resolved_doc['threshold']['value'], 1) 

self.assertEqual(resolved_doc['threshold']['operator'], '<') 

self.assertNotIn('base', resolved_doc) 

 

def test_unresolvable_document(self): 

"""Test that SpecificationResolutionError is raised for unresolveable 

inheritance bases. 

""" 

new_spec_doc = OrderedDict([ 

('name', 'PA1.unresolved'), 

('base', 'PA1.non_existent'), 

('package', 'validate_drp'), 

('threshold', OrderedDict([ 

('value', 10) 

])) 

]) 

 

with self.assertRaises(SpecificationResolutionError): 

self.spec_set.resolve_document(new_spec_doc) 

 

def test_serialization(self): 

"""Test json and deserialize.""" 

json_doc = self.spec_set.json 

new_spec_set = SpecificationSet.deserialize(json_doc) 

self.assertEqual(self.spec_set, new_spec_set) 

 

 

class TestSpecificationSetGetterSetter(unittest.TestCase): 

"""Test __setitem__, __getitem__ and __delitem__.""" 

 

def test_mapping(self): 

spec_PA1_design = ThresholdSpecification( 

'validate_drp.PA1.design', 5. * u.mmag, '<') 

spec_PA1_stretch = ThresholdSpecification( 

'validate_drp.PA1.stretch', 3. * u.mmag, '<') 

 

spec_set = SpecificationSet() 

self.assertEqual(len(spec_set), 0) 

 

# This syntax is slightly awkward, which is why we have `insert()` too 

spec_set[spec_PA1_design.name] = spec_PA1_design 

self.assertEqual(len(spec_set), 1) 

self.assertTrue('validate_drp.PA1.design' in spec_set) 

 

# Insert 

spec_set.insert(spec_PA1_stretch) 

self.assertEqual(len(spec_set), 2) 

self.assertTrue('validate_drp.PA1.stretch' in spec_set) 

 

# Delete 

del spec_set['validate_drp.PA1.stretch'] 

self.assertEqual(len(spec_set), 1) 

self.assertFalse('validate_drp.PA1.stretch' in spec_set) 

 

# Insert duplicate 

spec_set[spec_PA1_design.name] = spec_PA1_design 

self.assertEqual(len(spec_set), 1) 

self.assertTrue('validate_drp.PA1.design' in spec_set) 

 

# Insert weird value 

with self.assertRaises(TypeError): 

spec_set['validate_drp.PAX.design'] = 10 

 

# __setitem__ insert with a conflicting key. 

# This is why insert() is preferred. 

with self.assertRaises(KeyError): 

spec_set['validate_drp.hello.world'] = spec_PA1_design 

 

 

class TestSpecificationSetLoadYamlFile(unittest.TestCase): 

"""Test SpecificationSet._load_yaml_file() and sub-functions.""" 

 

def setUp(self): 

self.test_specs_dir = os.path.join( 

os.path.dirname(__file__), 

'data/specs') 

 

def test_load_yaml_file(self): 

package = 'validate_drp' 

package_dirname = os.path.join(self.test_specs_dir, package) 

path = os.path.join(package_dirname, 'cfht_gri.yaml') 

 

spec_docs, partial_docs = SpecificationSet._load_yaml_file( 

path, package_dirname) 

 

self.assertEqual(len(spec_docs), 9) 

self.assertEqual(len(partial_docs), 1) 

 

self.assertEqual(partial_docs[0]['id'], 'validate_drp:cfht_gri#base') 

 

def test_process_bases(self): 

yaml_id = 'dirname/filename' 

package_name = 'package' 

bases = ['PA2_minimum_gri.srd', '#base'] 

expected = ['package.PA2_minimum_gri.srd', 

'package:dirname/filename#base'] 

self.assertEqual( 

SpecificationSet._process_bases(bases, package_name, yaml_id), 

expected 

) 

 

def test_process_bases_known_yaml_id(self): 

"""Process bases when a partial already has a yaml path.""" 

yaml_id = 'dirname/filename' 

package_name = 'package' 

bases = ['PA2_minimum_gri.srd', 'otherdir/otherfile#base'] 

expected = ['package.PA2_minimum_gri.srd', 

'package:otherdir/otherfile#base'] 

self.assertEqual( 

SpecificationSet._process_bases(bases, package_name, yaml_id), 

expected 

) 

 

def test_normalize_partial_name(self): 

self.assertEqual( 

SpecificationSet._normalize_partial_name( 

'name', 

current_yaml_id='dirname/filename', 

package='package'), 

'package:dirname/filename#name' 

) 

 

self.assertEqual( 

SpecificationSet._normalize_partial_name( 

'otherdir/otherfile#name', 

current_yaml_id='dirname/filename', 

package='package'), 

'package:otherdir/otherfile#name' 

) 

 

def test_normalize_spec_name(self): 

self.assertEqual( 

SpecificationSet._normalize_spec_name( 

'metric.spec', package='package'), 

'package.metric.spec' 

) 

 

# Not resolveable 

with self.assertRaises(TypeError): 

SpecificationSet._normalize_spec_name( 

'spec', package='package'), 

 

def test_process_specification_yaml_doc_resolved_name(self): 

doc = ("name: 'cfht_gri'\n" 

"package: 'validate_drp'\n" 

"base: ['PA2_design_gri.srd', '#base']\n") 

yaml_doc = load_ordered_yaml(StringIO(doc)) 

processed = SpecificationSet._process_specification_yaml_doc( 

yaml_doc, 'cfht_gri') 

 

# name is unresolved 

self.assertEqual(processed['name'], 'cfht_gri') 

self.assertEqual( 

processed['base'], 

['validate_drp.PA2_design_gri.srd', 'validate_drp:cfht_gri#base']) 

 

def test_process_specification_yaml_doc_unresolved_name(self): 

doc = ('name: "design_gri"\n' 

'metric: "PA1"\n' 

'package: "validate_drp"\n' 

'base: "#PA1-base"\n' 

'threshold:\n' 

' value: 5.0\n') 

yaml_doc = load_ordered_yaml(StringIO(doc)) 

processed = SpecificationSet._process_specification_yaml_doc( 

yaml_doc, 'LPM-17-PA1') 

 

# name is resolved 

self.assertEqual(processed['name'], 'validate_drp.PA1.design_gri') 

self.assertEqual( 

processed['base'], 

["validate_drp:LPM-17-PA1#PA1-base"]) 

self.assertEqual( 

processed['metric'], 

'PA1') 

self.assertEqual( 

processed['package'], 

'validate_drp') 

 

def test_process_partial_yaml_doc(self): 

doc = ("id: 'PA1-base'\n" 

"metric: 'PA1'\n" 

"package: 'validate_drp'\n" 

"threshold:\n" 

" unit: 'mmag'\n" 

" operator: '<='\n") 

yaml_doc = load_ordered_yaml(StringIO(doc)) 

processed = SpecificationSet._process_partial_yaml_doc( 

yaml_doc, 'LPM-17-PA1') 

 

self.assertEqual( 

processed['id'], 

'validate_drp:LPM-17-PA1#PA1-base') 

self.assertEqual( 

processed['metric'], 

'PA1') 

self.assertEqual( 

processed['package'], 

'validate_drp') 

 

 

class TestSpecificationSetLoadSinglePackage(unittest.TestCase): 

"""Test SpecificationSet.load_single_package.""" 

 

def setUp(self): 

self.test_package_dir = os.path.join( 

os.path.dirname(__file__), 

'data/specs/validate_drp') 

 

def test_load(self): 

spec_set = SpecificationSet.load_single_package(self.test_package_dir) 

self.assertTrue('validate_drp.PA1.design_gri' in spec_set) 

self.assertTrue('validate_drp:cfht_gri#base' in spec_set) 

 

 

class TestSpecificationSetLoadMetricsPackage(unittest.TestCase): 

"""Test SpecificationSet.load_metrics_package().""" 

 

def setUp(self): 

# defaults to verify_metrics 

self.spec_set = SpecificationSet.load_metrics_package() 

 

def test_contains(self): 

self.assertTrue('validate_drp.PA1.design_gri' in self.spec_set) 

self.assertTrue('validate_drp:cfht_gri/base#base' in self.spec_set) 

 

 

class TestSpecificationSetNameSubset(unittest.TestCase): 

"""Test creating name-based subsets from a SpecificationSet.""" 

 

def setUp(self): 

# defaults to validate_metrics 

self.spec_set = SpecificationSet.load_metrics_package() 

 

def test_validate_drp_subset(self): 

package = Name('validate_drp') 

subset = self.spec_set.subset(name='validate_drp') 

 

self.assertTrue(isinstance(subset, type(self.spec_set))) 

self.assertTrue(len(subset) > 0) 

 

for spec_name, spec in subset._specs.items(): 

self.assertTrue(spec_name in package) 

 

def test_PA1_subset(self): 

metric = Name('validate_drp.PA1') 

subset = self.spec_set.subset(name='validate_drp.PA1') 

 

self.assertTrue(isinstance(subset, type(self.spec_set))) 

self.assertTrue(len(subset) > 0) 

 

for spec_name, spec in subset._specs.items(): 

self.assertTrue(spec_name in metric) 

 

 

class TestSpecificationSetMetadataSubset(unittest.TestCase): 

"""Test creating metadata-based or name and metadata-based subsets 

from a SpecificationSet. 

""" 

 

def setUp(self): 

s1 = ThresholdSpecification( 

Name('validate_drp.AM1.design_r'), 

5. * u.marcsec, '<', 

metadata_query={'filter_name': 'r'}) 

s2 = ThresholdSpecification( 

Name('validate_drp.AM1.design_i'), 

5. * u.marcsec, '<', 

metadata_query={'filter_name': 'i'}) 

s3 = ThresholdSpecification( 

Name('validate_drp.AM1.design_HSC_r'), 

5. * u.marcsec, '<', 

metadata_query={'filter_name': 'r', 'camera': 'HSC'}) 

s4 = ThresholdSpecification( 

Name('validate_drp.PA1.design_r'), 

10 * u.mmag, '<', 

metadata_query={'filter_name': 'r'}) 

s5 = ThresholdSpecification( 

Name('validate_drp.AM1.design'), 

5. * u.marcsec, '<', 

metadata_query={}) 

self.spec_set = SpecificationSet([s1, s2, s3, s4, s5]) 

 

def test_metadata_subset(self): 

"""Subset by metadata only.""" 

subset = self.spec_set.subset(meta={'filter_name': 'r'}) 

 

# In because filter_name: r does not conflict with spec 

self.assertIn('validate_drp.AM1.design_r', subset) 

# In because spec has no filter_name metadata query 

self.assertIn('validate_drp.AM1.design', subset) 

# Not in because spec has conflicting filter_name 

self.assertNotIn('validate_drp.AM1.design_i', subset) 

# Not in because spec requires 'camera' term 

self.assertNotIn('validate_drp.AM1.design_HSC_r', subset) 

# In because compatible filter_name 

self.assertIn('validate_drp.PA1.design_r', subset) 

 

def test_name_and_metadata_subset(self): 

"""Subset by name and metadata.""" 

subset = self.spec_set.subset(name='validate_drp.AM1', 

meta={'filter_name': 'r'}) 

 

# Spec has right metric, compatible metadata query 

self.assertIn('validate_drp.AM1.design_r', subset) 

# Spec has right metric, no metadata query 

self.assertIn('validate_drp.AM1.design', subset) 

# Conflicting filter_name 

self.assertNotIn('validate_drp.AM1.design_i', subset) 

# Requires camera term 

self.assertNotIn('validate_drp.AM1.design_HSC_r', subset) 

# Wrong metric 

self.assertNotIn('validate_drp.PA1.design_r', subset) 

 

def test_required_metadata_subset(self): 

"""Subset by required_meta only.""" 

subset = self.spec_set.subset(required_meta={'filter_name': 'r'}) 

 

# In because filter_name: r does not conflict with spec 

self.assertIn('validate_drp.AM1.design_r', subset) 

# Not in because spec has no filter_name metadata query 

self.assertNotIn('validate_drp.AM1.design', subset) 

# Not in because spec has conflicting filter_name 

self.assertNotIn('validate_drp.AM1.design_i', subset) 

# In because spec has compatible filter_name 

self.assertIn('validate_drp.AM1.design_HSC_r', subset) 

# In because compatible filter_name 

self.assertIn('validate_drp.PA1.design_r', subset) 

 

def test_name_and_required_metadata_subset(self): 

"""Subset by name and required_meta.""" 

subset = self.spec_set.subset(name='validate_drp.AM1', 

required_meta={'filter_name': 'r'}) 

 

# In because AM1.design_r has `filter_name: r` 

self.assertIn('validate_drp.AM1.design_r', subset) 

# This AM1.design spec doesn't have a `filter_name` term. 

self.assertNotIn('validate_drp.AM1.design', subset) 

# Wrong filter_name value 

self.assertNotIn('validate_drp.AM1.design_i', subset) 

# Has the filer_name: r term; ignores camera term. 

self.assertIn('validate_drp.AM1.design_HSC_r', subset) 

# Not in because PA1 metric 

self.assertNotIn('validate_drp.PA1.design_r', subset) 

 

def test_name_subset(self): 

"""Subset by name.""" 

subset = self.spec_set.subset(name='validate_drp.AM1') 

 

# In because AM1 metric 

self.assertIn('validate_drp.AM1.design_r', subset) 

self.assertIn('validate_drp.AM1.design_i', subset) 

self.assertIn('validate_drp.AM1.design_HSC_r', subset) 

# Not in because PA1 metric 

self.assertNotIn('validate_drp.PA1.design_HSC_r', subset) 

 

 

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

unittest.main()