Skip to contentSkip to conversation

Fix fail2ban

PATCH New Angelo Compagnucci 1 participant 3 messages Apr 19, 2024

lore
Share & tools
lore
#0 lore raw

cover Fix fail2ban

From: Angelo Compagnucci <[email protected]>

This series fixes fail2ban not installing configuration files in /etc anymore. While fixing the problem, I discovered a bug in the way we invoke the pyinstaller.py in pep517 compatibility.
Basically, pyinstaller.py will install data_files defined in setup.py and tarballed in the wheel inside the directory pointed by the --data parameter, which is nowadays pointing to /usr of TARGET/STAGING directory.

I consider this wrong, because the data folder shall point to the TARGET_DIR/STAGING_DIR to be correct and we shall trust the destination path expressed in the setup.py.

In the case of fail2ban, configuration files end up being installed in /usr/etc/fail2ban instead of /etc/fail2ban.

v1 -> v2:
Fix signed off with correct email.

Angelo Compagnucci (2):
package/fail2ban: fix data_files installation path package/pkg-python: fix pep517 data files installation

 ...001-setup.py-fix-data-relative-paths.patch | 73 +++++++++++++++++++
 package/pkg-python.mk                         |  4 +-
 2 files changed, 75 insertions(+), 2 deletions(-)
 create mode 100644 package/fail2ban/0001-setup.py-fix-data-relative-paths.patch
Signature · 6 lines
2.34.1

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#1 lore raw

PATCH 1/2 package/fail2ban: fix data_files installation path

From: Angelo Compagnucci <[email protected]>

When packaging data_files in a wheel, those files shall have the destination path expressed as relative to the wheel installation.
The reason for that is the wheel installation shall be contained inside a specific folder and/or in site-packages.
When building the wheel file by the bdist_wheel command, python will package files with absolute pats as python files ending up installing them in site-packages.

Fixes:
http://autobuild.buildroot.net/results/36ac5278d19195a21c3d02d087965e08f49228ef

---
 ...001-setup.py-fix-data-relative-paths.patch | 73 +++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 package/fail2ban/0001-setup.py-fix-data-relative-paths.patch
package/fail2ban/0001-setup.py-fix-data-relative-paths.patch new file +73 -0
new file mode 100644
index 0000000000..e1b5bc490b
@@ -0,0 +1,73 @@
+From 7b7fa3c02d4575c09362336bc310835c37859f1a Mon Sep 17 00:00:00 2001
+From: Angelo Compagnucci <[email protected]>
+Date: Fri, 19 Apr 2024 22:47:20 +0200
+Subject: [PATCH] setup.py: fix data relative paths
+MIME-Version: 1.0
+Content-Type: text/plain; charset=UTF-8
+Content-Transfer-Encoding: 8bit
+
+As per distutils documentation:
+
+The directory should be a relative path. It is interpreted relative to the
+installation prefix (Python’s sys.prefix for system installations;
+site.USER_BASE for user installations). Distutils allows directory to be an
+absolute installation path, but this is discouraged since it is incompatible
+with the wheel packaging format [1].
+
+When packaging to a bdist_wheel indeed, the files in the "data_files" dictionary
+are not picked at all as data files if they have an absolute path,
+but they are instead added to the wheel as python files.
+This has the effect of installing them as part of python files in the
+site-packages folder when the wheel is installed.
+
+This patch cannot be sent upstream because it breaks the legacy way of
+installing the package with *python setup.py install* and it is needed only to
+comply with the pep517 buildroot compatibility layer.
+
+[1] https://docs.python.org/3.10/distutils/setupscript.html#installing-additional-files
+Signed-off-by: Angelo Compagnucci <[email protected]>
+---
+ setup.py | 14 +++++++-------
+ 1 file changed, 7 insertions(+), 7 deletions(-)
+
+diff --git a/setup.py b/setup.py
+index 91f71cf2..99ba2e32 100755
+--- a/setup.py
++++ b/setup.py
+@@ -238,26 +238,26 @@ setup(
+ 				for f in w[2]]
+ 	} if with_tests else {},
+ 	data_files = [
+-		('/etc/fail2ban',
++		('etc/fail2ban',
+ 			glob("config/*.conf")
+ 		),
+-		('/etc/fail2ban/filter.d',
++		('etc/fail2ban/filter.d',
+ 			glob("config/filter.d/*.conf")
+ 		),
+-		('/etc/fail2ban/filter.d/ignorecommands',
++		('etc/fail2ban/filter.d/ignorecommands',
+ 			[p for p in glob("config/filter.d/ignorecommands/*") if isfile(p)]
+ 		),
+-		('/etc/fail2ban/action.d',
++		('etc/fail2ban/action.d',
+ 			glob("config/action.d/*.conf") +
+ 			glob("config/action.d/*.py")
+ 		),
+-		('/etc/fail2ban/fail2ban.d',
++		('etc/fail2ban/fail2ban.d',
+ 			''
+ 		),
+-		('/etc/fail2ban/jail.d',
++		('etc/fail2ban/jail.d',
+ 			''
+ 		),
+-		('/var/lib/fail2ban',
++		('var/lib/fail2ban',
+ 			''
+ 		),
+ 	] + data_files_extra,
+-- 
+2.34.1
+
Signature · 6 lines
2.34.1

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#2 lore raw

PATCH 2/2 package/pkg-python: fix pep517 data files installation

In reply to Angelo Compagnucci

From: Angelo Compagnucci <[email protected]>

When installing a wheel in pep517 compatibility mode, the pyinstaller.py is invoked with the --data parameter which point to the directory in which data files should be installed.
Actually the --data parameter points to the /usr subdirectory which is indeed wrong cause it shall point to the root directory where the wheel will be installed.
This fixes the problem of having configuration files installed in /usr/etc instead of /etc.

Fixes:
http://autobuild.buildroot.net/results/36ac5278d19195a21c3d02d087965e08f49228ef

---
 package/pkg-python.mk | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
package/pkg-python.mk +2 -2
index 839f728e2f..4f9bee4b90 100644
@@ -70,7 +70,7 @@ PKG_PYTHON_PEP517_INSTALL_TARGET_CMD = \
 	--purelib=$(TARGET_DIR)/usr/lib/python$(PYTHON3_VERSION_MAJOR)/site-packages \
 	--headers=$(TARGET_DIR)/usr/include/python$(PYTHON3_VERSION_MAJOR) \
 	--scripts=$(TARGET_DIR)/usr/bin \
-	--data=$(TARGET_DIR)/usr
+	--data=$(TARGET_DIR)
 
 PKG_PYTHON_PEP517_INSTALL_STAGING_CMD = \
 	$(TOPDIR)/support/scripts/pyinstaller.py \
@@ -79,7 +79,7 @@ PKG_PYTHON_PEP517_INSTALL_STAGING_CMD = \
 	--purelib=$(STAGING_DIR)/usr/lib/python$(PYTHON3_VERSION_MAJOR)/site-packages \
 	--headers=$(STAGING_DIR)/usr/include/python$(PYTHON3_VERSION_MAJOR) \
 	--scripts=$(STAGING_DIR)/usr/bin \
-	--data=$(STAGING_DIR)/usr
+	--data=$(STAGING_DIR)
 
 PKG_PYTHON_PEP517_DEPENDENCIES = \
 	host-python-pypa-build \
Signature · 6 lines
2.34.1

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot