swagger-ize dashboard and version apis of testAPI
[releng.git] / utils / test / result_collection_api / common / config.py
1 ##############################################################################
2 # Copyright (c) 2015 Orange
3 # guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 # feng.xiaowei@zte.com.cn remove prepare_put_request            5-30-2016
9 ##############################################################################
10
11
12 from ConfigParser import SafeConfigParser, NoOptionError
13
14
15 class ParseError(Exception):
16     """
17     Custom exception class for config file
18     """
19
20     def __init__(self, message):
21         self.msg = message
22
23     def __str__(self):
24         return 'error parsing config file : %s' % self.msg
25
26
27 class APIConfig:
28     """
29     The purpose of this class is to load values correctly from the config file.
30     Each key is declared as an attribute in __init__() and linked in parse()
31     """
32
33     def __init__(self):
34         self._default_config_location = "config.ini"
35         self.mongo_url = None
36         self.mongo_dbname = None
37         self.api_port = None
38         self.api_debug_on = None
39         self._parser = None
40
41     def _get_parameter(self, section, param):
42         try:
43             return self._parser.get(section, param)
44         except NoOptionError:
45             raise ParseError("[%s.%s] parameter not found" % (section, param))
46
47     def _get_int_parameter(self, section, param):
48         try:
49             return int(self._get_parameter(section, param))
50         except ValueError:
51             raise ParseError("[%s.%s] not an int" % (section, param))
52
53     def _get_bool_parameter(self, section, param):
54         result = self._get_parameter(section, param)
55         if str(result).lower() == 'true':
56             return True
57         if str(result).lower() == 'false':
58             return False
59
60         raise ParseError(
61             "[%s.%s : %s] not a boolean" % (section, param, result))
62
63     @staticmethod
64     def parse(config_location=None):
65         obj = APIConfig()
66
67         if config_location is None:
68             config_location = obj._default_config_location
69
70         obj._parser = SafeConfigParser()
71         obj._parser.read(config_location)
72         if not obj._parser:
73             raise ParseError("%s not found" % config_location)
74
75         # Linking attributes to keys from file with their sections
76         obj.mongo_url = obj._get_parameter("mongo", "url")
77         obj.mongo_dbname = obj._get_parameter("mongo", "dbname")
78
79         obj.api_port = obj._get_int_parameter("api", "port")
80         obj.api_debug_on = obj._get_bool_parameter("api", "debug")
81
82         return obj
83
84     def __str__(self):
85         return "mongo_url = %s \n" \
86                "mongo_dbname = %s \n" \
87                "api_port = %s \n" \
88                "api_debug_on = %s \n" % (self.mongo_url,
89                                          self.mongo_dbname,
90                                          self.api_port,
91                                          self.api_debug_on)