T6674: move patches to "package/<package_name>" subfolder

This prevents the accidental applying of a patch to multiple source directories
defined in package.toml.

Example FRR:
Package consits of build instructions for libyang, rtrlib and frr itself.
Previously patches in frr/patches folder got applied to libyang, rtrlib and frr
which made no sense and could also fail a build.
This commit is contained in:
Christian Breunig 2024-12-22 12:00:10 +01:00
parent 6aa3bb5fa8
commit 53ceb24988
21 changed files with 3 additions and 198 deletions

View File

@ -58,7 +58,6 @@ def apply_patches(repo_dir: Path, patch_dir: Path) -> None:
series.write(patch.name + '\n')
print(f"I: Applied patch: {patch.name}")
def prepare_package(repo_dir: Path, install_data: str) -> None:
"""Prepare a package"""
if not install_data:
@ -95,7 +94,7 @@ def build_package(package: list, patch_dir: Path) -> None:
# Apply patches if any
if (repo_dir / 'patches'):
apply_patches(repo_dir, patch_dir)
apply_patches(repo_dir, patch_dir / repo_name)
# Sanitize the commit ID and build a tarball for the package
commit_id_sanitized = package['commit_id'].replace('/', '_')

View File

@ -15,7 +15,7 @@ index 43e5d7e61..1f971ab22 100755
--enable-vty-group=frrvty \
--enable-configfile-mask=0640 \
--enable-logfile-mask=0640 \
+ --enable-pcre2posix \
+ --enable-pcre2posix \
# end
override_dh_auto_install:

View File

@ -1,195 +0,0 @@
#!/usr/bin/env python3
#
# Copyright (C) 2024 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import glob
import shutil
import toml
import os
from argparse import ArgumentParser
from pathlib import Path
from subprocess import run, CalledProcessError
def ensure_dependencies(dependencies: list) -> None:
"""Ensure Debian build dependencies are met"""
if not dependencies:
print("I: No additional dependencies to install")
return
print("I: Ensure Debian build dependencies are met")
run(['sudo', 'apt-get', 'update'], check=True)
run(['sudo', 'apt-get', 'install', '-y'] + dependencies, check=True)
def apply_patches(repo_dir: Path, patch_dir: Path, package_name: str) -> None:
"""Apply patches from the patch directory to the repository"""
package_patch_dir = patch_dir / package_name
if package_patch_dir.exists() and package_patch_dir.is_dir():
patches = list(package_patch_dir.glob('*'))
else:
print(f"I: No patch directory found for {package_name} in {patch_dir}")
return
# Filter out directories from patches list
patches = [patch for patch in patches if patch.is_file()]
if not patches:
print(f"I: No patches found in {package_patch_dir}")
return
debian_patches_dir = repo_dir / 'debian/patches'
debian_patches_dir.mkdir(parents=True, exist_ok=True)
series_file = debian_patches_dir / 'series'
with series_file.open('a') as series:
for patch in patches:
patch_dest = debian_patches_dir / patch.name
try:
# Ensure the patch file exists before copying
if patch.exists():
shutil.copy(patch, patch_dest)
series.write(patch.name + '\n')
print(f"I: Applied patch: {patch.name}")
else:
print(f"W: Patch file {patch} not found, skipping")
except FileNotFoundError:
print(f"W: Patch file {patch} not found, skipping")
def prepare_package(repo_dir: Path, install_data: str) -> None:
"""Prepare a package"""
if not install_data:
print("I: No install data provided, skipping package preparation")
return
try:
install_file = repo_dir / 'debian/install'
install_file.parent.mkdir(parents=True, exist_ok=True)
install_file.write_text(install_data)
print("I: Prepared package")
except Exception as e:
print(f"Failed to prepare package: {e}")
raise
def build_package(package: dict, dependencies: list, patch_dir: Path) -> None:
"""Build a package from the repository
Args:
package (dict): Package information
dependencies (list): List of additional dependencies
patch_dir (Path): Directory containing patches
"""
repo_name = package['name']
repo_dir = Path(repo_name)
try:
# Clone the repository if it does not exist
if not repo_dir.exists():
run(['git', 'clone', package['scm_url'], str(repo_dir)], check=True)
# Check out the specific commit
run(['git', 'checkout', package['commit_id']], cwd=repo_dir, check=True)
# Ensure dependencies
ensure_dependencies(dependencies)
# Apply patches if any
apply_patches(repo_dir, patch_dir, repo_name)
# Sanitize the commit ID and build a tarball for the package
commit_id_sanitized = package['commit_id'].replace('/', '_')
tarball_name = f"{repo_name}_{commit_id_sanitized}.tar.gz"
run(['tar', '-czf', tarball_name, '-C', str(repo_dir.parent), repo_name], check=True)
print(f"I: Tarball created: {tarball_name}")
# Prepare the package if required
if package.get('prepare_package', False):
prepare_package(repo_dir, package.get('install_data', ''))
# Build dependency package and install it
if (repo_dir / 'debian/control').exists():
try:
run('sudo mk-build-deps --install --tool "apt-get --yes --no-install-recommends"', cwd=repo_dir, check=True, shell=True)
run('sudo dpkg -i *build-deps*.deb', cwd=repo_dir, check=True, shell=True)
except CalledProcessError as e:
print(f"Failed to build package {repo_name}: {e}")
# Build the package, check if we have build_cmd in the package.toml
build_cmd = package.get('build_cmd', 'dpkg-buildpackage -uc -us -tc -b')
run(build_cmd, cwd=repo_dir, check=True, shell=True)
except CalledProcessError as e:
print(f"Failed to build package {repo_name}: {e}")
finally:
# Clean up repository directory
# shutil.rmtree(repo_dir, ignore_errors=True)
pass
def cleanup_build_deps(repo_dir: Path) -> None:
"""Clean up build dependency packages"""
try:
if repo_dir.exists():
for file in glob.glob(str(repo_dir / '*build-deps*.deb')):
os.remove(file)
print("Cleaned up build dependency packages")
except Exception as e:
print(f"Error cleaning up build dependencies: {e}")
def copy_packages(repo_dir: Path) -> None:
"""Copy generated .deb packages to the parent directory"""
try:
deb_files = glob.glob(str(repo_dir / '*.deb'))
for deb_file in deb_files:
shutil.copy(deb_file, repo_dir.parent)
print(f'I: copy generated "{deb_file}" package')
except Exception as e:
print(f"Error copying packages: {e}")
if __name__ == '__main__':
# Prepare argument parser
arg_parser = ArgumentParser()
arg_parser.add_argument('--config',
default='package.toml',
help='Path to the package configuration file')
arg_parser.add_argument('--patch-dir',
default='patches',
help='Path to the directory containing patches')
args = arg_parser.parse_args()
# Load package configuration
with open(args.config, 'r') as file:
config = toml.load(file)
packages = config['packages']
patch_dir = Path(args.patch_dir)
for package in packages:
dependencies = package.get('dependencies', {}).get('packages', [])
# Build the package
build_package(package, dependencies, patch_dir)
# Clean up build dependency packages after build
cleanup_build_deps(Path(package['name']))
# Copy generated .deb packages to parent directory
copy_packages(Path(package['name']))

View File

@ -0,0 +1 @@
../build.py