#!/usr/bin/env python # coding: utf-8 from __future__ import unicode_literals import os import shutil import tempfile import unittest from mkdocs import config from mkdocs import utils from mkdocs.config import config_options from mkdocs.exceptions import ConfigurationError from mkdocs.tests.base import dedent def ensure_utf(string): return string.encode('utf-8') if not utils.PY3 else string class ConfigTests(unittest.TestCase): def test_missing_config_file(self): def load_missing_config(): config.load_config(config_file='bad_filename.yaml') self.assertRaises(ConfigurationError, load_missing_config) def test_missing_site_name(self): c = config.Config(schema=config.DEFAULT_SCHEMA) c.load_dict({}) errors, warnings = c.validate() self.assertEqual(len(errors), 1) self.assertEqual(errors[0][0], 'site_name') self.assertEqual(str(errors[0][1]), 'Required configuration not provided.') self.assertEqual(len(warnings), 0) def test_empty_config(self): def load_empty_config(): config.load_config(config_file='/dev/null') self.assertRaises(ConfigurationError, load_empty_config) def test_nonexistant_config(self): def load_empty_config(): config.load_config(config_file='/path/that/is/not/real') self.assertRaises(ConfigurationError, load_empty_config) def test_invalid_config(self): file_contents = dedent(""" - ['index.md', 'Introduction'] - ['index.md', 'Introduction'] - ['index.md', 'Introduction'] """) config_file = tempfile.NamedTemporaryFile('w', delete=False) try: config_file.write(ensure_utf(file_contents)) config_file.flush() config_file.close() self.assertRaises( ConfigurationError, config.load_config, config_file=open(config_file.name, 'rb') ) finally: os.remove(config_file.name) def test_config_option(self): """ Users can explicitly set the config file using the '--config' option. Allows users to specify a config other than the default `mkdocs.yml`. """ expected_result = { 'site_name': 'Example', 'pages': [ {'Introduction': 'index.md'} ], } file_contents = dedent(""" site_name: Example pages: - ['index.md', 'Introduction'] """) config_file = tempfile.NamedTemporaryFile('w', delete=False) try: config_file.write(ensure_utf(file_contents)) config_file.flush() config_file.close() result = config.load_config(config_file=config_file.name) self.assertEqual(result['site_name'], expected_result['site_name']) self.assertEqual(result['pages'], expected_result['pages']) finally: os.remove(config_file.name) def test_theme(self): mytheme = tempfile.mkdtemp() custom = tempfile.mkdtemp() configs = [ dict(), # default theme {"theme": "readthedocs"}, # builtin theme {"theme_dir": mytheme}, # custom only {"theme": "readthedocs", "theme_dir": custom}, # builtin and custom ] abs_path = os.path.abspath(os.path.dirname(__file__)) mkdocs_dir = os.path.abspath(os.path.join(abs_path, '..', '..')) theme_dir = os.path.abspath(os.path.join(mkdocs_dir, 'themes')) search_asset_dir = os.path.abspath(os.path.join( mkdocs_dir, 'assets', 'search')) results = ( [os.path.join(theme_dir, 'mkdocs'), search_asset_dir], [os.path.join(theme_dir, 'readthedocs'), search_asset_dir], [mytheme, search_asset_dir], [custom, os.path.join(theme_dir, 'readthedocs'), search_asset_dir], ) for config_contents, result in zip(configs, results): c = config.Config(schema=( ('theme', config_options.Theme(default='mkdocs')), ('theme_dir', config_options.ThemeDir(exists=True)), )) c.load_dict(config_contents) c.validate() self.assertEqual(c['theme_dir'], result) def test_default_pages(self): tmp_dir = tempfile.mkdtemp() try: open(os.path.join(tmp_dir, 'index.md'), 'w').close() open(os.path.join(tmp_dir, 'about.md'), 'w').close() conf = config.Config(schema=config.DEFAULT_SCHEMA) conf.load_dict({ 'site_name': 'Example', 'docs_dir': tmp_dir }) conf.validate() self.assertEqual(['index.md', 'about.md'], conf['pages']) finally: shutil.rmtree(tmp_dir) def test_default_pages_nested(self): tmp_dir = tempfile.mkdtemp() try: open(os.path.join(tmp_dir, 'index.md'), 'w').close() open(os.path.join(tmp_dir, 'getting-started.md'), 'w').close() open(os.path.join(tmp_dir, 'about.md'), 'w').close() os.makedirs(os.path.join(tmp_dir, 'subA')) open(os.path.join(tmp_dir, 'subA', 'index.md'), 'w').close() os.makedirs(os.path.join(tmp_dir, 'subA', 'subA1')) open(os.path.join(tmp_dir, 'subA', 'subA1', 'index.md'), 'w').close() os.makedirs(os.path.join(tmp_dir, 'subC')) open(os.path.join(tmp_dir, 'subC', 'index.md'), 'w').close() os.makedirs(os.path.join(tmp_dir, 'subB')) open(os.path.join(tmp_dir, 'subB', 'index.md'), 'w').close() conf = config.Config(schema=config.DEFAULT_SCHEMA) conf.load_dict({ 'site_name': 'Example', 'docs_dir': tmp_dir }) conf.validate() self.assertEqual([ 'index.md', 'about.md', 'getting-started.md', {'subA': [ os.path.join('subA', 'index.md'), {'subA1': [ os.path.join('subA', 'subA1', 'index.md') ]} ]}, {'subB': [ os.path.join('subB', 'index.md') ]}, {'subC': [ os.path.join('subC', 'index.md') ]} ], conf['pages']) finally: shutil.rmtree(tmp_dir) def test_doc_dir_in_site_dir(self): j = os.path.join test_configs = ( {'docs_dir': j('site', 'docs'), 'site_dir': 'site'}, {'docs_dir': 'docs', 'site_dir': '.'}, {'docs_dir': '.', 'site_dir': '.'}, {'docs_dir': 'docs', 'site_dir': ''}, {'docs_dir': '', 'site_dir': ''}, ) conf = { 'site_name': 'Example', } for test_config in test_configs: patch = conf.copy() patch.update(test_config) # Same as the default schema, but don't verify the docs_dir exists. c = config.Config(schema=( ('docs_dir', config_options.Dir(default='docs')), ('site_dir', config_options.SiteDir(default='site')), )) c.load_dict(patch) self.assertRaises(config_options.ValidationError, c.validate)