😾 🤮 🕚 Jenkins + Gradleを使用したAndroidの継続的統合 🤷🏻 💃🏾 🚹

Androidアプリケーションの自動アセンブリに関するベストプラクティスを共有したいと思います。この記事では、2種類のアプリケーションのアセンブリの例を示します。1つ目は、個別のフォルダーに単体テストを含む単純なアプリケーション、2つ目は、Androidライブラリプロジェクトを使用するアプリケーションです。

最終的に、Jenkinsビルドアーティファクトからダウンロード可能な、テストの完了に関するレポートと署名済みのapkファイルを受け取ります。

自動アセンブリをセットアップするための要件

Jenkins Essentialプラグイン
- Android Emulatorプラグイン
- Gitプラグイン（gitを使用する場合）
- 複数のSCMプラグイン（複数のリポジトリを操作するため）
- Xvncプラグイン（Xサーバーがサーバーにインストールされていない場合にエミュレーターを実行するため）
Android SDK

こちらからダウンロードしてください。セクション他のプラットフォームのダウンロード-> SDKツールのみ
グラドル

ここからアーカイブをダウンロードして（gradle-**-bin.zip）、/ usr / local / libに解凍することをお勧めします
環境変数

ANDROID_HOME = / usr / local / lib / android / sdk

GRADLE_HOME = / usr / local / lib / gradle-1.8

JAVA_HOME = / usr / lib / jvm / jdk1.7.0_03

PATH = $ PATH：$ ANDROID_HOME / tools：$ ANDROID_HOME / platform-tools：$ JAVA_HOME / bin：$ GRADLE_HOME / bin
エミュレータを実行するライブラリ

Jenkinsが64ビットOSで実行される場合、ia32-libsライブラリを追加する必要があります。追加しないと、エミュレーターが起動しません。

sudo apt-get install ia32-libs

すべての要件が満たされたら、セットアップに進みます

私の仕事ではEclipseを使用しているため、プロジェクトには、いわば、gradleプロジェクト（androidStudioの作成など）に典型的ではない古い構造があります。プロジェクトの外観に基づいて、さらに例を示します。

 プロジェクト
  | -res
  | -src
  |-アセット
  | -libs
  | -tests（単体テストを含むプロジェクトを含むフォルダー）
      | -src
      | -res
      | -AndroidManifest.xml
  | -AndroidManifest.xml
  | -build.gradle
  | -gradle.properties

カスタマイズ

まず、通常のプロジェクトをセットアップします。最初のステップは、プロジェクトのルートにbuild.gradleファイルを作成することです

buile.gradle

buildscript { repositories { mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:0.6+' } } apply plugin: 'android' android { compileSdkVersion 18 buildToolsVersion "18.1.1" defaultConfig { minSdkVersion 8 targetSdkVersion 18 testPackageName "com.project.tests" testInstrumentationRunner "android.test.InstrumentationTestRunner" } sourceSets { main { manifest.srcFile file('AndroidManifest.xml') java.srcDirs = ['src'] resources.srcDirs = ['src'] res.srcDirs = ['res'] assets.srcDirs = ['assets'] } instrumentTest { java.srcDirs = ['tests/src'] manifest.srcFile file('tests/AndroidManifest.xml') java.srcDirs = ['tests/src'] resources.srcDirs = ['tests/src'] res.srcDirs = ['tests/res'] assets.srcDirs = ['tests/assets'] } } dependencies { compile fileTree(dir: 'libs', include: '*.jar') } //     if(project.hasProperty("debugSigningPropertiesPath") && project.hasProperty("releaseSigningPropertiesPath")) { //       File debugPropsFile = new File(System.getenv('HOME') + "/" + project.property("debugSigningPropertiesPath")) File releasePropsFile = new File(System.getenv('HOME') + "/" + project.property("releaseSigningPropertiesPath")) if(debugPropsFile.exists() && releasePropsFile.exists()) { Properties debugProps = new Properties() debugProps.load(new FileInputStream(debugPropsFile)) Properties releaseProps = new Properties() releaseProps.load(new FileInputStream(releasePropsFile)) //     signingConfigs { debug { storeFile file(debugPropsFile.getParent() + "/" + debugProps['keystore']) storePassword debugProps['keystore.password'] keyAlias debugProps['keyAlias'] keyPassword debugProps['keyPassword'] } release { storeFile file(releasePropsFile.getParent() + "/" + releaseProps['keystore']) storePassword releaseProps['keystore.password'] keyAlias releaseProps['keyAlias'] keyPassword releaseProps['keyPassword'] } } buildTypes { debug { signingConfig signingConfigs.debug } release { signingConfig signingConfigs.release } } } } }

テストを実行するには、android.sourceSetsのinstrumentTestセクションを指定するだけで十分です。このセクションには、テストプロジェクト内のフォルダーへのパスが示されます。 Gradleを扱ったとき、ユニットテストを実行するには、別のタスクを作成し、sourceSetsで別のエントリを作成し、それに応じてjunitを追加する必要があるという記事が複数ありました。一般に、私はこれに時間を無駄にしただけで、すべてがはるかに簡単です。

アプリケーションへの署名を担当する構成の部分を以下に説明します。構成を作成したら、Jenkinsの構成に進みます。

ジェンキンスのセットアップ

最初のステップは、プロジェクトでリポジトリを指定することです。次に、2つのオプションのいずれかを選択する必要があるビルド中にAndroidエミュレーターを実行を選択する必要があります。既存のエミュレーターの名前を指定するか、新しいエミュレーターを開始するパラメーターを指定します。同時に、 エミュレータウィンドウを表示する項目にチェックを入れたままにします。

次のステップは、 Invoke Gradleスクリプトアセンブリステップを追加し、 Gradleに必要なコマンドを指定することです。テストをビルドして実行するには、buildとconnectedCheckを指定するだけです

最後に、アセンブリ後に実行されるアクションを追加する必要があります。

1. JUnitテスト結果レポートを発行します（ユニットテストの実行に関するレポートを発行します）。完了したテストのレポートを含むxmlファイルの行に、次のパスを記述する必要があります。

**/build/instrumentTest-results/*/*.xml

Gradleは、htmlとxmlの2種類のレポートを作成します。 HTMLレポートはbuild / reports / instrumentTests / connected /フォルダーにありますが、Jenkinsの場合はxmlレポートを指定する必要があります。

2.アーティファクトをアーカイブします （アーティファクトからコンパイル済みの署名済みアプリケーションを直接ダウンロードできます）。アーカイブのファイルパス：

**/build/apk/workspace-release.apk

アプリケーションへの署名に戻ります

アプリケーション署名

アプリケーションに署名するには、keytoolユーティリティを使用してキーを作成する必要があります。これは、アプリケーション開発者に関するデータを保存します。作成する標準コマンドは次のとおりです。

keytool -genkey -v -alias appAlias -keyalg RSA -keysize 2048 -keystore release.keystore -validity 10000

エイリアスパラメータは各アプリケーションで使用する必要があり、アプリケーションに署名するときに指定する必要があります。

セキュリティ上の理由から、キーはバージョン管理システムの下に保管しないでください。このキーがあると、他のアプリケーションに署名できますが、システムはそれを同一のものとして認識します。したがって、ファイルはCIサーバーに直接保存する必要があります。

これらの考慮事項に基づいて、gradle.propertiesファイルをプロジェクトルートに追加しました。

 releaseSigningPropertiesPath=.androidSigning/releaseProperties debugSigningPropertiesPath=.androidSigning/debugProperties

releaseSigningPropertiesPathの値は、キーのパラメーター（パスワードとエイリアス）を持つファイルが配置されているパス（ホームディレクトリの〜/ .androidSigning /を基準とする）を指します。プロジェクトの場合、次の4つのファイルをこのフォルダーに保存する必要があります。

release.keystore-リリースビルドアプリケーションのキー

releaseProperties-リリースキーのパラメーター

debug.keystore-アプリケーションのビルドをデバッグするためのキー

debugProperties-デバッグキーのパラメーター

*プロパティファイルのそれぞれは、次の構造を持つ必要があります。

 keystore=- (   ) keystore.password=    keyAlias=alias     keyPassword=

例：

 keystore=release.keystore keystore.password=mypassword keyAlias=appAlias keyPassword=mypassword

これらのパラメーターはすべて、キーの作成時に指定されます。

他のすべてのアクションはbuild.gradleファイルで指定されました。 Gradleにとって便利なのは、構成内で通常のJavaコードも実行できることです。これにより、同様の署名メカニズムを作成できます。これで、アセンブリを安全に実行し、署名済みでテスト済みのアプリケーションを取得できます。

次に、ライブラリアプリケーションを使用するアプリケーションを作成する2番目の例を見てみましょう。

android-libraryを使用したアプリケーションの構築

私の場合、プロジェクトとプロジェクトライブラリは異なるリポジトリにあります。 Jenkinsの複数のリポジトリを操作できるようにするには、Multiple SCMs Pluginプラグインをインストールする必要があります。最初のことは、再びgradleの構成を作成することです。最初のファイルはライブラリプロジェクトにあります

ライブラリbuild.gradle

 buildscript { repositories { mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:0.6.3' } } apply plugin: 'android-library' android { compileSdkVersion 18 buildToolsVersion "19.0.0" defaultConfig { minSdkVersion 8 targetSdkVersion 18 testPackageName "com.project.tests" testInstrumentationRunner "android.test.InstrumentationTestRunner" } sourceSets { main { manifest.srcFile file('AndroidManifest.xml') java.srcDirs = ['src'] resources.srcDirs = ['src'] res.srcDirs = ['res'] assets.srcDirs = ['assets'] } instrumentTest { manifest.srcFile file('tests/AndroidManifest.xml') java.srcDirs = ['tests/src'] resources.srcDirs = ['tests/src'] res.srcDirs = ['tests/res'] assets.srcDirs = ['tests/assets'] } } dependencies { compile fileTree(dir: 'libs', include: '*.jar') } }

プロジェクトライブラリの主な違いは、適用されるプラグインです：apply plugin： 'android-library'

2番目の構成は既にプロジェクト内にあります

プロジェクトbuild.gradle

 buildscript { repositories { mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:0.6.3' } } apply plugin: 'android' android { compileSdkVersion 18 buildToolsVersion "19.0.0" defaultConfig { minSdkVersion 8 targetSdkVersion 18 } sourceSets { main { manifest.srcFile file('AndroidManifest.xml') java.srcDirs = ['src'] resources.srcDirs = ['src'] res.srcDirs = ['res'] assets.srcDirs = ['assets'] } } dependencies { compile fileTree(dir: 'libs', include: '*.jar') compile project(':MyLibrary') } //     if(project.hasProperty("debugSigningPropertiesPath") && project.hasProperty("releaseSigningPropertiesPath")) { //       File debugPropsFile = new File(System.getenv('HOME') + "/" + project.property("debugSigningPropertiesPath")) File releasePropsFile = new File(System.getenv('HOME') + "/" + project.property("releaseSigningPropertiesPath")) if(debugPropsFile.exists() && releasePropsFile.exists()) { Properties debugProps = new Properties() debugProps.load(new FileInputStream(debugPropsFile)) Properties releaseProps = new Properties() releaseProps.load(new FileInputStream(releasePropsFile)) //     signingConfigs { debug { storeFile file(debugPropsFile.getParent() + "/" + debugProps['keystore']) storePassword debugProps['keystore.password'] keyAlias debugProps['keyAlias'] keyPassword debugProps['keyPassword'] } release { storeFile file(releasePropsFile.getParent() + "/" + releaseProps['keystore']) storePassword releaseProps['keystore.password'] keyAlias releaseProps['keyAlias'] keyPassword releaseProps['keyPassword'] } } buildTypes { debug { signingConfig signingConfigs.debug } release { signingConfig signingConfigs.release } } } } }

次に、Jenkinsでリポジトリを正しく指定する必要があります。

前の例とは異なり、この場合、「ソース管理」セクションで、特定のバージョン管理システムではなく「複数のSCM」を選択する必要があります。その後、システムを追加し、リポジトリへのパスを指定できます。 1つ目はプロジェクトでリポジトリを指定すること、2つ目はライブラリで指定することです。一方、ライブラリを使用するリポジトリでは、コードが配置されるフォルダの名前を含む追加設定「サブディレクトリにチェックアウト」を指定する必要があります。このフォルダーの名前は、build.gradleファイル内の依存関係で指定したプロジェクトの名前と一致する必要があります（この例ではMyLibrary）。

compile project(':MyLibrary')

したがって、作業ディレクトリは通常のプロジェクトのように見え、ライブラリが配置されるMyLibraryフォルダが1つだけ追加されます。

他のすべての設定は、通常のプロジェクトの設定とまったく同じです。

ボーナスとして

私のプロジェクトでは、さまざまな環境で作業する必要があります。たとえば、アプリケーションのテストバージョンの場合、開発プロセス中に、要求を送信し、データを受信するために、テストサーバーにローカルサーバーに送信する必要があります。したがって、3つの典型的な環境dev、stage、およびprodを区別できます。 res / values / environment.xmlファイルのアプリケーションリソースに配置した環境に応じた設定には、データを適用する必要があるURLが含まれています。特定の環境の設定ファイルを、dev.xml、stage.xml、prod.xmlの3つの設定ファイルを含む個別の環境フォルダーに配置します。アプリケーションが必要な環境で動作するためには、environment.xmlの代わりにこれらのファイルの1つを置き換えるだけです。

これを行うには、Jenkinsで、アセンブリの最初のステップとしてシェルコマンドlaunchを追加し、次を指定する必要があります。

cp $WORKSPACE/environment/prod.xml $WORKSPACE/res/values/environment.xml

便利なリンク

www.gradle.org/docs/current/javadoc-Gradleドキュメント

tools.android.com/tech-docs/new-build-system/user-guide technical documentation

tools.android.com/recent/updatingsdkfromcommand-line-コンソール経由でAndroid SDKを更新します（Xがない場合）

vimeo.com/34436402-gradle wrapperの動作を説明するビデオ

Jenkins + Gradleを使用したAndroidの継続的統合