Fastfile: ουσία, δομή και ρύθμιση αυτοματισμού στην ανάπτυξη εφαρμογών για κινητά

Τι είναι το Fastfile και γιατί χρειάζεται

Το Fastfile είναι το κύριο αρχείο ρυθμίσεων του Fastlane, γραμμένο σε Ruby και βρίσκεται στον κατάλογο fastlane στη ρίζα του έργου. Καθορίζει όλα τα σενάρια αυτοματισμού (lanes) για τη μεταγλώττιση, δοκιμή, υπογραφή κώδικα και διανομή της εφαρμογής. Το Fastfile αντικαθιστά δεκάδες bash scripts, Makefile και χειροκίνητες οδηγίες με μια ενιαία δηλωτική περιγραφή CI/CD pipeline.

Η ανάγκη για Fastfile προκύπτει όταν το έργο απαιτεί επαναλήψιμες μεταγλωττίσεις σε διαφορετικούς υπολογιστές προγραμματιστών και CI/CD servers. Αντί να ρυθμίζει κάθε προγραμματιστής το περιβάλλον χειροκίνητα, το Fastfile καταγράφει όλα τα βήματα σε κώδικα που μπορεί να εκδοθεί σε Git, να ελεγχθεί και να επαναχρησιμοποιηθεί μεταξύ έργων. Το ενιαίο Fastfile εγγυάται ότι η μεταγλώττιση στον υπολογιστή του προγραμματιστή είναι ταυτόσημη με αυτήν στον CI/CD server.

Το Fastfile υποστηρίζει πλατφόρμες μέσω της οδηγίας default_platform. Σε ένα Fastfile μπορούν να περιγραφούν σενάρια για iOS, Android και macOS, ομαδοποιημένα σε blocks platform :ios και platform :android. Αυτό είναι ιδιαίτερα βολικό για έργα πολλαπλών πλατφορμών, όπου οι μεταγλωττίσεις iOS και Android έχουν κοινή λογική ανάπτυξης αλλά διαφορετικά εργαλεία μεταγλώττισης.

Δομή Fastfile: lanes, actions και παράμετροι

Το Fastfile αποτελείται από τρία βασικά στοιχεία: δήλωση πλατφόρμας (default_platform), ορισμούς lanes και ρυθμίσεις βοηθητικών συναρτήσεων. Κάθε lane ξεκινά με τη λέξη-κλειδί lane, ακολουθούμενη από το όνομα σεναρίου (σύμβολο Ruby), το σώμα με ακολουθία actions και blocks διαχείρισης σφαλμάτων error, success ή ensure.

Τα Actions στο Fastfile είναι κλήσεις ενσωματωμένων συναρτήσεων Fastlane με παραμέτρους σε μορφή Hash. Για παράδειγμα, το gym(scheme: 'App', export_method: 'app-store') ξεκινά τη μεταγλώττιση εφαρμογής iOS με τις καθορισμένες παραμέτρους. Κάθε action επιστρέφει ένα αποτέλεσμα που μπορεί να αποθηκευτεί σε μεταβλητή και να χρησιμοποιηθεί σε επόμενα actions – αυτό επιτρέπει τη δημιουργία υπό συνθήκη λογικής μέσα στο lane.

Το Fastfile υποστηρίζει μεταβλητές περιβάλλοντος μέσω του τυπικού μηχανισμού ENV της Ruby. Ευαίσθητα δεδομένα (κωδικοί, tokens, κλειδιά) δεν πρέπει να αποθηκεύονται στο Fastfile – χρησιμοποιήστε μεταβλητές περιβάλλοντος του CI/CD συστήματος ή αρχείο .env που προστίθεται στο .gitignore. Το Fastlane φορτώνει αυτόματα τα .env αρχεία από τον κατάλογο fastlane κατά την εκκίνηση.

Appfile και Matchfile

