Back to Repositories

Testing Shared Library Framework Implementation in Apktool

This test suite validates shared library functionality in Apktool, focusing on framework installation, resource handling, and APK rebuilding processes. It ensures proper handling of shared resources between library and client APKs while maintaining framework tagging integrity.

Test Coverage Overview

The test suite provides comprehensive coverage of shared library operations in Apktool:

Framework tagging verification
Framework installation validation
Shared resource decoding and rebuilding
Integration between library and client APKs
Framework directory configuration handling

Implementation Analysis

The testing approach utilizes JUnit framework with a structured setup for APK manipulation. It implements before-class initialization for resource preparation and employs multiple test methods to verify distinct aspects of shared library functionality.

Key patterns include resource directory copying, framework installation verification, and APK building validation using ExtFile implementations.

Technical Details

Testing infrastructure includes:

JUnit test framework
Apktool’s core libraries (ApkBuilder, ApkDecoder)
Custom utility classes (TestUtils, BaseTest)
Framework configuration management
Temporary directory handling for test artifacts

Best Practices Demonstrated

The test suite exemplifies strong testing practices through isolated test methods, clear setup procedures, and comprehensive validation points. It demonstrates proper resource cleanup, explicit configuration management, and thorough verification of both installation and building processes.

The code organization follows a clear pattern of setup, execution, and verification stages within each test method.

ibotpeaches/apktool

brut.apktool/apktool-lib/src/test/java/brut/androlib/aapt1/SharedLibraryTest.java

            
/*
 *  Copyright (C) 2010 Ryszard Wiśniewski <[email protected]>
 *  Copyright (C) 2010 Connor Tumbleson <[email protected]>
 *
 *  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
 *
 *       https://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 brut.androlib.aapt1;

import brut.androlib.ApkBuilder;
import brut.androlib.ApkDecoder;
import brut.androlib.BaseTest;
import brut.androlib.TestUtils;
import brut.androlib.res.Framework;
import brut.directory.ExtFile;
import brut.common.BrutException;

import java.io.File;

import org.junit.*;
import static org.junit.Assert.*;

public class SharedLibraryTest extends BaseTest {
    private static final String LIBRARY_APK = "library.apk";
    private static final String CLIENT_APK = "client.apk";

    @BeforeClass
    public static void beforeClass() throws Exception {
        TestUtils.copyResourceDir(SharedLibraryTest.class, "aapt1/shared_libraries", sTmpDir);
    }

    @Test
    public void isFrameworkTaggingWorking() throws BrutException {
        sConfig.setFrameworkDirectory(sTmpDir.getAbsolutePath());
        sConfig.setFrameworkTag("building");

        ExtFile libraryApk = new ExtFile(sTmpDir, LIBRARY_APK);
        new Framework(sConfig).install(libraryApk);

        assertTrue(new File(sTmpDir, "2-building.apk").exists());
    }

    @Test
    public void isFrameworkInstallingWorking() throws BrutException {
        sConfig.setFrameworkDirectory(sTmpDir.getAbsolutePath());

        ExtFile libraryApk = new ExtFile(sTmpDir, LIBRARY_APK);
        new Framework(sConfig).install(libraryApk);

        assertTrue(new File(sTmpDir, "2.apk").exists());
    }

    @Test
    public void isSharedResourceDecodingAndRebuildingWorking() throws BrutException {
        sConfig.setFrameworkDirectory(sTmpDir.getAbsolutePath());
        sConfig.setFrameworkTag("shared");
        sConfig.setAaptVersion(1);

        // install library/framework
        ExtFile libraryApk = new ExtFile(sTmpDir, LIBRARY_APK);
        new Framework(sConfig).install(libraryApk);

        assertTrue(new File(sTmpDir, "2-shared.apk").exists());

        // decode client.apk
        ExtFile clientApk = new ExtFile(sTmpDir, CLIENT_APK);
        ExtFile clientDir = new ExtFile(clientApk + ".out");
        new ApkDecoder(clientApk, sConfig).decode(clientDir);

        // decode library.apk
        ExtFile libraryDir = new ExtFile(libraryApk + ".out");
        new ApkDecoder(libraryApk, sConfig).decode(libraryDir);

        // build client.apk
        new ApkBuilder(clientDir, sConfig).build(null);

        assertTrue(new File(clientDir, "dist/" + clientApk.getName()).exists());

        // build library.apk (shared library)
        new ApkBuilder(libraryDir, sConfig).build(null);

        assertTrue(new File(libraryDir, "dist/" + libraryApk.getName()).exists());
    }
}