Sviluppo CTS

Inizializzare il client Repo

Segui le istruzioni riportate in Scaricare il codice sorgente per ottenere e compilare il codice sorgente di Android. Quando esegui il comando repo init, specifica un branch CTS specifico utilizzando -b. In questo modo, le modifiche CTS vengono incluse nelle release CTS successive.

Il seguente esempio di codice mostra come utilizzare repo init.

Compilare ed eseguire CTS

Esegui i seguenti comandi per compilare CTS e avviare la console CTS interattiva:

Compilare CTS (AOSP 14 o versioni precedenti)

cd /path/to/android/root
source build/envsetup.sh
make cts -j32 TARGET_PRODUCT=aosp_arm64
cts-tradefed

Compilare CTS (AOSP 15)

cd /path/to/android/root
source build/envsetup.sh
make cts -j32 TARGET_PRODUCT=aosp_arm64 TARGET_RELEASE=target-release
cts-tradefed

Fai riferimento alla tabella seguente per selezionare il valore target-release:

Eseguire CTS

Nella console CTS, inserisci:

tf> run cts --plan CTS

Scrivere test CTS

I test CTS utilizzano JUnit e le API di test di Android. Consulta il tutorial Testare l'app e i test esistenti nella directory cts/tests. I test CTS seguono per lo più le stesse convenzioni utilizzate in altri test Android.

CTS viene eseguito su molti dispositivi di produzione, pertanto i test devono rispettare le seguenti regole:

• Tieni conto delle diverse dimensioni dello schermo, degli orientamenti e dei layout della tastiera.
• Utilizza solo metodi API pubblici. In altre parole, evita tutte le classi, i metodi e i campi con l'annotazione hide.
• Evita di utilizzare layout di visualizzazione o di fare affidamento sulle dimensioni degli asset che potrebbero non essere presenti su alcuni dispositivi.
• Non fare affidamento sui privilegi di root.

Aggiungere un'annotazione Java

Se il test verifica il comportamento di un'API, annota il codice di test con @ApiTest ed elenca tutte le API coinvolte nel campo apis. Utilizza il formato appropriato tra i seguenti esempi:

Se il test verifica un requisito CDD, annota l'ID requisito (inclusi l'ID sezione CDD e l'ID requisito) con @CddTest nel codice di test CTS, come mostrato nell'esempio seguente. Nel messaggio di commit, indica quale requisito CDD viene testato dal tuo test facendo riferimento agli ID requisito CDD. Gli ID requisito CDD sono una combinazione di ID sezione e ID requisito, collegati da una barra (/) come in 7.3.1/C-1-1.

/**
* Verify Passpoint configuration management APIs for a Passpoint
* @throws Exception
*/
    @CddTest(requirement="7.4.2.3/C-1-1,C-2-1")
    public void testAddPasspointConfigWithUserCredential() throws Exception {
        if (!WifiFeature.isWifiSupported(getContext())) {
            // skip the test if WiFi is not supported
            return;
        }      testAddPasspointConfig(generatePasspointConfig(generateUserCredential()));
    }

Per CTS Verifier, annota ogni attività in AndroidManifest.xml con l' ID CDD pertinente. I formati per i campi valore sono simili ai formati delle annotazioni Java in CTS. Nel messaggio di commit, indica quale requisito CDD viene applicato facendo riferimento all'ID requisito CDD.

  <activity>
    ......
    <!-- OPTIONAL: Add a meta data attribute to indicate CDD requirements. -->
    <meta-data android:name="cdd_test" android:value="7.4.1/C-4-1" />

    <!-- OPTIONAL: Add a meta data attribute to indicate APIs being tested. -->
    <meta-data android:name="api_test"
               android:value="com.example.MyClass#myMethod" />

    <!-- OPTIONAL: Add a metadata attribute to indicate the reason why the test doesn't enforce any CDD requirement but still useful in CTS-V. -->
    <meta-data android:name="non_compliance_test"
               android:value="detailed reasons" />
  </activity>

Nel messaggio di commit

Indica chiaramente il motivo per cui è necessario aggiungere il test e aggiungi i link pertinenti per l'assistenza. Per i test CTS-D, includi un link alla proposta di test che hai creato in Google Issue Tracker nell'ambito di la procedura di invio di CTS-D.

