From 1f85d15c93c2b6fd601b405871c6e9304ac4a4e8 Mon Sep 17 00:00:00 2001
From: Bruno Oliveira <nicoddemus@gmail.com>
Date: Fri, 15 Oct 2021 18:00:00 -0300
Subject: [PATCH] Add test and improve CHANGELOG

---
 changelog/9205.improvement.rst |  1 +
 changelog/9205.trivial.rst     |  1 -
 testing/test_cacheprovider.py  | 22 ++++++++++++++++++++++
 3 files changed, 23 insertions(+), 1 deletion(-)
 create mode 100644 changelog/9205.improvement.rst
 delete mode 100644 changelog/9205.trivial.rst

diff --git a/changelog/9205.improvement.rst b/changelog/9205.improvement.rst
new file mode 100644
index 000000000..edfc30089
--- /dev/null
+++ b/changelog/9205.improvement.rst
@@ -0,0 +1 @@
+:meth:`pytest.Cache.set` now preserves key order when saving dicts.
diff --git a/changelog/9205.trivial.rst b/changelog/9205.trivial.rst
deleted file mode 100644
index 762b65dcb..000000000
--- a/changelog/9205.trivial.rst
+++ /dev/null
@@ -1 +0,0 @@
-Maintain sort order of dict in ``config.Cache``.
diff --git a/testing/test_cacheprovider.py b/testing/test_cacheprovider.py
index e43d4d94b..94d58a09b 100644
--- a/testing/test_cacheprovider.py
+++ b/testing/test_cacheprovider.py
@@ -35,6 +35,17 @@ class TestNewAPI:
         val = config.cache.get("key/name", -2)
         assert val == -2
 
+    def test_cache_order(self, pytester: Pytester) -> None:
+        pytester.makeini("[pytest]")
+        config = pytester.parseconfigure()
+        assert config.cache is not None
+        cache = config.cache
+        pytest.raises(TypeError, lambda: cache.set("key/name", cache))
+        config.cache.set("key/name", 0)
+        config.cache._getvaluepath("key/name").write_bytes(b"123invalid")
+        val = config.cache.get("key/name", -2)
+        assert val == -2
+
     @pytest.mark.filterwarnings("ignore:could not create cache path")
     def test_cache_writefail_cachfile_silent(self, pytester: Pytester) -> None:
         pytester.makeini("[pytest]")
@@ -1210,6 +1221,17 @@ def test_gitignore(pytester: Pytester) -> None:
     assert gitignore_path.read_text(encoding="UTF-8") == "custom"
 
 
+def test_preserve_keys_order(pytester: Pytester) -> None:
+    """Ensure keys order is preserved when saving dicts (#9205)."""
+    from _pytest.cacheprovider import Cache
+
+    config = pytester.parseconfig()
+    cache = Cache.for_config(config, _ispytest=True)
+    cache.set("foo", {"z": 1, "b": 2, "a": 3, "d": 10})
+    read_back = cache.get("foo", None)
+    assert list(read_back.items()) == [("z", 1), ("b", 2), ("a", 3), ("d", 10)]
+
+
 def test_does_not_create_boilerplate_in_existing_dirs(pytester: Pytester) -> None:
     from _pytest.cacheprovider import Cache