The PIN Project CI/CD gyakorlat

Előkövetelmény

Töltsük fel a The PIN Project legutolsó állapotát egy saját GitHub repositoryba.

Az utolsó állapot elérhető: https://github.com/AutSoft/AndroidKotlinPart2/tree/master/ThePinProject

Nyissuk meg a projektet a saját repository-t felhasználva!

New Project -> Project from Version Control -> Git -> URL: Saját repository URL

The PIN Project vizsgálata

Készítsünk három új Run Configuration-t ahhoz, hogy minden tesztet futtatni tudjunk.

JUnit tests Add New Configuration -> Android JUnit ->All in package
Instrumentation tests Add New Configuration -> Android Instrumentation Test -> All in module
All tests Add New Configuration -> Android Instrumentation Test -> All in module -> Before launch -> Run Unit Tests

Futtassuk a tesztjeinket

Pro Tip: Az IDEA-ban lehetőség van Shared Run Configuration-ök készítésére, ami commitolható a VCS-be, így bárki számára elérhető lesz az adott futtatási konfiguráció

Package név és alkalmazás azonosító módosítása

Nevezzük át a az AndroidManifest.xml-ben az alkalmazás package nevét hu.autsoft.hwsw.[SAJÁT_NÉV].pin-re!

Nevezzük át az app modul build.gradle-ben lévő applicationId attribútumot is hu.autsoft.hwsw.[SAJÁT_NÉV].pin-re!

Próbáljuk meg futtatni a tesztjeinket mindkét Flavor-rel, javítsuk meg a hibákat!

Importáljuk a helyes R.* azonosítókat
Frissítsük az Activity neveket az AndroidManifest.xml-ben

Aláíró kulcsok generálása

Készítsük el az alkalmazás Debug kulcsát!

Generate Sign bundle or APK -> APK -> Create New

Hely: PROJECT_ROOT/assets

Név: debug.keystore

Alias: androiddebugkey

Keypass: android

Storepass: android

Készítsük el az alkalmazás Release kulcsát, ahol már saját adatokat használunk!

Az app modul build.gradle-be vegyük fel az új aláírás konfigurációkat

signingConfigs {
    debug {
        storeFile file("../assets/debug.keystore")
    }
    release {
        storeFile file("../assets/release.keystore")
        storePassword "TPP1234"
        keyAlias "ThePinProject"
        keyPassword "TPP1234"
    }
}

