Skip to content

Commit 246a159

Browse files
MoeMahhoukMoeMahhouk
committed
refinements and following packaging best practices
1 parent a93f8bc commit 246a159

File tree

7 files changed

+173
-91
lines changed

7 files changed

+173
-91
lines changed

‎Makefile‎

Lines changed: 22 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -333,27 +333,9 @@ clean:
333333
make -C $(EF_TESTS) clean
334334
make -C $(STATE_TRANSITION_VECTORS) clean
335335

336-
.PHONY: install-cargo-deb deb-cargo deb-cargo-x86_64 deb-cargo-aarch64 deb-cargo-all test-deb-reproducible install-deb-local remove-deb-local clean-deb help-deb
337-
## Install cargo-deb if not present
338-
install-cargo-deb:
339-
@if ! command -v cargo-deb &> /dev/null; then \
340-
echo "Installing cargo-deb..."; \
341-
cargo install cargo-deb; \
342-
else \
343-
echo "cargo-deb already installed"; \
344-
fi
345-
346-
## Build .deb package using cargo-deb with reproducible settings
347-
deb-cargo: install-cargo-deb build-reproducible
336+
.PHONY: deb-cargo
337+
deb-cargo: build-reproducible ## Build .deb package using cargo-deb with reproducible settings
348338
@echo "Building .deb package with cargo-deb..."
349-
@if [ ! -f "lighthouse/lighthouse.service" ]; then \
350-
echo "❌ lighthouse.service not found in lighthouse/ directory"; \
351-
exit 1; \
352-
fi
353-
@if [ ! -f "README.md" ]; then \
354-
echo "❌ README.md not found in current directory"; \
355-
exit 1; \
356-
fi
357339

358340
cd lighthouse && \
359341
SOURCE_DATE_EPOCH=$(SOURCE_DATE) \
@@ -365,65 +347,26 @@ deb-cargo: install-cargo-deb build-reproducible
365347
@echo "✅ Package built successfully!"
366348
@find target/$(RUST_TARGET)/debian -name "*.deb" -exec ls -la {} \;
367349

368-
## Build .deb for specific architectures
369-
deb-cargo-x86_64:
350+
351+
.PHONY: deb-cargo-x86_64
352+
deb-cargo-x86_64: ## Build .deb for specific architectures
370353
$(MAKE) deb-cargo RUST_TARGET=x86_64-unknown-linux-gnu
371354

355+
.PHONY: deb-cargo-aarch64
372356
deb-cargo-aarch64:
373357
$(MAKE) deb-cargo RUST_TARGET=aarch64-unknown-linux-gnu
374358

359+
.PHONY: deb-cargo-all
375360
deb-cargo-all: deb-cargo-x86_64 deb-cargo-aarch64
376361

377-
## Test reproducibility of cargo-deb packages
378-
test-deb-reproducible:
379-
@echo "Testing cargo-deb package reproducibility..."
380-
@if ! command -v diffoscope &> /dev/null; then \
381-
echo "Installing diffoscope..."; \
382-
sudo apt-get update; \
383-
sudo apt-get install -y diffoscope binutils-multiarch; \
384-
fi
385-
386-
@echo "Building first package..."
387-
@rm -f lighthouse_*.deb lighthouse-deb-*.deb
388-
@$(MAKE) clean || true
389-
@$(MAKE) deb-cargo
390-
@FIRST_PACKAGE=$$(find target/$(RUST_TARGET)/debian -name "*.deb" | head -1); \
391-
if [ -n "$$FIRST_PACKAGE" ]; then \
392-
cp "$$FIRST_PACKAGE" ./lighthouse-deb-build-1.deb; \
393-
else \
394-
echo "❌ First package not found"; exit 1; \
395-
fi
396-
397-
@echo "Building second package..."
398-
@$(MAKE) clean || true
399-
@$(MAKE) deb-cargo
400-
@SECOND_PACKAGE=$$(find target/$(RUST_TARGET)/debian -name "*.deb" | head -1); \
401-
if [ -n "$$SECOND_PACKAGE" ]; then \
402-
cp "$$SECOND_PACKAGE" ./lighthouse-deb-build-2.deb; \
403-
else \
404-
echo "❌ Second package not found"; exit 1; \
405-
fi
406-
407-
@echo "Comparing packages..."
408-
@echo "=== Package sizes ==="
409-
@ls -la lighthouse-deb-build-*.deb
410-
@echo "=== SHA256 checksums ==="
411-
@sha256sum lighthouse-deb-build-*.deb
412-
413-
@if cmp -s lighthouse-deb-build-1.deb lighthouse-deb-build-2.deb; then \
414-
echo "✅ SUCCESS: cargo-deb packages are identical!"; \
415-
echo "✅ Reproducible build PASSED"; \
416-
else \
417-
echo "❌ FAILED: cargo-deb packages differ"; \
418-
echo "Running detailed analysis with diffoscope..."; \
419-
diffoscope --text lighthouse-deb-build-1.deb lighthouse-deb-build-2.deb > cargo-deb-diff.txt || true; \
420-
echo "Differences saved to cargo-deb-diff.txt"; \
421-
echo "❌ Reproducible build FAILED"; \
422-
exit 1; \
423-
fi
424362

