gitops/patroni
1
0
Fork 0
mirror of https://github.com/outbackdingo/patroni.git synced 2026-08-25 14:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improvements to 'patroni --validate-config' (#2344)

Browse Source 
* Let `patroni --validate-config` exit 1 when config is invalid
* Print configuration errors to stderr

Close #2345
This commit is contained in:
Denis Laxalde
2022-06-30 10:51:47 +02:00
committed by GitHub
parent 8d7828b079
commit 741243695a
4 changed files with 29 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
patroni/config.py
+3 -3
View File
@@ -102,9 +102,9 @@ class Config(object):
config_env = os.environ.pop(self.PATRONI_CONFIG_VARIABLE, None)
self._local_configuration = config_env and yaml.safe_load(config_env) or self.__environment_configuration
if validator:
error = validator(self._local_configuration)
if error:
raise ConfigParseError(error)
errors = validator(self._local_configuration)
if errors:
raise ConfigParseError("\n".join(errors))
self.__effective_configuration = self._build_effective_configuration({}, self._local_configuration)
self._data_dir = self.__effective_configuration.get('postgresql', {}).get('data_dir', "")
patroni/daemon.py
+6 -2
View File
@@ -1,3 +1,5 @@
from __future__ import print_function
import abc
import os
import signal
@@ -83,15 +85,17 @@ def abstract_main(cls, validator=None):
help='Patroni may also read the configuration from the {0} environment variable'
.format(Config.PATRONI_CONFIG_VARIABLE))
args = parser.parse_args()
validate_config = validator and args.validate_config
try:
if validator and args.validate_config:
if validate_config:
Config(args.configfile, validator=validator)
sys.exit()
config = Config(args.configfile)
except ConfigParseError as e:
if e.value:
print(e.value)
print(e.value, file=sys.stderr)
if not validate_config:
parser.print_help()
sys.exit(1)
patroni/validator.py
+3 -1
View File
@@ -178,9 +178,11 @@ class Schema(object):
self.validator = validator
def __call__(self, data):
errors = []
for i in self.validate(data):
if not i.status:
print(i)
errors.append(str(i))
return errors
def validate(self, data):
self.data = data
tests/test_validator.py
+16 -16
View File
@@ -141,14 +141,14 @@ class TestValidator(unittest.TestCase):
del directories[:]
def test_empty_config(self, mock_out, mock_err):
schema({})
output = mock_out.getvalue()
errors = schema({})
output = "\n".join(errors)
expected = list(sorted(['name', 'postgresql', 'restapi', 'scope'] + available_dcs))
self.assertEqual(expected, parse_output(output))
def test_complete_config(self, mock_out, mock_err):
schema(config)
output = mock_out.getvalue()
errors = schema(config)
output = "\n".join(errors)
self.assertEqual(['postgresql.bin_dir', 'raft.bind_addr', 'raft.self_addr'], parse_output(output))
def test_bin_dir_is_file(self, mock_out, mock_err):
@@ -158,8 +158,8 @@ class TestValidator(unittest.TestCase):
c["restapi"]["connect_address"] = 'False:blabla'
c["etcd"]["hosts"] = ["127.0.0.1:2379", "1244.0.0.1:2379", "127.0.0.1:invalidport"]
c["kubernetes"]["pod_ip"] = "127.0.0.1111"
schema(c)
output = mock_out.getvalue()
errors = schema(c)
output = "\n".join(errors)
self.assertEqual(['etcd.hosts.1', 'etcd.hosts.2', 'kubernetes.pod_ip', 'postgresql.bin_dir',
'postgresql.data_dir', 'raft.bind_addr', 'raft.self_addr',
'restapi.connect_address'], parse_output(output))
@@ -176,8 +176,8 @@ class TestValidator(unittest.TestCase):
c["etcd"]["host"] = "127.0.0.1:237"
c["postgresql"]["listen"] = "127.0.0.1:5432"
with patch('patroni.validator.open', mock_open(read_data='9')):
schema(c)
output = mock_out.getvalue()
errors = schema(c)
output = "\n".join(errors)
self.assertEqual(['consul.host', 'etcd.host', 'postgresql.bin_dir', 'postgresql.data_dir', 'postgresql.listen',
'raft.bind_addr', 'raft.self_addr', 'restapi.connect_address'], parse_output(output))
@@ -195,8 +195,8 @@ class TestValidator(unittest.TestCase):
files.append(os.path.join(config["postgresql"]["bin_dir"], "postgres"))
files.append(os.path.join(config["postgresql"]["bin_dir"], "pg_isready"))
with patch('patroni.validator.open', mock_open(read_data='12')):
schema(config)
output = mock_out.getvalue()
errors = schema(config)
output = "\n".join(errors)
self.assertEqual(['raft.bind_addr', 'raft.self_addr'], parse_output(output))
@patch('subprocess.check_output', Mock(return_value=b"postgres (PostgreSQL) 12.1"))
@@ -210,8 +210,8 @@ class TestValidator(unittest.TestCase):
c["etcd"]["hosts"] = []
del c["postgresql"]["bin_dir"]
with patch('patroni.validator.open', mock_open(read_data='11')):
schema(c)
output = mock_out.getvalue()
errors = schema(c)
output = "\n".join(errors)
self.assertEqual(['etcd.hosts', 'postgresql.data_dir',
'raft.bind_addr', 'raft.self_addr'], parse_output(output))
@@ -224,8 +224,8 @@ class TestValidator(unittest.TestCase):
c = copy.deepcopy(config)
del c["postgresql"]["bin_dir"]
with patch('patroni.validator.open', mock_open(read_data='11')):
schema(c)
output = mock_out.getvalue()
errors = schema(c)
output = "\n".join(errors)
self.assertEqual(['postgresql.data_dir', 'raft.bind_addr', 'raft.self_addr'], parse_output(output))
def test_data_dir_is_empty_string(self, mock_out, mock_err):
@@ -236,7 +236,7 @@ class TestValidator(unittest.TestCase):
c["postgresql"]["pg_hba"] = ""
c["postgresql"]["data_dir"] = ""
c["postgresql"]["bin_dir"] = ""
schema(c)
output = mock_out.getvalue()
errors = schema(c)
output = "\n".join(errors)
self.assertEqual(['kubernetes', 'postgresql.bin_dir', 'postgresql.data_dir',
'postgresql.pg_hba', 'raft.bind_addr', 'raft.self_addr'], parse_output(output))