annotate commons/core/checker/OldConfigChecker.py @ 71:d96f6c9a39e0 draft default tip

Removed pyc files.
author m-zytnicki
date Thu, 07 Apr 2016 09:25:18 -0400
parents 769e306b7933
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
1 # Copyright INRA (Institut National de la Recherche Agronomique)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
2 # http://www.inra.fr
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
3 # http://urgi.versailles.inra.fr
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
4 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
5 # This software is governed by the CeCILL license under French law and
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
6 # abiding by the rules of distribution of free software. You can use,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
7 # modify and/ or redistribute the software under the terms of the CeCILL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
8 # license as circulated by CEA, CNRS and INRIA at the following URL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
9 # "http://www.cecill.info".
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
10 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
11 # As a counterpart to the access to the source code and rights to copy,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
12 # modify and redistribute granted by the license, users are provided only
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
13 # with a limited warranty and the software's author, the holder of the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
14 # economic rights, and the successive licensors have only limited
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
15 # liability.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
16 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
17 # In this respect, the user's attention is drawn to the risks associated
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
18 # with loading, using, modifying and/or developing or reproducing the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
19 # software by the user in light of its specific status of free software,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
20 # that may mean that it is complicated to manipulate, and that also
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
21 # therefore means that it is reserved for developers and experienced
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
22 # professionals having in-depth computer knowledge. Users are therefore
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
23 # encouraged to load and test the software's suitability as regards their
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
24 # requirements in conditions enabling the security of their systems and/or
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
25 # data to be ensured and, more generally, to use and operate it in the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
26 # same conditions as regards security.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
27 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
28 # The fact that you are presently reading this means that you have had
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
29 # knowledge of the CeCILL license and that you accept its terms.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
30
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
31
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32 import ConfigParser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 from ConfigParser import NoOptionError
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 from commons.core.checker.IChecker import IChecker
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 from commons.core.checker.ConfigException import ConfigException
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 ## A checker for a configuration file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41 # A configuration file is formatted as follow:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 # [section1]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 # option_name1: option_value1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 # option_name2: option_value2
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49 # option_name3: option_value3
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 # [section2]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 # ...
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 # This class performs 3 checkes on a configuration file:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 # (i) check if file exists
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 # (ii) check if section exists
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 # (iii) check if option exists
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 class ConfigChecker( IChecker ):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 ## Constructor A checker for configuration file.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 # @param sectionName name of section to check in configuration file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 # @param optionsDict dictionary with option(s) to check as keys and empty strings ("") as values
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 def __init__ (self, sectionName, optionsDict):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 self._sectionName = sectionName
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 self._optionsDict = optionsDict
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 ## Perform 3 checks : file exists, sections exists, option exists
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 # @param configFile configuration file to check
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 # @exception ConfigException with a list of messages
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 def check (self, configFile):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 config = ConfigParser.ConfigParser()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 msg = []
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 try:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83 config.readfp( open(configFile) )
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 except IOError, e:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 msg.append("CONFIG FILE not found - " + e.message)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 raise ConfigException("", msg)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 if not (config.has_section(self._sectionName)):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 msg.append("[" + self._sectionName + "]" + " section not found - ")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 raise ConfigException("", msg)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 isExceptionOccured = False
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 for key in self._optionsDict.keys():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 try:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 self._optionsDict[key] = config.get(self._sectionName, key)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 except NoOptionError, e:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 msg.append("[" + self._sectionName + "]" + " - " + e.message)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 isExceptionOccured = True
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 if (isExceptionOccured):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 raise ConfigException("", msg)