Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d2824e3a authored by Paul Duffin's avatar Paul Duffin
Browse files

Merge latest API into single file before checking compatibility 

Previously, the `frameworks-base-api*-current-compat` modules would
perform a compatibility check between the latest released API
defined within multiple signature files and the current API
defined within a single signature file. That breaks on the latest
version of Metalava which has some more checks to ensure that the
API surfaces being compared are compatible.

Currently, the checks are heuristic based and essentially compare the
number of signature files for each API to catch comparing say public
API with one file against system API defined in two files (public +
system delta). This change works around the problem by merging the
files for the latest previously released API into a single file just as
is already done for the current API.

Longer term the signature files will contain information about which
API they belong to which will allow Metalava to make a much more
meaningful check at which point the affected modules can be simplified.

Bug: 374096206
Test: m checkapi
Change-Id: I934e7ac664b6b7fc9150a14b0787c0e706ccc3cd
parent 78374643

api/Android.bp

+48 −12
Original line number Diff line number Diff line
@@ -125,27 +125,54 @@ combined_apis { 
    }),

}



// Create a single file containing the latest released version of the whole

// Android public API.

java_genrule {

    name: "android.api.merged.public.latest",

    srcs: [

        ":android.api.combined.public.latest",

    ],

    out: ["public-latest.txt"],

    tools: ["metalava"],

    cmd: metalava_cmd + " merge-signatures --format=2.0 $(in) --out $(out)",

}



// Make sure that the Android public API is compatible with the

// previously released public API.

java_genrule {

    name: "frameworks-base-api-current-compat",

    srcs: [

        ":android.api.public.latest",

        ":android.api.merged.public.latest",

        ":android-incompatibilities.api.public.latest",

        ":frameworks-base-api-current.txt",

    ],

    out: ["updated-baseline.txt"],

    tools: ["metalava"],

    cmd: metalava_cmd +

        "--check-compatibility:api:released $(location :android.api.public.latest) " +

        "--check-compatibility:api:released $(location :android.api.merged.public.latest) " +

        "--baseline:compatibility:released $(location :android-incompatibilities.api.public.latest) " +

        "--update-baseline:compatibility:released $(genDir)/updated-baseline.txt " +

        "$(location :frameworks-base-api-current.txt)",

}



// Create a single file containing the latest released version of the whole

// Android system API.

java_genrule {

    name: "android.api.merged.system.latest",

    srcs: [

        ":android.api.combined.system.latest",

    ],

    out: ["system-latest.txt"],

    tools: ["metalava"],

    cmd: metalava_cmd + " merge-signatures --format=2.0 $(in) --out $(out)",

}



// Make sure that the Android system API is compatible with the

// previously released system API.

java_genrule {

    name: "frameworks-base-api-system-current-compat",

    srcs: [

        ":android.api.public.latest",

        ":android.api.system.latest",

        ":android.api.merged.system.latest",

        ":android-incompatibilities.api.system.latest",

        ":frameworks-base-api-current.txt",

        ":frameworks-base-api-system-current.txt",
@@ -153,20 +180,31 @@ java_genrule { 
    out: ["updated-baseline.txt"],

    tools: ["metalava"],

    cmd: metalava_cmd +

        "--check-compatibility:api:released $(location :android.api.public.latest) " +

        "--check-compatibility:api:released $(location :android.api.system.latest) " +

        "--check-compatibility:api:released $(location :android.api.merged.system.latest) " +

        "--baseline:compatibility:released $(location :android-incompatibilities.api.system.latest) " +

        "--update-baseline:compatibility:released $(genDir)/updated-baseline.txt " +

        "$(location :frameworks-base-api-current.txt) " +

        "$(location :frameworks-base-api-system-current.txt)",

}



// Create a single file containing the latest released version of the whole

// Android module-lib API.

java_genrule {

    name: "android.api.merged.module-lib.latest",

    srcs: [

        ":android.api.combined.module-lib.latest",

    ],

    out: ["module-lib-latest.txt"],

    tools: ["metalava"],

    cmd: metalava_cmd + " merge-signatures --format=2.0 $(in) --out $(out)",

}



// Make sure that the Android module-lib API is compatible with the

// previously released module-lib API.

java_genrule {

    name: "frameworks-base-api-module-lib-current-compat",

    srcs: [

        ":android.api.public.latest",

        ":android.api.system.latest",

        ":android.api.module-lib.latest",

        ":android.api.merged.module-lib.latest",

        ":android-incompatibilities.api.module-lib.latest",

        ":frameworks-base-api-current.txt",

        ":frameworks-base-api-system-current.txt",
@@ -175,9 +213,7 @@ java_genrule { 
    out: ["updated-baseline.txt"],

    tools: ["metalava"],

    cmd: metalava_cmd +

        "--check-compatibility:api:released $(location :android.api.public.latest) " +

        "--check-compatibility:api:released $(location :android.api.system.latest) " +

        "--check-compatibility:api:released $(location :android.api.module-lib.latest) " +

        "--check-compatibility:api:released $(location :android.api.merged.module-lib.latest) " +

        "--baseline:compatibility:released $(location :android-incompatibilities.api.module-lib.latest) " +

        "--update-baseline:compatibility:released $(genDir)/updated-baseline.txt " +

        "$(location :frameworks-base-api-current.txt) " +