From 3b833104fbe16931e8fa093ac7b993f081186f00 Mon Sep 17 00:00:00 2001
From: Roman Meier <meirodev@outlook.com>
Date: Sat, 21 Mar 2020 16:59:25 +0100
Subject: [PATCH] ci: Port Citra flatpak build to yuzu

Port Citra's travis based flatpak build
to yuzu's azure build system.
---
 .../linux-flatpak/azure-ci-flatpak.env        |   8 +
 .ci/scripts/linux-flatpak/azure-ci.env        |  14 ++
 .ci/scripts/linux-flatpak/docker.sh           |  46 +++++
 .ci/scripts/linux-flatpak/exec.sh             |   6 +
 .ci/scripts/linux-flatpak/finish.sh           |  10 +
 .ci/scripts/linux-flatpak/generate-data.sh    | 182 ++++++++++++++++++
 .ci/templates/build-flatpak-single.yml        |  35 ++++
 .ci/yuzu-flatpak-step2.yml                    |  39 ++++
 keys.tar.enc                                  |   0
 9 files changed, 340 insertions(+)
 create mode 100644 .ci/scripts/linux-flatpak/azure-ci-flatpak.env
 create mode 100644 .ci/scripts/linux-flatpak/azure-ci.env
 create mode 100755 .ci/scripts/linux-flatpak/docker.sh
 create mode 100755 .ci/scripts/linux-flatpak/exec.sh
 create mode 100755 .ci/scripts/linux-flatpak/finish.sh
 create mode 100644 .ci/scripts/linux-flatpak/generate-data.sh
 create mode 100644 .ci/templates/build-flatpak-single.yml
 create mode 100644 .ci/yuzu-flatpak-step2.yml
 create mode 100644 keys.tar.enc

