inmanta-module-files 0.1.0__tar.gz

inmanta-module-files-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include inmanta_plugins/files/setup.cfg
+include inmanta_plugins/files/py.typed
+recursive-include inmanta_plugins/files/model *.cf
+graft inmanta_plugins/files/files
+graft inmanta_plugins/files/templates

inmanta-module-files-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: inmanta-module-files
+Version: 0.1.0
+Summary: Simple module containing various types of resource to manage files.
+Author: Guillaume Everarts de Velp
+Author-email: edvgui@gmail.com
+License: ASL 2.0
+Description-Content-Type: text/markdown
+Requires-Dist: inmanta-module-std
+
+# inmanta-module-files
+
+This package is an adapter that is meant to be used with the inmanta orchestrator: https://docs.inmanta.com

inmanta-module-files-0.1.0/README.md

@@ -0,0 +1,3 @@
+# inmanta-module-files
+
+This package is an adapter that is meant to be used with the inmanta orchestrator: https://docs.inmanta.com

inmanta-module-files-0.1.0/inmanta_module_files.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: inmanta-module-files
+Version: 0.1.0
+Summary: Simple module containing various types of resource to manage files.
+Author: Guillaume Everarts de Velp
+Author-email: edvgui@gmail.com
+License: ASL 2.0
+Description-Content-Type: text/markdown
+Requires-Dist: inmanta-module-std
+
+# inmanta-module-files
+
+This package is an adapter that is meant to be used with the inmanta orchestrator: https://docs.inmanta.com

inmanta-module-files-0.1.0/inmanta_module_files.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+inmanta_module_files.egg-info/PKG-INFO
+inmanta_module_files.egg-info/SOURCES.txt
+inmanta_module_files.egg-info/dependency_links.txt
+inmanta_module_files.egg-info/not-zip-safe
+inmanta_module_files.egg-info/requires.txt
+inmanta_module_files.egg-info/top_level.txt
+inmanta_plugins/files/__init__.py
+inmanta_plugins/files/base.py
+inmanta_plugins/files/host.py
+inmanta_plugins/files/json.py
+inmanta_plugins/files/systemd_unit.py
+tests/test_basics.py
+tests/test_host_file.py
+tests/test_json_file.py
+tests/test_systemd_unit_file.py

inmanta-module-files-0.1.0/inmanta_module_files.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

inmanta-module-files-0.1.0/inmanta_module_files.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

inmanta-module-files-0.1.0/inmanta_module_files.egg-info/requires.txt

@@ -0,0 +1 @@
+inmanta-module-std

inmanta-module-files-0.1.0/inmanta_module_files.egg-info/top_level.txt

@@ -0,0 +1 @@
+inmanta_plugins

inmanta-module-files-0.1.0/inmanta_plugins/files/__init__.py

@@ -0,0 +1,17 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""

inmanta-module-files-0.1.0/inmanta_plugins/files/base.py

@@ -0,0 +1,83 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import typing
+
+import inmanta.agent.agent
+import inmanta.agent.handler
+import inmanta.agent.io.local
+import inmanta.const
+import inmanta.execute.proxy
+import inmanta.export
+import inmanta.resources
+
+
+class BaseFileResource(inmanta.resources.PurgeableResource):
+    fields = ("path", "permissions", "owner", "group")
+    path: str
+    permissions: typing.Optional[int]
+    owner: typing.Optional[str]
+    group: typing.Optional[str]
+
+
+X = typing.TypeVar("X", bound=BaseFileResource)
+
+
+class BaseFileHandler(inmanta.agent.handler.CRUDHandlerGeneric[X]):
+    _io: inmanta.agent.io.local.LocalIO
+
+    def read_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: X
+    ) -> None:
+        if not self._io.file_exists(resource.path):
+            raise inmanta.agent.handler.ResourcePurged()
+
+        for key, value in self._io.file_stat(resource.path).items():
+            if getattr(resource, key) is not None:
+                setattr(resource, key, value)
+
+    def create_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: X
+    ) -> None:
+        if resource.permissions is not None:
+            self._io.chmod(resource.path, str(resource.permissions))
+
+        if resource.owner is not None or resource.group is not None:
+            self._io.chown(resource.path, resource.owner, resource.group)
+
+        ctx.set_created()
+
+    def update_resource(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        changes: dict[str, dict[str, object]],
+        resource: X,
+    ) -> None:
+        if "permissions" in changes:
+            self._io.chmod(resource.path, str(resource.permissions))
+
+        if "owner" in changes or "group" in changes:
+            self._io.chown(resource.path, resource.owner, resource.group)
+
+        ctx.set_updated()
+
+    def delete_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: X
+    ) -> None:
+        self._io.remove(resource.path)
+        ctx.set_purged()

