Распространяйте приложения Android среди тестировщиков с помощью Gradle


Вы можете интегрировать App Distribution в процесс сборки Android с помощью плагина App Distribution Gradle. Плагин позволяет вам указывать тестировщиков и примечания к выпуску в файле Gradle вашего приложения, позволяя настраивать дистрибутивы для разных типов сборок и вариантов вашего приложения.

В этом руководстве описывается, как распространять APK-файлы тестировщикам с помощью плагина Gradle App Distribution .

Прежде чем начать

Если вы еще этого не сделали, добавьте Firebase в свой проект Android .

Если вы не используете какие-либо другие продукты Firebase, вам нужно только создать проект и зарегистрировать свое приложение. Однако, если вы решите использовать дополнительные продукты в будущем, обязательно выполните все шаги, указанные на странице, указанной выше.

Шаг 1. Настройте свой Android-проект

  1. В файле Gradle корневого уровня (уровня проекта) ( <project>/build.gradle.kts или <project>/build.gradle ) добавьте плагин Gradle App Distribution в качестве зависимости:

    Kotlin

    plugins {
    // ...
    id("com.android.application") version "7.3.0" apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id("com.google.gms.google-services") version "4.4.2" apply false

    // Add the dependency for the App Distribution Gradle plugin
    id("com.google.firebase.appdistribution") version "5.1.1" apply false
}

    Groovy

    plugins {
    // ...
    id 'com.android.application' version '7.3.0' apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id 'com.google.gms.google-services' version '4.4.2' apply false

    // Add the dependency for the App Distribution Gradle plugin
    id 'com.google.firebase.appdistribution' version '5.1.1' apply false
}

  2. В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) добавьте плагин Gradle App Distribution :

    Kotlin

    plugins {
  id("com.android.application")

  // Make sure that you have the Google services Gradle plugin
  id("com.google.gms.google-services")

  // Add the App Distribution Gradle plugin
  id("com.google.firebase.appdistribution")
}

    Groovy

    plugins {
  id 'com.android.application'

  // Make sure that you have the Google services Gradle plugin
  id 'com.google.gms.google-services'

  // Add the App Distribution Gradle plugin
  id 'com.google.firebase.appdistribution'
}

  3. Если вы используете корпоративный прокси-сервер или брандмауэр, добавьте следующее системное свойство Java , которое позволит App Distribution загружать ваши дистрибутивы в Firebase:

    -Djavax.net.ssl.trustStore=/path/to/truststore -Djavax.net.ssl.trustStorePassword=password

Шаг 2. Аутентификация с помощью Firebase

Прежде чем вы сможете использовать плагин Gradle, вы должны сначала пройти аутентификацию в своем проекте Firebase одним из следующих способов. По умолчанию плагин Gradle ищет учетные данные из интерфейса командной строки Firebase , если другой метод аутентификации не используется.

Шаг 3. Настройте свойства распространения

В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) настройте App Distribution , добавив хотя бы один раздел firebaseAppDistribution .

Например, чтобы распространить сборку release среди тестировщиков, следуйте этим инструкциям:

Kotlin

import com.google.firebase.appdistribution.gradle.firebaseAppDistribution

android {

  // ...

  buildTypes {
      getByName("release") {
          firebaseAppDistribution {
              artifactType = "APK"
              releaseNotesFile = "/path/to/releasenotes.txt"
              testers = "ali@example.com, bri@example.com, cal@example.com"
          }
      }
  }

  // ...
}

Groovy

android {

  // ...

  buildTypes {
      release {
          firebaseAppDistribution {
              artifactType="APK"
              releaseNotesFile="/path/to/releasenotes.txt"
              testers="ali@example.com, bri@example.com, cal@example.com"
          }
      }
  }

  // ...
}

Вы можете настроить App Distribution для типов сборок и разновидностей продуктов .

Например, чтобы распространять debug и release сборки в «демо» и «полной» версиях продукта, следуйте этим инструкциям:

Kotlin

import com.google.firebase.appdistribution.gradle.firebaseAppDistribution

