Upgrade meta-swift-examples to support meta-raspberrypi and share downloads/sstate-cache on Swift 6.1.2

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: scarthgap
+
+on:
+  workflow_dispatch:
+
+jobs:
+  runqemu:
+    runs-on: self-hosted
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          clean: false
+          submodules: recursive
+      - name: build Docker
+        run: ./build-docker.sh
+      - name: build Yocto
+        run: ./server-run-docker.sh ./build.sh
+      - name: runqemu swift hello world
+        run: ./server-run-docker.sh ./execute.exp
+

.gitignore

@@ -0,0 +1,110 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# Ignore build directories
+build*/
+tmp/
+sstate-cache/
+cache/
+deploy/
+downloads/
+
+# Ignore BitBake temporary files
+bitbake.lock
+*.run
+*.lock
+*.log
+*.sigdata
+*.siginfo
+*.done
+*.failed
+*.conf.old
+
+# Ignore editor/IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Ignore output files
+*.tar.gz
+*.bin
+*.wic*
+*.ext4
+*.rootfs.*
+
+# Ignore user-specific config
+conf/local.conf
+conf/site.conf
+conf/bblayers.conf
+
+# Ignore custom scripts and artifacts
+*.pyc
+*.pyo
+*.o
+*.a
+*.so
+*.la
+*.lo
+*.rej
+*.orig
+
+# Ignore Git submodule locks
+.gitmodules.lock
+.repo
+
+# Shared state
+downloads/
+sstate-cache/

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "meta-swift"]
 	path = meta-swift
 	url = git@github.com:xavgru12/meta-swift.git
+[submodule "meta-raspberrypi"]
+	path = meta-raspberrypi
+	url = https://github.com/agherzan/meta-raspberrypi.git
+[submodule "poky"]
+	path = poky
+	url = https://git.yoctoproject.org/poky

Dockerfile-Ubuntu-22.04

@@ -0,0 +1,49 @@
+FROM ubuntu:22.04
+
+# Update system and install required packages
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt update && apt upgrade -y && \
+    apt install -y gawk wget git-core diffstat unzip texinfo \
+    gcc-multilib build-essential chrpath socat file cpio python3 \
+    python3-pip python3-pexpect xz-utils debianutils iputils-ping \
+    libsdl1.2-dev xterm tar locales net-tools rsync sudo vim curl zstd \
+    liblz4-tool libssl-dev bc lzop libgnutls28-dev efitools git-lfs \
+    keychain pipx make ninja-build tmux xclip xsel iproute2 \
+    bridge-utils iptables expect
+
+# Install Neovim
+COPY neovim-installer.sh /neovim-installer.sh
+RUN chmod +x /neovim-installer.sh && \
+    /neovim-installer.sh && \
+    rm -f /neovim-installer.sh
+
+# Set up locales
+RUN locale-gen en_US.UTF-8 && \
+    update-locale LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8
+ENV LANG en_US.UTF-8
+ENV LC_ALL en_US.UTF-8
+
+# Ensure /bin/sh points to bash (Yocto requires this)
+RUN ln -sf bash /bin/sh
+
+# Install repo
+ADD https://storage.googleapis.com/git-repo-downloads/repo /usr/local/bin/repo
+RUN chmod 755 /usr/local/bin/repo
+
+ARG USER
+# Create the user with a home directory and set Bash as the default shell
+RUN useradd -m -s /bin/bash ${USER} && \
+    echo "${USER} ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/${USER} && \
+    chmod 0440 /etc/sudoers.d/${USER}
+
+
+# Ensure user has the correct UID/GID for volume-mounted builds
+ARG USER
+RUN usermod -u $(id -u ${USER}) -g $(id -g ${USER}) ${USER}
+
+# Set working directory
+ARG DOCKER_WORKDIR
+WORKDIR ${DOCKER_WORKDIR}
+
+# Switch to the Yocto user
+USER ${USER}

README.md

