Alfin Syahruddin's Blog RSS Feed

Stable Diffusion pada Swift

Sun, 08 Jun 2025 00:00:00 GMT

Sekarang ini, sudah ada banyak aplikasi yang dapat membantu kita menghasilkan gambar dari teks. Namun, hampir semua aplikasi tersebut menjalankan prosesnya di sisi server, sehingga membutuhkan koneksi internet dan terkadang prosesnya cukup lama tergantung seberapa banyak pengguna yang mengaksesnya.

Dari sisi privasi dan keamanan data, kita juga tidak tahu apakah gambar yang kita buat akan disimpan di server mereka atau tidak. Di beberapa aplikasi juga terdapat batasan jumlah gambar yang dapat kita buat dan prompt yang boleh kita berikan sehingga kita tidak bisa bebas berkreasi.

Pada artikel kali ini kita akan belajar bagaimana cara membuat aplikasi macOS untuk menghasilkan gambar dari teks secara lokal di perangkat kita sendiri, sehingga lebih bebas, cepat dan aman.

Apa itu Stable Diffusion?

Stable Diffusion adalah model kecerdasan buatan yang dikembangkan oleh Stability AI untuk menghasilkan gambar dari teks (prompt). Model ini meupakan model open-source sehingga dapat kita gunakan secara gratis.

Stable Diffusion (SD) merilis beberapa versi model, mulai dari SD 1.0, SD 1.5, SD 2.1, SDXL, SDXL Turbo, dan paling baru adalah SD 3.5 yang dirilis pada bulan oktober 2024 lalu. Model SD 3.5 ini dapat menghasilkan gambar dengan kualitas yang sangat baik, merender tulisan di dalam gambar dan juga dapat memahami prompt yang lebih kompleks.

Contoh Penggunaan Stable Diffusion

Berikut adalah beberapa contoh penggunaan Stable Diffusion untuk menghasilkan gambar dari teks:

Pembuatan Ilustrasi: misalnya ilustrasi buku, poster, atau thumbnail video youtube. (bahkan thumbnail pada artikel ini pun dibuat menggunakan Stable Diffusion 😁)
Arsitektur dan Interior Desain: arsitek dapat menggambarkan ide ruangan atau rumah dari deskripsi sebelum modeling 3D.
Desain Produk & Fashion: desainer dapat merancang sepatu atau pakaian hanya dari deskripsi teks.
Konten Media Sosial dan Marketing: membuat gambar menarik untuk postingan media sosial atau iklan.

Cara Kerja Stable Diffusion

Berikut adalah langkah-langkah utama dalam proses pembuatan gambar dari teks yang dilakukan oleh Stable Diffusion:

1. Text Encoding

Stable Diffusion dimulai dengan mengubah teks (prompt) menjadi representasi numerik menggunakan model text encoder bernama CLIP.

CLIP mengubah teks menjadi vektor yang merepresentasikan makna dari teks tersebut. Vektor ini akan digunakan untuk memandu proses pembuatan gambar.

2. Random Noise

Setelah teks di-encode, proses selanjutnya adalah membuat noise acak. Noise ini adalah gambar awal yang tidak memiliki makna. Noise ini akan menjadi dasar untuk proses pembuatan gambar.

Noise ini berupa latent image yang merupakan representasi dari gambar dalam bentuk tensor. Latent image ini memiliki dimensi yang lebih kecil dibandingkan dengan gambar asli (64x64x4), sehingga proses pembuatan gambar menjadi lebih efisien.

3. Denoising

Dengan bantuan model U-Net, noise tadi dihilangkan secara bertahap (biasanya 20–50 langkah). Setiap langkah, model U-Net akan memperbaiki noise tersebut dengan mengacu pada vektor teks yang telah di-encode sebelumnya. Proses ini menghasilkan gambar yang semakin mendekati deskripsi teks.

4. VAE Decoding

Setelah proses denoising selesai, latent image yang dihasilkan masih dalam bentuk tensor. Kita perlu menggunakan Variational Autoencoder (VAE) untuk men-decode latent image tersebut menjadi gambar yang dapat dilihat manusia. VAE akan mengubah tensor tersebut menjadi gambar dengan resolusi yang lebih tinggi (512x512 piksel misalnya).

Agar lebih mudah dipahami, berikut adalah diagram bagaimana Stable Diffusion bekerja:

Diagram Stable Diffusion

Mendapatkan Model

Untuk menjalankan Stable Diffusion di macOS, kita memerlukan model dalam format Core ML. Ada beberapa cara untuk mendapatkan model ini:

1. Model Core ML Siap Pakai

Apple telah menyediakan berbagai model Stable Diffusion dalam format Core ML yang dapat langsung digunakan. Kamu dapat melihat daftar model yang tersedia di sini

Untuk mengunduhnya, silakan pilih versi model yang diinginkan, maka akan diarahkan ke website Hugging Face, kemudian pilih tab "Files and versions" dan klik icon "download".

Hugging Face

2. Mengonversi Model ke Core ML

Meskipun Apple telah menyediakan beberapa model yang siap pakai, tidak semua versi model tersedia dalam format Core ML. Misalnya model SD 3.5 yang merupakan versi terbaru saat ini belum tersedia.

Jika kamu ingin menggunakan model yang belum tersedia dalam format Core ML, kamu dapat mengonversi sendiri model Stable Diffusion dari format PyTorch ke Core ML menggunakan script python_coreml_stable_diffusion.torch2coreml dari library ml-stable-diffusion.

Untuk mengonversi model, kita perlu menyiapkan environment Python serta menginstall beberapa dependensi yang diperlukan. Jalankan perintah berikut di terminal:


1git clone https://github.com/apple/ml-stable-diffusion.git
2cd ml-stable-diffusion
3
4python -m venv venv
5source venv/bin/activate
6
7pip install -e .

Setelah itu, kita dapat mengonversi model dengan perintah berikut:


1python -m python_coreml_stable_diffusion.torch2coreml \
2    --bundle-resources-for-swift-cli \
3    --model-version stabilityai/stable-diffusion-3.5-large \
4    --convert-unet \
5    --convert-text-encoder \
6    --convert-vae-decoder \
7    --convert-vae-encoder \
8    -o Resources

Silakan ganti stabilityai/stable-diffusion-3.5-large dengan versi model yang ingin dikonversi. Setelah proses konversi selesai, kamu akan mendapatkan file Core ML model di dalam folder Resources.

Membuat Aplikasi macOS

Sekarang kita akan membuat aplikasi macOS sederhana yang dapat menghasilkan sebuah gambar dari teks menggunakan model Stable Diffusion yang telah kita siapkan.

1. Setup Project

Silakan clone project "iMagine" dan checkout ke branch starter yang telah disediakan. Branch ini sudah berisi setup awal project macOS dengan SwiftUI sehingga kita bisa lebih fokus pada implementasi model Stable Diffusion.


1git clone https://github.com/alfinsyahruddin/iMagine.git
2cd iMagine
3git checkout starter

2. Menambahkan Model ke Project

Silakan copy semua file model Core ML yang telah kita siapkan sebelumnya ke dalam folder Resources.

Resources

3. Instalasi Dependensi

Kita perlu menambahkan library StableDiffusion dari Apple untuk memudahkan kita dalam menggunakan model Stable Diffusion di Swift.

Silakan klik File -> Add Package Dependencies, kemudian masukkan URL berikut: https://github.com/apple/ml-stable-diffusion.

Add Package Dependencies

4. Generate Image

Silakan buka file "ImageGenerator.swift", import StableDiffusion dan ubah implementasi dari fungsi generate menjadi seperti ini:

ImageGenerator.swift
1static func generate(
2    prompt: String,
3    image: CGImage? = nil,
4    imageSize: CGSize = CGSize(width: 512, height: 512),
5    numberOfImages: Int = 1
6) async throws -> [CGImage] {
8    guard let resourcesURL = Bundle.main.url(forResource: "Resources", withExtension: nil)?.path() else { return [] }
9
10    let url = URL(fileURLWithPath: resourcesURL)
11    let configuration = MLModelConfiguration()
12    configuration.computeUnits = .all
13
14    let pipeline = try StableDiffusionPipeline(
15        resourcesAt: url,
16        controlNet: [],
17        configuration: configuration
18    )
19    try pipeline.loadResources()
20
21    var pipelineConfig = StableDiffusionPipeline.Configuration(prompt: prompt)
22    pipelineConfig.startingImage = image?.resize(to: imageSize)
24    pipelineConfig.negativePrompt = "blurry, low detail, low resolution, low quality, ugly, distorted"
25    pipelineConfig.seed = UInt32.random(in: (0..<UInt32.max))
26    pipelineConfig.stepCount = 50
28    pipelineConfig.originalSize = Float32(imageSize.width)
29    pipelineConfig.targetSize = Float32(imageSize.width)
30    pipelineConfig.imageCount = numberOfImages
31
32    return try pipeline.generateImages(configuration: pipelineConfig)
33        .compactMap { $0 }
34}

Penjelasan kode:

Pertama, kita memberitahu Stable Diffusion dimana letak folder yang berisi model Core ML berada. Dalam hal ini adalah di folder Resources.
negativePrompt berfungsi untuk memberi tahu model, apa yang harus dihindari saat menghasilkan gambar.
seed digunakan untuk menghasilkan noise acak. Dengan seed yang sama, kita akan mendapatkan gambar yang sama setiap kali kita menjalankan proses ini.
stepCount menentukan berapa banyak langkah denoising yang akan dilakukan. Semakin tinggi nilainya, semakin detail gambar yang dihasilkan, namun semakin lama juga prosesnya.

Kalau kita jalankan aplikasi kita, hasilnya akan seperti ini:

iMagine ✨

Sekarang kita telah berhasil membuat aplikasi macOS yang dapat menghasilkan gambar dari teks di lokal menggunakan model Stable Diffusion. Selanjutnya kamu dapat eksplorasi lebih lanjut misalnya dengan menambahkan ControlNet untuk mengubah sketsa menjadi gambar realistis atau mendownload model pada saat runtime agar ukuran aplikasi lebih kecil.

Oke mungkin itu saja yang bisa saya bagikan kali ini, kalau kamu merasa artikel ini bermanfaat silakan Like & Share artikel ini ke teman-teman kamu atau jika kamu punya pertanyaan, tulis aja di kolom komentar, Thank you! 😁 🙏

Referensi :

RSS Feed

Android Reverse Engineering

Sat, 15 Mar 2025 00:00:00 GMT

Sebagai seorang Developer, kita pasti tidak ingin aplikasi yang kita buat dimodifikasi oleh orang lain (Attacker) dengan tujuan tidak baik yang bisa merugikan kita maupun pengguna dari aplikasi kita, seperti pembajakan lisensi, mendapatkan API Key, menambahkan keylogger untuk mendapatkan kredensial pengguna, dll.

Oleh karena itu, kita di sini akan belajar bagaimana Attacker bisa membongkar dan memodifikasi sebuah aplikasi Android. Karena dengan mengetahui hal tersebut, kita menjadi tahu bagaimana cara mencegah hal tersebut agar tidak terjadi.

Artikel ini ditulis hanya untuk tujuan edukasi, saya tidak bertanggung jawab atas tindakan apapun yang dilakukan atas informasi yang saya sampaikan.

Apa itu Reverse Engineering?

Secara umum, Reverse Engineering (RE) merupakan teknik dalam penetration testing untuk mengetahui alur jalannya program atau sistem tanpa mempunyai source code / dokumentasinya.

Dalam konteks aplikasi Mobile khususnya Android, kita bisa melakukan Reverse Engineering sebuah aplikasi dengan membongkar dan menganalisa file APK (Android Package Kit).

Reverse Engineering ini seperti membongkar resep dari sebuah masakan, kita akan bisa mengetahui apa saja bahan yang diperlukan, bagimana cara memasaknya, dll. Tentu tidak akan 100% akurat karena ada faktor-faktor tertentu yang mungkin tidak dapat terungkap sepenuhnya, Namun, dengan analisa yang mendalam, Reverse Engineering bisa sangat berguna untuk memahami bagaimana cara kerja suatu aplikasi.

Tujuan RE

Sebenarnya tujuan Reverse Engineering itu bukan sekedar mendapatkan source code hasil dekompilasi dari sebuah aplikasi, yang lebih penting adalah setelah kita mendapatkan source code tersebut, apa yang akan kita lakukan.

Berikut adalah beberapa tujuan mengapa orang melakukan RE:

Penetration Testing - Jika kita mempunyai sebuah aplikasi dan kita ingin mengujinya dari sisi keamanan, kita bisa melakukan Reverse Engineering untuk mencari tahu apakah ada Key yang bocor, apakah jika aplikasi kita dimodifikasi masih bisa berjalan, dll.
Bypass Penjagaan Security - Biasanya sebuah aplikasi ada proteksi pendeteksian Root, SSL Pinning, dll. Nah, kita bisa melakukan RE untuk bypass segala proteksi tersebut.
Membajak Lisensi - Jika ada aplikasi yang berbayar, kita bisa melakukan bypass pengecekan lisensi dengan RE, sehingga kita dapat menggunakan aplikasi tersebut secara gratis.
Injeksi Malware - Dalam aplikasi modifikasi yang mungkin terlihat baik misalnya menghilangkan iklan, Attacker juga bisa menyisipkan malware untuk mencuri data login, data pribadi pengguna, dll.

Requirements

Untuk mengikuti tutorial ini, berikut adalah beberapa device dan software yang perlu kita siapkan:

Laptop
HP Android
Android Studio
JADX
ApkTool

File APK

Jika di iOS kita menggunakan file IPA untuk menginstall sebuah aplikasi, di Android kita dapat menginstall sebuah aplikasi menggunakan file APK (Android Package Kit).

File APK sebenarnya hanyalah file ZIP yang berisi file-file yang digunakan untuk menjalankan sebuah aplikasi, berikut adalah isi dari sebuah file APK:

File APK

Jika kita ekstrak, mungkin terlihat ada banyak sekali file, tapi tenang saja, tidak semua file perlu kita analisa dalam melakukan RE, berikut adalah beberapa file yang penting untuk dilakukan analisa:

classes.dex (Dalvik Executable): Berisi Bytecode dari Kotlin / Java yang sudah dikompilasi, nantinya kita bisa lakukan dekompilasi menjadi source code Java agar bisa dibaca oleh manusia.
Android.manifest: Berisi konfigurasi & metadata aplikasi, seperti permission, Activity, dll.
lib/*.so: Berisi kode binary native yang ditulis menggunakan C/C++/Rust.
Resources Files: Pada aplikasi yang tidak aman, mungkin kita bisa mendapatkan konfigurasi atau Key yang dihardcode di dalam file resources.

Workflow RE

Berikut adalah langkah-langkah untuk melakukan Reverse Engineering aplikasi Android menggunakan Static Analysis yang akan kita bahas satu-persatu.

Static Analysis: Menganalisis kode atau aplikasi tanpa menjalankannya.
Dynamic Analysis: Menganalisis aplikasi ketika sedang dijalankan (runtime).

Workflow RE

1. Mendapatkan APK

Google Play Store

Untuk mendapatkan file APK, cara pertama kita bisa download saja melalui Google Play Store, setelah itu kita bisa export APK yang sudah terinstall menggunakan aplikasi seperti ES File Explorer.

Atau kita juga bisa pull APK yang sudah terinstall langsung ke komputer kita menggunakan ADB (Android Debug Bridge). Berikut adalah command-nya:


1adb shell pm list packages | grep "gpt"
2adb pull /data/app/VCISw==/com.openai.chatgpt/base.apk ChatGPT.apk

ApkPure

Cara yang kedua, kita dapat mendapatkan file APK melalui website ApkPure di sini

Kelebihan cara ini adalah kita bisa mendapatkan file APK tanpa perlu menginstallnya terlebih dahulu dan bisa memilih versi yang kita inginkan.

Untuk studi kasus pada artikel ini, kita akan melakukan Reverse Engineering untuk bypass pengecekan Serial Number agar aplikasinya menjadi PRO Version tanpa perlu membeli lisensinya. ☠️

Silakan download file APK-nya melalui Github di sini: https://github.com/alfinsyahruddin/crackme-android

CrackMeAndroid

2. Unpack APK

Setelah kita mendapatkan file APK, kita bisa Unpack APK-nya menggunakan ApkTool.

Proses Unpack ini akan mengubah file DEX menjadi kode smali yang bisa kita edit nantinya untuk melakukan Patching aplikasi.

Silakan jalankan commmand berikut:


1apktool d CrackMeAndroid.apk -o CrackMeAndroid

Unpack APK

3. Decompile

Sekarang, kita akan melakukan dekompilasi file DEX yang terdapat pada file APK CrackMeAndroid menggunakan aplikasi JADX.

Dekompilasi adalah proses untuk mengubah file DEX menjadi source code Java yang high-level, sehingga mudah untuk dibaca oleh manusia. Meskipun tidak bisa 100% mirip dengan source code aslinya, tapi ini dapat membantu kita dalam memahami bagaimana alur kerja sebuah program.

Silakan buka aplikasi JADX
Drag & Drop file APK yang ingin kita dekompilasi

4. Analisa

Setelah proses unpack dan dekompilasi selesai dilakukan, sekarang kita sudah bisa melakukan analisa terhadap sebuah aplikasi, proses ini adalah yang paling sulit, mungkin bisa menghabiskan waktu sampai beberapa menit atau bahkan beberapa hari, kita harus benar-benar teliti agar dapat menemukan celah yang ada pada suatu aplikasi.

Apa yang perlu di-analisa sebenarnya tergantung tujuan kita masing-masing, misalnya untuk mencari apakah ada API Key yang dihardcode di dalam source code, mencari bagian kode pengecekan Root & SSL Pinning untuk di-bypass, dll.

Untuk studi kasus kali ini, tujuan kita adalah untuk mencari bagian kode untuk bypass pengecekan Serial Number, sehingga kita bisa memasukkan Serial Number apa saja akan tetap dianggap valid.

Pertama, silakan ke menu Navigation -> Class Search, kemudian search dengan keyword "Verify" untuk mencari class yang berhubungan dengan verifikasi serial number.

JADX - Filter

Di sini, kita menemukan class bernama VerifySerialNumberActivity, kemudian kita klik, maka akan diarahkan ke kode java hasil dekompilasi terkait function tersebut.

Lalu, di bagian kode dekompilasinya, terdapat ViewOnClickListenerC0075a yang dipanggil, karena di page tersebut hanya ada 1 button, maka kita bisa simpulkan bahwa event on-click tersebut lah yang berfungsi untuk melakukan pengecekan serial number.

JADX

Di dalam class ViewOnClickListenerC0075a, kita melihat method m692a yang digunakan untuk membandingkan 2 variabel, bisa jadi inilah bagian kode untuk pengecekannya! 👀

Jadi, idenya adalah kita akan melakukan patching kondisi perbandingan 2 variabel ini agar hasilnya selalu true.

JADX

Untuk melihat kode smali yang berhubungan dengan logic tersebut, kita bisa centang "Split View" yang ada di bagian bawah, kemudian pilih tab "Smali"

JADX - Smali

5. Patching

Setelah kita tahu apa yang mau dipatch, kita bisa buka folder hasil Unpack oleh ApkTool tadi menggunakan Text Editor karena kita tidak bisa mengedit file secara langsung di JADX.

Untuk melakukan patching, kita hanya bisa mengedit kode smali-nya, hasil dekompilasi Java yang ada di JADX hanyalah preview saja untuk membantu kita dalam membaca alur sebuah program.

ApkTool - Before

Di bagian kode smali, kita melihat instruksi if-eqz (Equal to Zero) yang digunakan untuk melakukan mengecek register v0, jika hasilnya 0 (false), maka instruksi selanjutnya tidak akan dieksekusi dan akan berpindah ke block :cond-1. dan kalau kita cek isi dari :cond-1 adalah untuk menampilkan alert "Invalid Serial Number". Sehingga kita perlu set agar register v0 selalu 1 (true).

Dalam konteks kode Smali / Assembly, register adalah tempat untuk menyimpan nilai seperti angka, objek, atau tipe data lainnya. register biasanya diberi nama seperti v0, v1, v2, dan seterusnya.

Jadi, silakan tambahkan code berikut di sebelum instruksi if-eqz untuk menimpa isi dari register v0 menjadi 1 (true):

ApkTool - After

Setelah itu, simpan filenya.

6. Repacking APK

1. Repacking

Untuk me-repack APK, jalankan command berikut di Terminal:


1apktool b CrackMeAndroid -o modified.apk

2. Re-Signing

Agar aplikasi yang telah kita modifikasi dapat diinstall di Android, kita perlu melakukan Signing ulang.

Tool yang akan kita pakai adalah "uber-apk-signer", silakan download dulu di sini: https://github.com/patrickfav/uber-apk-signer

Jika sudah, jalankan command berikut:


1java -jar signer.jar --apk modified.apk

Command di atas akan menghasilkan file APK baru yang telah di-signing ulang bernama "modified-aligned-debugSigned.apk"

3. Install

Terakhir, kita tinggal install APK yang telah kita modifikasi ke HP Android menggunakan command berikut:


1adb install -r modified-aligned-debugSigned.apk

Sekarang, ketika kita memasukkan Serial Number random pun akan dianggap valid dan aplikasi kita menjadi PRO Version 🎉

CrackMeAndroid - Patched

Proteksi Aplikasi

Proteksi aplikasi Android agar tidak bisa di-reverse engineer sepenuhnya tidak mungkin dilakukan, karena teknik Reverse Engineering terus berkembang. Namun, ada beberapa cara yang dapat meningkatkan kesulitan bagi siapa saja yang mencoba melakukan RE aplikasi Android kita.

1. Obfuscation

Obfuscation adalah proses menyamarkan kode sumber aplikasi agar sulit dipahami oleh orang lain. Misalnya, nama variabel, fungsi, dan kelas bisa diubah menjadi nama yang tidak bermakna dan acak.

Tools: Licel DexProtector, ProGuard

2. App Integrity Checks

Kita bisa melakukan integrity check dalam aplikasi pada saat runtime untuk mendeteksi jika ada modifikasi pada binary aplikasi, misalnya dengan memeriksa checksum dari binary atau file tertentu, atau bisa juga menggunakan Play Integrity API.

Tools: Play Integrity, Firebase AppCheck

3. Anti Dynamic Instrumentation

Jika aplikasi kita di-reverse engineer menggunakan Dynamic Analysis seperti Frida, Objection atau Debugger, kita bisa tambahkan pengecekan juga agar aplikasi kita tidak bisa dimodifikasi behaviornya pada saat runtime. Misalnya kita cek apakah ada process frida-server yang berjalan, mendeteksi apakah ada debugger yang berjalan menggunakan library AntiDebugandMemoryDump, dll.

Tools: DetectFrida, AntiDebugandMemoryDump

What's Next?

Setelah kita tahu bagaimana cara membongkar dan memodifikasi aplikasi Android, serta bagaimana cara proteksinya agar hal tersebut sulit dilakukan, mungkin selanjutnya kamu bisa membaca lebih detail mengenai best practice penerapan keamanan pada aplikasi Mobile dari OWASP (Open Web Application Security Project), khususnya MASVS (Mobile Application Security Verification Standard) dan MASTG (Mobile Application Security Testing Guide). Kedua pedoman ini memberikan panduan yang sangat berguna untuk memastikan aplikasi Mobile kita aman dari berbagai serangan.

RSS Feed

iOS Reverse Engineering

Sat, 15 Mar 2025 00:00:00 GMT

Oleh karena itu, kita di sini akan belajar bagaimana Attacker bisa membongkar dan memodifikasi sebuah aplikasi iOS. Karena dengan mengetahui hal tersebut, kita menjadi tahu bagaimana cara mencegah hal tersebut agar tidak terjadi.

Artikel ini ditulis hanya untuk tujuan edukasi, saya tidak bertanggung jawab atas tindakan apapun yang dilakukan atas informasi yang saya sampaikan.

Apa itu Reverse Engineering?

Secara umum, Reverse Engineering (RE) merupakan teknik dalam penetration testing untuk mengetahui alur jalannya program atau sistem tanpa mempunyai source code / dokumentasinya.

Dalam konteks aplikasi Mobile khususnya iOS, kita bisa melakukan Reverse Engineering sebuah aplikasi dengan membongkar dan menganalisa file IPA (iOS AppStore Package).

Tujuan RE

Berikut adalah beberapa tujuan mengapa orang melakukan RE:

Penetration Testing - Jika kita mempunyai sebuah aplikasi dan kita ingin mengujinya dari sisi keamanan, kita bisa melakukan Reverse Engineering untuk mencari tahu apakah ada Key yang bocor, apakah jika aplikasi kita dimodifikasi masih bisa berjalan, dll.
Bypass Penjagaan Security - Biasanya sebuah aplikasi ada proteksi pendeteksian Jailbreak, SSL Pinning, dll. Nah, kita bisa melakukan RE untuk bypass segala proteksi tersebut.
Membajak Lisensi - Jika ada aplikasi yang berbayar, kita bisa melakukan bypass pengecekan lisensi dengan RE, sehingga kita dapat menggunakan aplikasi tersebut secara gratis.
Injeksi Malware - Dalam aplikasi modifikasi yang mungkin terlihat baik misalnya menghilangkan iklan, Attacker juga bisa menyisipkan malware untuk mencuri data login, data pribadi pengguna, dll.

Requirements

Untuk mengikuti tutorial ini, berikut adalah beberapa device dan software yang perlu kita siapkan:

Macbook
iPhone yang sudah dijailbreak (Opsional)
Xcode
Ghidra
Sideloadly

File IPA

Jika di Android kita menggunakan file APK untuk menginstall sebuah aplikasi, di IOS kita dapat menginstall sebuah aplikasi menggunakan file IPA (iOS AppStore Package).

File IPA sebenarnya hanyalah file ZIP yang berisi file-file yang digunakan untuk menjalankan sebuah aplikasi, berikut adalah isi dari sebuah file IPA:

File IPA

File Binary (Mach-O): Berisi binary dari Swift / Objective-C yang sudah dikompilasi, nantinya kita bisa lakukan dekompilasi menjadi source code agar bisa dibaca oleh manusia.
Info.plist: Berisi konfigurasi & metadata aplikasi, seperti permission, Base URL API, AID NFC, dll.
Frameworks: Dapat kita analisis untuk memahami dependensi aplikasi dan mengidentifikasi potensi kerentanannya.
Resources Files: Pada aplikasi yang tidak aman, mungkin kita bisa mendapatkan konfigurasi di dalam file resources.

Workflow RE

Berikut adalah langkah-langkah untuk melakukan Reverse Engineering aplikasi iOS menggunakan Static Analysis yang akan kita bahas satu-persatu.

Static Analysis: Menganalisis kode atau aplikasi tanpa menjalankannya.
Dynamic Analysis: Menganalisis aplikasi saat sedang dijalankan (runtime).

Workflow RE

1. Mendapatkan IPA

AppStore

Untuk mendapatkan file IPA, cara pertama kita bisa download saja melalui AppStore, namun perlu diketahui bahwa setiap aplikasi yang diinstall dari AppStore akan dienkripsi oleh Apple (Melalui DRM Fair Play) dan hanya bisa diinstall oleh akun tertentu saja.

Jika kita ingin melakukan Reverse Engineering aplikasi yang diinstall di AppStore dan ingin agar hasil patchingnya bisa diinstall oleh orang lain, maka kita perlu men-decrypt file IPA nya, yang akan kita bahas lebih detail di step ke-2.

iOSGods

Cara yang kedua, kita dapat mendapatkan file IPA yang sudah ter-decrypt melalui website iOSGods di sini

Namun, website ini berbayar jika kita ingin mengakses fitur-fitur VIP seperti decrypt IPA tanpa limit, melihat histori versi, dll.

Github

Ada beberapa aplikasi yang didistribusikan di Github melalui file IPA, meskipun jumlahnya tidak sebanyak yang ada di AppStore.

Untuk studi kasus pada artikel ini, kita akan melakukan Reverse Engineering untuk bypass pengecekan Serial Number agar aplikasinya menjadi PRO Version tanpa perlu membeli lisensinya. ☠️

Silakan download file IPA-nya melalui Github di sini: https://github.com/alfinsyahruddin/crackme-ios

CrackMeIOS

2. Decrypt IPA

Untuk men-decrypt file IPA dari aplikasi yang didownload dari AppStore, kita bisa menggunakan tool bernama "frida-ios-dump", sebenarnya bukan tool ini yang men-decrypt file IPA nya, tool ini hanya mengambil IPA yang sudah ter-decrypt di Memory pada saat aplikasinya sedang berjalan.

Untuk menggunakan tool ini, kita memerlukan iPhone yang sudah di-Jailbreak.

Berikut adalah langkah-langkahnya:

Install Frida
Jalankan command di Terminal: git clone https://github.com/AloneMonkey/frida-ios-dump
Masuk ke folder "frida-ios-dump" dan jalankan lagi: sudo pip install -r requirements.txt --upgrade
Jalankan iproxy 2222 22
Terakhir, dump file IPA dari memory: python3 dump.py -u root -p root -o CrackMeIOS.ipa CrackMeIOS

Note: Silakan sesuaikan nama aplikasi dan kredensial untuk mengakses shell ke iPhone kita.

3. Unpack IPA

Setelah kita mendapatkan file IPA yang telah ter-decrypt, kita bisa unpack IPA-nya, karena file IPA sebenarnya adalah file ZIP biasa, jadi silakan rename saja extensionnya menjadi .zip kemudian klik 2x untuk mengekstrak filenya.

Unpack IPA

4. Decompile

Sekarang, kita akan melakukan disassembly dan dekompilasi file binary yang terdapat pada file IPA CrackMeIOS menggunakan aplikasi Ghidra.

Disassembly adalah proses untuk mengubah file binary menjadi bahasa assembly, di iOS bahasa assembly-nya menggunakan arsitektur ARM64. Jika kamu ingin melakukan patching sebuah aplikasi iOS, pengetahuan tentang dasar bahasa assembly ARM akan sangat membantu, kamu bisa mulai belajar dari sini: https://azeria-labs.com/writing-arm-assembly-part-1/

Sedangkan Dekompilasi adalah proses untuk mengubah file binary menjadi source code bahasa pemrograman yang high-level, sehingga mudah untuk dibaca oleh manusia dibandingkan membaca langsung bahasa assembly-nya. Meskipun tidak bisa 100% mirip dengan source code aslinya, tapi ini dapat membantu kita dalam memahami bagaimana alur kerja sebuah program.

Silakan buka aplikasi Ghidra dan buat Project baru
Drag & Drop file binary yang ada di dalam folder Payload -> CrackMeIOS (Show Package Contents) -> CrackMeIOS
Click 2x file binary nya di aplikasi Ghidra
Centang "Decompiler Parameter ID"
Klik button Analyze

Ghidra

5. Analisa

Setelah proses unpack, disassembly dan dekompilasi selesai dilakukan, sekarang kita sudah bisa melakukan analisa terhadap sebuah aplikasi, proses ini adalah yang paling sulit, mungkin bisa menghabiskan waktu sampai beberapa menit atau bahkan beberapa hari, kita harus benar-benar teliti agar dapat menemukan celah yang ada pada suatu aplikasi.

Apa yang perlu di-analisa sebenarnya tergantung tujuan kita masing-masing, misalnya untuk mencari apakah ada API Key yang dihardcode di dalam binary / Info.plist, mencari bagian kode pengecekan Jailbreak & SSL Pinning untuk di-bypass, dll.

Untuk studi kasus kali ini, tujuan kita adalah untuk mencari bagian kode untuk bypass pengecekan Serial Number, sehingga kita bisa memasukkan Serial Number apa saja akan tetap dianggap valid.

Pertama, silakan ke menu Symbol Tree di sebelah kiri, kemudian filter dengan keyword "Verify" untuk mencari function yang berhubungan dengan verifikasi serial number.

Ghidra - Filter

Di sini, kita menemukan function bernama didTapVerifyButton, kemudian kita klik, maka view-nya akan diarahkan ke kode assembly (tengah) & hasil dekompilasi (kanan) terkait function tersebut.

Lalu, di bagian kode dekompilasinya, terdapat 2 function yang dipanggil, silakan masuk ke dalam function yang ada di baris ke-14 (FUN_100004364) karena setelah dilihat implementasinya, function tersebut lah yang berfungsi untuk melakukan pengecekan serial number.

Ghidra

Di dalam function FUN_100004364, kita melihat operator perbandingan 2 variabel, bisa jadi inilah bagian kode untuk pengecekannya! 👀

Jadi, idenya adalah kita akan melakukan patching kondisi perbandingan 2 variabel ini agar hasilnya selalu true.

Ghidra

6. Patching

Setelah kita tahu apa yang mau dipatch, kita bisa klik kondisi perbandingan tersebut, maka akan diarahkan ke kode assembly-nya.

Untuk melakukan patching, kita hanya bisa mengedit kode assembly-nya, hasil dekompilasi yang di sebelah kanan hanyalah preview saja untuk membantu kita dalam membaca alur sebuah program.

Ghidra - Before

Di bagian kode assembly, kita melihat 2 instruksi cmp (Compare) & bne (Branch if Not Equal)yang digunakan untuk melakukan operasi perbandingan, jika hasilnya tidak sama, maka instruksi selanjutnya tidak akan dieksekusi dan akan berpindah ke block LAB_100004440. dan kalau kita cek isi dari LAB_100004440 adalah untuk menampilkan alert "Invalid Serial Number". Sehingga kita perlu set agar hasil perbandingannya selalu sama.

Jadi, silakan arahkan cursor ke instruksi cmp, kemudian klik kanan -> Patch Instruction -> Ubah kedua valuenya agar menjadi sama.

Ghidra - After

Setelah itu, klik menu File -> Export Program -> Format: Original File -> Output: replace file binary yang ada di folder Payload -> OK.

Ghidra - Export

7. Repacking IPA

Karena file IPA sebenarnya adalah file ZIP biasa, silakan compress folder Payload dengan nama "modified.ipa"

Jika sudah, silakan buka aplikasi Sideloadly untuk menginstall aplikasi ke device kita dari file IPA.

Drag & Drop file IPA nya, pilih Apple ID, dan klik button Start.

Sideloadly

Sekarang, ketika kita memasukkan Serial Number random pun akan dianggap valid dan aplikasi kita menjadi PRO Version 🎉

CrackMeIOS - Patched

Proteksi Aplikasi

Proteksi aplikasi iOS agar tidak bisa di-reverse engineer sepenuhnya tidak mungkin dilakukan, karena teknik Reverse Engineering terus berkembang. Namun, ada beberapa cara yang dapat meningkatkan kesulitan bagi siapa saja yang mencoba melakukan RE aplikasi iOS kita.

1. Obfuscation

Obfuscation adalah proses menyamarkan kode sumber aplikasi agar sulit dipahami oleh orang lain. Misalnya, nama variabel, fungsi, dan kelas bisa diubah menjadi nama yang tidak bermakna dan acak.

Tools: Licel DexProtector, SwiftShield

2. App Integrity Checks

Tools: App Attest, Firebase AppCheck

3. Anti Dynamic Instrumentation

Jika aplikasi kita di-reverse engineer menggunakan Dynamic Analysis seperti Frida, Objection atau LLDB, kita bisa tambahkan pengecekan juga agar aplikasi kita tidak bisa dimodifikasi behaviornya pada saat runtime. Misalnya kita cek apakah ada process frida-server yang berjalan, mendeteksi apakah ada debugger yang berjalan menggunakan ptrace, dll.

Tools: IOSSecuritySuite

What's Next?

Setelah kita tahu bagaimana cara membongkar dan memodifikasi aplikasi iOS, serta bagaimana cara proteksinya agar hal tersebut sulit dilakukan, mungkin selanjutnya kamu bisa membaca lebih detail mengenai best practice penerapan keamanan pada aplikasi Mobile dari OWASP (Open Web Application Security Project), khususnya MASVS (Mobile Application Security Verification Standard) dan MASTG (Mobile Application Security Testing Guide). Kedua pedoman ini memberikan panduan yang sangat berguna untuk memastikan aplikasi Mobile kita aman dari berbagai serangan.

RSS Feed

Swift Ownership & Borrowing

Sat, 07 Dec 2024 00:00:00 GMT

Seperti yang telah kita ketahui, Swift mempunyai 2 tipe data yaitu Reference Type dan Value Type. Reference Type adalah tipe data yang disimpan di heap memory yang dikelola oleh Swift menggunakan ARC (Automatic Reference Counting).

Sedangkan Value Type adalah tipe data yang disimpan di stack memory dan jika dilakukan assignment ke variable lain atau dipassing ke sebuah function maka akan selalu dicopy valuenya.

Sebelumnya saya pernah menulis artikel tentang Automatic Reference Counting (ARC) pada Swift, kalian bisa membacanya di sini.

Problemnya adalah ketika kita mempunyai sebuah variable dengan tipe data Value Type seperti struct yang berukuran sangat besar, maka ketika kita melakukan assignment atau passing ke sebuah function maka valuenya akan selalu dicopy, yang berarti akan memakan waktu dan memori yang cukup besar juga.

Oke, kalau gitu kenapa tidak menggunakan Reference Type saja seperti class? Sebenarnya bisa saja, namun jika kita ingin performa yang lebih baik, cara ini tidak direkomendasikan karena tipe data class akan disimpan di heap memory yang dikelola oleh ARC, yang berarti ada proses retain release, kemudian kita harus memikirkan tentang retain cycle yang bisa menyebabkan memory leaks, dan juga menurut benchmark yang dilakukan oleh Infinum ternyata ARC mempunyai dampak pada performa yang cukup signifikan.

ARC Performance

Untuk mengatasi masalah tersebut, Swift 5.9 memperkenalkan konsep Ownership.

Apa itu Ownership?

Ownership adalah konsep dan aturan yang digunakan untuk mengelola memori di Swift secara efisien dan aman, dimana sebuah variabel hanya bisa dimiliki oleh satu owner saja, dan owner tersebut bertanggung jawab untuk menghapus variabel dari memori ketika variabel tersebut sudah tidak diperlukan lagi.

Konsep Ownership ini mirip dengan konsep Ownership di Rust, dimana setiap variabel hanya bisa dimiliki oleh satu owner saja, dan ketika variabel tersebut dipassing ke variabel lain misalnya, maka ownership dari variabel tersebut akan dipindahkan ke variabel lain tersebut.

Seperti di Rust, kita juga bisa melakukan Borrowing, dimana kita bisa meminjam value dari suatu variabel tanpa harus ada perpindahan ownership.

Perbedaan dengan sistem Ownership di Rust adalah sistem Ownership di Swift ini bersifat opsional, jadi kita bisa gunakan di bagian kode yang membutuhkan performa tinggi saja.

It is the core team's expectation that ownership can be delivered as an opt-in enhancement to Swift. Programmers should be able to largely ignore ownership and not suffer for it. If this expectation proves to not be satisfiable, we will reject ownership rather than imposing substantial burdens on regular programs.

Swift Ownership Manifesto

~Copyable

Hal pertama yang perlu kita lakukan untuk menggunakan sistem Ownership adalah dengan menambahkan ~Copyable pada Struct atau Enum kita.

Secara default, Struct & Enum di Swift adalah Copyable, yang berarti ketika kita melakukan assignment atau passing ke sebuah function, maka valuenya akan selalu dicopy. Namun, kita bisa mengubahnya menjadi Non-Copyable dengan cara menambahkan ~Copyable pada Struct atau Enum kita.

Contohnya seperti ini:


1struct Book: ~Copyable {
2    var price: String
3}
4
5let book = Book(price: 100_000)
6let book2 = book
7print(book2.price) // ✅ OK
8print(book.price) // ❌ Compilation Error: 'book' used after consume

Pada contoh di atas, kita membuat Non-Copyable struct Book dan kita melakukan assignment let book2 = book, ownership dari book akan dipindahkan ke book2, sehingga ketika kita mencoba mengakses book.price maka akan terjadi error pada saat dicompile.

Limitasi

Berikut adalah beberapa limitasi dari ~Copyable untuk saat ini:

Hanya bisa digunakan pada Struct & Enum
Struct & Enum yang menggunakan ~Copyable, properti2-nya juga harus ~Copyable
Belum mendukung Generic

Borrowing

Jika kita tidak ingin memindahkan ownership dari suatu variabel pada saat passing variabel tersebut ke suatu function, maka kita bisa melakukan Borrowing. Borrowing adalah proses meminjam value dari suatu variabel tanpa memindahkan ownership dari variabel tersebut.

Berikut adalah contoh penggunaan Borrowing:


1struct Book: ~Copyable {
2    var price: Int
3    
4    borrowing func read() {
5        print("Reading book...")
6    }
7}
8
9func describeBook(_ book: borrowing Book) {
10    print("Price: \(book.price)")
11}

Jika functionnya berada di luar struct maka kita perlu menambahkan keyword borrowing pada parameter functionnya.

Tapi jika functionnya di dalam struct maka kita perlu menambahkan keyword borrowing pada awal deklarasi functionnya dan secara default sebenarnya tipenya adalah borrowing, jadi kita bisa hapus keyword borrowing nya.


1struct Book: ~Copyable {
2    var price: Int
3    
4    func read() {
5        print("Reading book...")
6    }
7}

Inout

Seperti borrowing, inout juga digunakan untuk meminjam value dari suatu variabel, namun inout dapat digunakan jika kita ingin mengubah value dari variabel tersebut.

Berikut adalah contoh penggunaan inout:


1func modifyPrice(_ book: inout Book) {
2    book.price = 999
3}
4
5modifyPrice(&book)

Pada kode di atas, kita membuat function modifyPrice yang menerima parameter inout Book, dan kita memanggil function tersebut dengan menambahkan & sebelum variabel book.

Consuming

Jika kita ingin memindahkan ownership dari suatu variabel pada saat passing variabel ke suatu function, maka kita bisa melakukan Consuming. Dan apabila sudah mencapai akhir dari scope function tersebut, maka variabel tersebut akan dihapus dari memori.

Berikut adalah contoh penggunaan Consuming:


1struct Book: ~Copyable {
2    var price: Int
3    
4    consuming func delete() {
5        print("Deleting book from the database...")
6    }
7}

Pada kode di atas, kita menambahkan keyword consuming pada function delete(), sehingga ketika kita memanggil function delete() 2x maka akan terjadi error pada saat dicompile.


1let book = Book(price: 100_000)
2book.delete() // ✅ OK
3book.delete() // ❌ Compilation Error: 'book' consumed more than once

Discard

Terakhir, ada keyword discard yang digunakan untuk mencegah deinit dipanggil pada saat variabel tersebut dihapus dari memori.

Berikut adalah contoh penggunaan discard:


1struct Book: ~Copyable {
2    var price: Int
3    
4    consuming func delete() {
5        print("Deleting book from the database...")
6        discard self
7    }
8    
9    deinit {
10        print("Deleting book from the database...")
11    }
12}

Pada kode di atas, kita menambahkan keyword discard self pada function delete(), sehingga ketika kita memanggil function delete() maka deinit tidak akan dipanggil.

Performance Benchmark

Infinum telah melakukan benchmark terhadap sistem Ownership di Swift, berikut adalah hasilnya:

Borrowing

Consuming

Sekarang, kita sudah belajar tentang Ownership & Borrowing di Swift, agar lebih mudah diingat, berikut adalah perbedaan utama antara borrowing, inout, dan consuming:

borrowing: Digunakan untuk meminjam value dari suatu variabel (Read Only).
inout: Digunakan untuk meminjam value dari suatu variabel dan kita bisa mengubah valuenya.
consuming: Digunakan untuk memindahkan ownership dari suatu variabel.

Referensi:

RSS Feed

Sharing Code iOS & Android dengan Rust

Sun, 25 Aug 2024 00:00:00 GMT

Dalam membuat aplikasi Mobile tentu menggunakan teknologi Native dari masing-masing platform seperti SwiftUI untuk iOS dan Jetpack Compose untuk Android adalah pilihan terbaik dalam segi performa dan User Experience (UX).

Namun, kita juga tahu bahwa dalam membangun aplikasi Mobile, kita tidak hanya membuat User Interface (UI) saja, ada banyak sekali hal lain yang perlu kita buat, seperti network call, caching, image processing, dll. Yang mana itu sebetulnya tidak platform specific seperti UI, sehingga kita bisa mengurangi redundansi penulisan kode untuk bagian-bagian tersebut dengan cara hanya menulis 1 kali saja, kemudian kita akan pakai di kedua platform!

Ada beberapa cara Sharing Code yang bisa kita pilih, mungkin menggunakan Kotlin Multi Platform (KMP), mungkin menggunakan C++, atau menggunakan bahasa pemrograman Rust yang akan kita gunakan dalam tutorial ini.

Kenapa Rust?

Berikut adalah beberapa alasan mengapa Rust mungkin cocok digunakan dalam Sharing Code pada aplikasi Mobile:

1. Performance

Rust dikenal sebagai bahasa yang memiliki performa sangat tinggi, bahkan bisa mendekati C/C++. Hal ini bisa didapatkan dari Zero-Cost Abstraction (abstraksi yang tidak berdampak ke performa pada runtime) yang ada pada Rust dan juga memory management yang tidak menggunakan Garbage Collector.

Karena performanya yang sangat oke, ada beberapa perusahaan besar yang mulai mengadopsi Rust, contohnya seperti Discord (dari Go ke Rust), Figma (dari Typescript ke Rust), dll

2. Memory Safety

Memory Safety artinya program kita akan terbebas dari bugs yang berhubungan dengan memory management, seperti memory leaks (memory tidak pernah di-deallocate), mengakses null pointer, melakukan double free, dll.

Nah, di Rust, masalah-masalah tersebut akan terdeteksi lebih awal pada saat program kita dicompile.

Karena alasan memory safety inilah Linux & Windows mulai mengadopsi Rust dalam kernel OS-nya. Bahkan departemen pertahanan AS (DARPA) mulai rewrite program yang mereka tulis menggunakan C ke Rust.

3. Productivity

Ada beberapa fitur pada Rust yang dapat meningkatkan produktivitas kita sebagai Developer, misalnya Macros untuk code generator, Auto Completion, Auto Formatter, dll.

Jika program kita ada error, error message nya pun sangat useful. bahkan kadang compilernya memberikan suggestion untuk memperbaiki error tersebut.

Selain itu, ada ratusan ribu crates (library) di crates.io yang dapat kita gunakan sehingga proses development menjadi lebih cepat.

4. Support dari Android

Sejak beberapa tahun lalu, Android sudah mendukung Rust sebagai bahasa pemrograman untuk membangun native OS components mereka. (https://source.android.com/docs/setup/build/rust/building-rust-modules/overview)

Prerequisites

Untuk mengikuti tutorial ini, pastikan kamu sudah menginstall:

Rust
Xcode
Android Studio

Setup Project

Sekarang, kita akan mulai membuat projectnya, kita akan membuat library Rust yang memiliki function get_message dan library tersebut akan kita gunakan di iOS dan Android.

Silakan buat folder baru bernama "greeting-demo"


1mkdir greeting-demo
2cd greeting-demo

Membuat Library Rust

Untuk membuat library Rust, jalankan command:


1cargo new greeting --lib

Kemudian tambahkan crate uniffi ke library kita:

Cargo.toml
1[lib]
2crate_type = ["cdylib", "staticlib"]
3name = "greeting"
4
5[dependencies]
6uniffi = { version = "0.28.1", features = ["cli"] }

Setelah itu tambahkan function get_message pada file "lib.rs":

lib.rs
1uniffi::setup_scaffolding!();
2
3#[uniffi::export]
4fn get_message() -> String {
5    String::from("Hello from Rust! 🦀")
6}

Terakhir, buat file "uniffi-bindgen.rs" di dalam folder "bin", yang berisi:

uniffi-bindgen.rs
1fn main() {
2    uniffi::uniffi_bindgen_main()
3}

Jika kita build, maka akan muncul sebuah dynamic library bernama "libgreeting.dylib" pada folder "target/debug" yang akan kita pakai pada step berikutnya.


1cargo build

Membuat Aplikasi iOS

1. Setup Project

Silakan buka Xcode dan buat project SwiftUI baru bernama "GreetingIOS" pada folder "greeting".

Setup Project

2. Membuat iOS Binding & Binaries

Pertama, kita akan generate binding terlebih dahulu agar kita bisa memanggil library rust di swift.


1cargo run --bin uniffi-bindgen generate --library ./target/debug/libgreeting.dylib --language swift --out-dir ./bindings

Command di atas akan menghasilkan folder "bindings" di project rust kita yang berisi binding rust untuk swift.

Lalu pindahkan file "greeting.swift" ke folder "ios" dan rename menjadi "Greeting.swift"


1mv ./bindings/greeting.swift ./ios/Greeting.swift

Kemudian tambahkan beberapa target berikut ke Rust:


1rustup target add aarch64-apple-ios-sim aarch64-apple-ios

Jalankan command berikut untuk build library iOS:


1cargo build --release --target=aarch64-apple-ios-sim
2cargo build --release --target=aarch64-apple-ios

Command di atas akan menghasilkan 2 file binary bernama "target/aarch64-apple-ios-sim/release/libgreeting.a" dan "target/aarch64-apple-ios/release/libgreeting.a".

3. Membuat XCFramework

XCFramework memungkinkan kita untuk mengimport library iOS dengan lebih mudah. Jadi, kita akan membuat file .xcframework dari 2 file binary di atas.

Pertama, kita ubah rename dulu "bindings/greetingFFI.modulemap" menjadi "bindings/module.modulemap" agar Xcode dapat menemukan module kita.

Kemudian, buat file .xcframework:


1xcodebuild -create-xcframework \
2    -library ./target/aarch64-apple-ios-sim/release/libgreeting.a -headers ./bindings \
3    -library ./target/aarch64-apple-ios/release/libgreeting.a -headers ./bindings \
4    -output "ios/Greeting.xcframework"

4. Import XCFramework di Xcode

Silakan drag & drop file "Greeting.xcframework" dan file "Greeting.swift" ke project iOS kita.

Sekarang, kita sudah bisa memanggil function getMessage dari Rust di Swift.

Penamaan function akan disesuaikan secara otomatis sesuai konvensi dari masing-masing bahasa oleh binding yang telah kita buat di awal. Misalnya dalam hal ini get_message di Rust akan menjadi getMessage di Swift.

ContentView.swift
1import SwiftUI
2
3struct ContentView: View {
4    var body: some View {
5        VStack {
7            Text(getMessage())
8        }
9        .padding()
10    }
11}
12
13#Preview {
14    ContentView()
15}

iOS

5. Automation Script

Agar tiap kali ada perubahan di library Rust-nya kita tidak perlu menjalankan command satu per-satu, lebih baik kita membuat script automasi untuk pembuatan XCFramework.

Buat file baru bernama "build_ios.sh" yang berisi:

build ios.sh
1#!/bin/bash
2
3# Build the dylib
4cargo build
5
6# Generate bindings
7cargo run --bin uniffi-bindgen generate --library ./target/debug/libgreeting.dylib --language swift --out-dir ./bindings
8
9# Add the iOS targets and build
10for TARGET in \
11    aarch64-apple-darwin \
12    aarch64-apple-ios \
13    aarch64-apple-ios-sim \
14    x86_64-apple-darwin \
15    x86_64-apple-ios; do
16    rustup target add $TARGET
17    cargo build --release --target=$TARGET
18done
19
20# Rename *.modulemap to module.modulemap
21mv ./bindings/greetingFFI.modulemap ./bindings/module.modulemap
22
23# Move the Swift file to the project
24rm ./ios/Greeting.swift
25mv ./bindings/greeting.swift ./ios/Greeting.swift
26
27# Recreate XCFramework
28rm -rf "ios/Greeting.xcframework"
29xcodebuild -create-xcframework \
30    -library ./target/aarch64-apple-ios-sim/release/libgreeting.a -headers ./bindings \
31    -library ./target/aarch64-apple-ios/release/libgreeting.a -headers ./bindings \
32    -output "ios/Greeting.xcframework"
33
34# Cleanup
35rm -rf bindings


1chmod +x build_ios.sh
2./build_ios.sh

Membuat Aplikasi Android

1. Setup Project

Silakan buka Android Studio, dan buat project baru bernama "GreetingAndroid"

Setup Project

Di Android, kita membutuhkan NDK (Native Development Kit) untuk menggunakan library yang ditulis menggunakan bahasa native seperti C, C++ dan Rust.

Silakan klik Tools -> SDK Manager -> SDK Tools kemudian "Check (NDK Side by Side)"

NDK

Setelah itu pindah ke project Rust, dan jalankan command berikut:


1cargo install cargo-ndk

Dan tambahkan beberapa target berikut ke Rust:


1rustup target add \
2    aarch64-linux-android \
3    armv7-linux-androideabi \
4    i686-linux-android \
5    x86_64-linux-android

2. Membuat Library Android

Jalankan command berikut untuk membuat library Android:


1cargo ndk -o ../GreetingAndroid/app/src/main/jniLibs \
2    --manifest-path ./Cargo.toml \
3    -t armeabi-v7a \
4    -t arm64-v8a \
5    -t x86 \
6    -t x86_64 \
7    build --release

3. Generate Binding

Kemudian kita perlu generate Binding Rust ke Kotlin menggunakan command berikut:


1cargo run --bin uniffi-bindgen generate --library ./target/debug/libgreeting.dylib --language kotlin --out-dir ../GreetingAndroid/app/src/main/java/dev/alfin/greetingandroid

4. Import Library di Android Studio

Pertama, kita perlu menambahkan 2 dependencies berikut di file "build.gradle.kts"


1dependencies {
2    // ...
3    // UniFFI
4    implementation("net.java.dev.jna:jna:5.7.0@aar")
5    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
6}

Sekarang, kita sudah bisa memanggil function getMessage dari Rust di Kotlin.

MainActivity.kt
1import uniffi.greeting.getMessage
2
3class MainActivity : ComponentActivity() {
4    override fun onCreate(savedInstanceState: Bundle?) {
5        super.onCreate(savedInstanceState)
6        enableEdgeToEdge()
7        setContent {
8            GreetingAndroidTheme {
9                Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
10                    Column(
11                        verticalArrangement = Arrangement.Center,
12                        horizontalAlignment = Alignment.CenterHorizontally,
13                        modifier = Modifier.fillMaxSize().padding(innerPadding)
14                    ) {
15                        Text(
17                            text = getMessage()
18                        )
19                    }
20                }
21            }
22        }
23    }
24}

Android

5. Automation Script

Agar tiap kali ada perubahan di library Rust-nya kita tidak perlu menjalankan command satu per-satu, lebih baik kita membuat script automasi untuk pembuatan Library Android.

Buat file baru bernama "build_android.sh" yang berisi:

build android.sh
1#!/bin/bash
2
3# Set up cargo-ndk and add the Android targets
4cargo install cargo-ndk
5rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
6
7# Build the dylib
8cargo build
9
10# Build the Android libraries in jniLibs
11cargo ndk -o ../GreetingAndroid/app/src/main/jniLibs \
12    --manifest-path ./Cargo.toml \
13    -t armeabi-v7a \
14    -t arm64-v8a \
15    -t x86 \
16    -t x86_64 \
17    build --release
18
19# Create Kotlin bindings
20cargo run --bin uniffi-bindgen generate --library ./target/debug/libgreeting.dylib --language kotlin --out-dir ../GreetingAndroid/app/src/main/java/dev/alfin/greetingandroid


1chmod +x build_android.sh
2./build_android.sh

Sekarang, kita telah belajar bagaimana cara membuat sebuah library di Rust yang bisa digunakan di platform iOS dan Android. Selanjutnya mungkin kamu bisa kembangkan lagi library-nya agar bisa digunakan juga di Web atau di Desktop.

Source code lengkap dari tutorial ini bisa kalian akses di sini: https://github.com/alfinsyahruddin/greeting-demo

RSS Feed

Sourcery: Meta-programming pada iOS

Sun, 09 Jun 2024 00:00:00 GMT

Menulis kode adalah kegiatan yang paling saya sukai, saya sudah menganggapnya sebagai hobi. Namun, menulis kode yang repetitif adalah kegiatan yang paling saya benci. Mungkin bukan benci, tapi lebih ke malas saja. 😅

Contohnya adalah ketika menulis kode unit testing, kita perlu membuat mock dari sebuah protocol. Bayangkan kalau kita punya puluhan protocol, dan di protocol tersebut mempunyai banyak sekali functions! Dan yang paling repot adalah jika kita ingin menambahkan 1 function baru ke protocol, kita juga harus menambahkan juga ke mock kita satu per-satu. 😭

Nah, untuk mengatasi permasalahan tersebut, kita bisa melakukan Meta-programming.

Apa itu Meta-programming?

Meta-programming adalah teknik pemrograman di mana program komputer dapat menulis, memodifikasi, atau menghasilkan program lain, atau bahkan mengubah dirinya sendiri saat berjalan.

Chat GPT

Jadi, dengan Meta-programming kita bisa membuat program yang dapat memodifikasi dan menghasilkan program lain dari program yang ada. Sehingga kode yang kita tulis menjadi lebih dinamis, efisien dan tidak terlalu banyak boilerplate code.

Berikut adalah manfaat dari Meta-programming:

Meminimalisir penulisan kode yang repetitif
Mempercepat proses development aplikasi
Menghindari Human Error
Kode yang dihasilkan lebih efisien
Meningkatkan Developer Experience

Sourcery

Sourcery merupakan salah satu library open-source Meta-programming untuk bahasa pemrograman Swift. Sourcery memungkinkan kita untuk meng-generate boilerplate code secara otomatis.

Sourcery telah digunakan oleh lebih dari 40.000 project, termasuk Airbnb, Bumble, dan New York Times.

Fitur Sourcery

Lalu, apa saja yang bisa diotomatisasi oleh Sourcery ?

Bahkan Sourcery dapat meng-generate UI secara otomatis, kita hanya perlu mendefinisikan struktur datanya! Automatic Settings

Cara kerja Sourcery

Jika tanpa Sourcery, Xcode akan langsung mengkompilasi kode yang kita tulis menjadi sebuah aplikasi.

Tanpa Sourcery

Nah, jika menggunakan Sourcery, ada 1 proses tambahan yang dilakukan oleh Sourcery sebelum proses kompilasi kode, Sourcery akan meng-generate suatu kode dari Template yang telah kita berikan.

Dengan Sourcery

Setup Project

Oke, sekarang kita akan coba menyelesaikan permasalahan kita di awal tentang bagaimana cara membuat mock secara otomatis menggunakan Sourcery.

Silakan buka Xcode dan buatlah project baru bernama "SourceryDemo" dan jangan lupa centang "Include Tests".

Setup Project

Instalasi Sourcery

Untuk menggunakan Sourcery, silakan download zip yang berisi binary dari Sourcery pada link di bawah ini terlebih dahulu: https://github.com/krzysztofzablocki/Sourcery/releases/tag/2.2.4

Setelah ter-download, extract dan cari binary sourcery, kemudian buat folder bernama "sourcery" di dalam project "SourceryDemo" dan pindahkan binary sourcery ke dalam folder tersebut.

Membuat File Konfigurasi

Masih di dalam folder "sourcery", silakan buat file baru bernama ".sourcery.yml" yang berisi:

.sourcery.yml
1configurations:
2  - sources:
3      - ../SourceryDemo/
4    templates:
5      - ./templates/
6    output:
7        path: ../SourceryDemo/Generated/
8        link:
9          project: ../SourceryDemo.xcodeproj
10          targets: [SourceryDemo]
11          group: SourceryDemo/Generated

Pada file konfigurasi di atas, ada 3 bagian, yaitu:

sources: Letak Source Code kita.
templates: Letak template-template yang akan digunakan Sourcery untuk meng-generate code.
output: Letak dimana hasil generate code akan disimpan.

Membuat Template

Sourcery menggunakan template language bernama Stencil. Sintaksnya sangat mirip dengan Django dan Mustache.

Silakan buat folder bernama "templates" di dalam folder "sourcery".

Kemudian download template Sourcery yang kita ingin kita gunakan di sini: https://krzysztofzablocki.github.io/Sourcery/mocks.html

setelah di-download, pindahkan ke folder "templates". Sehingga struktur file kita akan menjadi seperti ini:

Struktur File

Menambahkan Run Script

Agar setiap kali kita melakukan build, Sourcery akan meng-generate code. Silakan buat Run Script baru dengan cara klik project SourceryDemo -> Build Phases -> New Run Script Phase

New Run Script

Ubah isi dari Run Script menjadi:


1./sourcery/sourcery --config ./sourcery/.sourcery.yml

kemudian pindahkan urutannya sebelum phase "Compile Sources"

Run Script

Terakhir, kita perlu mengubah "User Script Sandboxing" menjadi "NO" pada Build Settings.

Build Settings

Menggunakan Template

Sebelum menggunakan template, kita akan membuat sample code terlebih dahulu, silakan buat file bernama "UserService.swift" dan ubah isinya menjadi seperti ini:

UserService.swift
1protocol UserServiceProtocol {
2    func login() -> Bool
3}
4
5class UserService: UserServiceProtocol {
6    func login() -> Bool {
7        return false
8    }
9}

Nah, untuk menggunakan template "AutoMockable" yang telah kita tambahkan tadi, caranya sangat mudah:


2// sourcery: AutoMockable
3protocol UserServiceProtocol {

Setelah dicompile, secara otomatis Sourcery akan meng-generate sebuah class bernama UserServiceProtocolMock di dalam group "Generated".

Dan kita pun bisa langsung menggunakan class tersebut pada kode Unit Test kita 🎉


1func testExample() throws {
2    let userService = UserServiceProtocolMock()
3    userService.loginBoolClosure = { true }
4    XCTAssertTrue(userService.login())
5}

What's Next?

Sekarang kita telah belajar tentang Apa itu Meta-programming, Apa itu Sourcery, Cara kerja Sourcery, serta bagaimana cara menggunakannya.

Selanjutnya, kamu bisa coba eksperimen menggunakan template-template Sourcery yang lain atau bahkan membuat template sendiri sesuai dengan kebutuhan di project kamu.

Source code lengkapnya bisa kamu akses melalui link berikut: https://github.com/alfinsyahruddin/SourceryDemo

RSS Feed

Bluetooth Low Energy (BLE) pada iOS

Sat, 20 Apr 2024 00:00:00 GMT

Mulai dari Earphone Wireless yang kita pakai untuk mendengarkan musik, Smartwatch yang kita gunakan untuk memonitor kesehatan kita, sampai dengan Beacon yang terdapat di museum, bisa hadir karena adanya teknologi Bluetooth Low Energy (BLE).

Pada artikel ini, kita akan belajar mengenai Apa itu BLE, Perbedaan BLE dengan Classic Bluetooth, Generic Attribute Profile (GATT), serta bagaimana cara membuat Peripheral dan Central menggunakan framework Core Bluetooth.

Apa itu BLE?

Bluetooth Low Energy atau yang biasa dikenal dengan BLE merupakan protokol terbaru dari Bluetooth yang mengoptimalkan kinerja Bluetooth dalam aspek efektivitas pengunaan daya sehingga akan mengonsumsi lebih sedikit daya daripada Bluetooth versi sebelumnya (Classic Bluetooth).

Umumnya beacon atau perangkat-perangkat IoT seperti sensor suhu itu harus mengirimkan data secara berkala, maka sumber daya atau energi listrik menjadi faktor yang sangat krusial, nah teknologi BLE hadir untuk menyelesaikan permasalahan tersebut karena teknologi BLE sangat efisien dalam pemakaian baterai.

BLE vs Classic Bluetooth

Perbedaan utama dari BLE dengan Classic Bluetooth adalah dari segi konsumsi sumber daya-nya. Sebagai perbandingan, 1 Watt Classic Bluetooth setara dengan 0.01-0.5 Watt BLE!

Kemudian latency BLE juga lebih rendah dibandingkan dengan Classic Bluetooth, BLE 6 ms, sedangkan Classic Bluetooth sekitar 100 ms.

Namun untuk jangkauan sinyal yang bisa dipancarkan lebih unggul Classic Bluetooth, yaitu sekitar 10-100 meter, sedangkan BLE maksimal hanya 10 meter saja.

Kekurangan lain dari BLE adalah mengenai Data Rate yang lebih rendah dibandingkan Classic Bluetooth yaitu sekitar 1-3 Mbps, sedangkan BLE hanya 1 Mbps.

Kemudian perbedaan terakhir adalah Classic Bluetooth perlu melakukan Pairing Device untuk melakukan transfer data, sedangkan BLE tidak perlu.

Dari beberapa perbedaan di atas, bisa disimpulkan bahwa Classic Bluetooth cocok digunakan untuk mengirimkan data antar device yang berukuran agak besar seperti video, dll dengan jarak yang agak jauh. Sedangkan BLE cocok untuk mengirimkan data secara berkala dalam waktu yang lama seperti sensor perangkat IoT dan Beacon.

Peripheral vs Central

Perangkat Bluetooth Low Energy (BLE) dapat memiliki peran antara menjadi Peripheral atau menjadi Central, tidak bisa keduanya. Peripheral bisa dianalogikan sebagai Server dan Central sebagai Client.

Contohnya adalah Smartwatch yang mengirimkan data detak jantung kepada HP kita, dalam contoh tersebut Smartwatch berperan sebagai Peripheral, dan HP kita berperan sebagai Central karena HP kita lah yang menerima data dari Smartwatch (Central).

Satu Peripheral dapat terhubung dengan beberapa Central, dan Satu Central dapat terhubung dengan beberapa Peripheral dalam satu waktu.

Generic Attribute Profile (GATT)

Generic Attribute Profile atau yang biasa disebut dengan GATT merupakan sebuah protokol yang mendefinisikan cara bagaimana 2 perangkat BLE untuk saling mengirim dan menerima data.

GATT Profile

Sebuah Peripheral disebut juga sebagai GATT Server, karena berperan untuk menyediakan layanan kepada Central (GATT Client). GATT Server perlu mengimplementasikan GATT Profile dalam mendefiniskan layanan yang bisa digunakan oleh GATT Client.

Ada 5 bagian dalam GATT Profile, yaitu:

1. Profile

Profile merupakan bagian terluar pada GATT. Satu Profile dapat mempunyai beberapa Service. Contohnya adalah Profile Alat Pengukur Suhu mempunyai Service Suhu Celcius dan Service Suhu Fahrenheit.

2. Service

Service merupakan gabungan beberapa Characteristic yang memiliki keterkaitan. Contohnya adalah Service Suhu Celcius mempunyai Characteristic Rata-Rata Suhu Seminggu Terakhir, Characteristic Suhu Real-Time, dll.

3. Characteristic

Characteristic merupakan bagian utama pada GATT, satu Characteristic merepresentasikan satu layanan atau fitur yang ada pada Peripheral (GATT Server). Contohnya adalah Characteristic Rata-Rata Suhu Seminggu Terakhir.

4. Value

Value merupakan data yang terdapat pada Characteristic. Contohnya adalah Characteristic Rata-Rata Suhu Seminggu Terakhir mempunyai Value 30° Celcius.

5. Descriptor

Setiap Characteristic dapat mempunyai beberapa Descriptor. Sesuai namanya, Descriptor bertujuan untuk mendeskripsikan suatu Characteristic, misalnya fungsi dari Characteristic tersebut, format datanya, dll.

Setup Project

Sekarang, kita akan mengimplementasikan Bluetooth Low Energy pada iOS, Kita akan membuat aplikasi sederhana bernama "Bluetify" yang dapat berperan sebagai Peripheral atau sebagai Central.

Hasil akhirnya nanti akan seperti ini:

Bluetify

Untuk melakukan testing aplikasi "Bluetify" ini, kita memerlukan 2 buah iPhone, yang satu berperan sebagai Peripheral dan yang satunya sebagai Central.

Download Starter Project

Silakan download starter projectnya terlebih dahulu di link berikut, pilih branch "starter":

https://github.com/alfinsyahruddin/Bluetify/tree/starter

Jika sudah, silakan buka projectnya melalui Xcode.

Struktur Project

Pada project "Bluetify", terdapat 2 folder utama yaitu "BluetifyKit" dan "UI".

1. BluetifyKit

BluetifyKit berisi logic utama yang ada pada aplikasi ini.

Folder Enums

Bluetify: Berisi konfigurasi aplikasi Bluetify, seperti Nama Peripheral, dll.
BluetifyUUID: Berisi kumpulan UUID yang ada pada Peripheral.
State: Berisi UI State aplikasi kita.

Folder Helpers

DataHelper: Digunakan untuk konversi tipe data Data ke tipe data lain dan sebaliknya.

BluetifyPeripheralKit.swift

Sebuah Class yang berfungsi untuk melakukan advertising data dan mengirim notifikasi kepada Central. Semua logic dan detail implementasi terkait dengan Peripheral akan kita tambahkan di class ini.

BluetifyCentralKit.swift

Sebuah Class yang berfungsi untuk melakukan scanning Peripheral, subscribe notifikasi dan mengirim message ke Peripheral. Semua logic dan detail implementasi terkait dengan Central akan kita tambahkan di class ini.

2. UI

Untuk membuat User Interface (UI) pada project ini, kita menggunakan SwiftUI karena syntax-nya sangat ringkas dan dapat mempercepat proses pembuatan UI jika dibandingkan dengan UIKit.

Folder Core

Berisi komponen-komponen UI yang dapat digunakan di banyak tempat.

Folder Pages

Berisi semua halaman yang ada pada aplikasi Bluetify.

Menambahkan Permission

Untuk menggunakan fitur Bluetooth pada aplikasi kita, kita perlu menambahkan 2 permission berikut pada file Info.plist:

Info.plist
1<key>NSBluetoothPeripheralUsageDescription</key>
2<string>For advertising data.</string>
3
4<key>NSBluetoothAlwaysUsageDescription</key>
5<string>For transfer data between devices.</string>

Membuat Peripheral

Silakan buka file "BluetifyPeripheralKit.swift". Untuk membuat Peripheral, kita akan memodifikasi isi dari file ini.

Peripheral Manager

Silakan tambahkan code berikut sebelum init:


1private var peripheralManager: CBPeripheralManager!

dan code berikut di dalam init untuk membuat instance dari CBPeripheralManager


1override init() {
2    super.init()
3
5    peripheralManager = CBPeripheralManager(delegate: self, queue: nil)
6}

Advertising

Advertising merupakan proses dari Peripheral untuk melakukan broadcast data kepada Central. Advertising bertujuan agar Central dapat mendeteksi Peripheral, melakukan koneksi dan bertukar data dengan Peripheral.

Silakan tambahkan code berikut di atas init:


1private var deviceNameCharacteristic: CBMutableCharacteristic?
2private var messageCharacteristic: CBMutableCharacteristic?
3private var notificationCharacteristic: CBMutableCharacteristic?

Kemudian ubah implementasi dari function startAdvertising menjadi seperti ini:


1private func startAdvertising() {
2    print("[PERIPHERAL] Start Advertising...")
3
4    peripheralManager.removeAllServices()
5
6    self.deviceNameCharacteristic = CBMutableCharacteristic(
7        type: BluetifyUUID.deviceNameCharacteristic.cbuuid,
8        properties: [.read],
9        value: nil,
10        permissions: [.readable]
11    )
12
13    self.deviceNameCharacteristic!.descriptors = [
14        CBMutableDescriptor(
15            type: CBUUID(string: CBUUIDCharacteristicUserDescriptionString),
16            value: NSString(string: "Characteristic for reading peripheral device names.")
17        )
18    ]
19
20    self.messageCharacteristic = CBMutableCharacteristic(
21        type: BluetifyUUID.messageCharacteristic.cbuuid,
22        properties: [.write],
23        value: nil,
24        permissions: [.writeable]
25    )
26
27    self.notificationCharacteristic = CBMutableCharacteristic(
28        type: BluetifyUUID.notificationCharacteristic.cbuuid,
29        properties: [.notify],
30        value: nil,
31        permissions: [.readable]
32    )
33
34    let mainService = CBMutableService(type: BluetifyUUID.mainService.cbuuid, primary: true)
35
36    mainService.characteristics = [
37        deviceNameCharacteristic,
38        messageCharacteristic,
39        notificationCharacteristic
40    ].compactMap { $0 }
41
42    peripheralManager.add(mainService)
43
44    state = .advertising
45    peripheralManager.startAdvertising([
46        CBAdvertisementDataLocalNameKey: Bluetify.peripheralName.rawValue,
47        CBAdvertisementDataServiceUUIDsKey: [BluetifyUUID.mainService.cbuuid]
48    ])
49}

Pada code di atas, kita membuat sebuah Peripheral yang mempunyai 1 service bernama mainService, dan mainService tersebut memiliki 3 Characteristics, yaitu:

deviceNameCharacteristic: Informasi Nama Peripheral yang dapat dibaca oleh Central.
messageCharacteristic: Message yang dapat dikirim oleh Central.
notificationCharacteristic: Notifikasi yang akan dibroadcast ke Central.

Tiap Service dan Characteristic yang kita buat, kita perlu membuat UUID-nya. Pada project ini, kamu bisa melihat UUID tersebut pada enum BluetifyUUID.

Kita juga telah menambahkan Descriptor pada deviceNameCharacteristic dengan tipe CBUUIDCharacteristicUserDescriptionString yang bertujuan untuk memberi tahu Central mengenai deskripsi dari Characteristic tersebut.

Kamu bisa melihat tipe apa saja yang bisa digunakan untuk membuat Descriptor di sini: https://developer.apple.com/documentation/corebluetooth/cbdescriptor

Function startAdvertising akan kita panggil setelah bluetooth pada iPhone menyala. Silakan tambahkan code berikut pada delegate CBPeripheralManagerDelegate:


1func peripheralManagerDidUpdateState(_ peripheral: CBPeripheralManager) {
2    print("[PERIPHERAL] State: \(peripheral.state)")
3
4    switch peripheral.state {
5    case .unknown, .unsupported, .unauthorized, .resetting, .poweredOff:
6        self.state = .bluetoothUnavailable
7    case .poweredOn:
8        self.startAdvertising()
9    @unknown default:
10        self.state = .bluetoothUnavailable
11    }
12}

Pada saat user keluar dari halaman Peripheral Mode, kita perlu memberhentikan Advertising. Silakan ubah implementasi dari function stopAdvertising menjadi seperti ini:


1public func stopAdvertising() -> Void {
2    print("[PERIPHERAL] Stop Advertising.")
3
4    state = .bluetoothUnavailable
5    peripheralManager.stopAdvertising()
6}

Read

Agar Central dapat membaca Device Name dari Peripheral, silakan tambahkan code berikut pada delegate CBPeripheralManagerDelegate:


1func peripheralManager(_ peripheral: CBPeripheralManager, didReceiveRead request: CBATTRequest) {
2    let characteristic = BluetifyUUID(rawValue: request.characteristic.uuid.uuidString)
3
4    switch characteristic {
5    case .deviceNameCharacteristic:
6        request.value = deviceName.asData()
7    default:
8        break
9    }
10
11    peripheral.respond(to: request, withResult: .success)
12}

Write

Agar Peripheral dapat menerima Message yang dikirim dari Central, silakan tambahkan code berikut pada delegate CBPeripheralManagerDelegate:


1func peripheralManager(_ peripheral: CBPeripheralManager, didReceiveWrite requests: [CBATTRequest]) {
2    for request in requests {
3        let characteristic = BluetifyUUID(rawValue: request.characteristic.uuid.uuidString)
4
5        switch characteristic {
6        case .messageCharacteristic:
7            guard let newMessage = request.value?.asString() else { break }
8            print("[PERIPHERAL] New Message: \(newMessage)")
9
10            message = newMessage
11        default:
12            break
13        }
14
15        peripheral.respond(to: request, withResult: .success)
16    }
17}

Notification

Untuk mengirim notifikasi dari Peripheral ke Central, silakan ubah implementasi pada function sendNotification menjadi seperti ini:


1public func sendNotification(_ text: String) -> Void {
2    guard let notificationCharacteristic else { return }
3
4    peripheralManager.updateValue(
5        text.asData(),
6        for: notificationCharacteristic,
7        onSubscribedCentrals: notificationCharacteristic.subscribedCentrals
8    )
9
10    print("[PERIPHERAL] Send Notification: \(text)")
11}

Membuat Central

Silakan buka file "BluetifyCentralKit.swift". Untuk membuat Central, kita akan memodifikasi isi dari file ini.

Central Manager

Silakan tambahkan code berikut sebelum init:


1private var centralManager: CBCentralManager!
2private var peripheral: CBPeripheral?

dan code berikut di dalam init untuk membuat instance dari CBCentralManager


1override init() {
2    super.init()
3
5    centralManager = CBCentralManager(delegate: self, queue: nil)
6}

Scanning

Scanning merupakan proses dari Central untuk mendeteksi Peripheral. Jika Peripheral terdeteksi, maka Central bisa melakukan koneksi ke Peripheral tersebut, dan setelah terhubung dengan Peripheral, Central dapat melakukan Read, Write, dan Subscribe Notification ke pada Peripheral yang terhubung.

Silakan tambahkan code berikut di atas init:


1private var peripheral: CBPeripheral?
2private var deviceNameCharacteristic: CBCharacteristic?
3private var messageCharacteristic: CBCharacteristic?
4private var notificationCharacteristic: CBCharacteristic?

Kemudian ubah implementasi dari function startScanning menjadi seperti ini:


1public func startScanning() -> Void {
2    print("[CENTRAL] Start Scanning...")
3    state = .scanning
4    centralManager.scanForPeripherals(withServices: [BluetifyUUID.mainService.cbuuid])
5}

Pada code di atas, kita melakukan scanning untuk mencari Peripheral yang mempunyai Service dengan UUID Main Service yang ada pada BluetifyUUID.

Function startScanning akan kita panggil setelah bluetooth pada iPhone menyala. Silakan tambahkan code berikut pada delegate CBCentralManagerDelegate:


1func centralManagerDidUpdateState(_ central: CBCentralManager) {
2    print("[CENTRAL] State: \(central.state)")
3
4    switch central.state {
5    case .unknown, .unsupported, .unauthorized, .resetting, .poweredOff:
6        self.state = .bluetoothUnavailable
7    case .poweredOn:
8        self.startScanning()
9    @unknown default:
10        self.state = .bluetoothUnavailable
11    }
12}

Pada saat user keluar dari halaman Central Mode, kita perlu memberhentikan Scanning. Silakan ubah implementasi dari function stopScanning menjadi seperti ini:


1public func stopScanning() -> Void {
2    print("[CENTRAL] Stop Scanning.")
3    centralManager.stopScan()
4}

Connection

Setelah proses Scanning, kita perlu melakukan koneksi terhadap Peripheral yang kita inginkan agar kita bisa bertukar data dengan Peripheral tersebut.

Pada delegate CBCentralManagerDelegate, silakan tambahkan code berikut:


1func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String: Any], rssi RSSI: NSNumber) {
2    guard let peripheralName = peripheral.name else { return }
3
4    print("[CENTRAL] Peripheral: `\(peripheralName)`")
5
6    print("[CENTRAL] Connecting...")
7    centralManager.connect(peripheral, options: nil)
8
9    self.peripheral = peripheral
10}
11
12
13func centralManager(_ central: CBCentralManager, didConnect peripheral: CBPeripheral) {
14    print("[CENTRAL] Connected")
15
16    peripheral.delegate = self
17    peripheral.discoverServices(nil)
18
19    state = .connected
20}

Setelah berhasil terkoneksi dengan Peripheral, kita perlu mengimplementasikan delegate CBPeripheralDelegate

Silakan tambahkan code berikut pada delegate CBPeripheralDelegate:


1func peripheral(_ peripheral: CBPeripheral, didDiscoverServices error: Error?) {
2    guard let services = peripheral.services else { return }
3
4    for service in services {
5        peripheral.discoverCharacteristics(nil, for: service)
6    }
7}
8
9func peripheral(_ peripheral: CBPeripheral, didDiscoverCharacteristicsFor service: CBService, error: Error?) {
10    guard let characteristics = service.characteristics else { return }
11
12    print("[CENTRAL] Total characteristics: \(characteristics.count)")
13
14    for characteristic in characteristics {
15        if characteristic.uuid == BluetifyUUID.deviceNameCharacteristic.cbuuid {
16            self.deviceNameCharacteristic = characteristic
17            self.readDeviceName()
18        }
19
20        if characteristic.uuid == BluetifyUUID.messageCharacteristic.cbuuid {
21            self.messageCharacteristic = characteristic
22        }
23
24        if characteristic.uuid == BluetifyUUID.notificationCharacteristic.cbuuid {
25            self.notificationCharacteristic = characteristic
26            self.subscribeNotification()
27        }
28    }
29}

Pada code di atas, kita mencari 3 Characteristic, yaitu:

deviceNameCharacteristic: Informasi Nama Peripheral yang akan dibaca oleh Central.
messageCharacteristic: Message yang akan dikirim oleh Central.
notificationCharacteristic: Notifikasi yang dibroadcast ke Central.

Pada saat pertama kali terhubung dengan Peripheral yang kita inginkan, kita panggil function readDeviceName untuk membaca Device Name dari Peripheral dan function subscribeNotification agar dapat menerima notifikasi dari Peripheral.

Read

Agar Central dapat membaca Device Name dari Peripheral, silakan tambahkan code berikut pada delegate CBPeripheralDelegate:


1func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?) {
2    if characteristic.uuid == BluetifyUUID.deviceNameCharacteristic.cbuuid {
3        let deviceName = characteristic.value?.asString() ?? "-"
4        print("[CENTRAL] DEVICE NAME: \(deviceName)")
5        self.deviceName = deviceName
6    }
7}

Dan ubah implementasi dari function readDeviceName menjadi seperti ini:


1public func readDeviceName() -> Void {
2    guard let deviceNameCharacteristic else { return }
3    peripheral?.readValue(for: deviceNameCharacteristic)
4}

Write

Agar Central dapat mengirim Message ke Peripheral, silakan ubah implementasi dari function sendMessage menjadi seperti ini:


1public func sendMessage(_ text: String) -> Void {
2    guard let messageCharacteristic else { return }
3    peripheral?.writeValue(text.asData(), for: messageCharacteristic, type: .withResponse)
4}

Notification

Agar dapat menerima notifikasi dari Peripheral, silakan tambahkan code berikut pada function peripheral(_:didUpdateValueFor:error:):


1func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?) {
2    if characteristic.uuid == BluetifyUUID.deviceNameCharacteristic.cbuuid {
3        let deviceName = characteristic.value?.asString() ?? "-"
4        print("[CENTRAL] DEVICE NAME: \(deviceName)")
5        self.deviceName = deviceName
6    }
7
9    if characteristic.uuid == BluetifyUUID.notificationCharacteristic.cbuuid {
10        let notification = characteristic.value?.asString() ?? "-"
11        print("[CENTRAL] NOTIFICATION: \(notification)")
12        self.notification = notification
13    }
15}

Dan ubah implementasi dari function subscribeNotification menjadi seperti ini:


1public func subscribeNotification() -> Void {
2    guard let notificationCharacteristic else { return }
3    peripheral?.setNotifyValue(true, for: notificationCharacteristic)
4}

What's Next?

Sekarang kita telah belajar mengenai Apa itu BLE, Perbedaan BLE dengan Classic Bluetooth, Generic Attribute Profile (GATT), serta bagaimana cara membuat Peripheral dan Central menggunakan framework Core Bluetooth.

Selanjutnya, kamu bisa kembangkan lagi aplikasi Bluetify ini misalnya menambahkan Service dan Characteristic baru, melakukan pertukaran data di Mode Background, mengintegrasikan Core Bluetooth dengan WatchOS, dll.

RSS Feed

CI/CD aplikasi iOS dengan Xcode Cloud

Sat, 27 Jan 2024 00:00:00 GMT

Proses distribusi aplikasi iOS yang kita buat, biasanya memerlukan proses yang cukup panjang, mulai dari melakukan pengujian, code signing, increment build number, melakukan build, menyiapkan screenshot, kemudian yang terakhir kita perlu untuk meng-upload ke Testflight dan AppStore.

Untuk mengatasi hal tersebut, kita bisa menerapkan CI/CD pada project kita.

Apa itu CI/CD ?

CI/CD merupakan singkatan dari Continuous Integration / Continuous Delivery atau Deployment. CI/CD dapat membantu kita dalam membuat otomatisasi proses distribusi aplikasi.

Jadi, ketika kita melakukan perubahan kode pada Git Repository, proses distribusi aplikasi akan berjalan secara otomatis.

Sehingga kita bisa lebih fokus dalam mengembangkan aplikasi daripada menghabiskan waktu untuk melakukan hal-hal yang repetitif seperti distribusi aplikasi.

Manfaat CI/CD

Berikut adalah beberapa manfaat yang akan kita dapatkan apabila kita menerapkan CI/CD:

Lebih hemat waktu

Karena semua proses distribusi aplikasi dilakukan secara otomatis di cloud, maka kita akan punya lebih banyak waktu untuk melakukan hal-hal lain seperti mengembangkan fitur baru atau melakukan bug fixing.

Mempercepat distribusi aplikasi

Proses distribusi aplikasi juga akan menjadi lebih cepat karena tiap kali kita melakukan perubahan kode, maka proses distribusi akan dilakukan secara otomatis tanpa perlu khawatir ada step yang terlewat.

Mendeteksi bug lebih cepat

Jika kita menerapkan Unit Testing pada aplikasi kita, mungkin kita bisa menambahkan proses Testing pada pipeline CI yang kita buat. Sehingga apabila ada bug akan terdeteksi lebih cepat pada saat deployment, dan apabila ada bug maka kita perlu melakukan fixing agar pipeline CI yang kita buat bisa berjalan.

Siapa saja bisa melakukan distribusi aplikasi

Bayangkan jika dalam 1 team, hanya satu orang saja yang mengerti dan mempunyai provisioning profile untuk melakukan deployment. Lalu pada suatu hari seseorang tersebut sedang cuti, dan kebetulan ada kebutuhan untuk mendistribusikan aplikasi. 😅

Nah, dengan menerapkan CI/CD, semua orang dalam team bisa melakukan distribusi dan tidak terlalu bergantung dengan satu atau beberapa orang saja.

Menghindari Human Error

Jika kita melakukan deployment secara manual, ada step-step yang bisa jadi kita terlewat atau melakukan kesalahan, misalnya kita ingin build untuk environment Staging tapi yang kita build malah untuk environment Development, dll.

Tools CI/CD

Ada beberapa tools yang bisa kita gunakan untuk membuat CI/CD. Seperti Xcode Cloud, AppCenter, Fastlane, Codemagic, Jenkins, CircleCI, Travis CI, Github Actions, dll.

Namun pada tutorial kali ini, kita akan menggunakan Xcode Cloud. Alasannya karena Xcode Cloud menyediakan layanan untuk membuat CI/CD secara gratis. 🥳

Selain itu, Xcode Cloud juga menyediakan Graphical User Interface (GUI) yang terintegrasi langsung dengan Xcode, serta mempunyai cukup banyak fitur lainnya seperti Schedule Build, Menjalankan Test secara paralel, dll.

NOTE: Xcode Cloud gratis selama kita menghabiskan kurang dari 25 jam build time per bulan.

Persyaratan Xcode Cloud

Untuk menggunakan Xcode Cloud, ada beberapa persyaratan yang harus kita penuhi, yaitu:

Telah mendaftar Apple Developer Program
Xcode versi 14.0.1 atau lebih baru
Menggunakan Build System versi baru (Xcode 10)
Menggunakan "Automatic Code Signing"
Menggunakan Source Code Management (SCM) yang didukung oleh Xcode Cloud, seperti Github, Gitlab dan Bitbucket.

1. Setup Workflow

Workflow adalah konfigurasi untuk setiap step yang ingin dilakukan dalam proses CI/CD. Berikut adalah beberapa menu yang ada di dalam Workflow:

General
Environment
Start Condition
Actions
Post Actions

Untuk melakukan setup Workflow pada project kita, silakan buka projectnya di Xcode, kemudian pilih Report Navigator, kemudian pilih tab "Cloud", lalu klik "Get Started".

Setup Workflow

2. General

Pada menu General, kita bisa mengedit nama dari Workflow yang telah dibuat, deskripsi, repository, dan memilih project / workspace.

3. Environment

Pada menu Environment, kita bisa memilih versi Xcode dan macOS yang akan digunakan dalam proses CI/CD kita. Silakan pilih versi yang spesifik untuk menghindari behavior yang tidak diinginkan pada versi terbaru dari Xcode / macOS.

Lamu juga bisa mencentang opsi "Clean", jika tercentang Xcode akan melakukan build project kita tanpa cache.

Dan jika kamu ingin menaruh Environment Variable seperti API_KEY, BASE_URL, dll. Kamu bisa menambahkannya di menu ini.

4. Start Condition

Di menu ini, kita bisa mengatur kapan CI/CD akan dijalankan, Xcode Cloud menyediakan beberapa opsi yang dapat kita pilih, yaitu:

Ketika ada perubahan Pull Request (PR).
Ketika ada perubahan Tag.
Dijadwalkan, misalnya pada hari senin-jumat jam 5.30 sore.
Trigger Manual.

Kita juga bisa mencentang "Auto-cancel Build". Jadi, ketika ada build yang sedang berjalan dan kebetulan ada build baru di branch yang sama, maka Xcode Cloud akan secara otomatis membatalkan build yang sedang berjalan, dan akan melakukan build baru

5. Actions

Pada menu Actions, kita bisa melakukan konfigurasi untuk setiap step yang akan dilakukan dalam proses CI/CD. Seperti:

5.1 Build

Kita bisa mengatur Platform dan Scheme.

5.2 Test

Pada bagian Test, Kita bisa menentukan apakah kita ingin melakukan deployment hanya jika Test yang kita buat telah lolos. Kita juga bisa memilih versi iPhone dan iOS yang ingin kita gunakan untuk menjalankan Test kita.

5.3 Analyze

Pada bagian Analyze, Kita bisa menentukan apakah kita ingin melakukan deployment hanya jika Static Analyzer telah lolos. Static Analyzer adalah tool untuk mendeteksi source code kita tanpa menjalankannya, Static Analyzer dapat mendeteksi Infinite Loops, Variable yang tidak terpakai, dan masih banyak lagi.

5.4 Archive

Kita bisa melakukan konfigurasi Persiapan Deployment kita, Xcode Cloud menyediakan 3 opsi, yaitu:

None
Testflight (Internal Testing)
Testflight (External Testing) & AppStore

6. Post Actions

Di menu ini, kita bisa menambahkan sebuah action yang akan dijalankan setelah step Build, Test, Analyze, dan Archive telah berhasil. Contohnya kita ingin melakukan:

Mengirim Notifikasi melalui Email / Slack kepada Team Developer jika proses CI/CD kita gagal.
Membuat aplikasi beta kita tersedia di Testflight (Internal & External Testing).

Untuk mengaktifkan "External Testing", pastikan opsi "Deployment Preparation" di menu Actions -> Archive telah diset menjadi "Testflight & AppStore"

7. Test Notes

Kita bisa menambahkan Test Notes ketika kita mendistribusikan versi beta aplikasi kita dari Xcode Cloud melalui Testflight untuk memberikan detail mengenai perubahan apa saja dari aplikasi kita serta scope yang perlu ditest.

Test Notes yang telah kita buat akan muncul pada bagian "What to test" di aplikasi Testflight. Kita bisa membuat Test Notes untuk lebih dari 1 bahasa dan locale.

Berikut adalah beberapa informasi yang dapat kita cantumkan dalam Test Notes:

Fitur yang kita tambahkan dalam aplikasi kita
Issue atau Bug yang telah kita perbaiki.
Message dari commit terkait dengan perubahan kode kita.

Step untuk membuat Test Notes:

Buka Project atau Workspace di Xcode.
Buat group baru bernama "Testflight" di hirarki terluar project kita.
Buat file baru di dalam group "Testflight" bernama "WhatToTest.[LOCALE].txt". Untuk [LOCALE], gunakan kode bahasa dan negara yang digunakan dalam konten file tersebut. Contohnya, gunakan "WhatToTest.en-US.txt"
Isi konten dari file tersebut.
Commit dan Push file tersebut ke Remote Repository.

Test Notes

Pada deployment selanjutnya, Xcode Cloud akan secara otomatis mencari file ini, dan menambahkan isi file tersebut pada bagian "What to test" di aplikasi Testflight.

8. Set Next Build Number

Xcode Cloud menetapkan sebuah build number pada saat proses CI/CD kita berjalan. Build Number adalah sebuah angka yang akan ditambah +1 oleh Xcode Cloud di setiap build.

Namun, pada saat kita melakukan build aplikasi kita tidak menggunakan Xcode Cloud (contohnya kita melakukan build secara manual), Build Number yang ada di Xcode Cloud tidak lagi sinkron, Jadi kita perlu mengkonfigurasi Build Number yang ada di Xcode Cloud.

Berikut adalah step untuk mengedit Build Number di Xcode Cloud:

Kunjungi website App Store Connect.
Klik tab "Xcode Cloud", kemudian pilih "Settings" di sidebar
Klik tab Build Number
Klik tombol "Edit"
Masukkan Build Number selanjutnya, kemudian klik tombol "Save"

Set Build Number

9. Rollback

Dengan Xcode Cloud, kita bisa melakukan rollback aplikasi kita ke spesifik Build Number dengan sangat mudah!

Silakan klik menu "Report Navigator"
Pilih tab "Cloud"
Pilih spesifik Build Number yang kita ingin untuk deploy ulang.
Klik tombol "Rebuild"

Maka, Xcode Cloud akan melakukan rebuild dan deploy aplikasi kita berdasarkan Build Number yang kita pilih.

Rollback

CI/CD aplikasi iOS dengan AppCenter

Sun, 31 Dec 2023 00:00:00 GMT

Untuk mengatasi hal tersebut, kita bisa menerapkan CI/CD pada project kita.

Apa itu CI/CD ?

CI/CD merupakan singkatan dari Continuous Integration / Continuous Delivery atau Deployment. CI/CD dapat membantu kita dalam membuat otomatisasi proses distribusi aplikasi.

Jadi, ketika kita melakukan perubahan kode pada Git Repository, proses distribusi aplikasi akan berjalan secara otomatis.

Sehingga kita bisa lebih fokus dalam mengembangkan aplikasi daripada menghabiskan waktu untuk melakukan hal-hal yang repetitif seperti distribusi aplikasi.

Manfaat CI/CD

Berikut adalah beberapa manfaat yang akan kita dapatkan apabila kita menerapkan CI/CD:

Lebih hemat waktu

Mempercepat distribusi aplikasi

Mendeteksi bug lebih cepat

Siapa saja bisa melakukan distribusi aplikasi

Nah, dengan menerapkan CI/CD, semua orang dalam team bisa melakukan distribusi dan tidak terlalu bergantung dengan satu atau beberapa orang saja.

Menghindari Human Error

Tools CI/CD

Ada beberapa tools yang bisa kita gunakan untuk membuat CI/CD. Seperti AppCenter, Fastlane, Codemagic, Jenkins, CircleCI, Travis CI, Github Actions, dll.

Namun pada tutorial kali ini, kita akan menggunakan AppCenter. Alasannya karena AppCenter menyediakan layanan untuk membuat CI/CD secara gratis. 🥳

Selain itu, AppCenter juga menyediakan Graphical User Interface (GUI) untuk melakukan CI/CD, sehingga kita tidak perlu menuliskan script CI.

NOTE: AppCenter gratis selama kita menghabiskan kurang dari 240 menit build time per bulan.

1. Register ke AppCenter

Jika sebelumnya kamu belum pernah melakukan registrasi AppCenter, Silakan buka https://appcenter.ms/create-account dan buatlah akun baru.

2. Add new App

Klik button "Add New" di sebelah kanan, kemudian isi nama aplikasi dan tipe rilis.

Pilih OS "iOS", dan platform "Objective-C / Swift"

Add new App

3. Hubungkan Repository

Jika sudah membuat aplikasi di AppCenter, selanjutnya kita akan menghubungkan ke Repository di mana source code aplikasi tersebut berada.

Silakan klik menu "Build", pilih service git, dan pilih repositorynya.

4. Konfigurasi Build

Pada menu "Build", silakan klik menu "Config"

Build Configuration

Berikut adalah beberapa konfigurasi build yang bisa kita lakukan di AppCenter:

Build Scripts

Build Script digunakan jika kita ingin menjalankan command terkait dengan build project. Contohnya adalah kalau kita menggunakan Cocoapods sebagai Dependency Manager, maka kita perlu menjalankan command pod install terlebih dahulu, nah kita bisa memasukkan command-command tersebut ke dalam Build Scripts.

Kamu bisa mempelajari Build Scripts lebih lanjut di sini: https://learn.microsoft.com/en-us/appcenter/build/custom/scripts

Build Frequency

Di menu ini, kita bisa menentukan apakah kita ingin melakukan build tiap kali kita melakukan perubahan code di git atau kita trigger secara manual.

Auto Increment Build Number

Agar kita tidak perlu menaikkan build number tiap kali ingin build aplikasi, kita bisa mengaktifkan fitur "Automatically increment build number".

Kita juga bisa menentukan formatnya, apakah ingin Build ID (Number) atau Timestamp.

Sign Builds

Agar kita bisa melakukan distribusi ke Testflight atau ke AppStore, kita perlu mengaktifkan "Sign Build".

Setelah diaktifkan kita diminta untuk memberikan 2 file berikut:

Provisioning Profile (.mobileprovision)
Certificate (.p12)

Sign Builds

Certificate Signing Request (CSR)

Untuk mendapatkan file Certificate (.p12), kita perlu membuat Certificate Signing Request (CSR) terlebih dahulu.

File CSR mempunyai format .certSigningRequest

Silakan buka aplikasi "Keychain Access".
Pilih menu Keychain Access > Certificate Assistant > Request a Certificate from a Certificate Authority.
CSR
Setelah itu akan muncul dialog "Certificate Assistant", isi "Email Address", Common Name (Key untuk Certificate kita), CA Email Address biarkan kosong, dan "Request is" pilih "Saved to disk".
Certificate Assistant

Certificate

Untuk mendapatkan file Provisioning Profile, kita perlu membuat Certificate terlebih dahulu.

Silakan buka https://developer.apple.com/account kemudian pilih menu "Certificates"

Buat Certificate baru. Pada section "Software", pilih "Apple Distribution". klik "Continue".
Selanjutnya kita akan diminta untuk memberikan file Certificate Signing Request (CSR). Silakan upload file CSR yang telah kita buat tadi.
Terakhir klik "Continue", dan download certificate nya. maka file .cer akan terdownload. Nah, tapi yang dibutuhkan oleh AppCenter adalah file .p12 bukan .cer
Untuk mendapatkan file .p12, silakan klik 2x file .cer yang baru saja kita download, maka aplikasi "Keychain Access" akan terbuka. Pilih certificate kita -> klik kanan -> Export. Maka file .p12 akan terdownload.

Provisioning Profile

Untuk membuat file Provisioning Profile (.mobileprovision) Silakan buka https://developer.apple.com/account kemudian klik menu "Profiles"

Tambahkan "Profile" baru
Pada section "Distribution" pilih "App Store"
Pilih "App ID"
Pilih certificate yang telah kita buat tadi
Masukkan nama provisioning profile, misalnya "DemoAppCenter Distribution"
Klik "Generate" -> "Download"

Distribute Builds

Di AppCenter ada 2 metode untuk melakukan distribusi, yaitu Group (Distribution Tools milik AppCenter) dan Store (ke AppStore Connect).

Silakan pilih "Store" dan hubungkan ke akun AppStore Connect kita. Selanjutnya kita akan diminta untuk memberikan API Key dari AppStore Connect.

Buka https://appstoreconnect.apple.com/access/users
Pilih menu "Keys"
Klik button "+" untuk menambahkan key baru
Setelah menambahkan key baru, silakan klik "Download", maka file .p8 akan terdownload.

Silakan upload file .p8 yang telah kita download, masukkan Key Name, Issuer ID, dan Key ID. Kamu bisa melihat ketiga informasi tersebut di sini: https://appstoreconnect.apple.com/access/api

Setelah berhasil, silakan kembali ke menu "Build" pada AppCenter. Lalu di bagian Build Configuration -> Distribute Build -> Store -> Pilih "App Store Connect Users" -> Save.

5. Trigger Build

Sekarang tiap kali kita melakukan perubahan code di repository, secara otomatis AppCenter akan melakukan build dan distribusi aplikasi ke Testflight!

Untuk mengujinya, silakan lakukan perubahan code dan push ke remote repository.

AppCenter Build

Testflight

Troubleshooting

Apabila kamu menemukan error seperti ini:


1error: requires a provisioning profile. Select a provisioning profile in the Signing & Capabilities editor.
2** ARCHIVE FAILED **

Silakan buka projectmu melalui "Xcode"
Klik Target -> Signing & Capabilities -> Release -> Uncheck "Automatically manage signing"
Pilih Provisioning Profile yang sama dengan yang ada di AppCenter.

Kotlin DSL

Tue, 28 Nov 2023 00:00:00 GMT

Any fool can write code that a computer can understand. Good programmers write code that humans can understand.

Martin Fowler

Salah satu alasan mengapa bahasa Kotlin menjadi populer dan banyak disukai oleh para developer adalah karena syntax-nya yang ringkas dan mudah dimengerti.

Untuk menulis kode yang lebih ringkas, Kotlin memungkinkan kita untuk membuat Domain Specific Language atau DSL!

Apa itu DSL ?

DSL (Domain Specific Language) merupakan bahasa / syntax yang didesain khusus untuk bagian spesifik dari program kita. Kebalikan dari DSL adalah GPL (General Purpose Language) yaitu bahasa yang bisa digunakan untuk banyak bagian dari program kita, Contoh dari GPL adalah bahasa pemrograman Kotlin, Swift, dll.

Karena DSL didesain khusus untuk bagian tertentu dari program kita serta scope-nya lebih terfokus, maka hasil dari DSL yang kita buat akan jadi lebih ringkas & mudah untuk dibaca. Sehingga orang lain yang tidak mengerti detail implementasi dari kode kita pun tetap bisa memahami makna dari kode yang kita tulis.

Kotlin DSL

Contoh DSL

Berikut adalah contoh dari Domain Specific Language DSL pada Kotlin:

Gradle DSL

Salah satu contoh DSL yang paling populer adalah konfigurasi Gradle.


1plugins {
2    id("org.jetbrains.kotlin.jvm") version "1.8.20"
3}
4
5repositories {
6    mavenCentral()
7}
8
9dependencies {
10    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
11    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
12}

Koin DSL

Atau jika kamu pernah menggunakan library Koin untuk melakukan Dependency Injection, Koin juga mempunyai DSL sendiri.


1val appModule = module {
2    single { Service() }
3}
4
5startKoin {
6    logger()
7    modules(appModule)
8}

Karakteristik DSL

DSL mempunyai 2 karakteristik utama yaitu Context dan Fluency.

Context

Dengan adanya Context, kita tidak perlu lagi menuliskan kode-kode yang repetitif.

Contohnya jika tanpa Context, mungkin kode yang kita tulis akan seperti ini:

Tanpa Context
1val contact = Contact()
2contact.email = "me@alfin.dev"
3contact.phone = "088233104788"
4contact.ig = "alfinsyahruddin"
5myProfile.contact = contact

Namun dengan Context, kode kita akan menjadi lebih ringkas:

Dengan Context
1profile {
2  contact {
3    email = "me@alfin.dev"
4    phone = "088233104788"
5    ig = "alfinsyahruddin"
6  }
7}

Fluency

Dengan DSL, kita bisa menulis kode layaknya bahasa manusia sehingga kode kita akan lebih mudah untuk dibaca.

Perhatikan 2 kode di bawah ini, manakah menurutmu yang lebih mudah untuk dimengerti ketika pertama kali membaca kode tersebut? 😁

Regular Kotlin Code
1val dob = LocalDate.of(2003, Month.FEBRUARY, 10)

DSL
1val dob = 10 feb 2003

Internal vs External DSL

Ketika kita membuat DSL pada General Purpose Language seperti Kotlin, sebenarnya kita sedang membuat Internal DSL, karena kita menggunakan bahasa yang sudah ada (Kotlin). Kelebihannya kita bisa memanfaatkan fitur2 dari bahasa Kotlin tersebut seperti for-loop, Scope Functions, dll.

Di samping itu, ada juga External DSL, yaitu ketika kita membuat DSL dengan grammar, lexer, dan parser yang benar-benar baru. Contoh dari External DSL yang paling populer adalah SQL.

Membuat Custom DSL

Sekarang, kita akan belajar bagaimana cara membuat custom DSL pada Kotlin! 😃

Kita akan mengubah kode berikut:

Regular Kotlin Code
1val myProfile = Profile()
2myProfile.name = "Alfin"
3myProfile.dob = LocalDate.of(2003, Month.FEBRUARY, 10)
4
5val contact = Contact()
6contact.email = "me@alfin.dev"
7myProfile.contact = contact
8
9myProfile.interests += "TECH - Mobile Engineering"
10myProfile.interests += "TECH - Augmented Reality"
11myProfile.interests += "PHILOSOPHY - Libertarianism"

Menjadi seperti ini, tanpa mengubah struktur datanya:

DSL
1val myProfile = profile {
2    name = "Alfin"
3    dob = 10 feb 2003
4
5    contact {
6        email = "me@alfin.dev"
7    }
8
9    interests {
10        tech("Mobile Engineering")
11        tech("Augmented Reality")
12        philosophy("Libertarianism")
13    }
14}

Data Structure

Berikut adalah struktur data dari class Profile dan Contact :


1class Profile {
2    var name: String? = null
3    var dob: LocalDate? = null
4    var contact: Contact? = null
5    var interests = mutableListOf<String>()
6}
7
8class Contact {
9    var email: String? = null
10}

1. Lambda dengan Context Object

Agar kita bisa menggunakan syntax seperti ini:


1val myProfile = profile {
2    name = "Alfin"
3
4    contact {
5        email = "me@alfin.dev"
6    }
7}

Silakan tambahkan code berikut:


1fun profile(builder: Profile.() -> Unit): Profile {
2    return Profile().apply(builder)
3}
4
5fun Profile.contact(builder: Contact.() -> Unit) {
6    contact = Contact().apply(builder)
7}

Profile.() -> Unit akan memberikan Context Object dengan tipe data Profile di dalam lambda kita.


1val myProfile = profile { // this: Profile

apply merupakan salah satu dari 5 Scope Functions pada Kotlin. Baca juga: Scope Functions

2. Infix Function

Agar kita bisa menggunakan syntax seperti ini:


1dob = 10 feb 2003

Silakan tambahkan code berikut:


1infix fun Int.feb(year: Int): LocalDate = LocalDate.of(year, Month.FEBRUARY, this)

Infix Function memungkinkan kita untuk memanggil sebuah function tanpa perlu menuliskan tanda titik, kurang buka & kurung tutup.

10 feb 2003 jika tanpa Infix Function, kita perlu menuliskannya seperti ini: 10.feb(2003)

3. Lambda dengan Scope

Daripada kita menulis kode yang repetitif dan meng-hardcode topic seperti TECH, PHILOSOPHY seperti ini:


1myProfile.interests += "TECH - Mobile Engineering"
2myProfile.interests += "TECH - Augmented Reality"
3myProfile.interests += "PHILOSOPHY - Libertarianism"

Kita bisa merefactornya menggunakan Lambda dengan custom Scope menjadi seperti ini:


1interests { // this: InterestScope
2    tech("Mobile Engineering")
3    tech("Augmented Reality")
4    philosophy("Libertarianism")
5}

Silakan tambahkan kode berikut:


1fun Profile.interests(builder: InterestScope.() -> Unit) {
2    interests += InterestScope().apply(builder).interests
3}
4
5class InterestScope {
6    var interests: List<String> = mutableListOf()
7    private set
8
9    fun tech(topic: String) {
10        interests += "TECH - $topic"
11    }
12
13    fun philosophy(topic: String) {
14        interests += "PHILOSOPHY - $topic"
15    }
16}

4. Context Receiver

InterestScope yang baru saja kita buat sebenarnya masih ada issue, yaitu kita bisa menggunakan Scope tersebut di mana pun, bukankah seharusnya kita hanya bisa menggunakan Scope tersebut di dalam lambda profile saja ?

Untuk mengatasi hal tersebut, kita bisa memanfaatkan fitur pada Kotlin bernama Context Receiver, silakan modifikasi kodenya menjadi seperti ini:


2private object ProfileContext
3
4fun Profile.interests(builder: InterestScope.() -> Unit) {
6    with(ProfileContext) {
7        interests += InterestScope().apply(builder).interests
9    }
10}
11
13context(ProfileContext)
14class InterestScope {
15    var interests: List<String> = mutableListOf()
16    private set
17
18    fun tech(topic: String) {
19        interests += "TECH - $topic"
20    }
21
22    fun philosophy(topic: String) {
23        interests += "PHILOSOPHY - $topic"
24    }
25}

Jadi, ketika kita mencoba mengakses InterestScope dari luar lambda profile, maka akan muncul error seperti ini:

Context Receiver

NOTE: Pada saat artikel ini ditulis, Context Receiver merupakan fitur yang masih experimental, untuk menggunakannya, silakan tambahkan kode berikut di dalam file build.gradle.kts:

build.gradle.kts
1tasks.withType(KotlinCompile::class.java) {
2     kotlinOptions.freeCompilerArgs += "-Xcontext-receivers"
3}

Berikut adalah kode lengkap dari tutorial ini:

App.kt
1package dev.alfin.kotlincode
2
3import java.time.LocalDate
4import java.time.Month
5
6fun main() {
7    val myProfile = profile {
8        name = "Alfin"
9        dob = 10 feb 2003
10
11        contact {
12            email = "me@alfin.dev"
13        }
14
15        interests {
16            tech("Mobile Engineering")
17            tech("Augmented Reality")
18            philosophy("Libertarianism")
19        }
20    }
21}
22
23
24// MARK: - Data Structure
25
26class Profile {
27    var name: String? = null
28    var dob: LocalDate? = null
29    var contact: Contact? = null
30    var interests = mutableListOf<String>()
31}
32
33class Contact {
34    var email: String? = null
35}
36
37
38// MARK: - DSL
39
40fun profile(builder: Profile.() -> Unit): Profile {
41    return Profile().apply(builder)
42}
43
44fun Profile.contact(builder: Contact.() -> Unit) {
45    contact = Contact().apply(builder)
46}
47
48infix fun Int.feb(year: Int): LocalDate = LocalDate.of(year, Month.FEBRUARY, this)
49
50private object ProfileContext
51
52fun Profile.interests(builder: InterestScope.() -> Unit) {
53    with(ProfileContext) {
54        interests += InterestScope().apply(builder).interests
55    }
56}
57
58context(ProfileContext)
59class InterestScope {
60    var interests: List<String> = mutableListOf()
61    private set
62
63    fun tech(topic: String) {
64        interests += "TECH - $topic"
65    }
66
67    fun philosophy(topic: String) {
68        interests += "PHILOSOPHY - $topic"
69    }
70}

Referensi

RSS Feed

Scope Functions

Sun, 12 Nov 2023 00:00:00 GMT

Apa itu Scope Functions?

Scope Functions adalah function-function bawaan dari Kotlin yang bisa kita gunakan untuk mengeksekusi block kode di dalam scope sebuah object. dan di dalam scope tersebut kita bisa mengakses objectnya tanpa perlu menyebutkan namanya secara eksplisit.

Scope function sebenarnya tidak memberikan pengaruh apapun secara behavior, kita bisa saja menulis kode tanpa menggunakan scope function sama sekali. Namun dengan scope function, kode kita akan menjadi lebih ringkas dan mudah untuk dibaca.

Di Kotlin, terdapat 5 scope function yaitu let, with, run, apply, dan also. Kelima function tersebut mempunyai banyak kemiripan, sehingga kita kadang sulit untuk membedakannya.

Scope Functions

Nah, di artikel kali ini kita akan belajar apa saja sih perbedaan dari masing-masing function tersebut serta dalam case seperti apa kita akan menggunakannya.

3 Karakteristik Scope Functions

Agar lebih mudah dalam membedakan Scope Functions, kita perlu mengetahui karakteristik-karakteristik nya terlebih dahulu. berikut adalah 3 karakteristik dari Scope Functions:

1. Cara Pemanggilan

Ada 2 jenis pemanggilan Scope Functions, tergantung apakah Scope Functions tersebut merupakan Extension atau bukan.

Extension

Jika Scope Functions tersebut merupakan Extension maka kita panggil dengan dot lalu diikuti nama functionnya. Contohnya seperti ini:


1val name: String? = "kotlin"
2
3name?.let {
4    println(it.length)
5}

Berikut adalah Scope Functions yang merupakan Extension: let, run, apply, also

Bukan Extension

Tapi jika bukan Extension, kita tinggal panggil saja seperti function biasa. Contohnya seperti ini:


1val name = "kotlin"
2
3with(name) {
4    println(length)
5    println(reversed())
6}

Berikut adalah Scope Functions yang bukan merupakan Extension: run, with

Khusus Scope Function run, ada 2 cara untuk pemanggilannya, yaitu dengan cara dipanggil langsung atau melalui Extension.

2. Context Object

Context Object merupakan object yang tersedia di dalam lambda pada Scope Functions. Kita bisa mengakses object tersebut menggunakan this atau it. Berikut adalah kelebihan dan kekurangan dari kedua cara pengaksesan tersebut:

this

Kelebihan: Kita bisa mengakses properti dan method yang terdapat pada object this secara langsung tanpa perlu menuliskan this.
Kekurangan: Karena kita bisa mengakses secara langsung, jadi agak rancu apakah properti dan method yang kita akses itu apakah berasal dari object this atau berasal dari luar lambda?

Jadi, object reference this cocok digunakan jika di dalam lambda-nya kebanyakan hanya menggunakan properti & method milik dari object this saja.

Berikut adalah Scope Functions yang menggunakan object reference this:

run
with
apply

it

Kelebihan: Secara penulisan lebih singkat dari this, jadi akan lebih mudah untuk dibaca.
Kekurangan: Kita tidak bisa mengakses properti & method yang terdapat pada it secara langsung.

Jadi, object reference it cocok digunakan jika di dalam lambda-nya banyak menggunakan properti atau method dari luar Scope Functions.

Jika kamu mau, kamu juga bisa mengubah nama variabel it menjadi apapun yang kamu inginkan, contohnya seperti ini:


1Random.nextInt(100).also { randomValue ->
2    println(randomValue)
3}

Berikut adalah Scope Functions yang menggunakan object reference it:

let
also

3. Return Value

Kita juga perlu memperhatikan apa yang dikembalikan dari Scope Function yang ingin kita pakai, Apakah kita ingin yang dikembalikan adalah Context Object-nya atau hasil dari lambda kita (Lambda Result) ?

Context Object

Berikut adalah Scope Functions yang mengembalikan Context Object: apply, also


1val numberList = mutableListOf<Int>(1, 3, 2)
2numberList
3    .also { println("Sorting the list...") }
4    .sort()
5    .also { println("Sorted! ✅") }
6
7println(numberList)
8
9// RESULT:
10// Sorting the list...
11// Sorted! ✅
12// [1, 2, 3]

Lambda Result

Berikut adalah Scope Functions yang mengembalikan hasil dari lambda kita: let, run, with


1val animals = mutableListOf("🐥", "🐒", "🐥")
2val totalDucks = animals.run {
3    add("🐥")
4    add("🐥")
5    count { it == "🐥" }
6}
7println("There are $totalDucks ducks.")
8
9// RESULT:
10// There are 4 ducks.

Scope Functions

Setelah mengetahui karakteristik dari Scope Functions, kita akan belajar lebih detail terkait masing-masing dari Scope Functions serta contoh penggunaannya.

1. let

Let’s do the following stuff with it.

- Kotlin

Extension
Context Object: it
Return Value: Lambda Result

Scope Function let biasanya digunakan jika kita ingin melakukan sesuatu terhadap sebuah nullable object (object yang valuenya bisa null) dan kita ingin menghindari NullPointException.

Perhatikan contoh berikut:


1val name: String? = "kotlin"
2// val total = count(name) // ERROR: Type mismatch
3val total = name?.let {
4    println(it.reversed())
5    count(it) // OK
6}
7
8fun count(string: String): Int = string.length

Dengan menggunakan Scope Functions let, di dalam lambda-nya kita tidak perlu lagi menggunakan Safe Call Operator (?.) tiap kali kita mengakses variabel name.

Jika di dalam lambda let hanya memanggil 1 function saja dan function tersebut menerima it sebagai argumen, kamu bisa menggunakan method reference (::) untuk memperingkas kode.


2val total = name?.let(::count)
3
4fun count(): Int = "string".length

2. with

With this object, do the following.

- Kotlin

Bukan Extension
Context Object: this
Return Value: Lambda Result

Scope Function with biasanya digunakan untuk melakukan grouping pemanggilan function pada suatu variabel.

Contoh penggunaannya seperti ini:


1val name = "kotlin"
2with(name) {
3    println("The reversed of $this is ${reversed()}")
4}
5
6// RESULT:
7// The reversed of kotlin is niltok

3. run

Run the code block and return the result.

- Kotlin

Extension & Bukan Extension
Context Object: this
Return Value: Lambda Result

Scope Function run biasanya digunakan untuk melakukan inisialisasi object.

run mempunyai 2 cara untuk pemanggilannya, yaitu dengan cara dipanggil langsung atau melalui Extension.

Contoh penggunaannya seperti ini:


1val httpClient = HttpClient()
2
3// Extension
4val devHttpClient = httpClient.run {
5    baseURL = "http://dev.api.com"
6    timeout = 5000
7}
8
9// Bukan Extension
10val productionHttpClient = run {
11    val baseURL = "http://backend.com"
12    val timeout = 5000
13    HttpClient(baseURL, timeout)
14}
15
16class HttpClient(
17    var baseURL: String? = null,
18    var timeout: Int? = null
19)

4. apply

Apply the following assignments to the object.

- Kotlin

Extension
Context Object: this
Return Value: Context Object

Scope Function apply biasanya digunakan untuk melakukan konfigurasi object.


1val httpClient = HttpClient("http://backend.com")
2
3httpClient.apply {
4    timeout = 10_000
5}

5. also

And also do the following with the object.

- Kotlin

Extension
Context Object: it
Return Value: Context Object

Scope Function also biasanya digunakan untuk melakukan suatu action ketika sebuah object telah diinisialisasi. Misalnya seperti logging, tracker, dll.

Berikut adalah contoh penggunaannya:


1val numberList = mutableListOf<Int>(1, 3, 2)
2numberList
3    .also { println("Sorting the list...") }
4    .sort()
5    .also { println("Sorted! ✅") }
6
7println(numberList)
8
9// RESULT:
10// Sorting the list...
11// Sorted! ✅
12// [1, 2, 3]

Tabel Scope Functions

Agar lebih mudah dalam mengingat dan memahami perbedaan dari masing-masing Scope Functions, kamu bisa mengacu pada tabel berikut:

Scope Function	Object Reference	Return Value	Apakah Extension?
let	it	Lambda Result	Ya
with	this	Lambda Result	Bukan Extension
run	this	Lambda Result	Ya
run	-	Lambda Result	Bukan Extension
apply	this	Context Object	Ya
also	it	Context Object	Ya

RSS Feed

CI/CD aplikasi iOS dengan Fastlane dan Github Actions

Sun, 24 Sep 2023 00:00:00 GMT

Untuk mengatasi hal tersebut, kita bisa menerapkan CI/CD pada project kita.

Apa itu CI/CD ?

CI/CD merupakan singkatan dari Continuous Integration / Continuous Delivery atau Deployment. CI/CD dapat membantu kita dalam membuat otomatisasi proses distribusi aplikasi.

Jadi, ketika kita melakukan perubahan kode pada Git Repository, proses distribusi aplikasi akan berjalan secara otomatis.

Sehingga kita bisa lebih fokus dalam mengembangkan aplikasi daripada menghabiskan waktu untuk melakukan hal-hal yang repetitif seperti distribusi aplikasi.

Manfaat CI/CD

Berikut adalah beberapa manfaat yang akan kita dapatkan apabila kita menerapkan CI/CD:

Lebih hemat waktu

Mempercepat distribusi aplikasi

Mendeteksi bug lebih cepat

Siapa saja bisa melakukan distribusi aplikasi

Nah, dengan menerapkan CI/CD, semua orang dalam team bisa melakukan distribusi dan tidak terlalu bergantung dengan satu atau beberapa orang saja.

Menghindari Human Error

Tools CI/CD

Ada beberapa tools yang bisa kita gunakan untuk membuat CI/CD. Seperti Fastlane, Codemagic, Jenkins, CircleCI, Travis CI, Github Actions, dll.

Namun pada tutorial kali ini, kita akan menggunakan Fastlane dan Github Actions. Alasannya karena mereka menyediakan layanan untuk membuat CI/CD secara gratis. 🥳

Fastlane kita gunakan untuk membuat pipeline otomatisasi build, testing, screenshot, dan upload ke Testflight & AppStore.

Sedangkan Github Actions kita gunakan sebagai server untuk menjalankan pipeline tersebut.

Instalasi Fastlane

Sebelum kita mengintegrasikannya ke Github Actions, kita perlu menginstal dulu Fastlane di local komputer kita untuk melakukan pengujian apakah pipeline yang kita buat sudah sesuai atau belum.

Silakan jalankan beberapa command berikut di Terminal:

Xcode command line tools


1xcode-select --install

Brew


1/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Fastlane


1brew install fastlane

Jika sudah, pastikan Fastlane sudah terinstall di komputer kita dengan cara:


1$ fastlane --version
2
3fastlane installation at path:
4/opt/homebrew/Cellar/fastlane/2.214.0/libexec/gems/fastlane-2.216.0/bin/fastlane
5-----------------------------
6[✔] 🚀
7fastlane 2.216.0

Setup Fastlane

Untuk mengikuti tutorial ini, silakan download starter project nya di sini: https://github.com/alfinsyahruddin/Fasthub/tree/starter

Fasthub App

Selanjutnya, buka Terminal dan navigasi ke folder "Fasthub", lalu jalankan command berikut:


1fastlane init

Ketika muncul prompt seperti di bawah ini, pilih no 4 karena kita akan setup fastlane pada project kita secara manual.

fastlane init

Jika sudah, maka akan ter-generate sebuah folder "fastlane" yang berisi Appfile dan Fastfile.

Appfile adalah sebuah file konfigurasi project untuk distribusi ke AppStore, seperi identifier aplikasi, Apple ID, Team Name, dll.
Fastfile adalah file yang berisi lane atau command yang bisa kita pakai untuk melakukan sesuatu, sontohnya lane untuk build IPA, lane untuk mengambil screenshot, dll.

Otomatisasi Testing

Sekarang, kita akan membuat "lane" pertama kita bernama test, yaitu untuk menjalankan Unit Tests pada aplikasi Fasthub.

Silakan buka file Fastfile dan replace isinya menjadi seperti ini:


1default_platform(:ios)
2
3platform :ios do
4  desc "Run Unit Tests"
5  lane :test do
6    scan(scheme: "FasthubTests")
7  end
8end

Untuk menjalankan "lane" yang kita buat, caranya seperti ini:


1fastlane test

Hasil Testing

Otomatisasi Screenshot

Fastlane mempunyai fitur untuk mengambil screenshot aplikasi kita secara programmatic, kita juga bisa mengatur jenis device, bahasa, tema gelap/terang, dll.

Silakan jalankan command berikut di Terminal:


1fastlane snapshot init

Command di atas akan meng-generate 2 buah file, yaitu:

1. Snapshot

Snapshot merupakan sebuah file konfigurasi screenshot, seperti konfigurasi jenis device, bahasa, dll.

Silakan replace isi dari file Snapshot, menjadi seperti ini:


1devices([
2    "iPhone SE (3rd generation)"
3])
4
5languages([
6  'en-US'
7])
8
9dark_mode(true)
10
11scheme("FasthubUITests")
12
13output_directory "./fastlane/screenshots"
14
15clear_previous_screenshots(true)

2. SnapshotHelper.swift

File yang berisi code swift untuk mengambil screenshot.

Silakan drag & drop file tersebut ke dalam target FasthubUITests

SnapshotHelper.swift

Kemudian buka file FasthubUITests.swift dan replace isi dari function testExample menjadi dengan code berikut:


1func testExample() throws {
2    let app = XCUIApplication()
3    setupSnapshot(app)
4    app.launch()
5
6    snapshot("HOME_PAGE")
7}

Untuk mengambil screenshot, kita bisa menggunakan function snapshot yang berasal dari file SnapshotHelper.swift

Terakhir, tambahkan lane screenshot pada file Fastfile:


1default_platform(:ios)
2
3platform :ios do
4  desc "Run Unit Tests"
5  lane :test do
6    scan(scheme: "FasthubTests")
7  end
8
10  desc "Take screenshots"
11  lane :screenshot do
12    snapshot
13  end
15end

Untuk menjalankan lane screenshot yang telah kita buat, caranya seperti ini:


1fastlane screenshot

Otomatisasi Build IPA

Building aplikasi untuk diupload ke AppStore seringkali memakan banyak waktu, untungnya Fastlane mempunyai fitur untuk build IPA secara otomatis bernama gym.

Jalankan command berikut di Terminal:


1fastlane gym init

Command di atas akan meng-generate sebuah file konfigurasi build bernama Gymfile, silakan replace isinya menjadi seperti ini:


1scheme("Fasthub")
2
3output_directory("./fastlane/builds")
4
5export_xcargs("-allowProvisioningUpdates")

Dalam file Gymfile di atas, kita tentukan scheme aplikasi kita, path output hasil build, dan -allowProvisioningUpdates untuk melakukan provisioning secara otomatis.

Terakhir, tambahkan "lane" baru bernama build pada file Fastfile:


1desc "Create IPA"
2lane :build do
3  enable_automatic_code_signing
4  increment_build_number
5  gym
6end

Untuk melakukan build, kamu bisa menjalankan command berikut:


1fastlane build

Hasil Build

Membuat aplikasi di AppStore Connect

Sebelum kita upload file IPA yang hasil build ke Testflight dan AppStore, kita perlu untuk membuat aplikasi baru di AppStore Connect terlebih dahulu.

Namun kita tidak akan membuatnya dari website AppStore Connect, tetapi melalui action produce yang disediakan oleh Fastlane.

Replace isi dari file Appfile menjadi seperti ini:


1app_identifier("dev.alfin.Fasthub") # The bundle identifier of your app
2apple_id("alfin.syahruddin@icloud.com") # Your Apple Developer Portal username
3team_name("MUHAMMAD ALFIN SYAHRUDDIN")

dan buat file .env di dalam folder "fastlane", isinya seperti ini:


1FASTLANE_USER=alfin.syahruddin@icloud.com
2FASTLANE_PASSWORD=XXXXXXXXX
3FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD=xxx-xxx-xxx-xxx
4FASTLANE_ITC_TEAM_NAME=MUHAMMAD ALFIN SYAHRUDDIN

Sesuaikan isinya dengan credential milikmu. Untuk meng-generate App-Specific Password, kamu bisa mengikuti langkah dari website berikut: https://support.apple.com/en-us/102654

Terakhir, Silakan tambahkan lane create_app di file Fastfile


1desc "Create app on Apple Developer and App Store Connect sites"
2lane :create_app do
3    produce
4end

Untuk menggunakan "lane" yang baru saja kita buat, caranya seperti ini:


1fastlane create_app

Otomatisasi upload ke Testflight

Tambahkan code berikut pada file fastfile:


1desc "Upload to TestFlight"
2lane :upload_testflight do
3  upload_to_testflight(
4    ipa: "./fastlane/builds/Fasthub.ipa",
5    skip_waiting_for_build_processing: true,
6    uses_non_exempt_encryption: true
7  )
8end

dan untuk menggunakannya, caranya seperti ini:


1fastlane upload_testflight

Testflight

Otomatisasi upload ke AppStore

Pertama, silakan jalankan command berikut di Terminal:


1fastlane deliver init

Command di atas akan menghasilkan sebuah file bernama "Deliverfile", yang berisi konfigurasi-konfigurasi AppStore. Silakan replace isi dari file tersebut dengan kode berikut:


1price_tier(0)
2
3submission_information({
4    export_compliance_encryption_updated: false,
5    export_compliance_uses_encryption: false,
6    content_rights_contains_third_party_content: false,
7    add_id_info_uses_idfa: false
8})
9
10app_rating_config_path("./fastlane/metadata/app_store_rating_config.json")
11
12ipa("./fastlane/builds/Fasthub.ipa")
13
14submit_for_review(true)
15
16automatic_release(false)
17
18force(true)

Kita set price_tier(0) karena aplikasi kita free. dan automatic_release(false) agar kita bisa me-release secara manual apabila aplikasi kita sudah diaccept review-nya oleh Apple (kamu bisa mengesetnya menjadi true jika kamu mau).

Selain menghasilkan Deliverfile, command di atas juga akan meng-generate sebuah folder bernama "metadata" yang berisi informasi-informasi yang perlu kita isi untuk keperluan distribusi ke AppStore, misalnya seperti deskripsi aplikasi, kategori, dll.

1. Description

Ubah isi dari file fastline/metadata/en-US/description.txt menjadi seperti ini:


1Fasthub is a demo app for Fastline & Github tutorial.

2. Keywords

Ubah isi dari file fastline/metadata/en-US/keywords.txt menjadi seperti ini:


1CI/CD, Fastlane, Github

3. URL

Ubah isi dari ketiga file berikut:

fastline/metadata/en-US/privacy_url.txt
fastline/metadata/en-US/support_url.txt
fastline/metadata/en-US/marketing_url.txt

menjadi seperti ini:


1https://alfin.dev

4. Copyright

Ubah isi dari file fastline/metadata/copyright.txt menjadi seperti ini:


1Copyright © 2023 Fasthub

5. Category

Ubah isi dari file fastline/metadata/primary_category.txt menjadi seperti ini:


1UTILITIES

Kamu bisa melihat kategori apa saja yang tersedia, di sini: https://docs.fastlane.tools/actions/deliver/#reference

6. Rating

Buatlah file bernama "app_store_rating_config.json" di dalam folder "metadata" yang berisi code berikut:


1{
2  "CARTOON_FANTASY_VIOLENCE": 0,
3  "REALISTIC_VIOLENCE": 0,
4  "PROLONGED_GRAPHIC_SADISTIC_REALISTIC_VIOLENCE": 0,
5  "PROFANITY_CRUDE_HUMOR": 0,
6  "MATURE_SUGGESTIVE": 0,
7  "HORROR": 0,
8  "MEDICAL_TREATMENT_INFO": 0,
9  "ALCOHOL_TOBACCO_DRUGS": 0,
10  "GAMBLING": 0,
11  "SEXUAL_CONTENT_NUDITY": 0,
12  "GRAPHIC_SEXUAL_CONTENT_NUDITY": 0,
13  "UNRESTRICTED_WEB_ACCESS": 0,
14  "GAMBLING_CONTESTS": 0
15}

7. Review Information

Buka folder "metadata/review_information", dan silakan lengkapi kontennya, berikut adalah field-field yang mandatory:

First Name
Last Name
Email
Phone Number (+62)

Terakhir, silakan tambahkan lane baru bernama upload_appstore pada file Fastfile:


1desc "Upload to App Store"
2lane :upload_appstore do
3  deliver
4end

Untuk menggunakannya, caranya seperti ini:


1fastlane upload_appstore

Membuat pipeline otomatisasi

Sekarang, kita akan membuat sebauh lane baru untuk menggabungkan lane-lane yang telah kita buat.

Silakan buka file Fastfile dan tambahkan code berikut:


1desc "Test, take screenshots, build, Create app, and upload to TestFlight & App Store"
2lane :run_pipeline do
3  test
4  screenshot
5  build
6  create_app
7  upload_testflight
8  upload_appstore
9end

Jadi, jika kita ingin menjalankan semua lane yang telah kita buat, kita tinggal memasukkan command berikut ke Terminal:


1fastlane run_pipeline

Integrasi Github Actions

Agar ketika kita melakukan perubahan kode pada Repository, proses deployment aplikasi kita otomatis dijalankan, kita perlu mengintegrasikannya ke Github Actions.

Silakan buat sebuah file "deploy.yml" di dalam folder baru bernama ".github/workflows", yang berisi code berikut:


1name: deploy-ios-app
2on:
3  push:
4    branches:
5      - 'final'
6jobs:
7  deploy:
8    runs-on: macos-latest
9    steps:
10      - uses: actions/checkout@v2
11        with:
12         ruby-version: 3.2.1
13         bundler-cache: true
14      - run: |
15          bundle update
16          bundle exec fastlane run_pipeline

Sesuaikan nama branchnya jika diperlukan.

Untuk memastikan apakah pipeline CI/CD kita sudah berjalan atau belum, silakan push code kita ke Github, dan buka Tab "Actions" maka pipeline CI/CD kita akan berjalan secara otomatis! 🎉

Github Actions