Creare un piano secondario

Ad esempio, puoi aggiungere un file SubPlan.xml in android-cts/subplans come segue:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<SubPlan version="2.0">
<Entry include="CtsSystemIntentTestCases" />
<Entry include="CtsSystemUiHostTestCases" />
<Entry include="CtsSecurityHostTestCases android.security.cts.SELinuxHostTest#testAospFileContexts" />
<Entry include="CtsSecurityHostTestCases android.security.cts.SELinuxHostTest#testAospServiceContexts" />
</SubPlan>

Per eseguire il piano secondario:

run cts --subplan aSubPlan

Il formato della voce del piano secondario è:

Include a module name as follows:
<Entry include="MODULE_NAME" />

Include a package:
<Entry include="MODULE_NAME PACKAGE_NAME" />

Include a class:
<Entry include="MODULE_NAME PACKAGE_NAME.CLASS_NAME" />

Include an individual test:
<Entry include="MODULE_NAME PACKAGE_NAME.CLASS_NAME#TEST_NAME" />

Denominazione e posizione dei test

La maggior parte dei casi di test CTS ha come target una classe specifica nell'API Android. Questi test hanno nomi di pacchetti Java con un suffisso cts e nomi di classe con un suffisso Test. Ogni caso di test è costituito da più test, ognuno dei quali in genere esercita un metodo specifico della classe in fase di test. Questi test sono disposti in una struttura di directory in cui i test sono raggruppati in diverse categorie, ad esempio "widget" o "visualizzazioni".

Ad esempio, il test CTS per il pacchetto Java android.widget.TextView è android.widget.cts.TextViewTest con il nome del pacchetto Java android.widget.cts e il nome della classe TextViewTest.

• Nome del pacchetto Java
  Il nome del pacchetto Java per i test CTS è il nome del pacchetto della classe che il test sta testando, seguito da .cts. Nel nostro esempio, il nome del pacchetto sarebbe android.widget.cts.
• Nome della classe
  Il nome della classe per i test CTS è il nome della classe in fase di test con l'aggiunta di "Test". Ad esempio, se un test ha come target TextView, il nome della classe deve essere TextViewTest.
• Nome del modulo (solo CTS v2)
  CTS v2 organizza i test per modulo. Il nome del modulo è in genere la seconda stringa del nome del pacchetto Java (nel nostro esempio, widget).

La struttura di directory e il codice campione dipendono dal fatto che tu stia utilizzando CTS v1 o CTS v2.

CTS v1

Per Android 6.0 o versioni precedenti, utilizza CTS v1. Per CTS v1, il codice campione è disponibile all'indirizzo cts/tests/tests/example.

La struttura di directory nei test CTS v1 è la seguente:

cts/
  tests/
    tests/
      package-name/
        Android.mk
        AndroidManifest.xml
        src/
          android/
            package-name/
              SampleDeviceActivity.java
              cts/
                SampleDeviceTest.java

CTS v2

Per Android 7.0 o versioni successive, utilizza CTS v2. Per i dettagli, consulta il test di esempio in Android Open Source Project (AOSP).

La struttura di directory di CTS v2 è la seguente:

cts/
  tests/
    module-name/
      Android.mk
      AndroidManifest.xml
      src/
        android/
          package-name/
            SampleDeviceActivity.java
            cts/
              SampleDeviceTest.java

Nuovi pacchetti di esempio

Quando aggiungi nuovi test, potrebbe non esistere una directory in cui inserirli. In questi casi, devi creare la directory e copiare i file di esempio appropriati.

CTS v1

Se utilizzi CTS v1, fai riferimento all'esempio in cts/tests/tests/example e crea una nuova directory. Inoltre, assicurati di aggiungere il nome del modulo del nuovo pacchetto da Android.mk a CTS_COVERAGE_TEST_CASE_LIST in cts/CtsTestCaseList.mk. build/core/tasks/cts.mk utilizza questo makefile per combinare tutti i test e creare il pacchetto CTS finale.

CTS v2

Utilizza il test di esempio /cts/tests/sample/ per avviare rapidamente il nuovo modulo di test con i seguenti passaggi:

