facts/zfs: add Zfs prefix for consistency with backwards compatibility

Author: Fizzadar

pyinfra/facts/zfs.py

@@ -1,5 +1,5 @@
 """
-Manage ZFS filesystems.
+Gather information about ZFS filesystems.
 """
 
 from pyinfra.api import FactBase, ShortFactBase
@@ -15,38 +15,46 @@ def _process_zfs_props_table(output):
     return datasets
 
 
-class Pools(FactBase):
+class ZfsPools(FactBase):
     def command(self):
         return "zpool get -H all"
 
     def process(self, output):
         return _process_zfs_props_table(output)
 
 
-class Datasets(FactBase):
+class ZfsDatasets(FactBase):
     def command(self):
         return "zfs get -H all"
 
     def process(self, output):
         return _process_zfs_props_table(output)
 
 
-class Filesystems(ShortFactBase):
-    fact = Datasets
+class ZfsFilesystems(ShortFactBase):
+    fact = ZfsDatasets
 
     def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "filesystem"}
 
 
-class Snapshots(ShortFactBase):
-    fact = Datasets
+class ZfsSnapshots(ShortFactBase):
+    fact = ZfsDatasets
 
     def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "snapshot"}
 
 
-class Volumes(ShortFactBase):
-    fact = Datasets
+class ZfsVolumes(ShortFactBase):
+    fact = ZfsDatasets
 
     def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "volume"}
+
+
+# TODO: remove these in v4! Or flip the convention and remove all the other fact prefixes!
+Pools = ZfsPools
+Datasets = ZfsDatasets
+Filesystems = ZfsFilesystems
+Snapshots = ZfsSnapshots
+Volumes = ZfsVolumes

pyinfra/operations/zfs.py

@@ -4,7 +4,7 @@
 
 from pyinfra import host
 from pyinfra.api import operation
-from pyinfra.facts.zfs import Datasets, Snapshots
+from pyinfra.facts.zfs import ZfsDatasets, ZfsSnapshots
 
 
 @operation()
@@ -48,7 +48,7 @@ def dataset(
 
     properties.update(extra_props)
 
-    datasets = host.get_fact(Datasets)
+    datasets = host.get_fact(ZfsDatasets)
 
     existing_dataset = datasets.get(dataset_name)
 
@@ -103,7 +103,7 @@ def snapshot(snapshot_name, present=True, recursive=False, properties={}, **extr
 
     """
     properties.update(extra_props)
-    snapshots = host.get_fact(Snapshots)
+    snapshots = host.get_fact(ZfsSnapshots)
 
     if snapshot_name in snapshots or not present:
         yield from dataset._inner(snapshot_name, present=present, properties=properties)

tests/operations/zfs.dataset/create.json

@@ -10,7 +10,7 @@
     }
   },
   "facts": {
-    "zfs.Datasets": {}
+    "zfs.ZfsDatasets": {}
   },
   "commands": [
     "zfs create -o com.sun:auto_snapshot=true -o mountpoint=/home/james tank/home/james"

tests/operations/zfs.dataset/create_noop.json

@@ -7,7 +7,7 @@
     "compression": "lz4"
   },
   "facts": {
-    "zfs.Datasets": {
+    "zfs.ZfsDatasets": {
         "tank/home/james": {
             "compression": "lz4"
         }

tests/operations/zfs.dataset/create_recursive.json

@@ -8,7 +8,7 @@
     "compression": "lz4"
   },
   "facts": {
-    "zfs.Datasets": {}
+    "zfs.ZfsDatasets": {}
   },
   "commands": [
     "zfs create -o compression=lz4 -p tank/myzvol"

tests/operations/zfs.dataset/create_sparse.json

@@ -9,7 +9,7 @@
     "volume_size": "5G"
   },
   "facts": {
-    "zfs.Datasets": {}
+    "zfs.ZfsDatasets": {}
   },
   "commands": [
     "zfs create -V 5G -o compression=lz4 -s tank/myzvol"

tests/operations/zfs.dataset/create_volume.json

@@ -8,7 +8,7 @@
     "volume_size": "5G"
   },
   "facts": {
-    "zfs.Datasets": {}
+    "zfs.ZfsDatasets": {}
   },
   "commands": [
     "zfs create -V 5G -o compression=lz4 tank/myzvol"

tests/operations/zfs.dataset/delete.json

@@ -6,7 +6,7 @@
     "present": false
   },
   "facts": {
-    "zfs.Datasets": {
+    "zfs.ZfsDatasets": {
       "tank/home/james": {
         "mountpoint": "/home/james"
       }

tests/operations/zfs.dataset/delete_noop.json

@@ -6,7 +6,7 @@
     "present": false
   },
   "facts": {
-    "zfs.Datasets": {}
+    "zfs.ZfsDatasets": {}
   },
   "commands": [],
   "noop_description": "tank/home/james is already absent"

tests/operations/zfs.dataset/delete_recursive.json

@@ -7,7 +7,7 @@
     "recursive": true
   },
   "facts": {
-    "zfs.Datasets": {
+    "zfs.ZfsDatasets": {
       "tank/home": {
         "mountpoint": "/home"
       },