태그 보관물: Android

GitHub release에 바이너리 첨부 자동화

GitHub에서 release를 생성하면 source code의 snapshot이 zip과 tar.gz로 저장된다. 여기에 추가해서 컴파일된 결과가 자동으로 추가하도록 한다면, 간단히 source code와 연계된 바이너리도 함께 배포할 수 있을 것이다.

이 글에서는 안드로이드 프로젝트를 가정해서 release를 생성할 때 안드로이드 APK를 빌드하고 source code와 함께 배포하는 간단한 workflow를 설명한다.

전체 코드

Event trigger

on:
  release:
    types: [published]

Release에서만 동작하므로 event trigger는 release – published이다. 이 event는 web상에서 새로운 release package를 publish 할때 trigger 된다.

환경변수

env:
  TAG: ${{ github.ref_name }}
  ASSET_FILE_PATH: "./prebuilt-${{ github.ref_name }}.zip"

Release package를 생성할 때 넣는 version의 이름은 github.ref_name으로 참조 된다. 첨부되는 파일의 이름은 prebuilt-<version_tag>.zip으로 설정한다. 참고로 GitHub에서는 release에 추가되는 소스코드외의 파일들을 “Asset”이라 부른다.

빌드 수행 및 Asset 생성

    # Checkout source code and build Android APKs.
    - name: Checkout
      uses: actions/checkout@v3
    - name: Setup JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'
        cache: gradle
    - name: Build Android APK and zip
      run: |
        sh ./gradlew assemble
        zip ${{ env.ASSET_FILE_PATH }} \
          ./app/build/outputs/apk/debug/app-debug.apk \
          ./app/build/outputs/apk/release/app-release*.apk

Android build를 위한 JAVA를 설정하고 Gradle의 assemble target을 설정하여 APK file에 대한 빌드를 수행한다. Assemble은 debug와 release용 두개의 apk를 성성하므로 이들을 하나의 zip파일로 만들어서 prebuilt-<version_tag>.zip에 추가한다.

Release에 Asset 추가

Release에 asset을 추가해주는 GitHub action은 보이질 않는다. 그래서 GitHub script를 이용해서 release에 asset을 추가하는 동작을 다음과 같이 정의했다. 이는 두 개의 동작으로 이루어지는데 하나는 주어진 tag로 release 정보를 찾아오는 것이고, 다른 하나는 가져온 release 정보에 파일을 업로드하는 것이다.

동작 1. Tag로 release 가져오기

GitHub script project의 README.md에 따르면 GitHub script상에서 github객체는 사전인증된(pre-authenticated) Octokit client라고 한다. 따라서 새롭게 instance를 만들지 않고 바로 Octokit의 API를 사용할 수 있다. getReleaseByTag()에 tag를 넘겨주면 통해 release에 대한 객체가 반환된다. 그 중에 release를 구분하기 위한 ID만 사용한다.

    // Get a release for given tag.
    const release = await github.rest.repos.getReleaseByTag({
       owner: context.repo.owner,
       repo: context.repo.repo,
       tag: process.env.TAG
    });
    const release_id = release.data.id;
    console.log("Release id for the tag " + process.env.TAG + ": " + release_id);

동작 2. Release에 파일 업로드 하기

앞의 과정에서 만든 업로드할 zip파일과 release를 구분할 ID 정보를 uploadReleaseAsset()에 넘겨 주면 해당 파일이 asset으로 등록된다.

    // Upload release assets.
    const fs = require("fs");
    const filename = process.env.ASSET_FILE_PATH.replace(/^.*[\\/]/, "");
    var uploaded = await github.rest.repos.uploadReleaseAsset({
       owner: context.repo.owner,
       repo: context.repo.repo,
       release_id: release_id,
       name: filename,
       data: await fs.readFileSync(process.env.ASSET_FILE_PATH),
    });
    console.log(
       process.env.ASSET_FILE_PATH
       + " has been uploaded as " + filename
       + " to the release " + process.env.TAG);

주의: upload 동작은 release를 수정하는 것이므로 workflow가 repository에 대한 write permission이 있어야 하므로 settings 항목에서 에서 write permission이 허가되어 있는지 확인한다. 이 부분이 안되어 있다면 403 error가 날 것이다.

Release workflow 실행

GitHub repo의 Code 탭에서 Tags -> Releases -> Tag -> Draft a new release를 선택한 후 Choose a tag를 눌러서 나오는 입력창에 새로 생성할 version tag를 입력해 Create new tag를 선택한 다음 Publish release 버튼을 누른다.