android {

  // ...

  buildTypes {
      getByName("debug") {...}
      getByName("release") {...}
  }

  flavorDimensions += "version"
  productFlavors {
      create("demo") {
          dimension = "version"
          firebaseAppDistribution {
              releaseNotes = "Release notes for demo version"
              testers = "demo@testers.com"
          }
      }
      create("full") {
          dimension = "version"
          firebaseAppDistribution {
              releaseNotes = "Release notes for full version"
              testers = "full@testers.com"
          }
      }
  }

  // ...
}

Groovy

android {

  // ...

  buildTypes {
      debug {...}
      release {...}
  }

  flavorDimensions "version"
  productFlavors {
      demo {
          dimension "version"
          firebaseAppDistribution {
              releaseNotes="Release notes for demo version"
              testers="demo@testers.com"
          }
      }
      full {
          dimension "version"
          firebaseAppDistribution {
              releaseNotes="Release notes for full version"
              testers="full@testers.com"
          }
      }
  }

  // ...
}

Для настройки раздачи используйте следующие параметры:

Параметры сборки App Distribution
appId

Идентификатор приложения Firebase вашего приложения. Требуется только в том случае, если у вас не установлен плагин Google Services Gradle. Идентификатор приложения можно найти в файле google-services.json или в консоли Firebase на странице «Общие настройки» . Значение в вашем файле build.gradle переопределяет значение, выводимое из плагина google-services . 

appId="1:1234567890:android:321abc456def7890"
serviceCredentialsFile

Путь к JSON-файлу закрытого ключа вашего сервисного аккаунта. Требуется только в том случае, если вы используете аутентификацию учетной записи службы.

artifactType

Указывает тип файла вашего приложения. Можно установить "AAB" или "APK" .

artifactPath

Абсолютный путь к файлу APK или AAB, который вы хотите загрузить.

releaseNotes или releaseNotesFile

Примечания к выпуску для этой сборки.

Вы можете либо указать примечания к выпуску напрямую, либо путь к обычному текстовому файлу.

testers или testersFile

Адреса электронной почты тестировщиков, которым вы хотите распространять сборки.

Вы можете указать тестировщиков в виде списка адресов электронной почты, разделенных запятыми: 

testers="ali@example.com, bri@example.com, cal@example.com"

Или вы можете указать путь к файлу, содержащему список адресов электронной почты, разделенных запятыми: 

testersFile="/path/to/testers.txt"
groups или groupsFile

Группы тестировщиков, которым вы хотите распространять сборки (см. Управление тестировщиками ). Группы указываются с помощью групповые псевдонимы , который вы можете найти на вкладке «Тестеры» в консоли App Distribution Firebase.

Вы можете указать группы в виде списка псевдонимов групп, разделенных запятыми: 

groups="qa-team, android-testers"

Или вы можете указать путь к файлу, содержащему список псевдонимов групп, разделенных запятыми: 

groupsFile="/path/to/tester-groups.txt"
testDevices или testDevicesFile

Следующие типы распространения являются частью бета-функции автоматического тестировщика .

Тестовые устройства, на которые вы хотите распространять сборки (см. Автоматические тесты ).

Вы можете указать тестовые устройства в виде списка спецификаций устройств, разделенных точкой с запятой: 

testDevices="model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"

Или вы можете указать путь к файлу, содержащему список спецификаций устройств, разделенных точкой с запятой: 

testDevicesFile="/path/to/testDevices.txt"
testUsername

Имя пользователя для автоматического входа в систему, которое будет использоваться во время автоматических тестов .

testPassword или testPasswordFile

Пароль для автоматического входа в систему, который будет использоваться во время автоматических тестов .

Или вы можете указать путь к текстовому файлу, содержащему пароль: 

testPasswordFile="/path/to/testPassword.txt"
testUsernameResource

Имя ресурса для поля имени пользователя для автоматического входа в систему, которое будет использоваться во время автоматических тестов .

testPasswordResource

Имя ресурса для поля пароля для автоматического входа в систему, которое будет использоваться во время автоматических тестов .

testNonBlocking

Запускайте автоматические тесты асинхронно. Посетите консоль Firebase, чтобы увидеть результаты автоматического тестирования.

stacktrace

Распечатывает трассировку стека для пользовательских исключений. Это полезно при отладке проблем.

