Back to Repositories

Testing Minified ARSC Layout Decoding in Apktool

This test suite validates the handling of minified ARSC files in Android APK decoding, specifically focusing on layout file preservation and custom view attributes. It ensures proper decoding of resource files when dealing with minified configurations.

Test Coverage Overview

The test suite covers the decoding of minified ARSC (Android Resource) files with particular attention to XML layout preservation.

Key areas tested include:
  • Layout file integrity after decoding
  • Custom view attribute preservation
  • XML namespace handling
  • Resource file structure validation

Implementation Analysis

The testing approach utilizes JUnit framework with a structured setup using @BeforeClass for initialization.

Key implementation patterns include:
  • Resource directory copying for test isolation
  • APK decoder configuration management
  • Byte-level file comparison
  • String normalization for cross-platform testing

Technical Details

Testing tools and configuration:
  • JUnit test framework
  • ApkDecoder utility class
  • ExtFile for extended file operations
  • TestUtils for resource management
  • File system operations via java.nio
  • XML content validation

Best Practices Demonstrated

The test implementation showcases several testing best practices for Android APK processing.

Notable practices include:
  • Isolated test environment setup
  • Resource cleanup management
  • Cross-platform compatibility handling
  • Structured test case organization
  • Clear expected vs actual result comparison

ibotpeaches/apktool

brut.apktool/apktool-lib/src/test/java/brut/androlib/decode/MinifiedArscTest.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.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 MinifiedArscTest extends BaseTest {

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

        sConfig.setForceDelete(true);

        ExtFile testApk = new ExtFile(sTmpDir, "issue1157.apk");
        sTestNewDir = new ExtFile(testApk + ".out");

        new ApkDecoder(testApk, sConfig).decode(sTestNewDir);
    }

    @Test
    public void checkIfMinifiedArscLayoutFileMatchesTest() throws IOException {
        String expected = TestUtils.replaceNewlines("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" +
                "<LinearLayout n1:orientation=\"vertical\" n1:layout_width=\"fill_parent\" n1:layout_height=\"fill_parent\"\n" +
                "  xmlns:n1=\"http://schemas.android.com/apk/res/android\">\n" +
                "    <com.ibotpeaches.issue1157.MyCustomView n1:max=\"100\" n2:default_value=\"1.0\" n2:max_value=\"5.0\" n2:min_value=\"0.2\" xmlns:n2=\"http://schemas.android.com/apk/res-auto\" />\n" +
                "</LinearLayout>");

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

        assertEquals(expected, obtained);
    }
}