이 때 만들어지는 release에는 소스코드만 들어 있지만, 정상적으로 동작했다면 Actions tab에 release workflow가 등록되어 수행되는 것이 보일 것이다. Workflow가 정상 종료된 후 해당 release로 다시 가보면 asset이 등록되어 있는 것을 볼 수 있다.

Android recovery image 빌드 설정

1. BoardConfig.mk 수정
TARGET_NO_KERNEL과 TARGET_NO_RECOVERY가 true로 설정되어 있다면 설정한다.

2. device.mk 수정
TARGET_PREBUILT_KERNEL관련 설정을 삭제한다.

3. AndroidBoard.mk 추가
Kernel build 될 때 참고되는 파일이므로 추가해 주고 KERNEL_DEFCONFIG등의 설정을 자신에 맞게 변경해 준다.

4. AndroidKernel.mk 추가
AndroidKernel.mk는 kernel build를 위한 makefile script이다.

5. defconfig file 경로변경
defconfig file이 참조될 수 있도록 kernel/$(ARCH)/configs 아래에 옮겨준다.

6. 상대경로 참조로 인한 compile error 수정
Android build에 포함된 kernel build는 상대 경로를 참조하는 경우 build error를 발생할 수 있다. 절대 경로 path를 주기 위해 절대 경로를 얻고 make command line에 이를 넘겨주는 부분을 추가해 준다.

MinnowboardMAX에 Android 올려 본 내용 정리

Android / Chromium OS / Windows를 올려 볼 수 있는 Intel Baytrail 기반의 개발보드인 MinnowboardMAX에 Android 5.1을 install하는 과정을 설명한다.

필요한 것 들

  • Minnowboard MAX판매하는 곳, 2015년 9월 현재 국내에서 판매하는 곳은 없는것 같다.
  • FTDI cable – Serial 출력을 PC에서 받기 위해 guide 문서에는 TTL-232R을 사용하라고  나와 있는데 Amazon.com에서 배송비 빼고 $23정도에 판매한다. 하지만 국내에서도 호환가능한 케이블을 16,500원에 구할 수 있었는데 Windows 10에서 잘 인식되지 않았고 (Windows 7 / Linux에서는 잘 동작함) 핀 배열이 달라서 직접 배선을 연결해 주어야 하는 문제가 있기는 했다. FTDI 항목 참조.
  • HDMI monitor와 cable – 내부 display가 없기 때문에 화면 출력을 위해서는 Micro HDMI 변환 젠더나 이를 지원하는 cable이 있어야 한다.
  • Mouse / Keyboard – USB를 지원하는 mouse와 keyboard가 필요 하다.
  • SD card (16GB 이상) – Android OS가 설치되는 공간이다.
  • USB (thumb) drive – Android OS를 올릴 image를 flashing하기 위해 필요하다 5GB 이상이 필요하다고 하는데, 실제로는 그렇게 image가 큰 것 같진 않다.

Hooking up

minnowboardMAX_connection
(* Image from Minnowboard MAX wiki)

  • Micro-HDMI : HDMI를 지원하는 monitor와 연결
  • Network : Android image file들을 전송해 줄 host와 같은 network에 유선 LAN cable로 연결
  • Power : 구매시에 포함되어 있는 5V adapter에 연결
  • USB thumb drive : Fastboot image를 포함하고 있는 USB drive를 연결
  • USB keyboard : BIOS와 fastboot 진입 후 메뉴 선택등을 위해 keyboard를 연결
  • FTDI Serial : BIOS menu 선택이나 booting log를 보기 위해 필요하나 없어도 동작에는 문제가 없다.

FTDI 연결

“FTDI Serial”의 핀 배열은 다음과 같다.

minnowboardMAX_FTDI
(* Image from Minnowboard MAX wiki)

PN-USBTTL_connector추천되는 TTL-233R cable을 사용한다면 그냥 연결만 해도 되겠지만, 국내에서 판매하는 PN-USBTTL 제품은 GND / VCC / TXD / RXD 만을 지원하는데 이 네개만 연결해도 동작에는 문제가 없다. 다만 한가지 주의 할 점은 일반적인 연결과 달리 MinowboardMAX의 FTDI TXD연결 (4번핀)은 이 케이블의 G-TXD, RXD연결(5번핀)은 W-RXD로 연결해 주어야 한다는 점이다. 일반적으로 RX-TX, TX-RX로 연결하는 것과 다르다.

정리하면 다음과 같다.

FTDI Pin # PN-USBTTL connector
1 (GND) B-GND
3 (VCC) R-VCC
4 (TXD) G-TXD
5 (RXD) W-RXD

마지막으로 serial monitor program (PuTTY나 Minicom 같은)을 열어서 설정을 해주면 serial 입출력을 위한 준비는 끝난다.

