tests/src/com/android/tests/apex/host/ApexCompressionTests.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.tests.apex.host;

import static com.google.common.truth.Truth.assertThat;

import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;

import android.cts.install.lib.host.InstallUtilsHost;
import android.platform.test.annotations.LargeTest;

import com.android.tradefed.device.DeviceNotAvailableException;
import com.android.tradefed.testtype.DeviceJUnit4ClassRunner;
import com.android.tradefed.testtype.junit4.BaseHostJUnit4Test;
import com.android.tradefed.util.CommandResult;
import com.android.tradefed.util.CommandStatus;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Test for platform support for Apex Compression feature
 */
@RunWith(DeviceJUnit4ClassRunner.class)
public class ApexCompressionTests extends BaseHostJUnit4Test {
    private static final String COMPRESSED_APEX_PACKAGE_NAME = "com.android.apex.compressed";
    private static final String ORIGINAL_APEX_FILE_NAME =
            COMPRESSED_APEX_PACKAGE_NAME + ".v1_original.apex";
    private static final String DECOMPRESSED_DIR_PATH = "/data/apex/decompressed/";
    private static final String APEX_ACTIVE_DIR = "/data/apex/active/";

    private final InstallUtilsHost mHostUtils = new InstallUtilsHost(this);
    private boolean mWasAdbRoot = false;

    @Before
    public void setUp() throws Exception {
        mWasAdbRoot = getDevice().isAdbRoot();
        if (!mWasAdbRoot) {
            assumeTrue("Requires root", getDevice().enableAdbRoot());
        }
        deleteFiles("/system/apex/" + COMPRESSED_APEX_PACKAGE_NAME + "*apex",
                APEX_ACTIVE_DIR + COMPRESSED_APEX_PACKAGE_NAME + "*apex",
                DECOMPRESSED_DIR_PATH + COMPRESSED_APEX_PACKAGE_NAME + "*apex");
    }

    @After
    public void tearDown() throws Exception {
        if (!mWasAdbRoot) {
            getDevice().disableAdbRoot();
        }
        deleteFiles("/system/apex/" + COMPRESSED_APEX_PACKAGE_NAME + "*apex",
                APEX_ACTIVE_DIR + COMPRESSED_APEX_PACKAGE_NAME + "*apex",
                DECOMPRESSED_DIR_PATH + COMPRESSED_APEX_PACKAGE_NAME + "*apex");
    }

    /**
     * Runs the given phase of a test by calling into the device.
     * Throws an exception if the test phase fails.
     * <p>
     * For example, <code>runPhase("testApkOnlyEnableRollback");</code>
     */
    private void runPhase(String phase) throws Exception {
        assertTrue(runDeviceTests("com.android.tests.apex.app",
                "com.android.tests.apex.app.ApexCompressionTests",
                phase));
    }

    /**
     * Deletes files and reboots the device if necessary.
     * @param files the paths of files which might contain wildcards
     */
    private void deleteFiles(String... files) throws Exception {
        boolean found = false;
        for (String file : files) {
            CommandResult result = getDevice().executeShellV2Command("ls " + file);
            if (result.getStatus() == CommandStatus.SUCCESS) {
                found = true;
                break;
            }
        }

        if (found) {
            getDevice().remountSystemWritable();
            for (String file : files) {
                getDevice().executeShellCommand("rm -rf " + file);
            }
            getDevice().reboot();
        }
    }

    private void pushTestApex(final String fileName) throws Exception {
        final File apex = mHostUtils.getTestFile(fileName);
        getDevice().remountSystemWritable();
        assertTrue(getDevice().pushFile(apex, "/system/apex/" + fileName));
        getDevice().reboot();
    }

    private List<String> getFilesInDir(String baseDir) throws DeviceNotAvailableException {
        return getDevice().getFileEntry(baseDir).getChildren(false)
                .stream().map(entry -> entry.getName())
                .collect(Collectors.toList());
    }

