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

12 statements  

« prev     ^ index     » next       coverage.py v6.4.4, created at 2022-09-22 02:05 -0700

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 .._butler import Butler 

23from ..core import ValidationError 

24 

25 

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

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

28 

29 Parameters 

30 ---------- 

31 repo : `str` 

32 URI to the location to create the repo. 

33 quiet : `bool` 

34 Do not report individual failures if True. 

35 dataset_type : [`str`] 

36 Specific DatasetTypes to validate. 

37 ignore : [`str`] 

38 "DatasetTypes to ignore for validation." 

39 

40 Returns 

41 ------- 

42 is_good : `bool` 

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

44 error. 

45 """ 

46 logFailures = not quiet 

47 butler = Butler(config=repo) 

48 is_good = True 

49 try: 

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

51 except ValidationError: 

52 is_good = False 

53 else: 

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

55 return is_good