Merge ~cjwatson/lazr.restful:pretty-print-list-ordered-dict into lazr.restful:main

[Colin Watson]

Fix regression in pretty-printing lists of OrderedDicts

Launchpad's test suite (in `lib/lp/registry/stories/webservice/xx-project-registry.rst`) relies on lists of `OrderedDict` objects being pretty-printed as if they were ordinary dicts; the change in https://code.launchpad.net/~cjwatson/lazr.restful/+git/lazr.restful/+merge/413872 regressed this. Restore the previous behaviour, and ensure we have a local test for it.

[Andrey Fedoseev (andrey-fedoseev)]

review: Approve

[Andrey Fedoseev (andrey-fedoseev)]

Colin,

I noticed that you didn't update the version number in `setup.py`. I assumed that you didn't do that on purpose (like, to add some other changes before releasing 2.0.1), but I wanted to let you know anyway.

[Colin Watson (cjwatson)]

Yeah, I did that in a release commit, but thanks for checking.

[Jürgen Gmach (jugmac00)]

What I often see is that immediately after a release another "back to development" commit is done which updates the version number to version+1 and the dev0 suffix.

[Colin Watson (cjwatson)]

Fair enough - done for 2.0.2.dev0.

diff --git a/NEWS.rst b/NEWS.rst
index cf82019..b366942 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -6,6 +6,8 @@ NEWS for lazr.restful
 =====
 
 - Remove simplejson dependency.
+- Fix regression in rendering of lists of ``OrderedDict`` objects by
+  ``lazr.restful.testing.webservice.pformat_value``.
 
 2.0.0 (2022-06-01)
 ==================
diff --git a/src/lazr/restful/testing/webservice.py b/src/lazr/restful/testing/webservice.py
index 1de10b6..e3f8b7e 100644
--- a/src/lazr/restful/testing/webservice.py
+++ b/src/lazr/restful/testing/webservice.py
@@ -194,7 +194,9 @@ def pformat_value(value):
     This is similar to `repr()`, but for doctest compatibility we format
     values in a way that is unambiguous across Python versions.
     """
-    if isinstance(value, OrderedDict):
+    if isinstance(value, list):
+        return "[" + ", ".join(pformat_value(item) for item in value) + "]"
+    elif isinstance(value, OrderedDict):
         # WebServiceResponseWrapper.jsonBody turns JSON objects into
         # OrderedDicts, but for doctest compatibility we just want to
         # re-sort and render these as if they were ordinary dicts.
diff --git a/src/lazr/restful/tests/test_testing.py b/src/lazr/restful/tests/test_testing.py
new file mode 100644
index 0000000..3a77fc8
--- /dev/null
+++ b/src/lazr/restful/tests/test_testing.py
@@ -0,0 +1,43 @@
+# Copyright 2022 Canonical Ltd.  All rights reserved.
+#
+# This file is part of lazr.restful.
+#
+# lazr.restful is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, version 3 of the License.
+#
+# lazr.restful is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with lazr.restful.  If not, see <http://www.gnu.org/licenses/>.
+
+from collections import OrderedDict
+
+from testtools import TestCase
+
+from lazr.restful.testing.webservice import pformat_value
+
+
+class TestPrettyFormatValue(TestCase):
+    """Test `lazr.restful.testing.webservice.pformat_value`."""
+
+    def test_string(self):
+        self.assertEqual("'foo'", pformat_value("foo"))
+
+    def test_bytes(self):
+        self.assertEqual("b'foo'", pformat_value(b"foo"))
+
+    def test_ordered_dict(self):
+        self.assertEqual(
+            "{'abc': 'def', 'ghi': 'jkl'}",
+            pformat_value(OrderedDict((("abc", "def"), ("ghi", "jkl")))),
+        )
+
+    def test_list_of_ordered_dicts(self):
+        self.assertEqual(
+            "[{'abc': 'def', 'ghi': 'jkl'}]",
+            pformat_value([OrderedDict((("abc", "def"), ("ghi", "jkl")))]),
+        )