425-
## Install .deb package locally for testing
426-
install-deb-local:
363+
.PHONY: test-deb-reproducible
364+
test-deb-reproducible: ## Test reproducibility of cargo-deb packages
365+
@./scripts/test-deb-reproducible.sh $(RUST_TARGET)
366+
367+
368+
.PHONY: install-deb-local
369+
install-deb-local: ## Install .deb package locally for testing
427370
@PACKAGE=$$(find target/$(RUST_TARGET)/debian -name "*.deb" | head -1); \
428371
if [ -n "$$PACKAGE" ]; then \
429372
echo "Installing lighthouse package: $$PACKAGE"; \
@@ -440,22 +383,23 @@ install-deb-local:
440383
echo "❌ No .deb package found. Run 'make deb-cargo' first."; \
441384
fi
442385

443-
## Remove installed lighthouse package
444-
remove-deb-local:
386+
387+
.PHONY: remove-deb-local
388+
remove-deb-local: ## Remove installed lighthouse package
445389
@echo "Removing lighthouse package..."
446390
sudo dpkg -r lighthouse || true
447391
sudo systemctl daemon-reload || true
448392

449-
## Clean up debian packaging artifacts
450-
clean-deb:
393+
.PHONY: clean-deb
394+
clean-deb: ## Clean up debian packaging artifacts
451395
@echo "Cleaning up debian packaging artifacts..."
452396
rm -f lighthouse_*.deb lighthouse-deb-*.deb *-diff.txt
453397
rm -rf target/*/debian/
454398

455-
## Show help for debian packaging
456-
help-deb:
399+
400+
.PHONY: help-deb
401+
help-deb: ## Show help for debian packaging
457402
@echo "Clean Debian Packaging Targets:"
458-
@echo " install-cargo-deb - Install cargo-deb tool"
459403
@echo " deb-cargo - Build .deb package with cargo-deb"
460404
@echo " deb-cargo-x86_64 - Build x86_64 .deb package"
461405
@echo " deb-cargo-aarch64 - Build aarch64 .deb package"

‎lighthouse/Cargo.toml‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -98,31 +98,24 @@ name = "lighthouse_tests"
9898
path = "tests/main.rs"
9999

100100
[package.metadata.deb]
101-
# Package metadata
102101
maintainer = "Sigma Prime <team@sigmaprime.io>"
103102
extended-description = """\
104103
Lighthouse is a Rust implementation of the Ethereum beacon chain, \
105104
built by Sigma Prime. It implements the official Ethereum 2.0 specification."""
106105

107-
# Dependencies
108106
depends = "$auto, systemd"
109107
section = "net"
110108
priority = "optional"
109+
maintainer-scripts = "debian/" # This tells cargo-deb where to find scripts
111110

112111
# System integration
113112
systemd-units = { enable = false, start = false }
114113

115114
# Assets to include in the package
116115
assets = [
117-
# Binary - use target/release/ prefix (cargo-deb will replace with actual path)
118116
["target/release/lighthouse", "usr/bin/", "755"],
119-
120-
# Systemd service (in lighthouse directory)
121-
["lighthouse.service", "lib/systemd/system/", "644"],
122-
123-
# Documentation (in parent directory)
117+
["debian/lighthouse.service", "lib/systemd/system/", "644"],
124118
["../README.md", "usr/share/doc/lighthouse/", "644"],
125119
]
126120

127-
# Use default features - let Makefile handle the building
128121
default-features = false

lighthouse/lighthouse.service renamed to lighthouse/debian/lighthouse.service

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
[Unit]
2-
Description=Lighthouse Ethereum Beacon Chain Client
3-
Documentation=https://lighthouse-book.sigmaprime.io/
2+
Description=Lighthouse Ethereum Beacon Node
43
After=network.target
54
Wants=network.target
65

76
[Service]
87
Type=simple
9-
DynamicUser=true
108
User=lighthouse
11-
Group=eth
9+
Group=lighthouse
1210
Restart=always
1311
RestartSec=5
1412
TimeoutStopSec=180

‎lighthouse/debian/postinst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#!/bin/sh
2+
set -e
3+
4+
# Create lighthouse user if it doesn't exist
5+
if ! getent passwd lighthouse >/dev/null 2>&1; then
6+
adduser --system --group --home /var/lib/lighthouse \
7+
--shell /bin/false --gecos "Lighthouse Beacon Node" lighthouse
8+
fi
9+
10+
# Create data directory
11+
mkdir -p /var/lib/lighthouse
12+
chown lighthouse:lighthouse /var/lib/lighthouse
13+
chmod 750 /var/lib/lighthouse
14+
15+
# Create log directory
16+
mkdir -p /var/log/lighthouse
17+
chown lighthouse:lighthouse /var/log/lighthouse
18+
chmod 750 /var/log/lighthouse
19+
20+
# Reload systemd
21+
systemctl daemon-reload || true
22+
23+
#DEBHELPER#
24+
25+
exit 0

‎lighthouse/debian/postrm‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/bin/sh
2+
set -e
3+
4+
if [ "$1" = "purge" ]; then
5+
# Remove user (optional - some prefer to keep it)
6+
if getent passwd lighthouse >/dev/null 2>&1; then
7+
deluser lighthouse || true
8+
fi
9+
10+
# Remove data directory (be careful!)
11+
# rm -rf /var/lib/lighthouse || true
12+
# rm -rf /var/log/lighthouse || true
13+
fi
14+
15+
#DEBHELPER#
16+
17+
exit 0

‎lighthouse/debian/prerm‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/sh
2+
set -e
3+
4+
if [ "$1" = "remove" ]; then
5+
# Stop service if running
6+
systemctl stop lighthouse || true
7+
systemctl disable lighthouse || true
8+
fi
9+
10+
#DEBHELPER#
11+
12+
exit 0

‎scripts/test-deb-reproducible.sh‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
#!/bin/bash
2+
#
3+
# Test reproducibility of cargo-deb packages
4+
#
5+
# Usage: ./scripts/test-deb-reproducible.sh [RUST_TARGET]
6+
#
7+
# This script builds the same Debian package twice with clean builds in between,
8+
# then compares them to ensure reproducible builds are working correctly.
9+
10+
set -euo pipefail
11+
12+
# Default target if not provided
13+
RUST_TARGET="${1:-x86_64-unknown-linux-gnu}"
14+
15+
echo "🔄 Testing cargo-deb package reproducibility for ${RUST_TARGET}..."
16+
17+
# Check if diffoscope is available, install if needed
18+
if ! command -v diffoscope &> /dev/null; then
19+
echo "📦 Installing diffoscope..."
20+
sudo apt-get update
21+
sudo apt-get install -y diffoscope binutils-multiarch
22+
fi
23+
24+
# Clean up any existing test artifacts
25+
echo "🧹 Cleaning up previous test artifacts..."
26+
rm -f lighthouse_*.deb lighthouse-deb-*.deb *-diff.txt
27+
28+
# Build first package
29+
echo "🔨 Building first package..."
30+
make clean || true
31+
make deb-cargo RUST_TARGET="${RUST_TARGET}"
32+
33+
FIRST_PACKAGE=$(find target/"${RUST_TARGET}"/debian -name "*.deb" | head -1)
34+
if [ -n "$FIRST_PACKAGE" ]; then
35+
cp "$FIRST_PACKAGE" ./lighthouse-deb-build-1.deb
36+
echo "✅ First package built: $(basename "$FIRST_PACKAGE")"
37+
else
38+
echo "❌ First package not found"
39+
exit 1
40+
fi
41+
42+
# Build second package
43+
echo "🔨 Building second package..."
44+
make clean || true
45+
make deb-cargo RUST_TARGET="${RUST_TARGET}"
46+
47+
SECOND_PACKAGE=$(find target/"${RUST_TARGET}"/debian -name "*.deb" | head -1)
48+
if [ -n "$SECOND_PACKAGE" ]; then
49+
cp "$SECOND_PACKAGE" ./lighthouse-deb-build-2.deb
50+
echo "✅ Second package built: $(basename "$SECOND_PACKAGE")"
51+
else
52+
echo "❌ Second package not found"
53+
exit 1
54+
fi
55+
56+
# Compare packages
57+
echo "📊 Comparing packages..."
58+
echo ""
59+
echo "=== Package sizes ==="
60+
ls -lah lighthouse-deb-build-*.deb
61+
62+
echo ""
63+
echo "=== SHA256 checksums ==="
64+
sha256sum lighthouse-deb-build-*.deb
65+
66+
echo ""
67+
echo "=== Binary comparison ==="
68+
if cmp -s lighthouse-deb-build-1.deb lighthouse-deb-build-2.deb; then
69+
echo "✅ SUCCESS: cargo-deb packages are identical!"
70+
echo "✅ Reproducible build PASSED for ${RUST_TARGET}"
71+
echo ""
72+
echo "🧹 Cleaning up test artifacts..."
73+
rm -f lighthouse-deb-build-*.deb
74+
exit 0
75+
else
76+
echo "❌ FAILED: cargo-deb packages differ"
77+
echo "🔍 Running detailed analysis with diffoscope..."
78+
79+
# Generate detailed diff report
80+
DIFF_FILE="cargo-deb-diff-${RUST_TARGET}.txt"
81+
if diffoscope --text lighthouse-deb-build-1.deb lighthouse-deb-build-2.deb > "$DIFF_FILE" 2>/dev/null; then
82+
echo "📄 Differences saved to ${DIFF_FILE}"
83+
echo "📄 Summary of first few differences:"
84+
head -20 "$DIFF_FILE" || true
85+
else
86+
echo "⚠️ diffoscope encountered issues, but differences were detected"
87+
fi
88+
89+
echo ""
90+
echo "❌ Reproducible build FAILED for ${RUST_TARGET}"
91+
echo "💡 Tip: Check the diff file for details on what differs between builds"
92+
exit 1
93+
fi

0 commit comments

Comments
 (0)