Μαζί με το Fastfile στον κατάλογο fastlane βρίσκονται πρόσθετα αρχεία ρυθμίσεων. Το Appfile περιέχει τα αναγνωριστικά της εφαρμογής (app_identifier), Apple ID και Team ID – αυτά τα δεδομένα εισάγονται αυτόματα σε όλα τα actions, εξαλείφοντας την επανάληψη σε κάθε lane. Το Matchfile αποθηκεύει τις ρυθμίσεις για το match: URL Git repository, τύπο προφίλ και κλειδί κρυπτογράφησης.

Ο διαχωρισμός ρυθμίσεων σε πολλά αρχεία απλοποιεί τη συντήρηση έργων με διαφορετικά περιβάλλοντα. Για παράδειγμα, για staging και production μπορούν να δημιουργηθούν ξεχωριστοί κλάδοι στο repository Matchfile ή να παρακαμφθούν παράμετροι μέσω μεταβλητών περιβάλλοντος στο CI/CD σύστημα.

# Βασική δομή Fastfile
default_platform(:ios)

lane :build_and_test do
  cocoapods
  scan(scheme: 'App', devices: ['iPhone 15'])
  gym(scheme: 'App')
end

lane :deploy do
  match(type: 'appstore')
  build_and_test
  pilot(skip_waiting_for_build_processing: true)
end

Σύνταξη Fastfile: σύνταξη lanes

Η σύνταξη του Fastfile βασίζεται σε Ruby DSL (Domain Specific Language), ειδικά σχεδιασμένο για αναγνωσιμότητα σεναρίων αυτοματισμού. Το lane δηλώνεται μέσω της δομής lane :όνομα do ... end, όπου το όνομα είναι ένα σύμβολο Ruby που γίνεται η εντολή fastlane όνομα για εκτέλεση από το τερματικό ή το CI/CD σύστημα.

Μέσα στο lane μπορούν να χρησιμοποιηθούν τελεστές υπό συνθήκη Ruby: if, unless, case για διακλάδωση λογικής. Επίσης, διατίθενται βρόχοι each και while για επεξεργασία πινάκων τιμών. Το Fastlane παρέχει ειδικές μεθόδους before_all, after_all και error blocks για διαχείριση γεγονότων κύκλου ζωής του lane.

Οι παράμετροι lane μεταβιβάζονται μέσω του options hash. Κατά την εκτέλεση fastlane build --option_name value, η τιμή καταλήγει στο options[:option_name] μέσα στο lane. Μπορούν να οριστούν προεπιλεγμένες τιμές μέσω optional: true και type επικύρωσης για έλεγχο τύπων των μεταβιβαζόμενων παραμέτρων.

# Lane με παραμέτρους και υπό συνθήκη λογική
lane :build do |options|
  scheme = options[:scheme] || 'App'
  export_method = options[:export_method] || 'development'

  match(type: export_method)

  if export_method == 'appstore'
    gym(scheme: scheme, export_method: 'app-store')
    pilot(skip_waiting_for_build_processing: true)
  else
    gym(scheme: scheme, export_method: export_method)
  end
end

Παράδειγμα Fastfile για διανομή iOS

Ένα πλήρες Fastfile για έργο iOS περιλαμβάνει lanes για εγκατάσταση εξαρτήσεων, δοκιμή, μεταγλώττιση και ανάπτυξη σε TestFlight και App Store. Ας δούμε ένα παράδειγμα που καλύπτει μια τυπική διεργασία CI/CD από το commit έως τη δημοσίευση στο TestFlight για εσωτερική δοκιμή.

# Fastfile για διανομή iOS CI/CD
default_platform(:ios)

before_all do
  cocoapods(try_repo_update_on_error: true)
  setup_travis if ENV['TRAVIS']
end

lane :tests do
  scan(
    scheme: 'App',
    devices: ['iPhone 15', 'iPad Pro 12.9'],
    output_directory: './test_reports'
  )
end

lane :build_appstore do
  match(type: 'appstore', readonly: true)
  gym(
    scheme: 'App',
    export_method: 'app-store',
    include_bitcode: true
  )
end

lane :deploy_testflight do
  build_appstore
  pilot(
    skip_waiting_for_build_processing: true,
    distribute_external: false
  )
  slack(
    message: 'Η μεταγλώττιση μεταφορτώθηκε στο TestFlight για εσωτερική δοκιμή'
  )
