From cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Mon, 15 Apr 2024 19:25:40 +0200
Subject: Adding upstream version 7.2.6.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 tests/test_util_inventory.py | 116 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 116 insertions(+)
 create mode 100644 tests/test_util_inventory.py

(limited to 'tests/test_util_inventory.py')

diff --git a/tests/test_util_inventory.py b/tests/test_util_inventory.py
new file mode 100644
index 0000000..2c20763
--- /dev/null
+++ b/tests/test_util_inventory.py
@@ -0,0 +1,116 @@
+"""Test inventory util functions."""
+import os
+import posixpath
+import zlib
+from io import BytesIO
+
+from sphinx.testing.util import SphinxTestApp
+from sphinx.util.inventory import InventoryFile
+
+inventory_v1 = b'''\
+# Sphinx inventory version 1
+# Project: foo
+# Version: 1.0
+module mod foo.html
+module.cls class foo.html
+'''
+
+inventory_v2 = b'''\
+# Sphinx inventory version 2
+# Project: foo
+# Version: 2.0
+# The remainder of this file is compressed with zlib.
+''' + zlib.compress(b'''\
+module1 py:module 0 foo.html#module-module1 Long Module desc
+module2 py:module 0 foo.html#module-$ -
+module1.func py:function 1 sub/foo.html#$ -
+module1.Foo.bar py:method 1 index.html#foo.Bar.baz -
+CFunc c:function 2 cfunc.html#CFunc -
+std cpp:type 1 index.html#std -
+std::uint8_t cpp:type 1 index.html#std_uint8_t -
+foo::Bar cpp:class 1 index.html#cpp_foo_bar -
+foo::Bar::baz cpp:function 1 index.html#cpp_foo_bar_baz -
+foons cpp:type 1 index.html#foons -
+foons::bartype cpp:type 1 index.html#foons_bartype -
+a term std:term -1 glossary.html#term-a-term -
+ls.-l std:cmdoption 1 index.html#cmdoption-ls-l -
+docname std:doc -1 docname.html -
+foo js:module 1 index.html#foo -
+foo.bar js:class 1 index.html#foo.bar -
+foo.bar.baz js:method 1 index.html#foo.bar.baz -
+foo.bar.qux js:data 1 index.html#foo.bar.qux -
+a term including:colon std:term -1 glossary.html#term-a-term-including-colon -
+''')
+
+inventory_v2_not_having_version = b'''\
+# Sphinx inventory version 2
+# Project: foo
+# Version:
+# The remainder of this file is compressed with zlib.
+''' + zlib.compress(b'''\
+module1 py:module 0 foo.html#module-module1 Long Module desc
+''')
+
+
+def test_read_inventory_v1():
+    f = BytesIO(inventory_v1)
+    invdata = InventoryFile.load(f, '/util', posixpath.join)
+    assert invdata['py:module']['module'] == \
+        ('foo', '1.0', '/util/foo.html#module-module', '-')
+    assert invdata['py:class']['module.cls'] == \
+        ('foo', '1.0', '/util/foo.html#module.cls', '-')
+
+
+def test_read_inventory_v2():
+    f = BytesIO(inventory_v2)
+    invdata = InventoryFile.load(f, '/util', posixpath.join)
+
+    assert len(invdata['py:module']) == 2
+    assert invdata['py:module']['module1'] == \
+        ('foo', '2.0', '/util/foo.html#module-module1', 'Long Module desc')
+    assert invdata['py:module']['module2'] == \
+        ('foo', '2.0', '/util/foo.html#module-module2', '-')
+    assert invdata['py:function']['module1.func'][2] == \
+        '/util/sub/foo.html#module1.func'
+    assert invdata['c:function']['CFunc'][2] == '/util/cfunc.html#CFunc'
+    assert invdata['std:term']['a term'][2] == \
+        '/util/glossary.html#term-a-term'
+    assert invdata['std:term']['a term including:colon'][2] == \
+        '/util/glossary.html#term-a-term-including-colon'
+
+
+def test_read_inventory_v2_not_having_version():
+    f = BytesIO(inventory_v2_not_having_version)
+    invdata = InventoryFile.load(f, '/util', posixpath.join)
+    assert invdata['py:module']['module1'] == \
+        ('foo', '', '/util/foo.html#module-module1', 'Long Module desc')
+
+
+def _write_appconfig(dir, language, prefix=None):
+    prefix = prefix or language
+    os.makedirs(dir / prefix, exist_ok=True)
+    (dir / prefix / 'conf.py').write_text(f'language = "{language}"', encoding='utf8')
+    (dir / prefix / 'index.rst').write_text('index.rst', encoding='utf8')
+    assert sorted(os.listdir(dir / prefix)) == ['conf.py', 'index.rst']
+    assert (dir / prefix / 'index.rst').exists()
+    return dir / prefix
+
+
+def _build_inventory(srcdir):
+    app = SphinxTestApp(srcdir=srcdir)
+    app.build()
+    app.cleanup()
+    return (app.outdir / 'objects.inv')
+
+
+def test_inventory_localization(tmp_path):
+    # Build an app using Estonian (EE) locale
+    srcdir_et = _write_appconfig(tmp_path, "et")
+    inventory_et = _build_inventory(srcdir_et)
+
+    # Build the same app using English (US) locale
+    srcdir_en = _write_appconfig(tmp_path, "en")
+    inventory_en = _build_inventory(srcdir_en)
+
+    # Ensure that the inventory contents differ
+    assert inventory_et.read_bytes() != inventory_en.read_bytes()
-- 
cgit v1.2.3