Back to Repositories

Testing Android Manifest DOCTYPE Processing in Apktool

This test suite validates the handling of external entities and DOCTYPE declarations in Android manifest files within the Apktool library. It ensures proper processing of XML files during APK decoding and building operations.

Test Coverage Overview

The test suite focuses on validating the correct handling of XML DOCTYPE declarations in Android manifest files. It covers:

APK building from source files
APK decoding to source files
Manifest XML structure preservation
Version code and name handling
XML namespace management

Implementation Analysis

The testing approach utilizes JUnit framework with a before-class setup and targeted test methods. It implements a complete APK lifecycle test by:

Setting up test directories and resources
Building an APK with specific DOCTYPE content
Decoding the APK and verifying XML integrity
Comparing expected vs actual manifest content

Technical Details

Testing infrastructure includes:

JUnit 4 testing framework
Custom TestUtils for resource handling
ExtFile wrapper for file operations
ApkBuilder and ApkDecoder classes
AAPT version 1 configuration
XML content validation utilities

Best Practices Demonstrated

The test implementation showcases several testing best practices:

Proper test setup and resource management
Clear separation of setup and test logic
Detailed logging of test operations
Explicit expected vs actual result comparison
Resource cleanup and exception handling

ibotpeaches/apktool

brut.apktool/apktool-lib/src/test/java/brut/androlib/aapt1/ExternalEntityTest.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.directory.ExtFile;
import brut.common.BrutException;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;

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

public class ExternalEntityTest extends BaseTest {

    @BeforeClass
    public static void beforeClass() throws Exception {
        sTestOrigDir = new ExtFile(sTmpDir, "doctype-orig");
        sTestNewDir = new ExtFile(sTmpDir, "doctype-new");

        LOGGER.info("Unpacking doctype...");
        TestUtils.copyResourceDir(ExternalEntityTest.class, "aapt1/doctype", sTestOrigDir);

        sConfig.setAaptVersion(1);

        LOGGER.info("Building doctype.apk...");
        ExtFile testApk = new ExtFile(sTmpDir, "doctype.apk");
        new ApkBuilder(sTestOrigDir, sConfig).build(testApk);

        LOGGER.info("Decoding doctype.apk...");
        new ApkDecoder(testApk, sConfig).decode(sTestNewDir);
    }

    @Test
    public void doctypeTest() throws IOException {
        String expected = TestUtils.replaceNewlines("<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<manifest android:versionCode=\"1\" android:versionName=\"1.0\" android:compileSdkVersion=\"23\" android:compileSdkVersionCodename=\"6.0-2438415\" " +
                "hardwareAccelerated=\"true\" package=\"com.ibotpeaches.doctype\" platformBuildVersionCode=\"24\" platformBuildVersionName=\"6.0-2456767\"  " +
                "xmlns:android=\"http://schemas.android.com/apk/res/android\">    <supports-screens android:anyDensity=\"true\" android:smallScreens=\"true\" " +
                "android:normalScreens=\"true\" android:largeScreens=\"true\" android:resizeable=\"true\" android:xlargeScreens=\"true\" /></manifest>");

        byte[] encoded = Files.readAllBytes(new File(sTestNewDir, "AndroidManifest.xml").toPath());
        String obtained = TestUtils.replaceNewlines(new String(encoded));

        assertEquals(expected, obtained);
    }
}