Baud rate: 115200
Flow Control: No
Data bits: 8
Stop bits: 1

Firmware update

MinnowboardMAX를 구매 할 때 포함되어 있는 BIOS의 버전은 최신이 아닐 가능성이 많다. Version 0079 이상이면 굳이 업데이트 할 필요는 없으나 필요하다면 다음 과정에 따라 최신 firmware로 업데이트 할 수 있다.

  • Intel firmware resource center에서 MinnowboardMAX용 firmware를 download
  • USB thumb drive를 FAT32로 포맷하고 다운로드 받은 zip file을 풀어서 모든 내용을 복사
  • USB thumb drive를 MinnowboardMAX에 연결하고 전원을 켜기
  • Booting중 F2 혹은 DEL key를 눌러서 BIOS로 진입해서 UEFI shell을 실행
  • UEFI shell에서 다음의 명령어를 입력해서 firmware update를 실행
UEFI shell> fs0:
UEFI fs0:\> MinnowBoard.MAX.FirmwareUpdateX64.efi MinnowBoard.MAX.X64.082.R01.bin

Android image file 구하기

  • Pre-built binary download
    : 빌드 안해도 되는건 좋은데, userdebug image는 su 명령어를 사용할 수 없어서 제약이 있을 수 있다는 점을 고려해야 한다.
wget https://download.01.org/android-ia/releases/android-5.1.0_r1-ia0-minnowboard_max-64bit-userdebug.zip
  • MinnowboardMAX용 Android source code를 download 받고 직접 build
repo init -u https://github.com/android-ia/platform_manifest -b release/android-5.1.0_r1-ia0
repo sync -j4 -q -c --no-clone-bundle
source build/envsetup.sh
lunch minnow_64p-eng
make -j$(nproc) dist

Creating a fastboot USB thumb drive

Android image를 구했다면 fastboot-usb.img file을 USB thumb drive에 write한다. Linux를 사용한다면 USB drive를 unmount한다음 dd utility로 해당 device 경로에 write하고, Windows를 사용한다면 Win32 Disk imager 혹은 그와 비슷한 program을 사용하면 된다.

다음 예제는 Linux host에서 /media/THUMBDRIVE에 mount된 drive를 해제하고 /dev/sdg1 device path에 writing하는 상황을 설명한다. 당연한 말이지만, 자동으로 mount되지 않았다면 umount를 실행 필요가 없고, 연결된 device path에 대한 정보는 dmesg를 통해 확인할 수 있다.

sudo umount /media/THUMBDRIVE
sudo dd bs=1M if=fastboot-usb.img of=/dev/sdg1 conv=fsync

Flashing Android Image files

fastboot-usb.img가 설치된 USB thumb drive를 연결하고 USB drive로 MinnowboardMAX를 부팅시키면 다음과 같은 화면이 나온다. ‘BOOTLOADER ERROR CODE 04’라고 나오긴 하지만 사실 오류는 아니고 사용자입력을 기다리는 화면이다. SD card와 LAN cable이 제대로 연결되었는지 다시 한 번 확인하고 계속 하기위해 연결된 key board의 윗쪽 화살표키를 누른다.

Intel_bootloader_error_code_04

한참동안 화면 업데이트가 없어서 동작하지 않는것 처럼 보일수도 있는데, 연결된 Serial port로는 kernel이 load되고 실행되는 과정이 보이고 있을 것이다. Serial port에서 booting이 완료되는 것이 보이면, MinnowboardMAX와 같은 network에 연결되어 있는 host PC에서 다음 명령어를 수행해서 image file들을 LAN으로 전송한다.

# Linux
$ provision.sh <IP_ADDR>

# Windows
C:> provision.bat <IP_ADDR>

Tips

  • 실제로 잘 먹힌것인지는 모르겠는데… Network이 안 잡혀서 헤매다가 BIOS에서 IPv4 설정하는 menu가 있어서 DHCP를 설정해 주었다. Network을 못 잡는 다거나 한다면 한번 시도해 보자.
    – Device Manager -> Network Device List -> MAC:xx:xx:xx:xx:xx:xx -> IPv4 Network

SC_enabling_DHCP_from_BIOS

  • Guide 문서에 나와 있는것과는 달리 network 설정화면이 나오지 않아서 MinnowboardMAX의 IP 주소가 무엇을 받았는지 몰랐는데, 공유기의 IP 할당 테이블을 보면 유추할 수 있다.