inmanta-module-files-0.1.0/inmanta_plugins/files/host.py

@@ -0,0 +1,204 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import collections
+import copy
+import ipaddress
+import typing
+
+import inmanta.agent.agent
+import inmanta.agent.handler
+import inmanta.agent.io.local
+import inmanta.const
+import inmanta.execute.proxy
+import inmanta.export
+import inmanta.resources
+import inmanta_plugins.files.base
+import inmanta_plugins.files.json
+from inmanta.util import dict_path
+
+PARSED_HOST_FILE = dict[str, dict[str, typing.Optional[str]]]
+"""
+Define an alias for the parsed host file format.  The parsed host file
+is a dict which has as keys, hostnames, and as values, a dict containing
+two keys: address4 and address6, respectively representing the ipv4 and
+ipv6 address defined in the file for the given hostname.
+
+And example of such dict is:
+
+.. code-block::python
+
+    {
+        "localhost": {"address4": "127.0.0.1", "address6": "::1"},
+        "ip6-loopback": {"address4": None, "address6": "::1"},
+        "example.com": {"address4": "93.184.216.34", "address6": None},
+    }
+
+"""
+
+
+def parse_host_file(raw_content: str) -> PARSED_HOST_FILE:
+    """
+    Parse the content of an host file, and return it as a dict having as
+    keys the hostnames, and as values, the corresponding ips.
+    """
+    parsed_file: PARSED_HOST_FILE = collections.defaultdict(
+        lambda: {
+            "address4": None,
+            "address6": None,
+        }
+    )
+
+    for line in raw_content.splitlines():
+        if not line:
+            # No info in that line
+            continue
+
+        if line[0] not in "0123456789:":
+            # This is not a valid entry, probably a comment
+            continue
+
+        parsed_line = line.split()
+
+        # Parse the ip address
+        address = ipaddress.ip_address(parsed_line[0])
+
+        # For each hostname, add the ipaddress to the parsed file
+        for hostname in parsed_line[1:]:
+            parsed_file[hostname][f"address{address.version}"] = str(address)
+
+    return dict(parsed_file)
+
+
+def write_host_file(parsed_file: PARSED_HOST_FILE) -> str:
+    """
+    Generate the content of the hostfile in a single string, that
+    can be written down into a file.
+    """
+    raw_content = ""
+
+    for hostname, addresses in parsed_file.items():
+        if addresses.get("address4") is not None:
+            raw_content += f"{addresses['address4']} {hostname}\n"
+
+        if addresses.get("address6") is not None:
+            raw_content += f"{addresses['address6']} {hostname}\n"
+
+    return raw_content
+
+
+@inmanta.resources.resource(
+    name="files::HostFile",
+    id_attribute="path",
+    agent="host.name",
+)
+class HostFileResource(inmanta_plugins.files.base.BaseFileResource):
+    fields = ("values",)
+    values: list[dict]
+
+    @classmethod
+    def get_values(
+        cls,
+        _: inmanta.export.Exporter,
+        entity: inmanta.execute.proxy.DynamicProxy,
+    ) -> list[dict]:
+        return [
+            {
+                "path": str(dict_path.InDict(entry.hostname)),
+                "operation": entry.operation,
+                "value": {
+                    "address4": entry.address4,
+                    "address6": entry.address6,
+                },
+            }
+            for entry in entity.entries
+        ]
+
+
+@inmanta.agent.handler.provider("files::HostFile", "")
+class HostFileHandler(inmanta_plugins.files.base.BaseFileHandler[HostFileResource]):
+    _io: inmanta.agent.io.local.LocalIO
+
+    def read_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: HostFileResource
+    ) -> None:
+        super().read_resource(ctx, resource)
+
+        # Load the content of the existing file
+        raw_content = self._io.read_binary(resource.path).decode()
+        ctx.debug("Reading existing file", raw_content=raw_content)
+        ctx.set("current_content", parse_host_file(raw_content))
+
+    def calculate_diff(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        current: HostFileResource,
+        desired: HostFileResource,
+    ) -> dict[str, dict[str, object]]:
+        # For file permissions and ownership, we delegate to the parent class
+        changes = super().calculate_diff(ctx, current, desired)
+
+        # To check if some change content needs to be applied, we perform a "stable" addition
+        # operation: We apply our desired state to the current state, and check if we can then
+        # see any difference.
+        current_content = ctx.get("current_content")
+        desired_content = copy.deepcopy(current_content)
+
+        for value in desired.values:
+            inmanta_plugins.files.json.update(
+                desired_content,
+                dict_path.to_path(value["path"]),
+                inmanta_plugins.files.json.Operation(value["operation"]),
+                value["value"],
+            )
+
+        if current_content != desired_content:
+            changes["content"] = {
+                "current": current_content,
+                "desired": desired_content,
+            }
+
+        return changes
+
+    def create_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: HostFileResource
+    ) -> None:
+        # Build a config based on all the values we want to manage
+        content = {}
+        for value in resource.values:
+            inmanta_plugins.files.json.update(
+                content,
+                dict_path.to_path(value["path"]),
+                inmanta_plugins.files.json.Operation(value["operation"]),
+                value["value"],
+            )
+        raw_content = write_host_file(content)
+        self._io.put(resource.path, raw_content.encode())
+        super().create_resource(ctx, resource)
+
+    def update_resource(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        changes: dict[str, dict[str, object]],
+        resource: HostFileResource,
+    ) -> None:
+        if "content" in changes:
+            raw_content = write_host_file(changes["content"]["desired"])
+            self._io.put(resource.path, raw_content.encode())
+
+        super().update_resource(ctx, changes, resource)

