Require tests to explicitly include all fact values

This mostly impacts anywhere the operation expects the fact to return `None`, which was the default before this change. Now requires each test to explicitly define the fact return value or an exception will be raised. As can be seen in the mass update of test files there were a number of invalid test facts defined that relied on this bahavior, moving to an explicit definition is a significant improvement.
pyinfra-dev · Nov 16, 2024 · e5b2290 · e5b2290
1 parent 63ff580
commit e5b2290
Show file tree

Hide file tree

Showing 133 changed files with 250 additions and 161 deletions.
diff --git a/tests/operations/apt.deb/add.json b/tests/operations/apt.deb/add.json
@@ -6,7 +6,7 @@
             "path=_tempfile_": ""
         },
         "deb.DebPackage": {
-            "name=_tempfile_": {
+            "package=_tempfile_": {
                 "name": "test",
                 "version": 0
             }

diff --git a/tests/operations/apt.deb/download_add.json b/tests/operations/apt.deb/download_add.json
@@ -6,7 +6,7 @@
             "path=_tempfile_": null
         },
         "deb.DebPackage": {
-            "name=_tempfile_": null
+            "package=_tempfile_": null
         },
         "deb.DebPackages": {},
         "server.Which": {

diff --git a/tests/operations/apt.deb/remove_no_exist.json b/tests/operations/apt.deb/remove_no_exist.json
@@ -9,7 +9,7 @@
             "path=_tempfile_": ""
         },
         "deb.DebPackage": {
-            "name=_tempfile_": {
+            "package=_tempfile_": {
                 "name": "test",
                 "version": 0
             }

diff --git a/tests/operations/apt.dist_upgrade/dist_upgrade.json b/tests/operations/apt.dist_upgrade/dist_upgrade.json
@@ -5,7 +5,7 @@
     ],
     "facts": {
         "apt.SimulateOperationWillChange": {
-
+            "command=dist-upgrade": {}
         }
     }
 }
diff --git a/tests/operations/apt.packages/update_upgrade.json b/tests/operations/apt.packages/update_upgrade.json
@@ -5,7 +5,9 @@
     },
     "facts": {
         "deb.DebPackages": {},
-        "apt.SimulateOperationWillChange": {}
+        "apt.SimulateOperationWillChange": {
+            "command=upgrade": {}
+        }
     },
     "commands": [
         "apt-get update",

diff --git a/tests/operations/apt.repo/add.json b/tests/operations/apt.repo/add.json
@@ -3,7 +3,7 @@
     "facts": {
         "apt.AptSources": [],
         "files.FindInFile": {
-            "path=/etc/apt/sources.list, pattern=^.*deb http://archive\\.canonical\\.com/ubuntu hardy partner.*$, interpolate_variables=False": []
+            "interpolate_variables=False, path=/etc/apt/sources.list, pattern=^.*deb http://archive\\.canonical\\.com/ubuntu hardy partner.*$": []
         }
     },
     "commands": [

diff --git a/tests/operations/apt.repo/add_filename.json b/tests/operations/apt.repo/add_filename.json
@@ -6,7 +6,7 @@
     "facts": {
         "apt.AptSources": [],
         "files.FindInFile": {
-            "path=/etc/apt/sources.list.d/somefile.list, pattern=^.*deb http://archive\\.canonical\\.com/ubuntu hardy partner.*$, interpolate_variables=False": []
+            "interpolate_variables=False, path=/etc/apt/sources.list.d/somefile.list, pattern=^.*deb http://archive\\.canonical\\.com/ubuntu hardy partner.*$": []
         }
     },
     "commands": [

diff --git a/tests/operations/apt.upgrade/upgrade.json b/tests/operations/apt.upgrade/upgrade.json
@@ -2,10 +2,12 @@
     "args": [],
     "facts": {
         "apt.SimulateOperationWillChange": {
-            "upgraded": 15,
-            "newly_installed": 0,
-            "removed": 0,
-           "not_upgraded": 0
+            "command=upgrade": {
+                "upgraded": 15,
+                "newly_installed": 0,
+                "removed": 0,
+               "not_upgraded": 0
+            }
         }
     },
     "commands": [

diff --git a/tests/operations/apt.upgrade/upgrade_autoremove.json b/tests/operations/apt.upgrade/upgrade_autoremove.json
@@ -5,7 +5,7 @@
     ],
     "facts": {
         "apt.SimulateOperationWillChange": {
-
+            "command=upgrade --autoremove": {}
         }
     }
 }
diff --git a/tests/operations/bsdinit.service/disabled.json b/tests/operations/bsdinit.service/disabled.json
@@ -9,7 +9,7 @@
             "nginx": true
         },
         "files.FindInFile": {
-            "path=/etc/rc.conf.local, pattern=^nginx_enable=.*$, interpolate_variables=False": [
+            "interpolate_variables=False, path=/etc/rc.conf.local, pattern=^nginx_enable=.*$": [
                 "nginx_enable=\"YES\""
             ]
         }

diff --git a/tests/operations/bsdinit.service/enabled.json b/tests/operations/bsdinit.service/enabled.json
@@ -9,8 +9,8 @@
             "nginx": true
         },
         "files.FindInFile": {
-            "path=/etc/rc.conf.local, pattern=^nginx_enable=.*$, interpolate_variables=False": [],
-            "path=/etc/rc.conf.local, pattern=^.*nginx_enable=\"YES\".*$, interpolate_variables=False": []
+            "interpolate_variables=False, path=/etc/rc.conf.local, pattern=^nginx_enable=.*$": [],
+            "interpolate_variables=False, path=/etc/rc.conf.local, pattern=^nginx_enable=\"YES\"$": []
         }
     },
     "commands": [

diff --git a/tests/operations/dnf.repo/add.json b/tests/operations/dnf.repo/add.json
@@ -11,7 +11,8 @@
             "path=/etc/yum.repos.d/somerepo.repo": {}
         },
         "files.Directory": {
-            "path=/etc/yum.repos.d": true
+            "path=/etc/yum.repos.d": true,
+            "path=/etc/yum.repos.d/somerepo.repo": null
         }
     },
     "commands": [[

diff --git a/tests/operations/files.block/add_existing_block_different_content.json b/tests/operations/files.block/add_existing_block_different_content.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": ["previously was something else"]
+            "begin=None, end=None, marker=None, path=/home/someone/something": ["previously was something else"]
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/add_existing_block_different_content_and_backup.json b/tests/operations/files.block/add_existing_block_different_content_and_backup.json
@@ -9,7 +9,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": ["previously was something else"]
+            "begin=None, end=None, marker=None, path=/home/someone/something": ["previously was something else"]
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/add_existing_block_same_content.json b/tests/operations/files.block/add_existing_block_same_content.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": ["the one true string"]
+            "begin=None, end=None, marker=None, path=/home/someone/something": ["the one true string"]
         }
     },
     "commands": [],

