Back to Repositories

Validating Debug Tag Retention in Android Manifest Processing in Apktool

This test suite validates the retention of debug tags in Android manifest files during APK decoding and building processes using Apktool. It specifically focuses on ensuring debug attributes maintain their correct state through the build-decode cycle.

Test Coverage Overview

The test suite provides comprehensive coverage of debug tag handling in Android manifests.

Key areas tested include:

APK building process verification
Directory structure validation
XML manifest content verification
Debug attribute state preservation

The suite specifically addresses edge cases related to debug flag retention across build and decode operations.

Implementation Analysis

The testing approach utilizes JUnit framework with XML comparison capabilities through XMLUnit.

Implementation features:

BeforeClass setup for test environment preparation
Resource copying and APK building
Manifest content validation using XMLUnit assertions
File system operations verification

Technical Details

Testing tools and configuration:

JUnit test framework
XMLUnit for XML comparison
ExtFile for file operations
Custom TestUtils for resource handling
ApkBuilder and ApkDecoder utilities
AAPT version 1 configuration

Best Practices Demonstrated

The test suite exemplifies several testing best practices in Android tooling verification.

Notable practices include:

Proper test setup and cleanup
Isolated test environment
Detailed XML comparison
Resource management
Structured test organization
Clear test case naming

ibotpeaches/apktool

brut.apktool/apktool-lib/src/test/java/brut/androlib/aapt1/DebugTagRetainedTest.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 org.xml.sax.SAXException;

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

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

import org.custommonkey.xmlunit.XMLUnit;
import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;

public class DebugTagRetainedTest extends BaseTest {

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

        LOGGER.info("Unpacking issue1235...");
        TestUtils.copyResourceDir(DebugTagRetainedTest.class, "aapt1/issue1235", sTestOrigDir);

        sConfig.setAaptVersion(1);
        sConfig.setDebugMode(true);

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

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

    @Test
    public void buildAndDecodeTest() {
        assertTrue(sTestNewDir.isDirectory());
    }

    @Test
    public void DebugIsTruePriorToBeingFalseTest() throws IOException, SAXException {
        String expected = TestUtils.replaceNewlines("<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>" +
                "<manifest xmlns:android=\"http://schemas.android.com/apk/res/android\" android:compileSdkVersion=\"23\" " +
                "android:compileSdkVersionCodename=\"6.0-2438415\" package=\"com.ibotpeaches.issue1235\" platformBuildVersionCode=\"20\" " +
                "platformBuildVersionName=\"4.4W.2-1537038\">    <application android:debuggable=\"true\"/></manifest>");

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

        XMLUnit.setIgnoreWhitespace(true);
        XMLUnit.setIgnoreAttributeOrder(true);
        XMLUnit.setCompareUnmatched(false);

        assertXMLEqual(expected, obtained);
    }
}