inmanta-module-files-0.1.0/inmanta_plugins/files/json.py

@@ -0,0 +1,176 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import copy
+import enum
+import json
+
+import inmanta.agent.agent
+import inmanta.agent.handler
+import inmanta.agent.io.local
+import inmanta.const
+import inmanta.execute.proxy
+import inmanta.export
+import inmanta.resources
+import inmanta_plugins.files.base
+from inmanta.util import dict_path
+
+
+class Operation(str, enum.Enum):
+    REPLACE = "replace"
+    REMOVE = "remove"
+    MERGE = "merge"
+
+
+def update(
+    config: dict, path: dict_path.DictPath, operation: Operation, desired: object
+) -> dict:
+    """
+    Update the config config at the specified type, using given operation and desired value.
+
+    :param config: The configuration to update
+    :param path: The path pointing to an element of the config that should be modified
+    :param operation: The type of operation to apply to the config element
+    :param desired: The desired state to apply to the config element
+    """
+    if operation == Operation.REMOVE:
+        path.remove(config)
+        return config
+
+    if operation == Operation.REPLACE:
+        path.set_element(config, value=desired)
+        return config
+
+    if operation == Operation.MERGE:
+        if not isinstance(desired, dict):
+            raise ValueError(
+                f"Merge operation is only supported for dicts, but got {type(desired)} "
+                f"({desired})"
+            )
+        current = path.get_element(config, construct=True)
+        if not isinstance(current, dict):
+            raise ValueError(
+                f"A dict can only me merged to a dict, current value at path {path} "
+                f"is not a dict: {current} ({type(current)})"
+            )
+        current.update({k: v for k, v in desired.items() if v is not None})
+        return config
+
+    raise ValueError(f"Unsupported operation: {operation}")
+
+
+@inmanta.resources.resource(
+    name="files::JsonFile",
+    id_attribute="path",
+    agent="host.name",
+)
+class JsonFileResource(inmanta_plugins.files.base.BaseFileResource):
+    fields = (
+        "indent",
+        "values",
+    )
+    values: list[dict]
+    indent: int
+
+    @classmethod
+    def get_values(cls, _, entity: inmanta.execute.proxy.DynamicProxy) -> list[dict]:
+        return [
+            {
+                "path": value.path,
+                "operation": value.operation,
+                "value": value.value,
+            }
+            for value in entity.values
+        ]
+
+
+@inmanta.agent.handler.provider("files::JsonFile", "")
+class JsonFileHandler(inmanta_plugins.files.base.BaseFileHandler[JsonFileResource]):
+    _io: inmanta.agent.io.local.LocalIO
+
+    def read_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: JsonFileResource
+    ) -> None:
+        super().read_resource(ctx, resource)
+
+        # Load the content of the existing file
+        raw_content = self._io.read_binary(resource.path).decode()
+        ctx.debug("Reading existing file", raw_content=raw_content)
+        ctx.set("current_content", json.loads(raw_content))
+
+    def calculate_diff(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        current: JsonFileResource,
+        desired: JsonFileResource,
+    ) -> dict[str, dict[str, object]]:
+        # For file permissions and ownership, we delegate to the parent class
+        changes = super().calculate_diff(ctx, current, desired)
+
+        # To check if some change content needs to be applied, we perform a "stable" addition
+        # operation: We apply our desired state to the current state, and check if we can then
+        # see any difference.
+        current_content = ctx.get("current_content")
+        desired_content = copy.deepcopy(current_content)
+
+        for value in desired.values:
+            update(
+                desired_content,
+                dict_path.to_path(value["path"]),
+                Operation(value["operation"]),
+                value["value"],
+            )
+
+        if current_content != desired_content:
+            changes["content"] = {
+                "current": current_content,
+                "desired": desired_content,
+            }
+
+        return changes
+
+    def create_resource(
+        self, ctx: inmanta.agent.handler.HandlerContext, resource: JsonFileResource
+    ) -> None:
+        # Build a config based on all the elements we want to manage
+        content = {}
+        for value in resource.values:
+            update(
+                content,
+                dict_path.to_path(value["path"]),
+                Operation(value["operation"]),
+                value["value"],
+            )
+
+        indent = resource.indent if resource.indent != 0 else None
+        raw_content = json.dumps(content, indent=indent)
+        self._io.put(resource.path, raw_content.encode())
+        super().create_resource(ctx, resource)
+
+    def update_resource(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        changes: dict[str, dict[str, object]],
+        resource: JsonFileResource,
+    ) -> None:
+        if "content" in changes:
+            indent = resource.indent if resource.indent != 0 else None
+            raw_content = json.dumps(changes["content"]["desired"], indent=indent)
+            self._io.put(resource.path, raw_content.encode())
+
+        super().update_resource(ctx, changes, resource)

