cqrenet/relay
4
0
Fork 0
mirror of https://github.com/chatmail/relay.git synced 2026-05-21 13:28:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

simplify importing of resource files (avoid importlib.resources.files boilerplate)

Browse Source
This commit is contained in:
holger krekel
2025-11-13 18:39:05 +01:00
parent bdcccd858c
commit fc7240a1ad
2 changed files with 30 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
cmdeploy/src/cmdeploy/deployers.py
View File

@@ -40,6 +40,10 @@ class Port(FactBase):
return output[0] return output[0]
def get_resource(arg, pkg=__package__):
return importlib.resources.files(pkg).joinpath(arg)
def _build_chatmaild(dist_dir) -> None: def _build_chatmaild(dist_dir) -> None:
dist_dir = Path(dist_dir).resolve() dist_dir = Path(dist_dir).resolve()
if dist_dir.exists(): if dist_dir.exists():
@@ -119,7 +123,7 @@ def _configure_remote_venv_with_chatmaild(config) -> None:
) )
files.template( files.template(
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"), src=get_resource("metrics.cron.j2"),
dest="/etc/cron.d/chatmail-metrics", dest="/etc/cron.d/chatmail-metrics",
user="root", user="root",
group="root", group="root",
@@ -149,9 +153,7 @@ def _configure_remote_units(mail_domain, units) -> None:
basename = fn if "." in fn else f"{fn}.service" basename = fn if "." in fn else f"{fn}.service"
source_path = importlib.resources.files(__package__).joinpath( source_path = get_resource(f"service/{basename}.f")
"service", f"{basename}.f"
)
content = source_path.read_text().format(**params).encode() content = source_path.read_text().format(**params).encode()
files.put( files.put(
@@ -187,7 +189,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
need_restart = False need_restart = False
main_config = files.template( main_config = files.template(
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"), src=get_resource("opendkim/opendkim.conf"),
dest="/etc/opendkim.conf", dest="/etc/opendkim.conf",
user="root", user="root",
group="root", group="root",
@@ -197,7 +199,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
need_restart |= main_config.changed need_restart |= main_config.changed
screen_script = files.put( screen_script = files.put(
src=importlib.resources.files(__package__).joinpath("opendkim/screen.lua"), src=get_resource("opendkim/screen.lua"),
dest="/etc/opendkim/screen.lua", dest="/etc/opendkim/screen.lua",
user="root", user="root",
group="root", group="root",
@@ -206,7 +208,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
need_restart |= screen_script.changed need_restart |= screen_script.changed
final_script = files.put( final_script = files.put(
src=importlib.resources.files(__package__).joinpath("opendkim/final.lua"), src=get_resource("opendkim/final.lua"),
dest="/etc/opendkim/final.lua", dest="/etc/opendkim/final.lua",
user="root", user="root",
group="root", group="root",
@@ -224,7 +226,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
) )
keytable = files.template( keytable = files.template(
src=importlib.resources.files(__package__).joinpath("opendkim/KeyTable"), src=get_resource("opendkim/KeyTable"),
dest="/etc/dkimkeys/KeyTable", dest="/etc/dkimkeys/KeyTable",
user="opendkim", user="opendkim",
group="opendkim", group="opendkim",
@@ -234,7 +236,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
need_restart |= keytable.changed need_restart |= keytable.changed
signing_table = files.template( signing_table = files.template(
src=importlib.resources.files(__package__).joinpath("opendkim/SigningTable"), src=get_resource("opendkim/SigningTable"),
dest="/etc/dkimkeys/SigningTable", dest="/etc/dkimkeys/SigningTable",
user="opendkim", user="opendkim",
group="opendkim", group="opendkim",
@@ -263,7 +265,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
service_file = files.put( service_file = files.put(
name="Configure opendkim to restart once a day", name="Configure opendkim to restart once a day",
src=importlib.resources.files(__package__).joinpath("opendkim/systemd.conf"), src=get_resource("opendkim/systemd.conf"),
dest="/etc/systemd/system/opendkim.service.d/10-prevent-memory-leak.conf", dest="/etc/systemd/system/opendkim.service.d/10-prevent-memory-leak.conf",
) )
need_restart |= service_file.changed need_restart |= service_file.changed
@@ -314,7 +316,7 @@ class UnboundDeployer(Deployer):
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt # https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
# #
files.put( files.put(
src=importlib.resources.files(__package__).joinpath("policy-rc.d"), src=get_resource("policy-rc.d"),
dest="/usr/sbin/policy-rc.d", dest="/usr/sbin/policy-rc.d",
user="root", user="root",
group="root", group="root",
@@ -374,7 +376,7 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
need_restart = False need_restart = False
main_config = files.template( main_config = files.template(
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"), src=get_resource("postfix/main.cf.j2"),
dest="/etc/postfix/main.cf", dest="/etc/postfix/main.cf",
user="root", user="root",
group="root", group="root",
@@ -385,7 +387,7 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
need_restart |= main_config.changed need_restart |= main_config.changed
master_config = files.template( master_config = files.template(
src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"), src=get_resource("postfix/master.cf.j2"),
dest="/etc/postfix/master.cf", dest="/etc/postfix/master.cf",
user="root", user="root",
group="root", group="root",
@@ -396,9 +398,7 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
need_restart |= master_config.changed need_restart |= master_config.changed
header_cleanup = files.put( header_cleanup = files.put(
src=importlib.resources.files(__package__).joinpath( src=get_resource("postfix/submission_header_cleanup"),
"postfix/submission_header_cleanup"
),
dest="/etc/postfix/submission_header_cleanup", dest="/etc/postfix/submission_header_cleanup",
user="root", user="root",
group="root", group="root",
@@ -408,7 +408,7 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
# Login map that 1:1 maps email address to login. # Login map that 1:1 maps email address to login.
login_map = files.put( login_map = files.put(
src=importlib.resources.files(__package__).joinpath("postfix/login_map"), src=get_resource("postfix/login_map"),
dest="/etc/postfix/login_map", dest="/etc/postfix/login_map",
user="root", user="root",
group="root", group="root",
@@ -489,7 +489,7 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
need_restart = False need_restart = False
main_config = files.template( main_config = files.template(
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"), src=get_resource("dovecot/dovecot.conf.j2"),
dest="/etc/dovecot/dovecot.conf", dest="/etc/dovecot/dovecot.conf",
user="root", user="root",
group="root", group="root",
@@ -500,7 +500,7 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
) )
need_restart |= main_config.changed need_restart |= main_config.changed
auth_config = files.put( auth_config = files.put(
src=importlib.resources.files(__package__).joinpath("dovecot/auth.conf"), src=get_resource("dovecot/auth.conf"),
dest="/etc/dovecot/auth.conf", dest="/etc/dovecot/auth.conf",
user="root", user="root",
group="root", group="root",
@@ -508,9 +508,7 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
) )
need_restart |= auth_config.changed need_restart |= auth_config.changed
lua_push_notification_script = files.put( lua_push_notification_script = files.put(
src=importlib.resources.files(__package__).joinpath( src=get_resource("dovecot/push_notification.lua"),
"dovecot/push_notification.lua"
),
dest="/etc/dovecot/push_notification.lua", dest="/etc/dovecot/push_notification.lua",
user="root", user="root",
group="root", group="root",
@@ -589,7 +587,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
need_restart = False need_restart = False
main_config = files.template( main_config = files.template(
src=importlib.resources.files(__package__).joinpath("nginx/nginx.conf.j2"), src=get_resource("nginx/nginx.conf.j2"),
dest="/etc/nginx/nginx.conf", dest="/etc/nginx/nginx.conf",
user="root", user="root",
group="root", group="root",
@@ -600,7 +598,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
need_restart |= main_config.changed need_restart |= main_config.changed
autoconfig = files.template( autoconfig = files.template(
src=importlib.resources.files(__package__).joinpath("nginx/autoconfig.xml.j2"), src=get_resource("nginx/autoconfig.xml.j2"),
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml", dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
user="root", user="root",
group="root", group="root",
@@ -610,7 +608,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
need_restart |= autoconfig.changed need_restart |= autoconfig.changed
mta_sts_config = files.template( mta_sts_config = files.template(
src=importlib.resources.files(__package__).joinpath("nginx/mta-sts.txt.j2"), src=get_resource("nginx/mta-sts.txt.j2"),
dest="/var/www/html/.well-known/mta-sts.txt", dest="/var/www/html/.well-known/mta-sts.txt",
user="root", user="root",
group="root", group="root",
@@ -631,7 +629,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
files.put( files.put(
name="Upload cgi newemail.py script", name="Upload cgi newemail.py script",
src=importlib.resources.files("chatmaild").joinpath("newemail.py").open("rb"), src=get_resource("newemail.py", pkg="chatmaild").open("rb"),
dest=f"{cgi_dir}/newemail.py", dest=f"{cgi_dir}/newemail.py",
user="root", user="root",
group="root", group="root",
@@ -666,7 +664,7 @@ class NginxDeployer(Deployer):
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt # https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
# #
files.put( files.put(
src=importlib.resources.files(__package__).joinpath("policy-rc.d"), src=get_resource("policy-rc.d"),
dest="/usr/sbin/policy-rc.d", dest="/usr/sbin/policy-rc.d",
user="root", user="root",
group="root", group="root",
@@ -812,9 +810,7 @@ class MtailDeployer(Deployer):
# Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`. # Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`.
# This allows to read from journalctl instead of log files. # This allows to read from journalctl instead of log files.
files.template( files.template(
src=importlib.resources.files(__package__).joinpath( src=get_resource("mtail/mtail.service.j2"),
"mtail/mtail.service.j2"
),
dest="/etc/systemd/system/mtail.service", dest="/etc/systemd/system/mtail.service",
user="root", user="root",
group="root", group="root",
@@ -825,9 +821,7 @@ class MtailDeployer(Deployer):
mtail_conf = files.put( mtail_conf = files.put(
name="Mtail configuration", name="Mtail configuration",
src=importlib.resources.files(__package__).joinpath( src=get_resource("mtail/delivered_mail.mtail"),
"mtail/delivered_mail.mtail"
),
dest="/etc/mtail/delivered_mail.mtail", dest="/etc/mtail/delivered_mail.mtail",
user="root", user="root",
group="root", group="root",
@@ -877,7 +871,7 @@ class IrohDeployer(Deployer):
def configure(self): def configure(self):
systemd_unit = files.put( systemd_unit = files.put(
name="Upload iroh-relay systemd unit", name="Upload iroh-relay systemd unit",
src=importlib.resources.files(__package__).joinpath("iroh-relay.service"), src=get_resource("iroh-relay.service"),
dest="/etc/systemd/system/iroh-relay.service", dest="/etc/systemd/system/iroh-relay.service",
user="root", user="root",
group="root", group="root",
@@ -887,7 +881,7 @@ class IrohDeployer(Deployer):
iroh_config = files.put( iroh_config = files.put(
name="Upload iroh-relay config", name="Upload iroh-relay config",
src=importlib.resources.files(__package__).joinpath("iroh-relay.toml"), src=get_resource("iroh-relay.toml"),
dest="/etc/iroh-relay.toml", dest="/etc/iroh-relay.toml",
user="root", user="root",
group="root", group="root",
@@ -910,7 +904,7 @@ class JournaldDeployer(Deployer):
def configure(self): def configure(self):
journald_conf = files.put( journald_conf = files.put(
name="Configure journald", name="Configure journald",
src=importlib.resources.files(__package__).joinpath("journald.conf"), src=get_resource("journald.conf"),
dest="/etc/systemd/journald.conf", dest="/etc/systemd/journald.conf",
user="root", user="root",
group="root", group="root",

1
cmdeploy/src/cmdeploy/run.py
View File

@@ -5,7 +5,6 @@ import pyinfra
# pyinfra runs this module as a python file and not as a module so # pyinfra runs this module as a python file and not as a module so
# import paths must be absolute # import paths must be absolute
from cmdeploy.deployers import deploy_chatmail from cmdeploy.deployers import deploy_chatmail