diff --git a/tests/operations/files.block/add_line_given_but_before_eq_after.json b/tests/operations/files.block/add_line_given_but_before_eq_after.json
@@ -9,7 +9,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": null
+            "begin=None, end=None, marker=None, path=/home/someone/something": null
         }
     },
     "exception": {

diff --git a/tests/operations/files.block/add_no_content_provided.json b/tests/operations/files.block/add_no_content_provided.json
@@ -3,7 +3,7 @@
     "args": ["/home/someone/something"],
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": null
+            "begin=None, end=None, marker=None, path=/home/someone/something": null
         }
     },
     "exception": {

diff --git a/tests/operations/files.block/add_no_existing_block_and_no_line.json b/tests/operations/files.block/add_no_existing_block_and_no_line.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": null
+            "begin=None, end=None, marker=None, path=/home/someone/something": null
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/add_no_existing_block_line_provided.json b/tests/operations/files.block/add_no_existing_block_line_provided.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": []
+            "begin=None, end=None, marker=None, path=/home/someone/something": []
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/add_no_existing_block_line_provided_escape_regex.json b/tests/operations/files.block/add_no_existing_block_line_provided_escape_regex.json
@@ -9,7 +9,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": []
+            "begin=None, end=None, marker=None, path=/home/someone/something": []
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/add_no_existing_file.json b/tests/operations/files.block/add_no_existing_file.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": null
+            "begin=None, end=None, marker=None, path=/home/someone/something": null
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/add_no_line_given_but_before_ne_after.json b/tests/operations/files.block/add_no_line_given_but_before_ne_after.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": null
+            "begin=None, end=None, marker=None, path=/home/someone/something": null
         }
     },
     "exception": {

diff --git a/tests/operations/files.block/remove_but_content_not_none.json b/tests/operations/files.block/remove_but_content_not_none.json
@@ -7,7 +7,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": ["some existing content"]
+            "begin=None, end=None, marker=None, path=/home/someone/something": ["some existing content"]
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/remove_existing_block.json b/tests/operations/files.block/remove_existing_block.json
@@ -6,7 +6,7 @@
     },
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": ["existing content"]
+            "begin=None, end=None, marker=None, path=/home/someone/something": ["existing content"]
         }
     },
     "commands": [

diff --git a/tests/operations/files.block/remove_no_existing_block.json b/tests/operations/files.block/remove_no_existing_block.json
@@ -4,7 +4,7 @@
     "kwargs": {"present": false},
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": []
+            "begin=None, end=None, marker=None, path=/home/someone/something": []
         }
     },
     "commands": [],

