Merge "Eliminate appx 350 Sphinx Warnings"
[vfc/nfvo/lcm.git] / lcm / settings.py
1 # Copyright 2016 ZTE Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import os
16 import sys
17 import platform
18
19 import redisco
20
21 from lcm.pub.config.config import REDIS_HOST, REDIS_PORT, REDIS_PASSWD
22 from lcm.pub.config.config import DB_NAME, DB_IP, DB_USER, DB_PASSWD, DB_PORT
23 from lcm.pub.config import config as pub_config
24 from logging import config as log_config
25 from onaplogging import monkey
26 monkey.patch_all()
27
28 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
29 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
30
31 # Quick-start development settings - unsuitable for production
32 # See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/
33
34 # SECURITY WARNING: keep the secret key used in production secret!
35 SECRET_KEY = '3o-wney!99y)^h3v)0$j16l9=fdjxcb+a8g+q3tfbahcnu2b0o'
36
37 # SECURITY WARNING: don't run with debug turned on in production!
38 DEBUG = True
39
40 ALLOWED_HOSTS = ['*']
41
42 # Application definition
43
44 INSTALLED_APPS = [
45     'django.contrib.auth',
46     'django.contrib.contenttypes',
47     'django.contrib.sessions',
48     'django.contrib.messages',
49     'django.contrib.staticfiles',
50     'rest_framework',
51     'lcm.pub.database',
52     'lcm.swagger',
53     'drf_yasg'
54 ]
55
56 TEMPLATES = [
57     {
58         'BACKEND': 'django.template.backends.django.DjangoTemplates',
59         'DIRS': [],
60         'APP_DIRS': True,
61         'OPTIONS': {
62             'context_processors': [
63                 'django.template.context_processors.debug',
64                 'django.template.context_processors.request',
65                 'django.contrib.auth.context_processors.auth',
66                 'django.contrib.messages.context_processors.messages',
67             ],
68         },
69     },
70 ]
71
72 SWAGGER_SETTINGS = {
73     'LOGIN_URL': '/admin/login',
74     'LOGOUT_URL': '/admin/logout',
75     'DEFAULT_INFO': 'lcm.swagger.urls.swagger_info'
76 }
77
78 MIDDLEWARE_CLASSES = [
79     'django.middleware.security.SecurityMiddleware',
80     'django.contrib.sessions.middleware.SessionMiddleware',
81     'django.middleware.common.CommonMiddleware',
82     'django.middleware.csrf.CsrfViewMiddleware',
83     'django.contrib.auth.middleware.AuthenticationMiddleware',
84     'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
85     'django.contrib.messages.middleware.MessageMiddleware',
86     'django.middleware.clickjacking.XFrameOptionsMiddleware',
87     'lcm.middleware.LogContextMiddleware',
88 ]
89
90 ROOT_URLCONF = 'lcm.urls'
91
92 WSGI_APPLICATION = 'lcm.wsgi.application'
93
94 REST_FRAMEWORK = {
95     'DEFAULT_RENDERER_CLASSES': (
96         'rest_framework.renderers.JSONRenderer',
97     ),
98
99     'DEFAULT_PARSER_CLASSES': (
100         'rest_framework.parsers.JSONParser',
101         'rest_framework.parsers.MultiPartParser',
102         'rest_framework.parsers.FormParser',
103         # 'rest_framework.parsers.FileUploadParser',
104     )
105 }
106
107 DATABASES = {
108     'default': {
109         'ENGINE': 'django.db.backends.mysql',
110         'NAME': DB_NAME,
111         'HOST': DB_IP,
112         'PORT': DB_PORT,
113         'USER': DB_USER,
114         'PASSWORD': DB_PASSWD,
115     },
116 }
117
118 redisco.connection_setup(host=REDIS_HOST, port=REDIS_PORT, password=REDIS_PASSWD, db=0)
119 # CACHE_BACKEND = 'redis_cache.cache://%s@%s:%s' % (REDIS_PASSWD, REDIS_HOST, REDIS_PORT)
120
121 TIME_ZONE = 'UTC'
122
123 # Static files (CSS, JavaScript, Images)
124 # https://docs.djangoproject.com/en/1.6/howto/static-files/
125
126 STATIC_URL = '/static/'
127
128 STATICFILES_DIRS = [
129     os.path.join(BASE_DIR, "static")
130 ]
131
132 pub_config.CATALOG_ROOT_PATH = os.path.join(STATICFILES_DIRS[0], "catalog")
133 pub_config.CATALOG_URL_PATH = "static/catalog"
134 pub_config.AAI_BASE_URL = "http://%s:%s/aai/v11" % (pub_config.MSB_SERVICE_IP, pub_config.MSB_SERVICE_PORT)
135 pub_config.SDC_BASE_URL = "http://%s:%s/api" % (pub_config.MSB_SERVICE_IP, pub_config.MSB_SERVICE_PORT)
136
137 if platform.system() == 'Windows' or 'test' in sys.argv:
138     LOGGING = {
139         'version': 1,
140         'disable_existing_loggers': True,
141         'formatters': {
142             'standard': {
143                 'format': '%(asctime)s:[%(name)s]:[%(filename)s]-[%(lineno)d] [%(levelname)s]:%(message)s',
144             },
145         },
146         'filters': {
147         },
148         'handlers': {
149             'lcm_handler': {
150                 'level': 'DEBUG',
151                 'class': 'logging.handlers.RotatingFileHandler',
152                 'filename': os.path.join(BASE_DIR, 'logs/runtime_lcm.log'),
153                 'formatter': 'standard',
154                 'maxBytes': 1024 * 1024 * 50,
155                 'backupCount': 5,
156             },
157         },
158
159         'loggers': {
160             'lcm': {
161                 'handlers': ['lcm_handler'],
162                 'level': 'DEBUG',
163                 'propagate': False
164             },
165         }
166     }
167 else:
168     LOGGING_CONFIG = None
169     # yaml configuration of logging
170     LOGGING_FILE = os.path.join(BASE_DIR, 'lcm/log.yml')
171     log_config.yamlConfig(filepath=LOGGING_FILE, watchDog=True)
172
173 if 'test' in sys.argv:
174     pub_config.REG_TO_MSB_WHEN_START = False
175     pub_config.DEPLOY_WORKFLOW_WHEN_START = False
176     DATABASES = {}
177     DATABASES['default'] = {
178         'ENGINE': 'django.db.backends.sqlite3',
179         'NAME': ':memory:',
180     }
181     REST_FRAMEWORK = {}
182
183     if platform.system() == 'Linux':
184         TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'
185         TEST_OUTPUT_VERBOSE = True
186         TEST_OUTPUT_DESCRIPTIONS = True
187         TEST_OUTPUT_DIR = 'test-reports'
188
189     import mock
190     from lcm.pub.utils import idutil
191     idutil.get_auto_id = mock.Mock()
192     idutil.get_auto_id.return_value = 1