    @Test
    @LargeTest
    public void testCompressedApexCanBeQueried() throws Exception {
        pushTestApex(COMPRESSED_APEX_PACKAGE_NAME + ".v1.capex");
        runPhase("testCompressedApexCanBeQueried");
    }

    @Test
    @LargeTest
    public void testCompressedApexIsDecompressedAndActivated() throws Exception {
        pushTestApex(COMPRESSED_APEX_PACKAGE_NAME + ".v1.capex");

        // Ensure that compressed APEX was decompressed in DECOMPRESSED_DIR_PATH
        List<String> files = getFilesInDir(DECOMPRESSED_DIR_PATH);
        assertThat(files).contains(COMPRESSED_APEX_PACKAGE_NAME + "@1.apex");

        // Match the decompressed apex with original byte for byte
        final File originalApex = mHostUtils.getTestFile(ORIGINAL_APEX_FILE_NAME);
        final byte[] originalApexFileBytes = Files.readAllBytes(Paths.get(originalApex.toURI()));
        final File decompressedFile = getDevice().pullFile(
                DECOMPRESSED_DIR_PATH + COMPRESSED_APEX_PACKAGE_NAME + "@1.apex");
        final byte[] decompressedFileBytes =
                Files.readAllBytes(Paths.get(decompressedFile.toURI()));
        assertThat(decompressedFileBytes).isEqualTo(originalApexFileBytes);

        // Similarly, the decompressed APEX should be hard linked to APEX_ACTIVE_DIR
        files = getFilesInDir(APEX_ACTIVE_DIR);
        assertThat(files).contains(COMPRESSED_APEX_PACKAGE_NAME + "@1.apex");
        final File activatedApexFile = getDevice().pullFile(
                APEX_ACTIVE_DIR + COMPRESSED_APEX_PACKAGE_NAME + "@1.apex");
        final byte[] activatedApexFileBytes =
                Files.readAllBytes(Paths.get(activatedApexFile.toURI()));
        assertThat(activatedApexFileBytes).isEqualTo(originalApexFileBytes);
    }

    @Test
    @LargeTest
    public void testDecompressionDoesNotHappenOnEveryReboot() throws Exception {
        pushTestApex(COMPRESSED_APEX_PACKAGE_NAME + ".v1.capex");

        final String decompressedApexFilePath =
                APEX_ACTIVE_DIR + COMPRESSED_APEX_PACKAGE_NAME + "@1.apex";
        String lastModifiedTime1 =
                getDevice().executeShellCommand("stat -c %Y " + decompressedApexFilePath);

        getDevice().reboot();
        getDevice().waitForDeviceAvailable();

        String lastModifiedTime2 =
                getDevice().executeShellCommand("stat -c %Y " + decompressedApexFilePath);
        assertThat(lastModifiedTime1).isEqualTo(lastModifiedTime2);
    }

    @Test
    @LargeTest
    public void testHigherVersionOnSystemTriggerDecompression() throws Exception {
        // Install v1 on /system partition
        pushTestApex(COMPRESSED_APEX_PACKAGE_NAME + ".v1.capex");
        // On boot, /data partition will have decompressed v1 APEX in it
        List<String> files = getFilesInDir(APEX_ACTIVE_DIR);
        assertThat(files).contains(COMPRESSED_APEX_PACKAGE_NAME + "@1.apex");

        // Now replace /system APEX with v2
        getDevice().remountSystemWritable();
        getDevice().executeShellCommand("rm -rf /system/apex/"
                + COMPRESSED_APEX_PACKAGE_NAME + "*apex");
        pushTestApex(COMPRESSED_APEX_PACKAGE_NAME + ".v2.capex");

        // Ensure that v2 was decompressed
        files = getFilesInDir(APEX_ACTIVE_DIR);
        assertThat(files).contains(COMPRESSED_APEX_PACKAGE_NAME + "@2.apex");
    }
}