tests: Use textwrap.dedent to indent expected strings pleasingly

This introduces no functional changes.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
This commit is contained in:
Philip Withnall 2023-12-11 16:52:07 +00:00
parent b014d622ee
commit b96778ee43

View File

@ -28,6 +28,7 @@ import shutil
import subprocess import subprocess
import sys import sys
import tempfile import tempfile
import textwrap
import unittest import unittest
import xml.etree.ElementTree as ET import xml.etree.ElementTree as ET
@ -542,22 +543,22 @@ G_END_DECLS
self.assertEqual("", res.out) self.assertEqual("", res.out)
with open("test-org.project.Bar.Frobnicator.rst", "r") as f: with open("test-org.project.Bar.Frobnicator.rst", "r") as f:
rst = f.read() rst = f.read()
self.assertIn(""" self.assertIn(textwrap.dedent("""
------- -------
Methods Methods
------- -------
.. _org.project.Bar.Frobnicator.RandomMethod: .. _org.project.Bar.Frobnicator.RandomMethod:
org.project.Bar.Frobnicator.RandomMethod org.project.Bar.Frobnicator.RandomMethod
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:: ::
RandomMethod () RandomMethod ()
A random test method.""", rst) A random test method."""), rst)
def test_generate_rst_signal(self): def test_generate_rst_signal(self):
"""Test generating a signal documentation with the rst generator.""" """Test generating a signal documentation with the rst generator."""
@ -581,22 +582,22 @@ A random test method.""", rst)
self.assertEqual("", res.out) self.assertEqual("", res.out)
with open("test-org.project.Bar.Frobnicator.rst", "r") as f: with open("test-org.project.Bar.Frobnicator.rst", "r") as f:
rst = f.read() rst = f.read()
self.assertIn(""" self.assertIn(textwrap.dedent("""
------- -------
Signals Signals
------- -------
.. _org.project.Bar.Frobnicator::RandomSignal: .. _org.project.Bar.Frobnicator::RandomSignal:
org.project.Bar.Frobnicator::RandomSignal org.project.Bar.Frobnicator::RandomSignal
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:: ::
RandomSignal () RandomSignal ()
A random test signal.""", rst) A random test signal."""), rst)
def test_generate_rst_property(self): def test_generate_rst_property(self):
"""Test generating a property documentation with the rst generator.""" """Test generating a property documentation with the rst generator."""
@ -620,22 +621,22 @@ A random test signal.""", rst)
self.assertEqual("", res.out) self.assertEqual("", res.out)
with open("test-org.project.Bar.Frobnicator.rst", "r") as f: with open("test-org.project.Bar.Frobnicator.rst", "r") as f:
rst = f.read() rst = f.read()
self.assertIn(""" self.assertIn(textwrap.dedent("""
---------- ----------
Properties Properties
---------- ----------
.. _org.project.Bar.Frobnicator:RandomProperty: .. _org.project.Bar.Frobnicator:RandomProperty:
org.project.Bar.Frobnicator:RandomProperty org.project.Bar.Frobnicator:RandomProperty
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:: ::
RandomProperty readable s RandomProperty readable s
A random test property.""", rst) A random test property."""), rst)
@unittest.skipIf(on_win32(), "requires /dev/stdout") @unittest.skipIf(on_win32(), "requires /dev/stdout")
def test_glib_min_required_invalid(self): def test_glib_min_required_invalid(self):