Coverage for python/lsst/daf/butler/script/configValidate.py: 18%

11 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2022-12-01 19:55 +0000

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

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

7# for details of code ownership. 

8# 

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

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

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

12# (at your option) any later version. 

13# 

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

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

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

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

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

21 

22from .. import Butler, ValidationError 

23 

24 

25def configValidate(repo, quiet, dataset_type, ignore): 

26 """Validate the configuration files for a Gen3 Butler repository. 

27 

28 Parameters 

29 ---------- 

30 repo : `str` 

31 URI to the location to create the repo. 

32 quiet : `bool` 

33 Do not report individual failures if True. 

34 dataset_type : [`str`] 

35 Specific DatasetTypes to validate. 

36 ignore : [`str`] 

37 "DatasetTypes to ignore for validation." 

38 

39 Returns 

40 ------- 

41 is_good : `bool` 

42 `True` if validation was okay. `False` if there was a validation 

43 error. 

44 """ 

45 logFailures = not quiet 

46 butler = Butler(config=repo) 

47 is_good = True 

48 try: 

49 butler.validateConfiguration(logFailures=logFailures, datasetTypeNames=dataset_type, ignore=ignore) 

50 except ValidationError: 

51 is_good = False 

52 else: 

53 print("No problems encountered with configuration.") 

54 return is_good