Шаг 4. Распространите свое приложение среди тестировщиков

  1. Наконец, чтобы упаковать тестовое приложение и пригласить тестировщиков, создайте цели BUILD-VARIANT и appDistributionUpload BUILD-VARIANT с оболочкой Gradle вашего проекта, где BUILD-VARIANT — это необязательный вариант продукта и тип сборки, которые вы настроили на предыдущем шаге. Дополнительные сведения о вариантах продукта см. в разделе Настройка вариантов сборки .

    Например, чтобы распространить приложение с использованием варианта сборки release , выполните следующую команду: 

    ./gradlew assembleRelease appDistributionUploadRelease

    Или, если вы прошли аутентификацию с помощью своей учетной записи Google и не предоставили учетные данные в файле сборки Gradle, включите переменную FIREBASE_TOKEN : 

    export FIREBASE_TOKEN=1/a1b2c3d4e5f67890
./gradlew --stop // Only needed for environment variable changes
./gradlew assembleRelease appDistributionUploadRelease

  2. Вы также можете переопределить значения, установленные в файле build.gradle , передав аргументы командной строки в форме --<property-name>=<property-value> . Например:

    • Чтобы загрузить отладочную сборку в App Distribution : 

      ./gradlew bundleDebug appDistributionUploadDebug
    --artifactType="APK"

    • Чтобы пригласить дополнительных тестировщиков или удалить существующих тестировщиков из вашего проекта Firebase: 

      ./gradlew appDistributionAddTesters
    --projectNumber=<project_number>
    --emails="anothertester@email.com, moretesters@email.com"
./gradlew appDistributionRemoveTesters
    --projectNumber=<project_number>
    --emails="anothertester@email.com, moretesters@email.com"

      После добавления тестера в ваш проект Firebase вы можете добавить его в отдельные выпуски. Удаленные тестировщики больше не будут иметь доступа к релизам вашего проекта, но могут по-прежнему сохранять доступ к вашим релизам в течение определенного периода времени.

    Вы также можете указать тестировщиков, используя --file="/path/to/testers.txt" вместо --emails .

    Задачи appDistributionAddTesters и appDistributionRemoveTesters также принимают следующие аргументы:

    • projectNumber : номер вашего проекта Firebase.

    • serviceCredentialsFile : путь к файлу учетных данных службы Google. Это тот же аргумент, который используется в действии загрузки.

Плагин Gradle выводит следующие ссылки после загрузки релиза. Эти ссылки помогут вам управлять двоичными файлами и гарантировать, что у тестировщиков и других разработчиков есть правильный выпуск:

  • firebase_console_uri — ссылка на консоль Firebase , отображающая один выпуск. Вы можете поделиться этой ссылкой с другими разработчиками в вашей организации.
  • testing_uri — ссылка на выпуск в интерфейсе тестировщика (родное приложение Android), которая позволяет тестировщикам просматривать примечания к выпуску и устанавливать приложение на свое устройство. Чтобы использовать ссылку, тестировщику необходим доступ к выпуску.
  • binary_download_uri — подписанная ссылка, по которой непосредственно загружается и устанавливается двоичный файл приложения (файл APK или AAB). Срок действия ссылки истекает через час.

Как только вы распространите свою сборку, она станет доступна на панели App Distribution консоли Firebase на 150 дней (пять месяцев). Когда до истечения срока действия сборки остается 30 дней, уведомление об истечении срока действия появляется как на консоли, так и в списке сборок вашего тестировщика на его тестовом устройстве.

Тестировщики, которых не пригласили протестировать приложение, получают приглашения по электронной почте, чтобы начать работу, а существующие тестировщики получают уведомления по электронной почте о том, что новая сборка готова к тестированию (инструкции по установке тестового приложения см . в руководстве по настройке тестировщика ). Вы можете отслеживать статус каждого тестировщика — приняли ли они приглашение и загрузили ли приложение — в консоли Firebase .

У тестировщиков есть 30 дней, чтобы принять приглашение протестировать приложение до истечения срока его действия. Когда до истечения срока действия приглашения остается 5 дней, в консоли Firebase рядом с тестером в выпуске появляется уведомление об истечении срока действия. Приглашение можно продлить, отправив его повторно с помощью раскрывающегося меню в строке тестера.

Следующие шаги