diff --git a/.ci/scripts/linux-flatpak/azure-ci-flatpak.env b/.ci/scripts/linux-flatpak/azure-ci-flatpak.env
new file mode 100644
index 0000000000..93467a2815
--- /dev/null
+++ b/.ci/scripts/linux-flatpak/azure-ci-flatpak.env
@@ -0,0 +1,8 @@
+# Flatpak specific environment variables
+FLATPAK_ENC_IV
+FLATPAK_ENC_K
+FLATPAK_GPG_PUBLIC_KEY
+FLATPAK_SSH_HOSTNAME
+FLATPAK_SSH_PORT
+FLATPAK_SSH_PUBLIC_KEY
+FLATPAK_SSH_USER
diff --git a/.ci/scripts/linux-flatpak/azure-ci.env b/.ci/scripts/linux-flatpak/azure-ci.env
new file mode 100644
index 0000000000..6c8612d93c
--- /dev/null
+++ b/.ci/scripts/linux-flatpak/azure-ci.env
@@ -0,0 +1,14 @@
+# List of environment variables to be shared with Docker containers
+AZURE_BRANCH
+AZURE_BUILD_ID
+AZURE_BUILD_NUMBER
+AZURE_COMMIT
+AZURE_COMMIT_RANGE
+AZURE_EVENT_TYPE
+AZURE_JOB_ID
+AZURE_REPO_SLUG
+AZURE_TAG
+
+# yuzu specific flags
+ENABLE_COMPATIBILITY_REPORTING
+USE_DISCORD_PRESENCE
diff --git a/.ci/scripts/linux-flatpak/docker.sh b/.ci/scripts/linux-flatpak/docker.sh
new file mode 100755
index 0000000000..3cd5d44d69
--- /dev/null
+++ b/.ci/scripts/linux-flatpak/docker.sh
@@ -0,0 +1,46 @@
+#!/bin/bash -ex
+
+# Converts "yuzu-emu/yuzu-release" to "yuzu-release"
+REPO_NAME=$(echo $AZURE_REPO_SLUG | cut -d'/' -f 2)
+YUZU_SRC_DIR="/yuzu"
+BUILD_DIR="$YUZU_SRC_DIR/build"
+REPO_DIR="$YUZU_SRC_DIR/repo"
+STATE_DIR="$YUZU_SRC_DIR/.flatpak-builder"
+KEYS_ARCHIVE="/tmp/keys.tar"
+SSH_DIR="/upload"
+SSH_KEY="/tmp/ssh.key"
+GPG_KEY="/tmp/gpg.key"
+
+# Generate flatpak Manifest and AppData files (/tmp/appdata.xml and /tmp/org.yuzu.$REPO_NAME.json)
+/bin/bash -ex $YUZU_SRC_DIR/.ci/scripts/linux-flatpak/generate-data.sh $1
+
+# Extract keys
+openssl aes-256-cbc -K $FLATPAK_ENC_K -iv $FLATPAK_ENC_IV -in "$YUZU_SRC_DIR/keys.tar.enc" -out "$KEYS_ARCHIVE" -d
+tar -C /tmp -xvf $KEYS_ARCHIVE
+
+# Configure SSH keys
+eval "$(ssh-agent -s)"
+chmod -R 600 "$HOME/.ssh"
+chown -R root "$HOME/.ssh"
+chmod 600 "$SSH_KEY"
+ssh-add "$SSH_KEY"
+echo "[$FLATPAK_SSH_HOSTNAME]:$FLATPAK_SSH_PORT,[$(dig +short $FLATPAK_SSH_HOSTNAME)]:$FLATPAK_SSH_PORT $FLATPAK_SSH_PUBLIC_KEY" > ~/.ssh/known_hosts
+
+# Configure GPG keys
+gpg2 --import "$GPG_KEY"
+
+# Mount our flatpak repository
+# -o reconnect and -o ServerAliveInterval ensure that 
+# the share stays active during long flatpak builds
+mkdir -p "$REPO_DIR"
+sshfs "$FLATPAK_SSH_USER@$FLATPAK_SSH_HOSTNAME:$SSH_DIR" "$REPO_DIR" -C -p "$FLATPAK_SSH_PORT" -o IdentityFile="$SSH_KEY" -o ServerAliveInterval=60 -o "reconnect" -o auto_cache -o no_readahead
+
+
+# setup ccache location
+mkdir -p "$STATE_DIR"
+ln -sv --force /root/.ccache "$STATE_DIR/ccache"
+
+# Build the yuzu flatpak
+flatpak-builder -v --jobs=4 --ccache --force-clean --state-dir="$STATE_DIR" --gpg-sign="$FLATPAK_GPG_PUBLIC_KEY" --repo="$REPO_DIR" "$BUILD_DIR" "/tmp/org.yuzu.$REPO_NAME.json"
+flatpak build-update-repo "$REPO_DIR" -v --generate-static-deltas --gpg-sign="$FLATPAK_GPG_PUBLIC_KEY"
+
diff --git a/.ci/scripts/linux-flatpak/exec.sh b/.ci/scripts/linux-flatpak/exec.sh
new file mode 100755
index 0000000000..73613f60f3
--- /dev/null
+++ b/.ci/scripts/linux-flatpak/exec.sh
@@ -0,0 +1,6 @@
+#!/bin/bash -ex
+mkdir -p "$HOME/.ccache"
+
+# Configure docker and call the script that generates application data and build scripts
+docker run --env-file .ci/scripts/linux-flatpak/azure-ci.env --env-file .ci/scripts/linux-flatpak/azure-ci-flatpak.env -v $(pwd):/yuzu -v "$HOME/.ccache":/root/.ccache -v "$HOME/.ssh":/root/.ssh --privileged yuzuemu/build-environments:linux-flatpak /bin/bash -ex /yuzu/.ci/scripts/linux-flatpak/docker.sh
+
diff --git a/.ci/scripts/linux-flatpak/finish.sh b/.ci/scripts/linux-flatpak/finish.sh
new file mode 100755
index 0000000000..45e543e079
--- /dev/null
+++ b/.ci/scripts/linux-flatpak/finish.sh
@@ -0,0 +1,10 @@
+#!/bin/bash -ex
+
+YUZU_SRC_DIR="/yuzu"
+REPO_DIR="$YUZU_SRC_DIR/repo"
+
+# When the script finishes, unmount the repository and delete sensitive files,
+# regardless of whether the build passes or fails
+umount "$REPO_DIR" || true
+rm -rf "$REPO_DIR" "/tmp/*" || true
+
diff --git a/.ci/scripts/linux-flatpak/generate-data.sh b/.ci/scripts/linux-flatpak/generate-data.sh
new file mode 100644
index 0000000000..dbaf0dcd2a
--- /dev/null
+++ b/.ci/scripts/linux-flatpak/generate-data.sh
@@ -0,0 +1,182 @@
+#!/bin/bash -ex
+# This script generates the appdata.xml and org.yuzu.$REPO_NAME.json files
+# needed to define application metadata and build yuzu
+
+# Converts "yuzu-emu/yuzu-release" to "yuzu-release"
+REPO_NAME=$(echo $AZURE_REPO_SLUG | cut -d'/' -f 2)
+# Converts "yuzu-release" to "yuzu Release"
+REPO_NAME_FRIENDLY=$(echo $REPO_NAME | sed -e 's/-/ /g' -e 's/\b\(.\)/\u\1/g')
+
+# Generate the correct appdata.xml for the version of yuzu we're building
+cat > /tmp/appdata.xml <<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<application>
+  <id type="desktop">org.yuzu.$REPO_NAME.desktop</id>
+  <name>$REPO_NAME_FRIENDLY</name>
+  <summary>Nintendo Switch emulator</summary>
+  <metadata_license>CC0-1.0</metadata_license>
+  <project_license>GPL-2.0</project_license>
+  <description>
+    <p>yuzu is an experimental open-source emulator for the Nintendo Switch from the creators of Citra.</p>
+    <p>It is written in C++ with portability in mind, with builds actively maintained for Windows and Linux. The emulator is currently only useful for homebrew development and research purposes.</p>
+    <p>yuzu only emulates a subset of Switch hardware and therefore is generally only useful for running/debugging homebrew applications. At this time, yuzu cannot play a majority of commercial games without major problems. yuzu can boot some commercial Switch games to varying degrees of success, but your experience may vary between games and for different combinations of host hardware.</p>
+    <p>yuzu is licensed under the GPLv2 (or any later version). Refer to the license.txt file included.</p>
+  </description>
+  <url type="homepage">https://yuzu-emu.org/</url>
+  <url type="donation">https://yuzu-emu.org/donate/</url>
+  <url type="bugtracker">https://github.com/yuzu-emu/yuzu/issues</url>
+  <url type="faq">https://yuzu-emu.org/wiki/faq/</url>
+  <url type="help">https://yuzu-emu.org/wiki/home/</url>
+  <screenshot>https://yuzu-emu.org/images/screenshots/001-Super%20Mario%20Odyssey.png</screenshot>
+  <screenshot>https://yuzu-emu.org/images/screenshots/004-Super%20Mario%20Odyssey.png</screenshot>
+  <screenshot>https://yuzu-emu.org/images/screenshots/019-Pokken%20Tournament.png</screenshot>
+  <screenshot>https://yuzu-emu.org/images/screenshots/052-Pokemon%20Let%27s%20Go.png</screenshot>
+  <categories>
+    <category>Games</category>
+    <category>Emulator</category>
+  </categories>
+</application>
+EOF
+
+cat > /tmp/yuzu-wrapper <<EOF
+#!/bin/bash
+
+# Discord only accepts activity updates from pids >= 10
+for i in 1 2 3 .. 20
+do
+    # Spawn a new shell
+    # This guarantees that a new process is created (unlike with potential bash internals like echo etc.)
+    bash -c "true"
+    sleep 0
+done
+
+# Symlink com.discordapp.Discord ipc pipes if they do not exist yet
+for i in {0..9}; do
+    test -S \$XDG_RUNTIME_DIR/app/com.discordapp.Discord/discord-ipc-\$i && ln -sf {\$XDG_RUNTIME_DIR/app/com.discordapp.Discord,\$XDG_RUNTIME_DIR}/discord-ipc-\$i;
+done
+
+yuzu \$@
+EOF
+
+# Generate the yuzu flatpak manifest
+cat > /tmp/org.yuzu.$REPO_NAME.json <<EOF
+{
+    "app-id": "org.yuzu.$REPO_NAME",
+    "runtime": "org.kde.Sdk",
+    "runtime-version": "5.13",
+    "sdk": "org.kde.Sdk",
+    "command": "yuzu-wrapper",
+    "rename-desktop-file": "yuzu.desktop",
+    "rename-icon": "yuzu",
+    "rename-appdata-file": "org.yuzu.$REPO_NAME.appdata.xml",
+    "build-options": {
+        "build-args": [
+            "--share=network"
+        ],
+        "env": {
+            "AZURE_BRANCH": "$AZURE_BRANCH",
+            "AZURE_BUILD_ID": "$AZURE_BUILD_ID",
+            "AZURE_BUILD_NUMBER": "$AZURE_BUILD_NUMBER",
+            "AZURE_COMMIT": "$AZURE_COMMIT",
+            "AZURE_JOB_ID": "$AZURE_JOB_ID",
+            "AZURE_REPO_SLUG": "$AZURE_REPO_SLUG",
+            "AZURE_TAG": "$AZURE_TAG"
+        }
+    },
+    "finish-args": [
+        "--device=all",
+        "--socket=x11",
+        "--socket=pulseaudio",
+        "--share=network",
+        "--share=ipc",
+        "--filesystem=xdg-config/yuzu-emu:create",
+        "--filesystem=xdg-data/yuzu-emu:create",
+        "--filesystem=host:ro",	
+        "--filesystem=xdg-run/app/com.discordapp.Discord:create",
+        "--filesystem=xdg-run/discord-ipc-0:rw",
+        "--filesystem=xdg-run/discord-ipc-1:rw",
+        "--filesystem=xdg-run/discord-ipc-2:rw",
+        "--filesystem=xdg-run/discord-ipc-3:rw",
+        "--filesystem=xdg-run/discord-ipc-4:rw",
+        "--filesystem=xdg-run/discord-ipc-5:rw",
+        "--filesystem=xdg-run/discord-ipc-6:rw",
+        "--filesystem=xdg-run/discord-ipc-7:rw",
+        "--filesystem=xdg-run/discord-ipc-8:rw",
+        "--filesystem=xdg-run/discord-ipc-9:rw"
+    ],
+    "modules": [
+    {
+        "name": "python2",
+        "sources": [
+            {
+            "type": "archive",
+            "url": "https://www.python.org/ftp/python/2.7.17/Python-2.7.17.tar.xz",
+            "sha256": "4d43f033cdbd0aa7b7023c81b0e986fd11e653b5248dac9144d508f11812ba41"
+            }
+        ],
+        "config-opts": [
+            "--enable-shared",
+            "--with-ensurepip=yes",
+            "--with-system-expat",
+            "--with-system-ffi",
+            "--enable-loadable-sqlite-extensions",
+            "--with-dbmliborder=gdbm",
+            "--enable-unicode=ucs4"
+        ],
+        "post-install": [
+            "chmod 644 \$FLATPAK_DEST/lib/libpython2.7.so.1.0"
+        ],
+        "cleanup": [
+            "'*'"
+        ]
+    },
+        {
+            "name": "yuzu",
+            "buildsystem": "cmake-ninja",
+            "builddir": true,
+            "config-opts": [
+                "-DDISPLAY_VERSION=$1",
+                "-DYUZU_USE_BUNDLED_UNICORN=ON",
+                "-DYUZU_USE_QT_WEB_ENGINE=OFF",
+                "-DCMAKE_BUILD_TYPE=Release",
+                "-DYUZU_ENABLE_COMPATIBILITY_REPORTING=ON",
+                "-DENABLE_COMPATIBILITY_LIST_DOWNLOAD=ON",
+                "-DUSE_DISCORD_PRESENCE=ON",
+                "-DENABLE_VULKAN=Yes"
+            ],
+            "cleanup": [
+              "/bin/yuzu-cmd",
+              "/share/man",
+              "/share/pixmaps"
+            ],
+            "post-install": [
+                "install -Dm644 ../appdata.xml /app/share/appdata/org.yuzu.$REPO_NAME.appdata.xml",
+                "desktop-file-install --dir=/app/share/applications ../dist/yuzu.desktop",
+                "install -Dm644 ../dist/yuzu.svg /app/share/icons/hicolor/scalable/apps/yuzu.svg",
+                "sed -i 's/Name=yuzu/Name=$REPO_NAME_FRIENDLY/g' /app/share/applications/yuzu.desktop",
+                "mv /app/share/mime/packages/yuzu.xml /app/share/mime/packages/org.yuzu.$REPO_NAME.xml",
+                "sed 's/yuzu/org.yuzu.$REPO_NAME/g' -i /app/share/mime/packages/org.yuzu.$REPO_NAME.xml",
+                'install -D ../yuzu-wrapper /app/bin/yuzu-wrapper',
+                "desktop-file-edit --set-key=Exec --set-value='/app/bin/yuzu-wrapper %f' /app/share/applications/yuzu.desktop"
+            ],
+            "sources": [
+                {
+                    "type": "git",
+                    "url": "https://github.com/yuzu-emu/$REPO_NAME.git",
+                    "branch": "$AZURE_BRANCH",
+                    "disable-shallow-clone": true
+                },
+                {
+                    "type": "file",
+                    "path": "/tmp/appdata.xml"
+                },
+                {
+                    "type": "file",
+                    "path": "/tmp/yuzu-wrapper"
+                }
+            ]
+        }
+    ]
+}
+EOF
+
diff --git a/.ci/templates/build-flatpak-single.yml b/.ci/templates/build-flatpak-single.yml
new file mode 100644
index 0000000000..3d9283bcd4
--- /dev/null
+++ b/.ci/templates/build-flatpak-single.yml
@@ -0,0 +1,35 @@
+parameters:
+  cache: 'false'
+  version: ''
+
+steps:
+- task: DockerInstaller@0
+  displayName: 'Prepare Environment'
+  inputs:
+    dockerVersion: '17.09.0-ce'
+- task: CacheBeta@0
+  displayName: 'Cache Build System'
+  inputs:
+    key: yuzu-v1-$(BuildName)-$(BuildSuffix)-$(CacheSuffix)
+    path: $(System.DefaultWorkingDirectory)/ccache
+    cacheHitVar: CACHE_RESTORED
+- script: chmod a+x ./.ci/scripts/$(ScriptFolder)/exec.sh && ./.ci/scripts/$(ScriptFolder)/exec.sh ${{ parameters['version'] }}
+  displayName: 'Build'
+  env:
+    FLATPAK_ENC_IV: $(FLATPAK_ENC_IV)
+    FLATPAK_ENC_K: $(FLATPAK_ENC_K)
+    FLATPAK_GPG_PUBLIC_KEY: $(FLATPAK_GPG_PUBLIC_KEY)
+    FLATPAK_SSH_HOSTNAME: $(FLATPAK_SSH_HOSTNAME)
+    FLATPAK_SSH_PORT: $(FLATPAK_SSH_PORT)
+    FLATPAK_SSH_PUBLIC_KEY: $(FLATPAK_SSH_PUBLIC_KEY)
+    FLATPAK_SSH_USER: $(FLATPAK_SSH_USER)
+    AZURE_BRANCH: $(Build.SourceBranch)
+    AZURE_BUILD_ID: $(Build.BuildId)
+    AZURE_BUILD_NUMBER: $(Build.BuildNumber)
+    AZURE_COMMIT: $(Build.SourceVersion)
+    AZURE_JOB_ID: $(System.JobId)
+    AZURE_REPO_SLUG: $(Build.Repository.Name)
+    AZURE_TAG: $(Build.SourceBranch)
+- script: chmod a+x ./.ci/scripts/$(ScriptFolder)/finish.sh && ./.ci/scripts/$(ScriptFolder)/finish.sh
+  condition: always()
+  displayName: 'Clean up'
diff --git a/.ci/yuzu-flatpak-step2.yml b/.ci/yuzu-flatpak-step2.yml
new file mode 100644
index 0000000000..2f12913a72
--- /dev/null
+++ b/.ci/yuzu-flatpak-step2.yml
@@ -0,0 +1,39 @@
+trigger:
+- master
+
+variables:
+  DisplayVersion: $[counter(variables['DisplayPrefix'], 1)]
+
+stages:
+- stage: format
+  displayName: 'format'
+  jobs:
+  - job: format
+    displayName: 'clang'
+    pool:
+      vmImage: ubuntu-latest
+    steps:
+    - template: ./templates/format-check.yml
+- stage: build
+  dependsOn: format
+  displayName: 'build'
+  jobs:
+  - job: build
+    displayName: 'standard'
+    pool:
+      vmImage: ubuntu-latest
+    strategy:
+      maxParallel: 10
+      matrix:
+        linux:
+          BuildSuffix: 'linux-flatpak'
+          ScriptFolder: 'linux-flatpak'
+    steps:
+    - template: ./templates/sync-source.yml
+      parameters:
+        artifactSource: $(parameters.artifactSource)
+        needSubmodules: 'true'   
+    - template: ./templates/build-flatpak-single.yml
+      parameters:
+        cache: 'true'
+        version: $(DisplayVersion)
diff --git a/keys.tar.enc b/keys.tar.enc
new file mode 100644
index 0000000000..e69de29bb2