Introduce SHOW_DB_URI config value
ClosedPublic
Actions

resultsdb/config.py
50	Unfortunately, this still leaks the DBURI by default since `DevelopmentConfig` is the config used if nothing else is selected. I'd rather see it false in `config.py` and maybe commented out or set to false in `conf/settings.py.example`

This revision now requires changes to proceed.Jun 17 2014, 11:11 AM

resultsdb/config.py
50	Unfortunately, this still leaks the DBURI by default since DevelopmentConfig is the config used if nothing else is selected. Isn't it expected that the DBURI is shown in DevelopmentConfig?

If you have other ideas on how to keep the DBURI from leaking to logs by default, I'm not set on a single particular solution

resultsdb/config.py
50	Perhaps but my concern is that the complete DBURI is leaking by default. I just don't want to have to run around changing db passwords every time I forget to put `PROD='true'` in front of a command

Address issue mentioned in the review

Looks good to me

This revision is now accepted and ready to land.Jun 17 2014, 2:45 PM

Closed by commit rRSDB55bfa3c97e0a (authored by @mkrizek).

Revision Contents

			Path	Packages
M			conf/settings.py.example (1 line)
M			resultsdb/__init__.py (3 lines)
M			resultsdb/config.py (2 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	415	15fc32e		Jun 17 2014, 9:00 AM	★	★
Diff 2	421	15fc32e	Address issue mentioned in the review	Jun 17 2014, 2:35 PM	★	★
Diff 3	427	042b24b	Commit rRSDB55bfa3c97e0a46c4f6a5188b77360d6d0bb5a0b2	Jun 23 2014, 8:50 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
c220b6214122	e29fa59522e1	15fc32e2857b	Martin Krizek	Introduce SHOW_DB_URI config value (Show More…)	Jun 17 2014, 8:42 AM

Diff 427

View Options

conf/settings.py.example

1	# while you can use this as a template, we recommend that you use the blockerbugs	1	# while you can use this as a template, we recommend that you use the blockerbugs
2	# cli to generate a config file	2	# cli to generate a config file
3	SECRET_KEY = 'not-really-a-secret'	3	SECRET_KEY = 'not-really-a-secret'
4	SQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://dbuser:dbpassword@dbhost:dbport/dbname'	4	SQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://dbuser:dbpassword@dbhost:dbport/dbname'
5	FAS_ADMIN_GROUP = "magic-fas-group"	5	FAS_ADMIN_GROUP = "magic-fas-group"
6	FAS_USER = "magicuser@unicornsarereal.com"	6	FAS_USER = "magicuser@unicornsarereal.com"
7	FAS_PASSWORD = "password"	7	FAS_PASSWORD = "password"
8	BUGZILLA_COOKIE = None	8	BUGZILLA_COOKIE = None
9	FILE_LOGGING = False	9	FILE_LOGGING = False
10	LOGFILR = '/var/log/resultsdb/resultsdb.log'	10	LOGFILR = '/var/log/resultsdb/resultsdb.log'
11	SYSLOG_LOGGING = False	11	SYSLOG_LOGGING = False
12	STREAM_LOGGING = True	12	STREAM_LOGGING = True
		13	SHOW_DB_URI = False

View Options

resultsdb/init.py

Show First 20 Lines • Show All 104 Lines • ▼ Show 20 Line(s)		103	if app.config['FILE_LOGGING'] and app.config['LOGFILE']:
105	file_handler = logging.handlers.RotatingFileHandler(app.config['LOGFILE'], maxBytes=500000, backupCount=5)	105		file_handler = logging.handlers.RotatingFileHandler(app.config['LOGFILE'], maxBytes=500000, backupCount=5)
106	file_handler.setLevel(loglevel)	106		file_handler.setLevel(loglevel)
107	file_handler.setFormatter(formatter)	107		file_handler.setFormatter(formatter)
108	root_logger.addHandler(file_handler)	108		root_logger.addHandler(file_handler)
109	app.logger.addHandler(file_handler)	109		app.logger.addHandler(file_handler)
110		110
111	setup_logging()	111		setup_logging()
112		112
113	app.logger.debug('using DBURI: %s' % app.config['SQLALCHEMY_DATABASE_URI'])	113		if app.config['SHOW_DB_URI']:
		114		app.logger.debug('using DBURI: %s' % app.config['SQLALCHEMY_DATABASE_URI'])
114		115
115		116
116	# database	117		# database
117	db = SQLAlchemy(app)	118		db = SQLAlchemy(app)
118		119
119	# setup login manager	120		# setup login manager
120	login_manager = LoginManager()	121		login_manager = LoginManager()
121	login_manager.setup_app(app)	122		login_manager.setup_app(app)
Show All 15 Lines

View Options

resultsdb/config.py

Show All 27 Lines		22	class Config(object):
28	SYSLOG_LOGGING = False	28		SYSLOG_LOGGING = False
29	STREAM_LOGGING = True	29		STREAM_LOGGING = True
30		30
31	HOST = None	31		HOST = None
32	PORT = None	32		PORT = None
33		33
34	PRODUCTION = False	34		PRODUCTION = False
35		35
		36		SHOW_DB_URI = False
		37
36		38
37	class ProductionConfig(Config):	39		class ProductionConfig(Config):
38	DEBUG = False	40		DEBUG = False
39	PRODUCTION = True	41		PRODUCTION = True
40		42
41		43
42	class DevelopmentConfig(Config):	44		class DevelopmentConfig(Config):
43	TRAP_BAD_REQUEST_ERRORS = True	45		TRAP_BAD_REQUEST_ERRORS = True
44	SQLALCHEMY_DATABASE_URI = \	46		SQLALCHEMY_DATABASE_URI = \
45	'mysql://resultsdb:TOP_SECRET_PASSWORD@localhost/resultsdb'	47		'mysql://resultsdb:TOP_SECRET_PASSWORD@localhost/resultsdb'
46	HOST = '0.0.0.0'	48		HOST = '0.0.0.0'
47	PORT = 5000	49		PORT = 5000
48		50
			tflinkUnsubmitted Not Done Unfortunately, this still leaks the DBURI by default since `DevelopmentConfig` is the config used if nothing else is selected. I'd rather see it false in `config.py` and maybe commented out or set to false in `conf/settings.py.example`
			mkrizekAuthorUnsubmitted Not Done Unfortunately, this still leaks the DBURI by default since DevelopmentConfig is the config used if nothing else is selected. Isn't it expected that the DBURI is shown in DevelopmentConfig?
			tflinkUnsubmitted Not Done Perhaps but my concern is that the complete DBURI is leaking by default. I just don't want to have to run around changing db passwords every time I forget to put `PROD='true'` in front of a command
49		51
50	class TestingConfig(Config):	52		class TestingConfig(Config):
51	TRAP_BAD_REQUEST_ERRORS = True	53		TRAP_BAD_REQUEST_ERRORS = True
52	TESTING = True	54		TESTING = True

Introduce SHOW_DB_URI config valueClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 427

conf/settings.py.example

resultsdb/__init__.py

resultsdb/config.py

Introduce SHOW_DB_URI config value
ClosedPublic
Actions

resultsdb/init.py