Мобилно искуство CICD: еден стандард за брза лента за многу мобилни апликации

Би сакал да зборувам за континуирана интеграција и испорака за мобилни апликации користејќи fastlane. Како имплементираме CI/CD на сите мобилни апликации, како стигнавме до таму и што се случи на крајот.

Веќе има доволно материјал на мрежата за алатката, што ни недостасуваше на почетокот, па намерно нема да ја опишам алатката во детали, туку само ќе се осврнам на она што го имавме тогаш:

• Официјална документација за брза линија
• Примери од други компании
• Ние го автоматизираме склопувањето на апликации за iOS користејќи Fastlane

Статијата се состои од два дела:

• Позадина на појавата на мобилни CI/CD во компанијата
• Техничко решение за пуштање CI/CD за N-апликации

Првиот дел е повеќе носталгија за старите времиња, а вториот е искуство кое можете да го примените на себе.

Така се случувало историски

Година 2015 година

Само што почнавме да развиваме мобилни апликации, тогаш не знаевме ништо за континуирана интеграција, за DevOps и други модерни работи. Секое ажурирање на апликацијата беше спроведено од самиот развивач од неговата машина. И ако за Андроид е прилично едноставно - склопено, потпишано .apk и го постави на Google Developer Console, а потоа за iOS тогашната алатка за дистрибуција преку Xcode ни остави одлични вечери - обидите за преземање на архивата често завршуваа со грешки и моравме да се обидеме повторно. Се покажа дека најнапредниот развивач не пишува код неколку пати месечно, туку ја ослободува апликацијата.

Година 2016 година

Пораснавме, веќе размислувавме како да ги ослободиме програмерите од цел ден за издавање, а се појави и втора апликација, која само не турна повеќе кон автоматизација. Истата година, за прв пат го инсталиравме Џенкинс и напишавме еден куп застрашувачки сценарија, многу слични на оние што fastlane ги прикажува во својата документација.

$ xcodebuild clean archive -archivePath build/MyApp 
    -scheme MyApp

$ xcodebuild -exportArchive 
                        -exportFormat ipa 
                        -archivePath "build/MyApp.xcarchive" 
                        -exportPath "build/MyApp.ipa" 
                        -exportProvisioningProfile "ProvisioningProfileName"

$ cd /Applications/Xcode.app/Contents/Applications/Application Loader.app/Contents/Frameworks/ITunesSoftwareService.framework/Versions/A/Support/

$ ./altool —upload-app 
-f {abs path to your project}/build/{release scheme}.ipa  
-u "[email protected]" 
-p "PASS_APPLE_ID"

За жал, до сега само нашите програмери знаеја како функционираат овие скрипти и зошто е потребен овој бескраен куп клучеви, а кога нешто повторно се скрши, ги добија „прекрасните вечери“ за анализа на дневниците.

Година 2017 година

Оваа година дознавме дека постои такво нешто како fastlane. Немаше толку многу информации колку што има сега - како да се започне, како да се користи. И самата алатка беше сè уште груба во тоа време: постојаните грешки само не разочараа и беше тешко да се поверува во магичната автоматизација што ја ветија.

Сепак, главните комунални услуги вклучени во јадрото fastlane се gym и pilot, успеавме да го започнеме.

Нашите скрипти се малку подобрени.

$ fastlane gym  —-workspace "Example.xcworkspace" 
                --scheme "AppName" 
                —-buildlog_path "/tmp" 
                -—clean

Тие се подобрени, само затоа што не се сите потребни параметри за xcodebuild, треба да наведете - gym самостојно ќе разбере каде и што лежи. И за повеќе дотерување, можете да ги наведете истите копчиња како во xcodebuild, појасно е само именувањето на копчињата.

Овој пат, благодарение на салата и вградениот форматер xcpretty, логовите за изградба станаа многу почитливи. Ова почна да заштедува време за поправање на скршените склопови, а понекогаш тимот за ослободување можеше сам да го сфати тоа.

За жал, мерења на брзината на склопување xcodebuild и gym Не го направивме тоа, но ќе и веруваме на документацијата - до 30% забрзување.

Единствен процес за сите апликации

2018 година и сега

До 2018 година, процесот на градење и пуштање апликации целосно се пресели во Џенкинс, програмерите престанаа да објавуваат од нивните машини, а само тимот за издавање имаше право да објавува.

Веќе сакавме да го подобриме лансирањето на тестови и статички анализи, а нашите скрипти растеа и растеа. Растеше и се менуваше заедно со нашите апликации. Во тоа време имаше околу 10 апликации. Со оглед на тоа што имаме две платформи, тоа се околу 20 „живи“ скрипти.