1. Per creare la directory di test e copiare i file di esempio, esegui:

   mkdir cts/tests/module-name && cp -r cts/tests/sample/* cts/tests/module-name

2. Vai a cts/tests/module-name e sostituisci tutte le istanze di "[Ss]ample" con la convenzione di denominazione consigliata sopra.
3. Aggiorna SampleDeviceActivity per esercitare la funzionalità che stai testando.
4. Aggiorna SampleDeviceTest per assicurarti che l'attività vada a buon fine o registri i relativi errori.

Directory aggiuntive

È possibile aggiungere anche altre directory Android come assets, jni, libs e res. Per aggiungere codice JNI, crea una directory nella radice del progetto accanto a src con il codice nativo e un makefile Android.mk al suo interno.

Il makefile in genere contiene le seguenti impostazioni:

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := libCtsSample_jni

# don't include this package in any target
LOCAL_MODULE_TAGS := optional
LOCAL_SRC_FILES := list of source code files
LOCAL_C_INCLUDES := $(JNI_H_INCLUDE)

# Tag this module as a cts test artifact
LOCAL_COMPATIBILITY_SUITE := cts
LOCAL_SHARED_LIBRARIES := libnativehelper
LOCAL_SDK_VERSION := current
include $(BUILD_SHARED_LIBRARY)

File Android.mk

Infine, modifica il file Android.mk nella radice del progetto per compilare il codice nativo e dipendere da esso, come mostrato di seguito:

# All tests should include android.test.runner.
LOCAL_JAVA_LIBRARIES := android.test.runner

# Includes the jni code as a shared library
LOCAL_JNI_SHARED_LIBRARIES := libCtsSample_jni

# Include for InstrumentationCtsTestRunner
LOCAL_STATIC_JAVA_LIBRARIES := ctstestrunner...
LOCAL_SDK_VERSION := currentinclude $(BUILD_CTS_PACKAGE)

#Tells make to look in subdirectories for more make files to include
include $(call all-makefiles-under,$(LOCAL_PATH))

Correggere o rimuovere i test

Oltre ad aggiungere nuovi test, puoi correggere o rimuovere i test annotati con BrokenTest o KnownFailure.

Inviare le modifiche

Segui il flusso di lavoro per l'invio delle modifiche al codice quando contribuisci con le modifiche a CTS.

• Scegli il branch di sviluppo in base ai livelli API a cui si applica la patch.
• Sviluppa o seleziona le modifiche per il branch di test corretto con DO NOT MERGE o RESTRICT AUTOMERGE nel messaggio di commit.

A un revisore viene assegnato il compito di esaminare la modifica e selezionarla per il Gerrit interno di conseguenza.

Informazioni sul branch e sul programma delle pubblicazioni

Le release CTS seguono questa pianificazione.

Date importanti durante la release

• Fine della prima settimana: blocco del codice. Le modifiche unite nel branch fino al blocco del codice vengono prese in considerazione per la prossima versione di CTS. Gli invii al branch dopo il blocco del codice o dopo la scelta di un candidato per la release vengono presi in considerazione per la release successiva.
• Seconda o terza settimana: CTS viene pubblicato nella pagina di download della suite di test di compatibilità.

Flusso di unione automatica

I branch di sviluppo CTS sono stati configurati in modo che le modifiche inviate a ogni branch vengano unite automaticamente ai branch di livello superiore.

Per le modifiche direttamente a un branch di sviluppo di test AOSP, il percorso di unione automatica è:
android13-tests-dev > android14-tests-dev > android15-tests-dev

• Per le versioni CTS 16+, un revisore selezionerà la modifica per il Gerrit interno Gerrit di conseguenza.

Se un elenco di modifiche non viene unito correttamente, l'autore della patch riceve un'email con le istruzioni su come risolvere il conflitto. Nella maggior parte dei casi, l'autore della patch può utilizzare le istruzioni per ignorare l'unione automatica dell'elenco di modifiche in conflitto.

Se una versione precedente richiede la modifica, la patch deve essere selezionata dalla versione più recente.

Per le modifiche ai test applicabili alla versione Android successiva, dopo aver caricato una modifica proposta, Google la esamina e, se accettata, la selezionerà per il Gerrit interno.