SC_guessing_minnowboard_IP“할당된 device는 4개인데 사용중인 디바이스는 3개니까… IP는 중간에 건너뛴 4가 아니면 6으로 끝나지 않을까?” 너무 막 찍는것 같지만 실제로 4번으로 끝나는 IP였다! 😉

Boot up

이제 USB thumb drive를 빼고, BIOS menu에서 SD card로 부팅하도록 설정하면 Android로 부팅되는 것을 볼 수 있을 것이다.

ADB over network

USB로 직접 연결할 수 없으므로, 같은 network에 연결되어 있는 PC에서 ADB over network으로 ADB를 실행시킬 수 있다. 먼저 serial emulator program으로 Android device에서 다음을 실행 시킨다.

#> adb tcpip 5555

이제 host PC에서 다음 명령어로 연결한다.

CMD> adb connect 192.168.173.4:5555
CMD> adb devices

References & Links

Android emacs (android-host.el) 기능 추가

AOSP에서 제공되는 Emacs용 Andorid 개발환경을 설정한 이후(이 post 참조) 잘 모르는 LISP을 더듬어 가며 추가한 몇 가지 기능을 소개합니다.

adb reboot (M-x android-adb-reboot)

Module등을 변경한 후에 device를 reset하는 명령어가 없어서 추가했다. 이 기능의 장점을 굳이 꼽자면 shell을 따로 뛰우지 않고 리붓을 할수 있다는거…

(defun android-adb-reboot ()
  "Execute 'adb reboot'."
  (interactive)
  (android-adb-command "reboo

Module push (M-x android-adb-push-module)

Compile한 module을 target에 push 할 때 사용한다. Command를 입력하면 push 할 source와 target을 물어보고 adb push command를 실행한다.

(defun android-adb-push-module (source target)
  "Push specified module into target path."
  (interactive "fSource: \nsTarget: ")

  (android-adb-root)
  (android-adb-remount)
  (android-adb-command
    (concat "push " source " " target) 'p))

Module push Hotkey  (C-x a p)

위의 android-adb-push-module 함수를 쓰다보니 path를 입력하는게 무척 귀찮다. android-compile 명령어를 수행해서 만들어지는 출력 버퍼에서 위의 단축키로 target의 해당 directory로 module을 push한다.

Install: out/target/product/TARGET_DEVICE/system/xxx/yyy.zz

출력 버퍼로 이동해서 출력된 결과물 위에 cursor를 놓고 ‘C-x a p’를 입력하면 그 경로를 읽어서 target으로 push 한다. Source의 path에서 target 위치를 읽어 오게 되어 있어서 특별한 입력이 필요 하지 않다.

(define-key map (kbd "p") 'android-adb-push-module-at-point)
...

(defun android-adb-push-module-at-point ()
  "Push module path at cursor point an push to the target path."
  (interactive)

  (let*
    (
      (sourcepath (concat (android-find-build-tree-root) (thing-at-point 'filename)))
      (targetpath (substring sourcepath (string-match "\/system" sourcepath) nil)))
    (android-adb-push-module sourcepath targetpath)))

전체 수정내역을 포함하는 파일: icon_text_file android-host.el

Cygwin에서 Android systrace 실행 문제

2014년 8월 현재, Cygwin으로 systrace를 사용하려고 하면 zlib 관련한 error가 나면서 동작하지 않는다.

$ python systrace.py -o output.html gfx input view wm am video hal dalvik
capturing trace... done
downloading trace... done

Traceback (most recent call last):
  File "systrace.py", line 286, in <module>
    main()
  File "systrace.py", line 231, in main
    decoded_chunk = dec.decompress(chunk)
zlib.error: Error -3 while decompressing: incorrect header check

AOSP project의 이 링크에 보면 문제를 해결하기 위한 patch가 올려져 있는데 comment를 보니 한동안 받아들여 지지 않다가 현재 source와 달라져서 적용할 수 없게 된 모양이다. 같은 동작을 하도록 약간만 수정해서 이렇게 고쳐 보니 좀 지저분하긴 해도 zlib error 없이 Cygwin에서 systrace를 사용할 수 있었다.

diff --git a/systrace.py b/systrace.py
index 387f413..0d3be25 100644
--- a/systrace.py
+++ b/systrace.py
@@ -205,8 +205,12 @@ def main():
       data = ''.join(data)

       # Collapse CRLFs that are added by adb shell.
-      if data.startswith('\r\n'):
-        data = data.replace('\r\n', '\n')
+      if sys.platform == 'cygwin':
+        if data.startswith('\r\r\n'):
+          data = data.replace('\r\r\n', '\n')
+      else:
+        if data.startswith('\r\n'):
+          data = data.replace('\r\n', '\n')

       # Skip the initial newline.
       data = data[1:]