diff --git a/tests/operations/files.block/remove_no_file.json b/tests/operations/files.block/remove_no_file.json
@@ -4,7 +4,7 @@
     "kwargs": {"present": false},
     "facts": {
         "files.Block": {
-            "path=/home/someone/something, marker=None, begin=None, end=None": null
+            "begin=None, end=None, marker=None, path=/home/someone/something": null
         }
     },
     "commands": [],

diff --git a/tests/operations/files.directory/add_with_spaces.json b/tests/operations/files.directory/add_with_spaces.json
@@ -8,7 +8,7 @@
     },
     "facts": {
         "files.Directory": {
-            "path=testdir": null
+            "path=test dir": null
         }
     },
     "commands": [

diff --git a/tests/operations/files.line/add.json b/tests/operations/files.line/add.json
@@ -2,7 +2,7 @@
     "args": ["somefile", "match_line"],
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": []
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": []
         }
     },
     "commands": [

diff --git a/tests/operations/files.line/add_backup.json b/tests/operations/files.line/add_backup.json
@@ -5,7 +5,7 @@
     },
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": []
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": []
         }
     },
     "commands": [

diff --git a/tests/operations/files.line/add_existing.json b/tests/operations/files.line/add_existing.json
@@ -6,7 +6,7 @@
     },
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": ["replace_line"]
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": ["replace_line"]
         }
     },
     "commands": [],

diff --git a/tests/operations/files.line/add_replace.json b/tests/operations/files.line/add_replace.json
@@ -7,7 +7,7 @@
     "facts": {
         "files.FindInFile": {
             "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": [],
-            "interpolate_variables=False, path=somefile, pattern=^.*replace_line.*$": []
+            "interpolate_variables=False, path=somefile, pattern=^replace_line$": []
         }
     },
     "commands": [

diff --git a/tests/operations/files.line/add_replace_noop.json b/tests/operations/files.line/add_replace_noop.json
@@ -6,8 +6,8 @@
     },
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": [],
-            "path=somefile, pattern=^replace_line$, interpolate_variables=False": ["replace_line"]
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": [],
+            "interpolate_variables=False, path=somefile, pattern=^replace_line$": ["replace_line"]
         }
     },
     "commands": [],

diff --git a/tests/operations/files.line/edit.json b/tests/operations/files.line/edit.json
@@ -6,7 +6,7 @@
     },
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": [
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": [
                 "match_line"
             ]
         }

diff --git a/tests/operations/files.line/edit_backup.json b/tests/operations/files.line/edit_backup.json
@@ -7,7 +7,7 @@
     },
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": [
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": [
                 "match_line"
             ]
         }

diff --git a/tests/operations/files.line/pathlib_edit.json b/tests/operations/files.line/pathlib_edit.json
@@ -6,7 +6,7 @@
     },
     "facts": {
         "files.FindInFile": {
-            "path=somefile, pattern=^.*match_line.*$, interpolate_variables=False": [
+            "interpolate_variables=False, path=somefile, pattern=^.*match_line.*$": [
                 "match_line"
             ]
         }

diff --git a/tests/operations/files.put/copy_local_permissions.json b/tests/operations/files.put/copy_local_permissions.json
@@ -11,9 +11,11 @@
     },
     "facts": {
         "files.File": {
-            "path=/home/some\\ file.txt": null
+            "path=/somefile.txt": null,
+            "path=/somefile.txt/somefile.txt": null
         },
         "files.Directory": {
+            "path=/somefile.txt": false,
             "path=/": true
         }
     },

diff --git a/tests/operations/files.put/create_directory.json b/tests/operations/files.put/create_directory.json
@@ -16,7 +16,8 @@
             "path=/home/somefile.txt": null
         },
         "files.Directory": {
-            "path=/home": null
+            "path=/home": null,
+            "path=/home/somefile.txt": null
         }
     },
     "commands": [

diff --git a/tests/operations/files.put/no_remote.json b/tests/operations/files.put/no_remote.json
@@ -16,7 +16,8 @@
             "path=/home/somefile.txt": null
         },
         "files.Directory": {
-            "path=/home": true
+            "path=/home": true,
+            "path=/home/somefile.txt": null
         }
     },
     "commands": [

diff --git a/tests/operations/files.put/path_with_spaces.json b/tests/operations/files.put/path_with_spaces.json
@@ -8,10 +8,11 @@
     },
     "facts": {
         "files.File": {
-            "path=/home/some\\ file.txt": null
+            "path=/home/some file.txt": null
         },
         "files.Directory": {
-            "path=/home": true
+            "path=/home": true,
+            "path=/home/some file.txt": false
         }
     },
     "commands": [

diff --git a/tests/operations/files.put/path_with_spaces_already_escaped.json b/tests/operations/files.put/path_with_spaces_already_escaped.json
@@ -11,7 +11,8 @@
             "path=/home/some\\ file.txt": null
         },
         "files.Directory": {
-            "path=/home": true
+            "path=/home": true,
+            "path=/home/some\\ file.txt": false
         }
     },
     "commands": [