nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-05-27 10:44:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

cfg: Convert tests to pytest style

Browse Source 
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
This commit is contained in:
Sunil Mohan Adapa 2019-05-01 16:10:32 -07:00 committed by Joseph Nuthalapati
parent 05bf200906
commit 29b2d664b0
No known key found for this signature in database
GPG Key ID: 5398F00A2FA43C35
1 changed files with 95 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
plinth/tests/test_cfg.py
View File

@ -21,7 +21,8 @@ Test module for configuration module.
import configparser import configparser
import logging import logging
import os import os
import unittest
import pytest
from plinth import cfg from plinth import cfg
@ -34,113 +35,112 @@ CONFIG_FILE_WITH_MISSING_SECTIONS = \
logging.disable(logging.CRITICAL) logging.disable(logging.CRITICAL)
pytestmark = pytest.mark.usefixtures('load_cfg')
class TestCfg(unittest.TestCase):
"""Verify that the configuration module behaves as expected."""
@classmethod @pytest.fixture(name='test_config_file')
def setUpClass(cls): def fixture_test_config_file(load_cfg):
"""Locate and copy the official plinth.config file.""" """Test fixture to return the configuration file path"""
cls.test_config_file, cls.test_config_dir = cfg.get_config_paths() return cfg.get_config_paths()[0]
@classmethod
def tearDownClass(cls):
"""Cleanup after all tests are completed."""
cfg.read()
def test_read_default_config_file(self): @pytest.fixture(name='test_config_dir')
"""Verify that the default config file can be read correctly.""" def fixture_test_config_dir(load_cfg):
# Read the plinth.config file directly """Test fixture to return the configuration file directory."""
parser = configparser.ConfigParser( return cfg.get_config_paths()[1]
defaults={'root': self.test_config_dir})
parser.read(self.test_config_file)
# Read the plinth.config file via the cfg module
cfg.read(self.test_config_file, self.test_config_dir)
# Compare the two results def test_read_default_config_file(test_config_dir, test_config_file):
self.compare_configurations(parser) """Verify that the default config file can be read correctly."""
# Read the plinth.config file directly
parser = configparser.ConfigParser(defaults={'root': test_config_dir})
parser.read(test_config_file)
def test_read_primary_config_file(self): # Read the plinth.config file via the cfg module
"""Verify that the primary config file is used by default.""" cfg.read(test_config_file, test_config_dir)
original_config_path = cfg.DEFAULT_CONFIG_FILE
original_root_directory = cfg.DEFAULT_ROOT
expected_config_path = CONFIG_FILE_WITH_MISSING_OPTIONS # Compare the two results
root_directory = 'x-default-root' compare_configurations(parser)
expected_root_directory = os.path.realpath(root_directory)
def test_read_primary_config_file():
"""Verify that the primary config file is used by default."""
original_config_path = cfg.DEFAULT_CONFIG_FILE
original_root_directory = cfg.DEFAULT_ROOT
expected_config_path = CONFIG_FILE_WITH_MISSING_OPTIONS
root_directory = 'x-default-root'
expected_root_directory = os.path.realpath(root_directory)
try:
cfg.DEFAULT_CONFIG_FILE = expected_config_path
cfg.DEFAULT_ROOT = root_directory
# reading the config file will fail, but still cfg.root and
# cfg.config_file will be set for parsing the config file
try: try:
cfg.DEFAULT_CONFIG_FILE = expected_config_path cfg.read()
cfg.DEFAULT_ROOT = root_directory except configparser.NoOptionError:
# reading the config file will fail, but still cfg.root and pass
# cfg.config_file will be set for parsing the config file assert cfg.config_file == expected_config_path
try: assert cfg.root == expected_root_directory
cfg.read() finally:
except configparser.NoOptionError: cfg.DEFAULT_CONFIG_FILE = original_config_path
pass cfg.DEFAULT_ROOT = original_root_directory
self.assertEqual(cfg.config_file, expected_config_path)
self.assertEqual(cfg.root, expected_root_directory)
finally:
cfg.DEFAULT_CONFIG_FILE = original_config_path
cfg.DEFAULT_ROOT = original_root_directory
def test_read_fallback_config_file(self):
"""Verify that the correct fallback config file is used"""
fallback_root = os.path.realpath('.')
fallback_config_file = os.path.join(fallback_root, 'plinth.config')
config_path, root_directory = cfg.get_fallback_config_paths()
cfg.read(config_path, root_directory)
self.assertEqual(cfg.config_file, fallback_config_file)
self.assertEqual(cfg.root, fallback_root)
def test_read_missing_config_file(self): def test_read_fallback_config_file():
"""Verify that an exception is raised when there's no config file.""" """Verify that the correct fallback config file is used"""
self.assertRaises(FileNotFoundError, cfg.read, 'x-non-existant-file', fallback_root = os.path.realpath('.')
'x-root-directory') fallback_config_file = os.path.join(fallback_root, 'plinth.config')
config_path, root_directory = cfg.get_fallback_config_paths()
cfg.read(config_path, root_directory)
assert cfg.config_file == fallback_config_file
assert cfg.root == fallback_root
def test_read_config_file_with_missing_sections(self):
"""Verify that missing configuration sections can be detected."""
self.assertRaises(configparser.NoSectionError, cfg.read,
CONFIG_FILE_WITH_MISSING_SECTIONS,
self.test_config_dir)
def test_read_config_file_with_missing_options(self): def test_read_missing_config_file():
"""Verify that missing configuration options can be detected.""" """Verify that an exception is raised when there's no config file."""
self.assertRaises(configparser.NoOptionError, cfg.read, with pytest.raises(FileNotFoundError):
CONFIG_FILE_WITH_MISSING_OPTIONS, cfg.read('x-non-existant-file', 'x-root-directory')
self.test_config_dir)
def compare_configurations(self, parser):
"""Compare two sets of configuration values."""
# Note that the count of items within each section includes the number
# of default items (1, for 'root').
self.assertEqual(9, len(parser.items('Path')))
self.assertEqual(parser.get('Path', 'root'), cfg.root)
self.assertEqual(parser.get('Path', 'file_root'), cfg.file_root)
self.assertEqual(parser.get('Path', 'config_dir'), cfg.config_dir)
self.assertEqual(
parser.get('Path', 'custom_static_dir'), cfg.custom_static_dir)
self.assertEqual(parser.get('Path', 'data_dir'), cfg.data_dir)
self.assertEqual(parser.get('Path', 'store_file'), cfg.store_file)
self.assertEqual(parser.get('Path', 'actions_dir'), cfg.actions_dir)
self.assertEqual(parser.get('Path', 'doc_dir'), cfg.doc_dir)
self.assertEqual(6, len(parser.items('Network'))) def test_read_config_file_with_missing_sections(test_config_dir):
self.assertEqual(parser.get('Network', 'host'), cfg.host) """Verify that missing configuration sections can be detected."""
self.assertEqual(int(parser.get('Network', 'port')), cfg.port) with pytest.raises(configparser.NoSectionError):
self.assertEqual( cfg.read(CONFIG_FILE_WITH_MISSING_SECTIONS, test_config_dir)
parser.get('Network', 'secure_proxy_ssl_header'),
cfg.secure_proxy_ssl_header)
self.assertIsInstance(cfg.use_x_forwarded_for, bool) def test_read_config_file_with_missing_options(test_config_dir):
self.assertEqual( """Verify that missing configuration options can be detected."""
parser.get('Network', 'use_x_forwarded_for'), with pytest.raises(configparser.NoOptionError):
str(cfg.use_x_forwarded_for)) cfg.read(CONFIG_FILE_WITH_MISSING_OPTIONS, test_config_dir)
self.assertIsInstance(cfg.use_x_forwarded_host, bool)
self.assertEqual(
parser.get('Network', 'use_x_forwarded_host'), def compare_configurations(parser):
str(cfg.use_x_forwarded_host)) """Compare two sets of configuration values."""
self.assertEqual(3, len(parser.items('Misc'))) # Note that the count of items within each section includes the number
self.assertEqual( # of default items (1, for 'root').
parser.get('Misc', 'danube_edition'), str(cfg.danube_edition)) assert len(parser.items('Path')) == 9
self.assertEqual(parser.get('Misc', 'box_name'), cfg.box_name) assert parser.get('Path', 'root') == cfg.root
assert parser.get('Path', 'file_root') == cfg.file_root
assert parser.get('Path', 'config_dir') == cfg.config_dir
assert parser.get('Path', 'custom_static_dir') == cfg.custom_static_dir
assert parser.get('Path', 'data_dir') == cfg.data_dir
assert parser.get('Path', 'store_file') == cfg.store_file
assert parser.get('Path', 'actions_dir') == cfg.actions_dir
assert parser.get('Path', 'doc_dir') == cfg.doc_dir
assert len(parser.items('Network')) == 6
assert parser.get('Network', 'host') == cfg.host
assert int(parser.get('Network', 'port')) == cfg.port
assert parser.get('Network', 'secure_proxy_ssl_header') == \
cfg.secure_proxy_ssl_header
assert isinstance(cfg.use_x_forwarded_for, bool)
assert parser.get('Network', 'use_x_forwarded_for') == \
str(cfg.use_x_forwarded_for)
assert isinstance(cfg.use_x_forwarded_host, bool)
assert parser.get('Network', 'use_x_forwarded_host') == \
str(cfg.use_x_forwarded_host)
assert len(parser.items('Misc')) == 3
assert parser.get('Misc', 'danube_edition') == str(cfg.danube_edition)
assert parser.get('Misc', 'box_name') == cfg.box_name