end

Σε αυτό το παράδειγμα, το block before_all εκτελείται πριν από κάθε lane και εγκαθιστά τις εξαρτήσεις. Το lane tests εκτελεί UI και Unit tests σε δύο συσκευές. Το lane build_appstore υπογράφει τον κώδικα μέσω match και δημιουργεί IPA με bitcode. Το lane deploy_testflight συνδυάζει όλα τα βήματα για πλήρη διανομή.

Ανάπτυξη με πολλαπλούς στόχους

Έργα με πολλαπλούς στόχους (κύρια εφαρμογή, watchOS, widget, Notification Service Extension) απαιτούν ξεχωριστά lanes για κάθε στόχο. Στο Fastfile μπορεί να δημιουργηθεί ένα γενικό lane :deploy_target που δέχεται το όνομα σχήματος και τη διαδρομή μεταγλώττισης ως παράμετρο. Αυτό επιτρέπει την εκτέλεση ανάπτυξης για όλες τις επεκτάσεις μέσω fastlane deploy_target scheme:Widget.

Για οργάνωση πολλαπλών στόχων χρησιμοποιήστε έναν πίνακα σχημάτων και βρόχο each μέσα στο lane. Το Fastlane υποστηρίζει παράλληλη μεταγλώττιση πολλαπλών σχημάτων μέσω της σημαίας parallel: true, μειώνοντας τον συνολικό χρόνο του CI/CD pipeline για εφαρμογές με επεκτάσεις.

Παράδειγμα Fastfile για μεταγλώττιση Android

Το Fastfile για έργο Android χρησιμοποιεί το gradle action για εκτέλεση εργασιών Gradle και το supply action για δημοσίευση στο Google Play. Σε αντίθεση με το iOS, το Android δεν απαιτεί match, αλλά χρησιμοποιεί Keystore για υπογραφή, το οποίο αποθηκεύεται εκτός αποθετηρίου και μεταβιβάζεται μέσω μεταβλητών περιβάλλοντος.

# Fastfile για μεταγλώττιση Android CI/CD
default_platform(:android)

lane :build_release do
  gradle(task: 'clean')
  gradle(task: 'bundleRelease')
  gradle(task: 'assembleRelease')
end

lane :deploy_internal do
  build_release
  supply(
    track: 'internal',
    aab: 'app/build/outputs/bundle/release/app-release.aab',
    release_status: 'completed'
  )
end

Για την υπογραφή Android της εφαρμογής, ρυθμίστε τα signingConfigs στο build.gradle και μεταβιβάστε τις παραμέτρους Keystore μέσω μεταβλητών περιβάλλοντος: ANDROID_KEYSTORE_PATH, ANDROID_KEYSTORE_PASSWORD, ANDROID_KEY_ALIAS και ANDROID_KEY_PASSWORD. Το Fastlane χρησιμοποιεί αυτόματα το σύστημα apksigner για υπογραφή του μεταγλωττισμένου AAB ή APK.

Υπογραφή Android στο Fastfile

Για ρύθμιση υπογραφής Android στο Fastfile χρησιμοποιήστε το action sign_android ή βασιστείτε στα signingConfigs στο build.gradle. Το Fastlane ενσωματώνεται με το apksigner μέσω Gradle – η μεταβίβαση της σημαίας SIGNING_CONFIG στην εργασία gradle ενεργοποιεί την υπογραφή με παραμέτρους από μεταβλητές περιβάλλοντος. Αυτό επιτρέπει την υπογραφή αρχείων AAB πριν από τη μεταφόρτωση στο Google Play Console.

Για ασφαλή αποθήκευση Keystore σε CI/CD χρησιμοποιήστε κωδικοποίηση Base64 και μεταβλητές περιβάλλοντος. Το Fastlane υποστηρίζει το action setup_keystore, το οποίο αποκωδικοποιεί το Keystore από τη μεταβλητή και το αποθηκεύει σε προσωρινό αρχείο στο στάδιο before_all. Μετά την ολοκλήρωση του lane, το προσωρινό αρχείο διαγράφεται αυτόματα για την αποφυγή διαρροής πιστοποιητικών.

