Back to Repositories

Testing Resource Decoding Modes in Apktool

This test suite evaluates the resource decoding modes in Apktool, focusing on different handling strategies for Android resource files. It verifies the behavior of three distinct decoding modes – remove, dummies, and leave – when processing APK resources.

Test Coverage Overview

The test suite provides comprehensive coverage of Apktool’s resource decoding functionality:

Tests three distinct resource resolution modes: remove, dummies, and retain
Verifies XML file generation and structure integrity
Validates correct handling of Android resource files including strings.xml, attrs.xml, colors.xml, and public.xml
Ensures proper element count and structure in generated XML files

Implementation Analysis

The testing approach utilizes JUnit framework with a structured setup and verification process:

Implements BeforeClass setup for test resource preparation
Uses ApkDecoder class with different configuration modes
Employs XML document parsing and validation
Performs systematic verification of file existence and content structure

Technical Details

Testing infrastructure and components:

JUnit 4 testing framework
W3C DOM for XML parsing and validation
Custom TestUtils for resource management
ExtFile wrapper for file handling
Configuration-driven test execution
BrutException handling for error cases

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Clear test method naming reflecting functionality under test
Proper test setup and resource management
Systematic verification of output artifacts
Independent test cases for each decoding mode
Consistent assertion patterns
Thorough XML structure validation

ibotpeaches/apktool

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

import brut.androlib.ApkDecoder;
import brut.androlib.BaseTest;
import brut.androlib.Config;
import brut.androlib.TestUtils;
import brut.directory.ExtFile;
import brut.common.BrutException;
import org.w3c.dom.Document;

import java.io.File;

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

public class ResourceModeTest extends BaseTest {
    private static final String TEST_APK = "issue2836.apk";

    @BeforeClass
    public static void beforeClass() throws Exception {
        TestUtils.copyResourceDir(ResourceModeTest.class, "decode/issue2836", sTmpDir);
    }

    @Test
    public void checkDecodingModeAsRemove() throws BrutException {
        sConfig.setDecodeResolveMode(Config.DECODE_RES_RESOLVE_REMOVE);

        ExtFile testApk = new ExtFile(sTmpDir, TEST_APK);
        ExtFile testDir = new ExtFile(testApk + ".out.remove");
        new ApkDecoder(testApk, sConfig).decode(testDir);

        assertTrue(new File(testDir, "res/values/strings.xml").isFile());

        File attrXml = new File(testDir, "res/values/attrs.xml");
        Document attrDocument = loadDocument(attrXml);
        assertEquals(3, attrDocument.getElementsByTagName("enum").getLength());

        File colorXml = new File(testDir, "res/values/colors.xml");
        Document colorDocument = loadDocument(colorXml);
        assertEquals(8, colorDocument.getElementsByTagName("color").getLength());
        assertEquals(0, colorDocument.getElementsByTagName("item").getLength());

        File publicXml = new File(testDir, "res/values/public.xml");
        Document publicDocument = loadDocument(publicXml);
        assertEquals(21, publicDocument.getElementsByTagName("public").getLength());
    }

    @Test
    public void checkDecodingModeAsDummies() throws BrutException {
        sConfig.setDecodeResolveMode(Config.DECODE_RES_RESOLVE_DUMMY);

        ExtFile testApk = new ExtFile(sTmpDir, TEST_APK);
        ExtFile testDir = new ExtFile(testApk + ".out.dummies");
        new ApkDecoder(testApk, sConfig).decode(testDir);

        assertTrue(new File(testDir, "res/values/strings.xml").isFile());

        File attrXml = new File(testDir, "res/values/attrs.xml");
        Document attrDocument = loadDocument(attrXml);
        assertEquals(4, attrDocument.getElementsByTagName("enum").getLength());

        File colorXml = new File(testDir, "res/values/colors.xml");
        Document colorDocument = loadDocument(colorXml);
        assertEquals(8, colorDocument.getElementsByTagName("color").getLength());
        assertEquals(1, colorDocument.getElementsByTagName("item").getLength());

        File publicXml = new File(testDir, "res/values/public.xml");
        Document publicDocument = loadDocument(publicXml);
        assertEquals(22, publicDocument.getElementsByTagName("public").getLength());
    }

    @Test
    public void checkDecodingModeAsLeave() throws BrutException {
        sConfig.setDecodeResolveMode(Config.DECODE_RES_RESOLVE_RETAIN);

        ExtFile testApk = new ExtFile(sTmpDir, TEST_APK);
        ExtFile testDir = new ExtFile(testApk + ".out.leave");
        new ApkDecoder(testApk, sConfig).decode(testDir);

        assertTrue(new File(testDir, "res/values/strings.xml").isFile());

        Document attrDocument = loadDocument(new File(testDir, "res/values/attrs.xml"));
        assertEquals(4, attrDocument.getElementsByTagName("enum").getLength());

        Document colorDocument = loadDocument(new File(testDir, "res/values/colors.xml"));
        assertEquals(8, colorDocument.getElementsByTagName("color").getLength());
        assertEquals(0, colorDocument.getElementsByTagName("item").getLength());

        Document publicDocument = loadDocument(new File(testDir, "res/values/public.xml"));
        assertEquals(21, publicDocument.getElementsByTagName("public").getLength());
    }
}