Add utility methods and testcases to sphinx.util.images

1 files changed, 97 insertions, 0 deletions

diff --git a/tests/test_util_images.py b/tests/test_util_images.py
new file mode 100644
index 000000000..45ee66c55
--- /dev/null
+++ b/tests/test_util_images.py
@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+"""
+    test_util_images
+    ~~~~~~~~~~~~~~~~
+
+    Test images util.
+
+    :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+from __future__ import print_function
+
+import pytest
+
+from sphinx.util.images import (
+    get_image_size, guess_mimetype, get_image_extension, parse_data_uri
+)
+
+from util import rootdir
+
+
+GIF_FILENAME = rootdir / 'root' / 'img.gif'
+PNG_FILENAME = rootdir / 'root' / 'img.png'
+PDF_FILENAME = rootdir / 'root' / 'img.pdf'
+TXT_FILENAME = rootdir / 'root' / 'contents.txt'
+
+
+def test_get_image_size():
+    assert get_image_size(GIF_FILENAME) == (200, 181)
+    assert get_image_size(PNG_FILENAME) == (200, 181)
+    assert get_image_size(PDF_FILENAME) is None
+    assert get_image_size(TXT_FILENAME) is None
+
+
+def test_guess_mimetype():
+    # guess by filename
+    assert guess_mimetype('img.png') == 'image/png'
+    assert guess_mimetype('img.jpg') == 'image/jpeg'
+    assert guess_mimetype('img.txt') is None
+    assert guess_mimetype('img.txt', default='text/plain') == 'text/plain'
+    assert guess_mimetype('no_extension') is None
+    assert guess_mimetype('IMG.PNG') == 'image/png'
+
+    # guess by content
+    assert guess_mimetype(content=GIF_FILENAME.bytes()) == 'image/gif'
+    assert guess_mimetype(content=PNG_FILENAME.bytes()) == 'image/png'
+    assert guess_mimetype(content=PDF_FILENAME.bytes()) is None
+    assert guess_mimetype(content=TXT_FILENAME.bytes()) is None
+    assert guess_mimetype(content=TXT_FILENAME.bytes(), default='text/plain') == 'text/plain'
+
+    # the priority of params: filename > content > default
+    assert guess_mimetype('img.png',
+                          content=GIF_FILENAME.bytes(),
+                          default='text/plain') == 'image/png'
+    assert guess_mimetype('no_extension',
+                          content=GIF_FILENAME.bytes(),
+                          default='text/plain') == 'image/gif'
+    assert guess_mimetype('no_extension',
+                          content=TXT_FILENAME.bytes(),
+                          default='text/plain') == 'text/plain'
+
+
+def test_get_image_extension():
+    assert get_image_extension('image/png') == '.png'
+    assert get_image_extension('image/jpeg') == '.jpg'
+    assert get_image_extension('image/svg+xml') == '.svg'
+    assert get_image_extension('text/plain') is None
+
+
+def test_parse_data_uri():
+    # standard case
+    uri = ("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4"
+           "//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==")
+    image = parse_data_uri(uri)
+    assert image is not None
+    assert image.mimetype == 'image/png'
+    assert image.charset == 'US-ASCII'
+
+    # no mimetype
+    uri = ("data:charset=utf-8,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElE"
+           "QVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==")
+    image = parse_data_uri(uri)
+    assert image is not None
+    assert image.mimetype == 'text/plain'
+    assert image.charset == 'utf-8'
+
+    # non data URI
+    uri = ("image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4"
+           "//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==")
+    image = parse_data_uri(uri)
+    assert image is None
+
+    # invalid data URI (no properties)
+    with pytest.raises(ValueError):
+        uri = ("data:iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4"
+               "//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==")
+        parse_data_uri(uri)