Skip to content

Commit

Permalink
chore: refactor the image builder script into multiple files (#2161)
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicomiguelino
nicomiguelino authored Dec 17, 2024
1 parent ba26fda commit de804d4
Show file tree
Hide file tree
Showing 7 changed files with 312 additions and 281 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-build.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:

- name: Build Containers
run: |
poetry run python tools/image_builder \
poetry run python -m tools.image_builder \
--build-target=${{ matrix.board }} \
--push
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-test.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:

- name: Build Containers
run: |
poetry run python tools/image_builder \
poetry run python -m tools.image_builder \
--dockerfiles-only \
--disable-cache-mounts \
--service celery \
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/generate-openapi-schema.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ jobs:
- name: Build Images
run: |
poetry run python tools/image_builder \
poetry run python -m tools.image_builder \
--dockerfiles-only \
--disable-cache-mounts \
--environment=development
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ $ MODE=build \
Build and start the containers.

```bash
$ poetry run python tools/image_builder \
$ poetry run python -m tools.image_builder \
--dockerfiles-only \
--disable-cache-mounts \
--service celery \
Expand Down
292 changes: 15 additions & 277 deletions tools/image_builder/__main__.py
View file
Original file line number Diff line number Diff line change
@@ -1,79 +1,21 @@
import click
import pygit2
import requests

from jinja2 import Environment, FileSystemLoader
from python_on_whales import docker


SHORT_HASH_LENGTH = 7
BUILD_TARGET_OPTIONS = ['pi1', 'pi2', 'pi3', 'pi4', 'x86']
SERVICES = (
'server',
'celery',
'redis',
'websocket',
'nginx',
'viewer',
'wifi-connect',
'test',
from tools.image_builder.utils import (
generate_dockerfile,
get_build_parameters,
get_docker_tag,
get_test_context,
get_viewer_context,
get_wifi_connect_context,
)
from tools.image_builder.constants import (
SHORT_HASH_LENGTH,
BUILD_TARGET_OPTIONS,
SERVICES,
)
GITHUB_REPO_URL = 'https://github.com/Screenly/Anthias'


templating_environment = Environment(loader=FileSystemLoader('docker/'))
templating_environment.lstrip_blocks = True
templating_environment.trim_blocks = True


def get_build_parameters(build_target: str) -> dict:
default_build_parameters = {
'board': 'x86',
'base_image': 'debian',
'target_platform': 'linux/amd64',
}

if build_target == 'pi4':
return {
'board': 'pi4',
'base_image': 'balenalib/raspberrypi3-debian',
'target_platform': 'linux/arm/v8',
}
elif build_target == 'pi3':
return {
'board': 'pi3',
'base_image': 'balenalib/raspberrypi3-debian',
'target_platform': 'linux/arm/v7',
}
elif build_target == 'pi2':
return {
'board': 'pi2',
'base_image': 'balenalib/raspberry-pi2',
'target_platform': 'linux/arm/v6',
}
elif build_target == 'pi1':
return {
'board': 'pi1',
'base_image': 'balenalib/raspberry-pi',
'target_platform': 'linux/arm/v6',
}

return default_build_parameters


def get_docker_tag(git_branch: str, board: str) -> str:
if git_branch == 'master':
return f'latest-{board}'
else:
return f'{git_branch}-{board}'


def generate_dockerfile(service: str, context: dict) -> None:
template = templating_environment.get_template(f'Dockerfile.{service}.j2')
dockerfile = template.render(**context)

with open(f'docker/Dockerfile.{service}', 'w') as f:
f.write(dockerfile)


def build_image(
Expand Down Expand Up @@ -127,215 +69,11 @@ def build_image(
base_apt_dependencies.extend(['libraspberrypi0'])

if service == 'viewer':
webview_git_hash = '5e556681738a1fa918dc9f0bf5879ace2e603e12'
releases_url = f'{GITHUB_REPO_URL}/releases/download'
webview_base_url = f'{releases_url}/WebView-v0.3.3'

qt_version = '6.6.3' if board == 'x86' else '5.15.14'
qt_major_version = qt_version.split('.')[0]

apt_dependencies = [
'build-essential',
'ca-certificates',
'curl',
'dbus-daemon',
'fonts-arphic-uming',
'git-core',
'libasound2-dev',
'libavcodec-dev',
'libavformat-dev',
'libavutil-dev',
'libbz2-dev',
'libcec-dev ',
'libdbus-1-dev',
'libdbus-glib-1-dev',
'libdrm-dev',
'libegl1-mesa-dev',
'libevent-dev',
'libffi-dev',
'libfontconfig1-dev',
'libfreetype6-dev',
'libgbm-dev',
'libgcrypt20-dev',
'libgles2-mesa',
'libgles2-mesa-dev',
'libglib2.0-dev',
'libicu-dev',
'libinput-dev',
'libiodbc2-dev',
'libjpeg62-turbo-dev',
'libjsoncpp-dev',
'libminizip-dev',
'libnss3',
'libnss3-dev',
'libnss3-tools',
'libopus-dev',
'libpci-dev',
'libpng-dev',
'libpng16-16',
'libpq-dev',
'libpulse-dev',
'librsvg2-common',
'libsdl2-dev',
'libsnappy-dev',
'libsqlite3-dev',
'libsrtp2-dev',
'libssl-dev',
'libzmq3-dev',
'libswscale-dev',
'libsystemd-dev',
'libts-dev',
'libudev-dev',
'libvpx-dev',
'libwebp-dev',
'libx11-dev',
'libx11-xcb-dev',
'libx11-xcb1',
'libxcb-glx0-dev',
'libxcb-icccm4',
'libxcb-icccm4-dev',
'libxcb-image0',
'libxcb-image0-dev',
'libxcb-keysyms1',
'libxcb-keysyms1-dev',
'libxcb-randr0-dev',
'libxcb-render-util0',
'libxcb-render-util0-dev',
'libxcb-shape0-dev',
'libxcb-shm0',
'libxcb-shm0-dev',
'libxcb-sync-dev',
'libxcb-sync1',
'libxcb-xfixes0-dev',
'libxcb-xinerama0',
'libxcb-xinerama0-dev',
'libxcb1',
'libxcb1-dev',
'libxext-dev',
'libxi-dev',
'libxkbcommon-dev',
'libxrender-dev',
'libxslt1-dev',
'libxss-dev',
'libxtst-dev',
'libzmq5-dev',
'libzmq5',
'net-tools',
'procps',
'psmisc',
'python3-dev',
'python3-gi',
'python3-netifaces',
'python3-pip',
'python3-setuptools',
'python-is-python3',
'ttf-wqy-zenhei',
'vlc',
'sudo',
'sqlite3',
'ffmpeg',
'libavcodec-dev',
'libavdevice-dev',
'libavfilter-dev',
'libavformat-dev',
'libavutil-dev',
'libswresample-dev',
'libswscale-dev',
]

if board != 'x86':
apt_dependencies.extend([
'libraspberrypi0',
'libgst-dev',
'libsqlite0-dev',
'libsrtp0-dev',
])

if board != 'pi1':
apt_dependencies.extend(['libssl1.1'])

context.update({
'apt_dependencies': apt_dependencies,
'qt_version': qt_version,
'qt_major_version': qt_major_version,
'webview_git_hash': webview_git_hash,
'webview_base_url': webview_base_url,
})

context.update(get_viewer_context(board))
elif service == 'test':
chrome_dl_url = (
'https://storage.googleapis.com/chrome-for-testing-public/'
'123.0.6312.86/linux64/chrome-linux64.zip'
)
chromedriver_dl_url = (
'https://storage.googleapis.com/chrome-for-testing-public/'
'123.0.6312.86/linux64/chromedriver-linux64.zip'
)

context.update({
'apt_dependencies': [
'wget',
'unzip',
'libnss3',
'libatk1.0-0',
'libatk-bridge2.0.0',
'libcups2',
'libxcomposite1',
'libxdamage1',
'nodejs',
'npm',
],
'chrome_dl_url': chrome_dl_url,
'chromedriver_dl_url': chromedriver_dl_url,
})
context.update(get_test_context())
elif service == 'wifi-connect':
if target_platform == 'linux/arm/v6':
architecture = 'rpi'
elif target_platform in ['linux/arm/v7', 'linux/arm/v8']:
architecture = 'armv7hf'
elif target_platform == 'linux/amd64':
architecture = 'amd64'

wc_download_url = (
'https://api.github.com/repos/balena-os/wifi-connect/'
'releases/93025295'
)

try:
response = requests.get(wc_download_url)
response.raise_for_status()
data = response.json()
assets = [
asset['browser_download_url'] for asset in data['assets']
]

try:
archive_url = next(
asset for asset in assets
if f'linux-{architecture}' in asset
)
except StopIteration:
click.secho(
'No wifi-connect release found for this architecture.',
fg='red',
)
archive_url = ""

except requests.exceptions.RequestException as e:
click.secho(f'Failed to get wifi-connect release: {e}', fg='red')
return

context.update({
'apt_dependencies': [
'dnsmasq',
'iw',
'network-manager',
'unzip',
'wget',
'wireless-tools',
],
'archive_url': archive_url,
})
context.update(get_wifi_connect_context(target_platform))
elif service == 'server':
if environment == 'development':
base_apt_dependencies.extend(['nodejs', 'npm'])
Expand Down
13 changes: 13 additions & 0 deletions tools/image_builder/constants.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
SHORT_HASH_LENGTH = 7
BUILD_TARGET_OPTIONS = ['pi1', 'pi2', 'pi3', 'pi4', 'x86']
SERVICES = (
'server',
'celery',
'redis',
'websocket',
'nginx',
'viewer',
'wifi-connect',
'test',
)
GITHUB_REPO_URL = 'https://github.com/Screenly/Anthias'
Loading

0 comments on commit de804d4

Please sign in to comment.