@@ -0,0 +1,66 @@
+# meta-swift examples
+
+This repo provides a simple workspace to compile the [meta-swift](https://github.com/jeremy-prater/meta-swift) layer
+for a sizeable set of supported Yocto machines for the purpose of evalulation and testing.
+
+The following machines are supported and have been tested:
+
+- `qemuarm`
+- `qemuarm64`
+- `qemux86-64`
+- `beaglebone-yocto`
+- `raspberrypi-armv7`
+- `raspberrypi-armv8`
+
+Others will likely also work, but have not been tested.
+
+## Clone
+
+```console
+git clone git@github.com:xavgru12/meta-swift-project.git --recurse-submodules
+```
+
+## Build
+
+It is recommended to build and run the included Docker container for a working environment for
+building Yocto:
+
+```console
+./build-docker.sh
+./run-docker.sh
+```
+
+Build the `core-image-minimal` for the default architecture (`qemuarm`):
+
+```console
+./build.sh
+```
+
+You may also customize the ./build.sh invocation by adding `MACHINE=` and/or `EXTRA_IMAGE_INSTALL=`:
+
+```console
+MACHINE=beaglebone-yocto EXTRA_IMAGE_INSTALL="openssh" ./build.sh
+```
+
+Builds will be found under poky/build-$MACHINE. Downloads and sstate-cache are shared between builds to keep disk size down as much as possible.
+
+## Execution
+
+Execute `hello-world` for the default `qemuarm` machine. This is an easy way to confirm that the meta-swift build worked correctly:
+
+```console
+./execute.exp
+```
+
+If you built for a different machine, prefix the command with `MACHINE=` like this:
+
+```console
+MACHINE=beaglebone-yocto ./build.sh
+```
+
+## Github Actions
+
+Start runner and trigger job via Github API:
+
+https://github.com/xavgru12/github-self-hosted-runner
+

build-docker.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+#
+# This script creates the yocto-ready docker image.
+# The --build-arg options are used to pass data about the current user.
+# Also, a tag is used for easy identification of the generated image.
+#
+
+# source the common variables
+. ./env.sh
+
+if [[ $PWD != $HOME* && $(whoami) != "root" ]]; then
+    echo "Error: Current directory is outside $HOME"
+    exit 1
+fi
+
+USERNAME=$(whoami)
+if [[ $USERNAME == "root" ]]; then
+  USERNAME=yocto
+fi
+
+docker build --tag "${DOCKER_IMAGE_TAG}" \
+             --build-arg "DOCKER_WORKDIR=${DOCKER_WORKDIR}" \
+             --build-arg "USER=$USERNAME" \
+             --build-arg "host_uid=$(id -u)" \
+             --build-arg "host_gid=$(id -g)" \
+             -f Dockerfile-Ubuntu-22.04 \
+             .
+

build.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+set -e
+
+# Configuration
+SRC_ROOT="${SRC_ROOT:=$(pwd)}"
+POKY_DIR="${POKY_DIR:=$SRC_ROOT/poky}"
+META_SWIFT_DIR="${META_SWIFT_DIR:=$SRC_ROOT/meta-swift}"
+META_RASPBERRYPI_DIR=${META_RASPBERRYPI_DIR:=$SRC_ROOT/meta-raspberrypi}
+
+MACHINE="${MACHINE:=qemuarm}"
+DOWNLOADS_DIR=${DOWNLOADS_DIR:=$SRC_ROOT/downloads}
+SSTATE_DIR=${SSTATE_DIR:=$SRC_ROOT/sstate-cache}
+
+# Build Yocto Poky
+cd $POKY_DIR
+source oe-init-build-env build-$MACHINE
+bitbake-layers add-layer $META_SWIFT_DIR
+# Support for Raspberry PI devices
+if [[ $MACHINE == "raspberrypi"* ]]; then
+    bitbake-layers add-layer $META_RASPBERRYPI_DIR
+fi
+# Customize build
+touch conf/sanity.conf
+CONF_FILE=./conf/local.conf
+rm -rf $CONF_FILE
+echo "# Swift for Yocto" >> $CONF_FILE
+echo "MACHINE=\"${MACHINE}\"" >> $CONF_FILE
+echo "DL_DIR ?= \"${DOWNLOADS_DIR}\"" >> $CONF_FILE
+echo "SSTATE_DIR ?= \"${SSTATE_DIR}\"" >> $CONF_FILE
+echo 'IMAGE_FEATURES += "debug-tweaks"' >> $CONF_FILE
+echo "IMAGE_INSTALL:append = \" swift-hello-world ${EXTRA_IMAGE_INSTALL}\"" >> $CONF_FILE
+
+#echo 'SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH"' >> $CONF_FILE
+#echo "USER_CLASSES += \"buildstats buildstats-summary\"" >> $CONF_FILE
+
+# build Swift
+bitbake core-image-minimal

env.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+# Here are some default settings.
+# Make sure DOCKER_WORKDIR is created and owned by current user.
+
+# Docker
+
+DOCKER_IMAGE_TAG="meta-swift-project"
+DOCKER_WORKDIR="$PWD"
+
+# Yocto
+
+YOCTO_DIR="$PWD"
+

execute.exp

@@ -0,0 +1,45 @@
+#!/usr/bin/expect -f
+
+# Grab machine from env
+set MACHINE qemuarm
+catch {set MACHINE $env(MACHINE)}
+
+spawn bash -c "cd poky && source oe-init-build-env build-${MACHINE} && runqemu ${MACHINE} nographic"
+
+set timeout 180
+
+expect {
+    -re ".*login: " {
+        send "root\r"
+    }
+    timeout {
+        puts "ERROR: Login prompt not received"
+        exit 1
+    }
+}
+
+expect {
+    -re {root@.*# } {
+        # got shell prompt after login
+    }
+    timeout {
+        puts "ERROR: Timeout waiting for root shell prompt after login"
+        exit 1
+    }
+}
+
+send "hello-world\r"
+
+expect {
+    -re {root@.*# } {
+        # got shell prompt after command
+    }
+    timeout {
+        puts "ERROR: Timeout waiting for shell prompt after command"
+        exit 1
+    }
+}
+
+# Optional: interact to keep session open
+#interact
+