Секој пат кога сакавме да додадеме нов чекор во сценариото, моравме да ги копираме парчињата во сите скрипти на школка. Можеби можевме да работиме повнимателно, но често таквите промени завршуваа со печатни грешки, кои се претворија во вечери за тимот за издавање да ги поправи скриптите и да открие кој паметен човек ја додал оваа команда и што всушност прави таа. Во принцип, не може да се каже дека скриптите за склопување за една платформа беа барем малку слични. Иако тие сигурно го направија истото.

За да започнете процес за нова апликација, требаше да поминете еден ден за да изберете „свежа“ верзија на овие скрипти, да ја дебагирате и да кажете дека „да, работи“.

Во летото 2018 година, уште еднаш погледнавме кон сè уште во развој fastlane.

Задача бр. 1: сумирајте ги сите чекори на скриптата и препишете ги во Fastfile

Кога почнавме, нашите скрипти изгледаа како крпа за нозе составена од сите чекори и патерици во една скрипта на школка во Џенкинс. Сè уште не сме преминале на гасовод и поделба по фаза.

Разгледавме што имаме и идентификувавме 4 чекори кои одговараат на описот на нашиот CI/CD:

• изградба - инсталирање на зависности, составување на архивата,
• тест - извршување на тестови за програмерски единици, пресметување на покриеноста,
• сонар - ги лансира сите линтери и испраќа извештаи до SonarQube,
• распореди - испраќање артефакт на алфа (TestFlight).

И ако не навлегувате во детали, испуштајќи ги копчињата што се користат во дејствата, ќе ја добиете оваа Fastfile:

default_platform(:ios)

platform :ios do
  before_all do
    unlock
  end

  desc "Build stage"
  lane :build do
    match
    prepare_build
    gym
  end

  desc "Prepare build stage: carthage and cocoapods"
  lane :prepare_build do
    pathCartfile = ""
    Dir.chdir("..") do
      pathCartfile = File.join(Dir.pwd, "/Cartfile")
    end
    if File.exist?(pathCartfile)
      carthage
    end
    pathPodfile = ""
    Dir.chdir("..") do
      pathPodfile = File.join(Dir.pwd, "/Podfile")
    end
    if File.exist?(pathPodfile)
      cocoapods
    end
  end

  desc "Test stage"
  lane :test do
    scan
    xcov
  end

  desc "Sonar stage (after run test!)"
  lane :run_sonar do
    slather
    lizard
    swiftlint
    sonar
  end

  desc "Deploy to testflight stage"
  lane :deploy do
    pilot
  end

  desc "Unlock keychain"
  private_lane :unlock do
    pass = ENV['KEYCHAIN_PASSWORD']
    unlock_keychain(
      password: pass
    )
  end
end

Всушност, нашиот прв Fastfile се покажа како монструозен, со оглед на некои од патериците што сè уште ни беа потребни и бројот на параметри што ги заменивме:

lane :build do
carthage(
  command: "update",
  use_binaries: false,
  platform: "ios",
  cache_builds: true)
cocoapods(
  clean: true,
    podfile: "./Podfile",
    use_bundle_exec: false)

gym(
  workspace: "MyApp.xcworkspace",
  configuration: "Release",
  scheme: "MyApp",
  clean: true,
  output_directory: "/build",
  output_name: "my-app.ipa")
end 

lane :deploy do
 pilot(
  username: "[email protected]",
  app_identifier: "com.example.app",
  dev_portal_team_id: "TEAM_ID_NUMBER_DEV",
  team_id: "ITS_TEAM_ID")
end

Во примерот погоре, само дел од параметрите што треба да ги наведеме: тоа се параметрите за градба - шема, конфигурација, имиња на профили за обезбедување, како и параметри на дистрибуција - Apple ID на сметката на развивачот, лозинка, ID на апликацијата итн. на. Како прво приближување, ги ставаме сите овие клучеви во специјални датотеки - Gymfile, Matchfile и Appfile.

Сега во Џенкинс можете да повикате кратки команди кои не го заматуваат погледот и се лесно читливи со око:

# fastlane ios <lane_name>

$ fastlane ios build
$ fastlane ios test
$ fastlane ios run_sonar
$ fastlane ios deploy

Ура, супер сме

Што доби? Исчистете ги командите за секој чекор. Исчистени скрипти, уредно распоредени во фајлови fastlane. Со радост, истрчавме кај програмерите барајќи од нив да додадат сè што им е потребно во нивните складишта.

