centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Refactor File tests

Browse Source
This commit is contained in:
Oleh Prypin
2023-10-29 21:53:32 +01:00
parent 3a69c9a6dd
commit f3d5c8dc8d
1 changed files with 145 additions and 234 deletions
Download Patch File Download Diff File Expand all files Collapse all files

379
mkdocs/tests/structure/file_tests.py
View File

@@ -79,256 +79,167 @@ class TestFiles(PathAssertionMixin, unittest.TestCase):
) )
def test_md_file(self): def test_md_file(self):
f = File('foo.md', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo.md') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo.md') f = File('foo.md', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo.html') self.assertEqual(f.src_uri, 'foo.md')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo.html') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo.md')
self.assertEqual(f.url, 'foo.html') if use_directory_urls:
self.assertEqual(f.name, 'foo') self.assertEqual(f.dest_uri, 'foo/index.html')
self.assertTrue(f.is_documentation_page()) self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/index.html')
self.assertFalse(f.is_static_page()) self.assertEqual(f.url, 'foo/')
self.assertFalse(f.is_media_file()) else:
self.assertFalse(f.is_javascript()) self.assertEqual(f.dest_uri, 'foo.html')
self.assertFalse(f.is_css()) self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo.html')
self.assertEqual(f.url, 'foo.html')
def test_md_file_use_directory_urls(self): self.assertEqual(f.name, 'foo')
f = File('foo.md', '/path/to/docs', '/path/to/site', use_directory_urls=True) self.assertTrue(f.is_documentation_page())
self.assertEqual(f.src_uri, 'foo.md') self.assertFalse(f.is_static_page())
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo.md') self.assertFalse(f.is_media_file())
self.assertEqual(f.dest_uri, 'foo/index.html') self.assertFalse(f.is_javascript())
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/index.html') self.assertFalse(f.is_css())
self.assertEqual(f.url, 'foo/')
self.assertEqual(f.name, 'foo')
self.assertTrue(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_md_file_nested(self): def test_md_file_nested(self):
f = File('foo/bar.md', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo/bar.md') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.md') f = File('foo/bar.md', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo/bar.html') self.assertEqual(f.src_uri, 'foo/bar.md')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.html') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.md')
self.assertEqual(f.url, 'foo/bar.html') if use_directory_urls:
self.assertEqual(f.name, 'bar') self.assertEqual(f.dest_uri, 'foo/bar/index.html')
self.assertTrue(f.is_documentation_page()) self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar/index.html')
self.assertFalse(f.is_static_page()) self.assertEqual(f.url, 'foo/bar/')
self.assertFalse(f.is_media_file()) else:
self.assertFalse(f.is_javascript()) self.assertEqual(f.dest_uri, 'foo/bar.html')
self.assertFalse(f.is_css()) self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.html')
self.assertEqual(f.url, 'foo/bar.html')
def test_md_file_nested_use_directory_urls(self): self.assertEqual(f.name, 'bar')
f = File('foo/bar.md', '/path/to/docs', '/path/to/site', use_directory_urls=True) self.assertTrue(f.is_documentation_page())
self.assertEqual(f.src_uri, 'foo/bar.md') self.assertFalse(f.is_static_page())
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.md') self.assertFalse(f.is_media_file())
self.assertEqual(f.dest_uri, 'foo/bar/index.html') self.assertFalse(f.is_javascript())
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar/index.html') self.assertFalse(f.is_css())
self.assertEqual(f.url, 'foo/bar/')
self.assertEqual(f.name, 'bar')
self.assertTrue(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_md_index_file(self): def test_md_index_file(self):
f = File('index.md', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'index.md') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/index.md') f = File('index.md', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'index.html') self.assertEqual(f.src_uri, 'index.md')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/index.html') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/index.md')
self.assertEqual(f.url, 'index.html') self.assertEqual(f.dest_uri, 'index.html')
self.assertEqual(f.name, 'index') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/index.html')
self.assertTrue(f.is_documentation_page()) if use_directory_urls:
self.assertFalse(f.is_static_page()) self.assertEqual(f.url, './')
self.assertFalse(f.is_media_file()) else:
self.assertFalse(f.is_javascript()) self.assertEqual(f.url, 'index.html')
self.assertFalse(f.is_css()) self.assertEqual(f.name, 'index')
self.assertTrue(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_md_readme_index_file(self): def test_md_readme_index_file(self):
f = File('README.md', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'README.md') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/README.md') f = File('README.md', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'index.html') self.assertEqual(f.src_uri, 'README.md')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/index.html') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/README.md')
self.assertEqual(f.url, 'index.html') self.assertEqual(f.dest_uri, 'index.html')
self.assertEqual(f.name, 'index') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/index.html')
self.assertTrue(f.is_documentation_page()) if use_directory_urls:
self.assertFalse(f.is_static_page()) self.assertEqual(f.url, './')
self.assertFalse(f.is_media_file()) else:
self.assertFalse(f.is_javascript()) self.assertEqual(f.url, 'index.html')
self.assertFalse(f.is_css()) self.assertEqual(f.name, 'index')
self.assertTrue(f.is_documentation_page())
def test_md_index_file_use_directory_urls(self): self.assertFalse(f.is_static_page())
f = File('index.md', '/path/to/docs', '/path/to/site', use_directory_urls=True) self.assertFalse(f.is_media_file())
self.assertEqual(f.src_uri, 'index.md') self.assertFalse(f.is_javascript())
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/index.md') self.assertFalse(f.is_css())
self.assertEqual(f.dest_uri, 'index.html')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/index.html')
self.assertEqual(f.url, './')
self.assertEqual(f.name, 'index')
self.assertTrue(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_md_readme_index_file_use_directory_urls(self):
f = File('README.md', '/path/to/docs', '/path/to/site', use_directory_urls=True)
self.assertEqual(f.src_uri, 'README.md')
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/README.md')
self.assertEqual(f.dest_uri, 'index.html')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/index.html')
self.assertEqual(f.url, './')
self.assertEqual(f.name, 'index')
self.assertTrue(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_md_index_file_nested(self): def test_md_index_file_nested(self):
f = File('foo/index.md', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo/index.md') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/index.md') f = File('foo/index.md', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo/index.html') self.assertEqual(f.src_uri, 'foo/index.md')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/index.html') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/index.md')
self.assertEqual(f.url, 'foo/index.html') self.assertEqual(f.dest_uri, 'foo/index.html')
self.assertEqual(f.name, 'index') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/index.html')
self.assertTrue(f.is_documentation_page()) if use_directory_urls:
self.assertFalse(f.is_static_page()) self.assertEqual(f.url, 'foo/')
self.assertFalse(f.is_media_file()) else:
self.assertFalse(f.is_javascript()) self.assertEqual(f.url, 'foo/index.html')
self.assertFalse(f.is_css()) self.assertEqual(f.name, 'index')
self.assertTrue(f.is_documentation_page())
def test_md_index_file_nested_use_directory_urls(self): self.assertFalse(f.is_static_page())
f = File('foo/index.md', '/path/to/docs', '/path/to/site', use_directory_urls=True) self.assertFalse(f.is_media_file())
self.assertEqual(f.src_uri, 'foo/index.md') self.assertFalse(f.is_javascript())
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/index.md') self.assertFalse(f.is_css())
self.assertEqual(f.dest_uri, 'foo/index.html')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/index.html')
self.assertEqual(f.url, 'foo/')
self.assertEqual(f.name, 'index')
self.assertTrue(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_static_file(self): def test_static_file(self):
f = File('foo/bar.html', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo/bar.html') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.html') f = File('foo/bar.html', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo/bar.html') self.assertEqual(f.src_uri, 'foo/bar.html')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.html') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.html')
self.assertEqual(f.url, 'foo/bar.html') self.assertEqual(f.dest_uri, 'foo/bar.html')
self.assertEqual(f.name, 'bar') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.html')
self.assertFalse(f.is_documentation_page()) self.assertEqual(f.url, 'foo/bar.html')
self.assertTrue(f.is_static_page()) self.assertEqual(f.name, 'bar')
self.assertFalse(f.is_media_file()) self.assertFalse(f.is_documentation_page())
self.assertFalse(f.is_javascript()) self.assertTrue(f.is_static_page())
self.assertFalse(f.is_css()) self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
def test_static_file_use_directory_urls(self): self.assertFalse(f.is_css())
f = File('foo/bar.html', '/path/to/docs', '/path/to/site', use_directory_urls=True)
self.assertEqual(f.src_uri, 'foo/bar.html')
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.html')
self.assertEqual(f.dest_uri, 'foo/bar.html')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.html')
self.assertEqual(f.url, 'foo/bar.html')
self.assertEqual(f.name, 'bar')
self.assertFalse(f.is_documentation_page())
self.assertTrue(f.is_static_page())
self.assertFalse(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_media_file(self): def test_media_file(self):
f = File('foo/bar.jpg', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo/bar.jpg') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.jpg') f = File('foo/bar.jpg', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo/bar.jpg') self.assertEqual(f.src_uri, 'foo/bar.jpg')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.jpg') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.jpg')
self.assertEqual(f.url, 'foo/bar.jpg') self.assertEqual(f.dest_uri, 'foo/bar.jpg')
self.assertEqual(f.name, 'bar') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.jpg')
self.assertFalse(f.is_documentation_page()) self.assertEqual(f.url, 'foo/bar.jpg')
self.assertFalse(f.is_static_page()) self.assertEqual(f.name, 'bar')
self.assertTrue(f.is_media_file()) self.assertFalse(f.is_documentation_page())
self.assertFalse(f.is_javascript()) self.assertFalse(f.is_static_page())
self.assertFalse(f.is_css()) self.assertTrue(f.is_media_file())
self.assertFalse(f.is_javascript())
def test_media_file_use_directory_urls(self): self.assertFalse(f.is_css())
f = File('foo/bar.jpg', '/path/to/docs', '/path/to/site', use_directory_urls=True)
self.assertEqual(f.src_uri, 'foo/bar.jpg')
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.jpg')
self.assertEqual(f.dest_uri, 'foo/bar.jpg')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.jpg')
self.assertEqual(f.url, 'foo/bar.jpg')
self.assertEqual(f.name, 'bar')
self.assertFalse(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertTrue(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertFalse(f.is_css())
def test_javascript_file(self): def test_javascript_file(self):
f = File('foo/bar.js', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo/bar.js') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.js') f = File('foo/bar.js', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo/bar.js') self.assertEqual(f.src_uri, 'foo/bar.js')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.js') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.js')
self.assertEqual(f.url, 'foo/bar.js') self.assertEqual(f.dest_uri, 'foo/bar.js')
self.assertEqual(f.name, 'bar') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.js')
self.assertFalse(f.is_documentation_page()) self.assertEqual(f.url, 'foo/bar.js')
self.assertFalse(f.is_static_page()) self.assertEqual(f.name, 'bar')
self.assertTrue(f.is_media_file()) self.assertFalse(f.is_documentation_page())
self.assertTrue(f.is_javascript()) self.assertFalse(f.is_static_page())
self.assertFalse(f.is_css()) self.assertTrue(f.is_media_file())
self.assertTrue(f.is_javascript())
def test_javascript_file_use_directory_urls(self): self.assertFalse(f.is_css())
f = File('foo/bar.js', '/path/to/docs', '/path/to/site', use_directory_urls=True)
self.assertEqual(f.src_uri, 'foo/bar.js')
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.js')
self.assertEqual(f.dest_uri, 'foo/bar.js')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.js')
self.assertEqual(f.url, 'foo/bar.js')
self.assertEqual(f.name, 'bar')
self.assertFalse(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertTrue(f.is_media_file())
self.assertTrue(f.is_javascript())
self.assertFalse(f.is_css())
def test_css_file(self): def test_css_file(self):
f = File('foo/bar.css', '/path/to/docs', '/path/to/site', use_directory_urls=False) for use_directory_urls in True, False:
self.assertEqual(f.src_uri, 'foo/bar.css') with self.subTest(use_directory_urls=use_directory_urls):
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.css') f = File('foo/bar.css', '/path/to/docs', '/path/to/site', use_directory_urls)
self.assertEqual(f.dest_uri, 'foo/bar.css') self.assertEqual(f.src_uri, 'foo/bar.css')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.css') self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.css')
self.assertEqual(f.url, 'foo/bar.css') self.assertEqual(f.dest_uri, 'foo/bar.css')
self.assertEqual(f.name, 'bar') self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.css')
self.assertFalse(f.is_documentation_page()) self.assertEqual(f.url, 'foo/bar.css')
self.assertFalse(f.is_static_page()) self.assertEqual(f.name, 'bar')
self.assertTrue(f.is_media_file()) self.assertFalse(f.is_documentation_page())
self.assertFalse(f.is_javascript()) self.assertFalse(f.is_static_page())
self.assertTrue(f.is_css()) self.assertTrue(f.is_media_file())
self.assertFalse(f.is_javascript())
def test_css_file_use_directory_urls(self): self.assertTrue(f.is_css())
f = File('foo/bar.css', '/path/to/docs', '/path/to/site', use_directory_urls=True)
self.assertEqual(f.src_uri, 'foo/bar.css')
self.assertPathsEqual(f.abs_src_path, '/path/to/docs/foo/bar.css')
self.assertEqual(f.dest_uri, 'foo/bar.css')
self.assertPathsEqual(f.abs_dest_path, '/path/to/site/foo/bar.css')
self.assertEqual(f.url, 'foo/bar.css')
self.assertEqual(f.name, 'bar')
self.assertFalse(f.is_documentation_page())
self.assertFalse(f.is_static_page())
self.assertTrue(f.is_media_file())
self.assertFalse(f.is_javascript())
self.assertTrue(f.is_css())
def test_file_name_with_space(self): def test_file_name_with_space(self):
f = File('foo bar.md', '/path/to/docs', '/path/to/site', use_directory_urls=False) f = File('foo bar.md', '/path/to/docs', '/path/to/site', use_directory_urls=False)