buildTypes {
    debug {
        signingConfig signingConfigs.debug
    }
    release {
        signingConfig signingConfigs.release
        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}

Próbáljuk meg Release módban futtatni az alkalmazást Prod Flavor-rel

CircleCI integráció

Előkövetelmény

CircleCI és a GitHub account összekapcsolása (SignUp with GitHub).

Projekt inicializálása

A CircleCI webes felületén végezzük el az alábbiakat:

Set Up Project a korábban létrehozott projektre
Operating System -> Linux
Language -> Gradle (Java)

CircleCI konfiguráció leíró létrehozása

Hozzuk létre a CircleCI konfigurációt leíró fájlt!

Hely: PROJECT_ROOT/circleci

Név: config.yml

version: 2
jobs:
  build:
    working_directory: ~/code
    docker:
      - image: circleci/android:api-28-alpha
    environment:
      JVM_OPTS: -Xmx3200m
    steps:
      - checkout
      - restore_cache:
          key: jars-{{ checksum "build.gradle" }}-{{ checksum  "app/build.gradle" }}
      - run:
         name: Chmod permissions
         command: sudo chmod +x ./gradlew
      - run:
          name: Download Dependencies
          command: ./gradlew androidDependencies
      - save_cache:
          paths:
            - ~/.gradle
          key: jars-{{ checksum "build.gradle" }}-{{ checksum  "app/build.gradle" }}
      - run:
          name: Run Unit Tests
          command: ./gradlew lint test
      - store_artifacts:
          path: app/build/reports
          destination: reports
      - store_test_results:
          path: app/build/test-results
          destination: test-results
      - run:
          name: Build Debug
          command: ./gradlew assembleDebug assembleAndroidTest
      - run:
          name: Build Release
          command: ./gradlew assembleProdRelease
      - store_artifacts:
                path: app/build/outputs/apk
                destination: apks

Kattintsunk a Start building-re, amivel elindul az első buildünk!

Javítsuk ki a problémát: refaktoráljunk, hogy a MockPinValidator osztály elérhető legyen a main könyvtárból is minden konfigurációban!

Töröljük a local.properties fájlt és adjuk hozzá a módosítást a Git-hez

Pusholjuk a változtatást, majd gyönyörködjünk, ahogy kizöldül a build.

Vizsgáljuk meg a Job által létrehozott könyvtárakat, riportokat.

Firebase Test Lab integráció

Ahhoz, hogy a CircleCI jogosultságot szerezzen a Firebase Test Lab-on végzett műveletekhez, regisztrálnunk kell az alkalmazást a Firebase console -on.

Előkövetelmény

Érvényes Google account összekötve a Firebase console-al és Google Developer Console-al

UI Tesztek futtatása manuálisan

Hozzunk létre egy új projektet a Firebase Console-on ThePinProject néven

Jegyezzük fel a létrehozott Project ID-t! Pl. thepinproject-dbd56

CircleCI Job eredményéből töltsük le a app-mock-debug.apk és az app-mock-debug-androidTest.apk alkalmazásokat
Töltsük fel a Firebase Test Lab-ba és futtassuk manuálisan

UI Tesztek futtatása automatizáltan

Válasszuk ki a létrehozott projektet a Google Developer Console-on és engedélyezzük a következő API-kat:

Google Cloud Testing API
Cloud Tool Results API

Hozzunk létre egy új Service Account Key-t!

Service account name: circleci-instrumentation-tests

Role: Project-Editor

Jegyezzük fel az Email-t, illetve vegyük elő a korábban megjegyzett Project ID-t !

Például:

Project ID: thepinproject-dbd56
Email: circleci-instrumentation-tests@thepinproject-dbd56.iam.gserviceaccount.com

Hogy a Service Account kulcsaink biztonságban legyenek, ezeket környezeti változóként kell felvenni a CricleCI-ban base64 kódolással

A generált JSON kulcsot kódoljuk BASE64-el például a következő online eszközzel: https://www.base64encode.net/

A kiementet adjuk hozzá a projekthez egy új környezeti változóként a projekt beállításoknál: Environment Variable -> GCLOUD_SERVICE_KEY

Egészítsük ki a CircleCI configot a következő kódrészlettel a Build Debug és Build Release lépések közé

# Firebase Test Lab
    - run:
        name: Export Google Cloud Service key environment variable
        command: echo 'export GCLOUD_SERVICE_KEY="$GCLOUD_SERVICE_KEY"' >> $BASH_ENV
    - run:
        name: Decode Google Cloud credentials
        command: echo $GCLOUD_SERVICE_KEY | base64 -di > ${HOME}/client-secret.json
    - run:
        name: Set Google Cloud target project
        command: gcloud config set project [PROJECT_ID]
    - run:
        name: Authenticate with Google Cloud
        command: gcloud auth activate-service-account [GCLOUD_SERVICE_EMAIL] --key-file ${HOME}/client-secret.json
    - run:
        name: Run instrumented test on Firebase Test Lab
        command: gcloud firebase test android run --type instrumentation --app app/build/outputs/apk/mock/debug/app-mock-debug.apk --test app/build/outputs/apk/androidTest/mock/debug/app-mock-debug-androidTest.apk --device model=sailfish,version=28,locale=en_US,orientation=portrait --timeout 8m

Töltsük ki a PROJECT_ID-t és a GCLOUD_SERVICE_EMAIL-t

Az elérhető eszközökről a GCloud command line tool adhat bővebb információt, egy lehetséges device összerendelés táblázat megtalálható: https://firebase.google.com/docs/test-lab/android/command-line

Google Play Store publikálás

Előkövetelmények a manuális publikáláshoz

Érvényes Google account
Érvényes Google Developer Account. Előzetes regisztrációhoz kötött, melynek díja 25 $.

Google Play Store manuális publikálás

Hozzunk létre egy új alkalmazást a Google Play Store Developer Console-on The PIN Project néven

Töltsük ki a szükséges információkat az App releases menüpontban!

Töltsük ki a szükséges információkat a Store listing menüpontban!

Töltsük ki a szükséges információkat a Content rating menüpontban!

Töltsük ki a szükséges információkat a Pricing & distribution menüpontban!

Készítsünk egy Release-t manuálisan!

Készítsünk egy Internal test csoportot és adjuk hozzá magunkat!

Publikáljuk az új alkalmazás verziót!

Az Internal test csatornán kiadott alkalmazások esetében nem küld a Google Play automatikusan értesítést a felvett tesztelőknek, hanem egy opt-in URL segítségével hívhatjuk meg őket, amit az App releases->Internal Test track->Manage testers->Opt-in URL mezőben találunk.

Google Play Store automatizált publikálás

Előkövetelmények

Egy korábban feltöltött, elfogadott és kiadott alkalmazás a Google Play-ben

Google Play Developer API engedélyezése

A Google Play Conseole-on navigáljunk a Settings->Developer account->API Access->Linked Project->Keressük ki a projektünket és linkeljük össze

A Service Accounts részen adjuk hozzá a szükséges jogosultásgokat GRANT ACCESS->ADD USER opcióval.

Válasszuk ki a korábban létrehozott projektet a Google Developer Console-on és engedélyezzük a következő API-kat:

Google Play Android Developer API

Hozzunk létre egy új Service Account Key-t!

Service account name: google-play-publisher

Role: Project-Editor

A generált JSON kulcsot kódoljuk BASE64-el például a következő online eszközzel: https://www.base64encode.net/

A kiementet adjuk hozzá a projekthez egy új környezeti változóként a projekt beállításoknál: Environment Variable -> PLAY_PUBLISHER_SERVICE_KEY

Publisher plugin beállítása

Az automatikus publikálásra egy Gradle plugin segítségével van lehetőségünk: gradle-play-publisher

A projekt root modul build.gradle fájlba vegyük fel a következő függőséget:

classpath "com.github.triplet.gradle:play-publisher:2.0.0-beta2"

A projekt app modul build.gradle fájlba használjuk a plugint és a végére vegyük fel a konfigurációt:

apply plugin: 'com.github.triplet.play'

play {
    serviceAccountCredentials = file("thepinproject-google-play-publisher.json")
    track = "internal"
    releaseStatus = "completed"
}

Állítsunk be egy txt kiterejesztésű szöveget a publikáláshoz használt Release Notes-ként, amelyet a plugin fog használni alkalmazás kiadásnál.

app/src/prod/play/release-notes/en-US/default.txt

Például: "We continuously update the application for the best quality and performance."

CircleCI beállítása a publikáláshoz

Adjuk hozzá a config.yml leíró végéhez a következő kódrészletet:

# Google Play Publish
- run:
  name: Export Play Publisher Service Key environment variable
  command: echo 'export PLAY_PUBLISHER_SERVICE_KEY="$PLAY_PUBLISHER_SERVICE_KEY"' >> $BASH_ENV
- run:
  name: Decode Play Publisher Service Key credentials
  command: echo $PLAY_PUBLISHER_SERVICE_KEY | base64 -di > app/thepinproject-google-play-publisher.json
- run:
  name: Publish to Google Play Store
  command: ./gradlew publishProdReleaseApk

Új verzió publikálása

Adjunk ki egy új verziót: növeljük meg a versionCode-ot és a versionName-et és commitoljuk!

RolandMostoha/the-pin-project-ci-HWSW-K2

The PIN Project CI/CD gyakorlat

Előkövetelmény

The PIN Project vizsgálata

Package név és alkalmazás azonosító módosítása

Aláíró kulcsok generálása

CircleCI integráció

Előkövetelmény

Projekt inicializálása

CircleCI konfiguráció leíró létrehozása

Firebase Test Lab integráció

Előkövetelmény

UI Tesztek futtatása manuálisan

UI Tesztek futtatása automatizáltan

Google Play Store publikálás

Előkövetelmények a manuális publikáláshoz

Google Play Store manuális publikálás

Google Play Store automatizált publikálás

Előkövetelmények

Google Play Developer API engedélyezése

Publisher plugin beállítása

CircleCI beállítása a publikáláshoz

Új verzió publikálása