Но, со време сфативме дека ќе наидеме на истите тешкотии - сè уште ќе имаме 20 скрипти за склопување кои на еден или друг начин ќе почнат да живеат свој живот, ќе биде потешко да ги уредуваме, бидејќи скриптите ќе се префрлат во складишта, а ние немавме пристап до таму. И, воопшто, нема да може вака да се реши нашата болка.

Задача бр. 2: добијте една Fastfile за N апликации

Сега се чини дека решавањето на проблемот не е толку тешко - поставете ги променливите и ајде да одиме. Да, всушност, така беше решен проблемот. Ама во моментот кога го заебавме, немавме ниту експертиза за самиот fastlane, ниту за Ruby, во кој пишува fastlane, ниту корисни примери на мрежата - сите што пишуваа за fastlane тогаш беа ограничени на пример за една апликација. за еден развивач.

Fastlane може да се справи со променливите на околината, а ние веќе го пробавме ова со поставување на лозинката на Keychain:

ENV['KEYCHAIN_PASSWORD']

Откако ги разгледавме нашите скрипти, ги идентификувавме заедничките делови:

#for build, test and deploy
APPLICATION_SCHEME_NAME=appScheme
APPLICATION_PROJECT_NAME=app.xcodeproj
APPLICATION_WORKSPACE_NAME=app.xcworkspace
APPLICATION_NAME=appName

OUTPUT_IPA_NAME=appName.ipa

#app info
APP_BUNDLE_IDENTIFIER=com.example.appName
[email protected]
TEAM_ID=ABCD1234
FASTLANE_ITC_TEAM_ID=123456789

Сега, за да почнеме да ги користиме овие клучеви во датотеките fastlane, моравме да откриеме како да ги доставиме таму. Fastlane има решение за ова: вчитување на променливите преку dotenv. Документацијата вели дека ако ви е важно да вчитате клучеви за различни намени, креирајте неколку конфигурациски датотеки во директориумот fastlane .env, .env.default, .env.development.

И тогаш решивме да ја користиме оваа библиотека малку поинаку. Да ги ставиме во складиштето на програмерите не скриптите fastlane и неговите мета информации, туку уникатните клучеви на оваа апликација во датотеката .env.appName.

Самите Fastfile, Appfile, Matchfile и Gymfile, го сокривме во посебно складиште. Таму беше скриена дополнителна датотека со клучеви за лозинка од други услуги - .env.
Можете да видите пример тука.

На CI, повикот не се промени многу; додаден е клуч за конфигурација за одредена апликација:

# fastlane ios <lane_name> --env appName

$ fastlane ios build --env appName
$ fastlane ios test --env appName
$ fastlane ios run_sonar --env appName
$ fastlane ios deploy --env appName

Пред да ги извршиме командите, го вчитуваме нашето складиште со скрипти. Не изгледа толку убаво:

git clone [email protected]/FastlaneCICD.git fastlane_temp

cp ./fastlane_temp/fastlane/* ./fastlane/
cp ./fastlane_temp/fastlane/.env fastlane/.env

Засега го остави ова решение, иако Fastlane има решение за преземање Fastfile преку акција import_from_git, но работи само за Fastfile, но не и за други датотеки. Ако сакате „навистина убава“, можете да напишете своја action.

Сличен сет е направен за Android апликации и ReactNative, датотеките се во исто складиште, но во различни гранки iOS, android и react_native.

Кога тимот за издавање сака да додаде некој нов чекор, промените во сценариото се снимаат преку MR во git, веќе нема потреба да се бараат виновниците за скршените скрипти и воопшто, сега треба да се обидете да го скршите.

Сега тоа е сигурно

Претходно, потрошивме време на одржување на сите скрипти, нивно ажурирање и поправање на сите последици од ажурирањата. Беше многу разочарувачки кога причините за грешките и застојот во изданијата беа едноставни печатни грешки што беше толку тешко да се следи во метежот на скрипти на школка. Сега таквите грешки се сведени на минимум. Промените се префрлаат на сите апликации одеднаш. И потребни се 15 минути за да се стави нова апликација во процесот - поставете шаблон на CI и додајте ги клучевите во складиштето на развивачот.

Се чини дека поентата со Fastfile за Android и потписот на апликацијата останува необјаснета, ако статијата е интересна, ќе напишам продолжение. Ќе ми биде драго да ги видам вашите прашања или предлози „како би го решиле овој проблем“ во коментарите или на Телеграма башкирова.

Извор: www.habr.com