モバイル CICD エクスペリエンス: 多くのモバイル アプリケーションに XNUMX つのファーストレーン標準を適用

fastlane を使用したモバイル アプリの継続的インテグレーションとデリバリーについて話したいと思います。すべてのモバイル アプリケーションに CI/CD を実装する方法、そこに至るまでの経緯、そして最終的に何が起こったか。

このツールについてはネットワーク上にすでに十分な資料がありますが、当初はそれが不足していたので、意図的にツールの詳細については説明しませんが、当時の内容についてのみ言及します。

• ファストレーンの公式ドキュメント
• 他社の事例
• Fastlane を使用して iOS アプリケーションの組み立てを自動化します

この記事は XNUMX つの部分で構成されています。

• 社内にモバイルCI/CDが登場した背景
• N アプリケーション向けの CI/CD を展開するための技術ソリューション

最初の部分は昔へのノスタルジーであり、二番目の部分は自分自身に適用できる経験です。

歴史的にはこうなった

年2015

私たちはモバイル アプリケーションの開発を始めたばかりで、継続的インテグレーション、DevOps、その他の流行のことについては何も知りませんでした。各アプリケーションの更新は、開発者自身が自分のマシンからロールアウトしました。 Android の場合、それは非常に簡単です - 組み立てられ、署名されます .apk それを Google Developer Console にアップロードしてから、iOS の場合は、Xcode 経由の配布ツールで素晴らしい夜を過ごすことができました。アーカイブをダウンロードしようとすると、エラーで終了することが多く、再試行する必要がありました。最先端の開発者は月に数回コードを書くのではなく、アプリケーションをリリースすることが判明しました。

年2016

私たちは成長し、開発者をリリースのために丸一日から解放する方法についてすでに考えていました。そして XNUMX 番目のアプリケーションも登場し、それが私たちを自動化へとさらに推し進めました。同年、私たちは初めて Jenkins をインストールし、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 コアに含まれる主なユーティリティは次のとおりです。 gym и pilot、なんとか起動できました。

スクリプトが少し改善されました。

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

必要なパラメータがすべて揃っていないという理由だけで、それらは改善されました。 xcodebuild、指定する必要があります - gym どこに何があるかを独自に理解します。さらに微調整するには、と同じキーを指定できます。 xcodebuild、キーの名前のみが明確になります。

今回は、gym と組み込みの xcpretty フォーマッタのおかげで、ビルド ログがはるかに読みやすくなりました。これにより、壊れたアセンブリを修正する時間が節約され始め、場合によってはリリース チームが自分たちで問題を解決できるようになりました。

残念ながら、組み立て速度の測定 xcodebuild и gym 私たちはそれを実行しませんでしたが、ドキュメントを信頼します - 最大 30% の高速化。

すべてのアプリケーションに対する単一プロセス

2018年と現在

2018 年までに、アプリケーションの構築とロールアウトのプロセスは完全に Jenkins に移行し、開発者は自分のマシンからリリースすることをやめ、リリース チームだけがリリースする権利を持ちました。

私たちはすでにテストの起動と静的分析を改善したいと考えていましたが、スクリプトはどんどん増えていきました。アプリケーションとともに成長し、変化しました。当時、アプリケーションは約 10 個あり、プラットフォームが 20 つあることを考慮すると、「生きている」スクリプトは約 XNUMX 個になります。

スクリプトに新しいステップを追加するたびに、その部分をコピーしてすべてのシェル スクリプトに貼り付ける必要がありました。もっと慎重に作業できたかもしれませんが、そのような変更はタイプミスで終わることが多く、リリースチームがスクリプトを修正し、どの賢い人がこのコマンドを追加したか、そしてそれが実際に何をするのかを調べるために夕方になってしまいました。一般に、あるプラットフォームのアセンブリ用のスクリプトが少なくともある程度似ているとは言えません。確かに同じことをしましたが。

新しいアプリケーションのプロセスを開始するには、これらのスクリプトの「新しい」バージョンを選択し、デバッグして「はい、動作します」と判断するまでに XNUMX 日を費やす必要がありました。

2018 年の夏、私たちは再び発展途上のファストレーンに目を向けました。

タスク #1: すべてのスクリプト ステップを要約し、Fastfile に書き直す

私たちが始めたとき、私たちのスクリプトは、Jenkins の XNUMX つのシェル スクリプトにすべてのステップと松葉杖で構成される足布のように見えました。まだパイプラインと段階ごとの分割には切り替えていません。

私たちは現状を検討し、CI/CD の説明に適合する 4 つのステップを特定しました。

• ビルド - 依存関係のインストール、アーカイブの組み立て、
• テスト — 開発者単体テストの実行、カバレッジの計算、
• sonar - すべてのリンターを起動し、レポートを 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.

Jenkins では、ビューがぼやけず、目で簡単に読み取れる短いコマンドを呼び出すことができます。

# fastlane ios <lane_name>

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

万歳、私たちは素晴らしいです

何を手に入れましたか？ステップごとにコマンドをクリアします。クリーンアップされたスクリプトは、fastlane ファイルにきちんと配置されています。喜んで、私たちは開発者に駆け寄り、必要なものをすべてリポジトリに追加するように頼みました。

しかし、私たちはやがて同じ問題に遭遇することに気づきました。それでも 20 個のアセンブリ スクリプトがあり、何らかの形で独自の生活を開始することになりますが、スクリプトはリポジトリに移動するため、編集がより困難になるでしょう。そして私たちはそこにアクセスできませんでした。そして、一般的には、この方法で私たちの痛みを解決することは不可能です。

タスク #2: N 個のアプリケーションに対して XNUMX つの Fastfile を取得する

さて、問題を解決するのはそれほど難しくないようです。変数を設定して、始めましょう。はい、実際、それで問題は解決されました。しかし、私たちが失敗していた時点では、fastlane 自体の専門知識も、fastlane が記述されている Ruby の専門知識も、ネットワーク上の有用な例もありませんでした。当時、fastlane について書いた人は皆、XNUMX つのアプリケーションの例に限定されていました。ある開発者にとって。

Fastlane は環境変数を処理でき、キーチェーンのパスワードを設定してこれをすでに試しています。

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 ファイルにキーを配信する方法を理解する必要がありました。 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 for Android とアプリケーション署名のポイントはまだ解明されていないようですが、記事が面白ければ続きを書きます。コメントまたは Telegram で「この問題をどのように解決しますか」というご質問やご提案をお待ちしております。 バシキーロワ.

出所： habr.com