python3-cyberfusion-ferm-support 1.1.2.3__py3-none-any.whl

cyberfusion/FermSupport/__init__.py

@@ -0,0 +1 @@
+"""Empty file to turn this into a package."""

cyberfusion/FermSupport/configuration/__init__.py

@@ -0,0 +1,75 @@
+"""Helpers for ferm configuration."""
+
+import os
+import subprocess
+from typing import List
+
+from cyberfusion.Common import find_executable
+from cyberfusion.FermSupport.configuration.custom_lines import CustomLine
+from cyberfusion.FermSupport.configuration.variables import (
+    Variable,
+    VariableValue,
+)
+from cyberfusion.FermSupport.exceptions import ConfigInvalidError
+from cyberfusion.SystemdSupport.units import Unit
+
+
+class Configuration:
+    """Represents configuration."""
+
+    def __init__(self, *, path: str) -> None:
+        """Set attributes."""
+        self.path = path
+
+        self.variables: List[Variable] = []
+        self.custom_lines: List[CustomLine] = []
+
+    def add_variable(self, *, name: str, values: List[str]) -> None:
+        """Add variable."""
+        self.variables.append(
+            Variable(
+                name=name,
+                values=[VariableValue(content=value) for value in values],
+            )
+        )
+
+    def add_custom_line(self, *, contents: str) -> None:
+        """Add custom line."""
+        self.custom_lines.append(CustomLine(contents=contents))
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        return (
+            "\n".join([str(line) for line in self.variables + self.custom_lines]) + "\n"
+        )
+
+    @property
+    def is_valid(self) -> bool:
+        """Get if config is valid."""
+        try:
+            subprocess.run([find_executable("ferm"), "--noexec", self.path], check=True)
+        except subprocess.CalledProcessError:
+            return False
+
+        return True
+
+    def save(self) -> bool:
+        """Get file object."""
+        if not os.path.exists(self.path):
+            with open(self.path, "w") as f:
+                pass
+
+        original_contents = open(self.path, "r").read()
+
+        with open(self.path, "w") as f:
+            f.write(str(self))
+
+        changed = original_contents != open(self.path, "r").read()
+
+        if changed:
+            if not self.is_valid:
+                raise ConfigInvalidError
+
+            Unit(f"ferm.{Unit.SUFFIX_SERVICE}").restart()
+
+        return changed

cyberfusion/FermSupport/configuration/custom_lines.py

@@ -0,0 +1,13 @@
+"""Helpers for ferm custom lines."""
+
+
+class CustomLine:
+    """Represents custom line."""
+
+    def __init__(self, *, contents: str) -> None:
+        """Set attributes."""
+        self.contents = contents
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        return self.contents

cyberfusion/FermSupport/configuration/variables.py

@@ -0,0 +1,42 @@
+"""Helpers for ferm variables."""
+
+from typing import List
+
+
+class Variable:
+    """Represents variable."""
+
+    def __init__(self, *, name: str, values: List["VariableValue"]) -> None:
+        """Set attributes."""
+        self._name = name
+        self.values = values
+
+    @property
+    def name(self) -> str:
+        """Get name."""
+        return self._name.upper()
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        lines = []
+
+        lines.append(f"@def ${self.name} = (")
+
+        for value in self.values:
+            lines.append("  " + str(value))
+
+        lines.append(");")
+
+        return "\n".join(lines)
+
+
+class VariableValue:
+    """Represents variable value."""
+
+    def __init__(self, *, content: str) -> None:
+        """Set attributes."""
+        self.content = content
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        return self.content

cyberfusion/FermSupport/exceptions/__init__.py

@@ -0,0 +1,7 @@
+"""Exceptions."""
+
+
+class ConfigInvalidError(Exception):
+    """Config is invalid."""
+
+    pass

python3_cyberfusion_ferm_support-1.1.2.3.dist-info/METADATA

@@ -0,0 +1,50 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-ferm-support
+Version: 1.1.2.3
+Summary: Library for ferm.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-ferm-support
+Description-Content-Type: text/markdown
+Requires-Dist: cached-property ==1.5.2
+Requires-Dist: python3-cyberfusion-common ~=2.0
+Requires-Dist: python3-cyberfusion-systemd-support ~=1.0
+
+# python3-cyberfusion-ferm-support
+
+Library for [ferm](http://ferm.foo-projects.org/).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-ferm-support
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.FermSupport.configuration import Configuration
+
+c = Configuration(path="/etc/ferm/vars.d/example.conf")
+
+c.add_variable(
+    name="EXAMPLE",
+    values=["2001:0db8::/32"]
+)
+
+c.save()
+```

python3_cyberfusion_ferm_support-1.1.2.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+cyberfusion/FermSupport/__init__.py,sha256=8JByOElHmHLFiNx9xTHIU6dy5AjPQQmpPLFq5IR4bpM,46
+cyberfusion/FermSupport/configuration/__init__.py,sha256=1sTNrVys65Kqa7SlB4AoFgiTa55MsHsY5tzwl8hFOMw,2121
+cyberfusion/FermSupport/configuration/custom_lines.py,sha256=IElDtYccl89Mn2epZdTwZW_6U3zvMO7CGXGGwYk5f48,306
+cyberfusion/FermSupport/configuration/variables.py,sha256=gTPwQ_CJ5cIUwHUKmXkpgbBpAxpiz9_wouLUMld9U3w,921
+cyberfusion/FermSupport/exceptions/__init__.py,sha256=HbLbR-C62FtD6fcSizxv2I5A5_1oyWhIV9H1KKJTiI0,96
+python3_cyberfusion_ferm_support-1.1.2.3.dist-info/METADATA,sha256=eHIF9LwJProGEQK6mh9-CnhnBY31CocwKi-3IWs0upw,1115
+python3_cyberfusion_ferm_support-1.1.2.3.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+python3_cyberfusion_ferm_support-1.1.2.3.dist-info/top_level.txt,sha256=ss011q9S6SL_KIIyq7iujFmIYa0grSjlnInO7cDkeag,12
+python3_cyberfusion_ferm_support-1.1.2.3.dist-info/RECORD,,

python3_cyberfusion_ferm_support-1.1.2.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (73.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

python3_cyberfusion_ferm_support-1.1.2.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+cyberfusion