Χρήση private lanes και ομάδων

Τα private lanes (κλειστά σενάρια) είναι lanes που δεν μπορούν να κληθούν απευθείας από τη γραμμή εντολών, αλλά είναι διαθέσιμα για κλήση από άλλα lanes μέσα στο Fastfile. Το private lane δηλώνεται μέσω της δομής private_lane :όνομα do ... end και χρησιμοποιείται για ενσωμάτωση επαναλαμβανόμενων βημάτων που δεν έχουν νόημα ως αυτόνομα σενάρια.

Τα private lanes είναι ιδανικά για ομαδοποίηση επαναλαμβανόμενης λογικής: εγκατάσταση εξαρτήσεων, ρύθμιση περιβάλλοντος, αποστολή ειδοποιήσεων. Για παράδειγμα, μπορεί να δημιουργηθεί ένα private lane :setup_signing που καλείται από πολλά lanes ανάπτυξης, αλλά δεν πρέπει να είναι διαθέσιμο για απευθείας εκτέλεση από τον προγραμματιστή για αποφυγή σφαλμάτων.

# Private lane και ομαδοποίηση
default_platform(:ios)

private_lane :setup_signing do |options|
  match(
    type: options[:type],
    readonly: true,
    verbose: false
  )
end

lane :beta do
  setup_signing(type: 'adhoc')
  gym(export_method: 'ad-hoc')
  pilot(distribute_external: true)
end

lane :release do
  setup_signing(type: 'appstore')
  gym(export_method: 'app-store')
  deliver(
    force: true,
    submit_for_review: true
  )
end

Η ομαδοποίηση lanes μέσω blocks platform επιτρέπει τον διαχωρισμό σεναρίων για iOS και Android σε ένα Fastfile. Η δομή platform :ios do ... end και platform :android do ... end απομονώνει τα lanes της αντίστοιχης πλατφόρμας, ενώ τα κοινά private lanes μπορούν να τοποθετηθούν εκτός των blocks πλατφόρμας για επαναχρησιμοποίηση.

Μεταβίβαση παραμέτρων σε lanes

Ο μηχανισμός παραμέτρων του Fastfile επιτρέπει την ευελιξία και επαναχρησιμοποίηση των lanes. Οι παράμετροι μεταβιβάζονται κατά την εκτέλεση μέσω της γραμμής εντολών: fastlane build scheme:App export_method:appstore. Μέσα στο lane, οι τιμές είναι προσβάσιμες μέσω του options hash, το οποίο μεταβιβάζεται στο block lane ως όρισμα.

Το Fastlane υποστηρίζει τυποποιημένες παραμέτρους με επικύρωση μέσω OptionalHash. Μπορεί να οριστεί ο τύπος τιμής (String, Boolean, Integer), η προεπιλεγμένη τιμή και περιγραφή για αυτόματη δημιουργία τεκμηρίωσης. Επίσης, διατίθενται μεταβλητές περιβάλλοντος ως εναλλακτικός τρόπος μεταβίβασης παραμέτρων, βολικός για συστήματα CI/CD.

# Παράμετροι με επικύρωση τύπων
lane :build do |options|
  gym(
    scheme: options[:scheme],
    export_method: options[:export_method] || 'development',
    include_bitcode: options[:include_bitcode] || false,
    output_name: options[:output_name]
  )
  slack(message: "Δημιουργία #{options[:scheme]} ολοκληρώθηκε")
end

# Εκτέλεση: fastlane build scheme:MyApp export_method:appstore

Συνιστάται η χρήση προεπιλεγμένων τιμών για όλες τις προαιρετικές παραμέτρους, ώστε το lane να μπορεί να εκτελεστεί χωρίς ρητή δήλωση κάθε ορίσματος. Για υποχρεωτικές παραμέτρους, ελέγξτε την ύπαρξη τιμής στην αρχή του lane και διακόψτε την εκτέλεση με κατανοητό μήνυμα σφάλματος μέσω UI.user_error!.