Back to Repositories

Validating Android Manifest Debuggable Attribute Processing in Apktool

This test suite validates the handling of debuggable attribute settings in Android manifests using AAPT2 within Apktool. It specifically focuses on verifying the correct preservation and modification of debuggable flags during APK building and decoding processes.

Test Coverage Overview

The test suite provides comprehensive coverage of debuggable attribute handling in Android manifests.

Tests APK building and decoding with debug mode enabled
Verifies correct preservation of debuggable=true attribute
Validates XML manifest structure and content integrity
Covers edge cases around manifest attribute handling

Implementation Analysis

The testing approach utilizes JUnit framework with XML comparison capabilities.

Key implementation patterns include:

Resource directory copying and manipulation
APK building and decoding workflow testing
XML content validation using XMLUnit
File system operations with ExtFile handling

Technical Details

Testing tools and configuration:

JUnit test framework
XMLUnit for XML comparison
Custom TestUtils for resource handling
ApkBuilder and ApkDecoder utilities
ExtFile for directory management
Configured with debug mode and verbose logging

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test setup and cleanup using @BeforeClass
Isolated test cases for specific functionality
Detailed logging for debugging
XML comparison with whitespace and attribute order handling
Resource cleanup and temporary file management

ibotpeaches/apktool

brut.apktool/apktool-lib/src/test/java/brut/androlib/aapt2/DebuggableTrueAddedTest.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.aapt2;

import brut.androlib.ApkBuilder;
import brut.androlib.ApkDecoder;
import brut.androlib.BaseTest;
import brut.androlib.TestUtils;
import brut.common.BrutException;
import brut.directory.ExtFile;
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 DebuggableTrueAddedTest extends BaseTest {

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

        LOGGER.info("Unpacking issue2328-debuggable-missing...");
        TestUtils.copyResourceDir(DebuggableTrueAddedTest.class, "aapt2/issue2328/debuggable-missing", sTestOrigDir);

        sConfig.setDebugMode(true);
        sConfig.setVerbose(true);

        LOGGER.info("Building issue2328-debuggable-missing.apk...");
        ExtFile testApk = new ExtFile(sTmpDir, "issue2328-debuggable-missing.apk");
        new ApkBuilder(sTestOrigDir, sConfig).build(testApk);

        LOGGER.info("Decoding issue2328-debuggable-missing.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\" " +
            "package=\"com.ibotpeaches.issue2328\" 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);
    }
}