inmanta-module-files-0.1.0/inmanta_plugins/files/systemd_unit.py

@@ -0,0 +1,73 @@
+"""
+Copyright 2024 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import inmanta.agent.agent
+import inmanta.agent.handler
+import inmanta.agent.io.local
+import inmanta.const
+import inmanta.execute.proxy
+import inmanta.export
+import inmanta.resources
+import inmanta_plugins.files.base
+
+
+@inmanta.resources.resource(
+    name="files::SystemdUnitFile",
+    id_attribute="path",
+    agent="host.name",
+)
+class SystemdUnitFileResource(inmanta_plugins.files.base.BaseFileResource):
+    fields = ("content",)
+    content: str
+
+
+@inmanta.agent.handler.provider("files::SystemdUnitFile", "")
+class SystemdUnitFileHandler(
+    inmanta_plugins.files.base.BaseFileHandler[SystemdUnitFileResource]
+):
+    _io: inmanta.agent.io.local.LocalIO
+
+    def read_resource(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        resource: SystemdUnitFileResource,
+    ) -> None:
+        super().read_resource(ctx, resource)
+
+        # Load the content of the existing file
+        resource.content = self._io.read_binary(resource.path).decode()
+        ctx.debug("Reading existing file", content=resource.content)
+
+    def create_resource(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        resource: SystemdUnitFileResource,
+    ) -> None:
+        self._io.put(resource.path, resource.content.encode())
+        super().create_resource(ctx, resource)
+
+    def update_resource(
+        self,
+        ctx: inmanta.agent.handler.HandlerContext,
+        changes: dict[str, dict[str, object]],
+        resource: SystemdUnitFileResource,
+    ) -> None:
+        if "content" in changes:
+            self._io.put(resource.path, resource.content.encode())
+
+        super().update_resource(ctx, changes, resource)

inmanta-module-files-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

inmanta-module-files-0.1.0/setup.cfg

@@ -0,0 +1,47 @@
+[metadata]
+name = inmanta-module-files
+version = 0.1.0
+description = Simple module containing various types of resource to manage files.
+long_description = file: README.md
+long_description_content_type = text/markdown
+author = Guillaume Everarts de Velp
+author_email = edvgui@gmail.com
+license = ASL 2.0
+copyright = 2023 Guillaume Everarts de Velp
+
+[options]
+zip_safe = False
+include_package_data = True
+packages = find_namespace:
+install_requires = 
+	inmanta-module-std
+
+[options.packages.find]
+include = inmanta_plugins*
+
+[flake8]
+ignore = H405,H404,H302,H306,H301,H101,H801,E402,W503,E252,E203
+builtins = string,number,bool
+max-line-length = 128
+exclude = **/.env,.venv,.git,.tox,dist,doc,**egg
+copyright-check = True
+copyright-author = Guillaume Everarts de Velp
+select = E,F,W,C,BLK,I
+
+[isort]
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+line_length = 88
+known_first_party = inmanta
+known_third_party = pytest,pydantic,Jinja2
+
+[black]
+line-length = 128
+target-version = 'py36', 'py37', 'py38'
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

inmanta-module-files-0.1.0/tests/test_basics.py

@@ -0,0 +1,23 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+from pytest_inmanta.plugin import Project
+
+
+def test_basics(project: Project) -> None:
+    project.compile("import files")

inmanta-module-files-0.1.0/tests/test_host_file.py

@@ -0,0 +1,120 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import grp
+import os
+import pathlib
+
+import pytest
+import pytest_inmanta.plugin
+
+
+@pytest.mark.parametrize(
+    (
+        "file_path",
+        "purged",
+    ),
+    [
+        (pathlib.Path("/tmp/example"), False),
+    ],
+)
+def test_model(
+    project: pytest_inmanta.plugin.Project, file_path: pathlib.Path, purged: bool
+) -> None:
+    user = os.getlogin()
+    group = grp.getgrgid(os.getgid()).gr_name
+    model = f"""
+        import files
+        import files::host
+
+        import std
+
+        host = std::Host(
+            name="localhost",
+            os=std::linux,
+        )
+
+        files::HostFile(
+            host=host,
+            path={repr(str(file_path))},
+            owner={repr(user)},
+            group={repr(group)},
+            purged={str(purged).lower()},
+            entries=[
+                files::host::Entry(
+                    hostname="example.com",
+                    address4="192.168.10.10",
+                    operation="replace",
+                ),
+                files::host::Entry(
+                    hostname="example.be",
+                    operation="remove",
+                ),
+                files::host::Entry(
+                    hostname="example.eu",
+                    address4="192.168.10.10",
+                    operation="merge",
+                ),
+            ],
+        )
+    """
+
+    project.compile(model.strip("\n"), no_dedent=False)
+
+
+def test_deploy(project: pytest_inmanta.plugin.Project, tmp_path: pathlib.Path) -> None:
+    file = tmp_path / "host"
+
+    # Create the file
+    test_model(project, file, purged=False)
+    assert project.dryrun_resource("files::HostFile")
+    project.deploy_resource("files::HostFile")
+    assert not project.dryrun_resource("files::HostFile")
+
+    # Manually remove a managed line from the file and make sure we detect a change
+    lines = file.read_text().splitlines()
+    lines = lines[1:]
+    file.write_text("\n".join(lines))
+    assert project.dryrun_resource("files::HostFile")
+    project.deploy_resource("files::HostFile")
+    assert not project.dryrun_resource("files::HostFile")
+
+    # Insert an extra entry in the file and me sure we don't detect any change as we don't
+    # manage that entry
+    lines = file.read_text().splitlines()
+    lines.append("127.0.0.1 localhost")
+    file.write_text("\n".join(lines))
+    assert not project.dryrun_resource("files::HostFile")
+
+    # Add the entry that should not be there and make sure it is removed, the unmanaged
+    # entry should remain untouched
+    lines.append("::1 example.be")
+    file.write_text("\n".join(lines))
+    assert project.dryrun_resource("files::HostFile")
+    project.deploy_resource("files::HostFile")
+    assert not project.dryrun_resource("files::HostFile")
+    lines = file.read_text().splitlines()
+    assert "::1 example.be" not in lines
+    assert "127.0.0.1 localhost" in lines
+
+    # Delete the file
+    test_model(project, file, purged=True)
+    assert project.dryrun_resource("files::HostFile")
+    project.deploy_resource("files::HostFile")
+    assert not project.dryrun_resource("files::HostFile")
+    assert not file.exists()

inmanta-module-files-0.1.0/tests/test_json_file.py

@@ -0,0 +1,122 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import grp
+import json
+import os
+import pathlib
+
+import pytest
+import pytest_inmanta.plugin
+
+
+@pytest.mark.parametrize(
+    (
+        "file_path",
+        "purged",
+    ),
+    [
+        (pathlib.Path("/tmp/example"), False),
+    ],
+)
+def test_model(
+    project: pytest_inmanta.plugin.Project, file_path: pathlib.Path, purged: bool
+) -> None:
+    user = os.getlogin()
+    group = grp.getgrgid(os.getgid()).gr_name
+    model = f"""
+        import files
+        import files::json
+
+        import std
+
+        host = std::Host(
+            name="localhost",
+            os=std::linux,
+        )
+
+        files::JsonFile(
+            host=host,
+            path={repr(str(file_path))},
+            owner={repr(user)},
+            group={repr(group)},
+            purged={str(purged).lower()},
+            values=[
+                files::json::Object(
+                    path="people[name=bob]",
+                    operation="replace",
+                    value={{"name": "bob", "age": 20}},
+                ),
+                files::json::Object(
+                    path="people[name=alice]",
+                    operation="merge",
+                    value={{"name": "alice", "age": 20}},
+                ),
+                files::json::Object(
+                    path="people[name=eve]",
+                    operation="remove",
+                    value={{}},
+                ),
+            ],
+        )
+    """
+
+    project.compile(model.strip("\n"), no_dedent=False)
+
+
+def test_deploy(project: pytest_inmanta.plugin.Project, tmp_path: pathlib.Path) -> None:
+    file = tmp_path / "friends.json"
+
+    # Create the file
+    test_model(project, file, purged=False)
+    assert project.dryrun_resource("files::JsonFile")
+    project.deploy_resource("files::JsonFile")
+    assert not project.dryrun_resource("files::JsonFile")
+
+    # Manually remove a managed line from the file and make sure we detect a change
+    friends = json.loads(file.read_text())
+    del friends["people"]
+    file.write_text(json.dumps(friends))
+    assert project.dryrun_resource("files::JsonFile")
+    project.deploy_resource("files::JsonFile")
+    assert not project.dryrun_resource("files::JsonFile")
+
+    # Insert an extra entry in the file and me sure we don't detect any change as we don't
+    # manage that entry
+    friends = json.loads(file.read_text())
+    friends["people"].append({"name": "chris"})
+    file.write_text(json.dumps(friends))
+    assert not project.dryrun_resource("files::JsonFile")
+
+    # Add the entry that should not be there and make sure it is removed, the unmanaged
+    # entry should remain untouched
+    friends["people"].append({"name": "eve"})
+    file.write_text(json.dumps(friends))
+    assert project.dryrun_resource("files::JsonFile")
+    project.deploy_resource("files::JsonFile")
+    assert not project.dryrun_resource("files::JsonFile")
+    friends = json.loads(file.read_text())
+    assert friends["people"][2] == {"name": "chris"}
+    assert len(friends["people"]) == 3
+
+    # Delete the file
+    test_model(project, file, purged=True)
+    assert project.dryrun_resource("files::JsonFile")
+    project.deploy_resource("files::JsonFile")
+    assert not project.dryrun_resource("files::JsonFile")
+    assert not file.exists()

inmanta-module-files-0.1.0/tests/test_systemd_unit_file.py

@@ -0,0 +1,134 @@
+"""
+Copyright 2023 Guillaume Everarts de Velp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contact: edvgui@gmail.com
+"""
+
+import grp
+import os
+import pathlib
+
+import pytest
+import pytest_inmanta.plugin
+
+EXAMPLE_UNIT = """
+[Unit]
+Description=Podman inmanta-orchestrator-net.service
+Documentation=https://github.com/edvgui/inmanta-module-podman
+RequiresMountsFor=%t/containers
+Wants=network-online.target
+Wants=inmanta-orchestrator-db.service
+Wants=inmanta-orchestrator-server.service
+Before=inmanta-orchestrator-db.service
+Before=inmanta-orchestrator-server.service
+After=network-online.target
+
+[Service]
+Restart=on-failure
+TimeoutStopSec=70
+ExecStartPre=/usr/bin/podman network create --ignore --subnet=172.42.0.0/24 inmanta-orchestrator-net
+ExecStart=/usr/bin/bash -c "/usr/bin/sleep infinity & /usr/bin/podman network inspect inmanta-orchestrator-net"
+ExecStopPost=/usr/bin/podman network rm -f inmanta-orchestrator-net
+Type=forking
+
+[Install]
+WantedBy=default.target
+
+""".lstrip(
+    "\n"
+)
+
+
+@pytest.mark.parametrize(
+    (
+        "file_path",
+        "purged",
+    ),
+    [
+        (pathlib.Path("/tmp/example"), False),
+    ],
+)
+def test_model(
+    project: pytest_inmanta.plugin.Project, file_path: pathlib.Path, purged: bool
+) -> None:
+    user = os.getlogin()
+    group = grp.getgrgid(os.getgid()).gr_name
+    model = f"""
+        import files
+        import files::systemd_unit
+
+        import std
+
+        host = std::Host(
+            name="localhost",
+            os=std::linux,
+        )
+
+        files::SystemdUnitFile(
+            host=host,
+            path={repr(str(file_path))},
+            owner={repr(user)},
+            group={repr(group)},
+            purged={str(purged).lower()},
+            unit=Unit(
+                description="Podman inmanta-orchestrator-net.service",
+                documentation=["https://github.com/edvgui/inmanta-module-podman"],
+                requires_mounts_for=["%t/containers"],
+                wants=[
+                    "network-online.target",
+                    "inmanta-orchestrator-db.service",
+                    "inmanta-orchestrator-server.service",
+                ],
+                before=[
+                    "inmanta-orchestrator-db.service",
+                    "inmanta-orchestrator-server.service",
+                ],
+                after=["network-online.target"],
+            ),
+            service=Service(
+                restart="on-failure",
+                timeout_stop_sec=70,
+                exec_start_pre="/usr/bin/podman network create --ignore --subnet=172.42.0.0/24 inmanta-orchestrator-net",
+                exec_start="/usr/bin/bash -c \\"/usr/bin/sleep infinity & /usr/bin/podman network inspect inmanta-orchestrator-net\\"",
+                exec_stop_post="/usr/bin/podman network rm -f inmanta-orchestrator-net",
+                type="forking",
+            ),
+            install=Install(
+                wanted_by=["default.target"],
+            ),
+        )
+    """  # noqa: E501
+
+    project.compile(model.strip("\n"), no_dedent=False)
+
+
+def test_deploy(project: pytest_inmanta.plugin.Project, tmp_path: pathlib.Path) -> None:
+    file = tmp_path / "inmanta-orchestrator-net.service"
+
+    # Create the file
+    test_model(project, file, purged=False)
+    assert project.dryrun_resource("files::SystemdUnitFile")
+    project.deploy_resource("files::SystemdUnitFile")
+    assert not project.dryrun_resource("files::SystemdUnitFile")
+
+    # Check that the file content is the expected one
+    assert file.read_text() == EXAMPLE_UNIT
+
+    # Delete the file
+    test_model(project, file, purged=True)
+    assert project.dryrun_resource("files::SystemdUnitFile")
+    project.deploy_resource("files::SystemdUnitFile")
+    assert not project.dryrun_resource("files::SystemdUnitFile")
+    assert not file.exists()