DisassemblyTest.java revision d6043955f56f374165123c6f4ad8b70b824c5773 
1/*
2 * Copyright 2015, Google Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 *     * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *     * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
14 * distribution.
15 *     * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32package org.jf.baksmali;
33
34import com.google.common.collect.Iterables;
35import org.jf.dexlib2.Opcodes;
36import org.jf.dexlib2.dexbacked.DexBackedDexFile;
37import org.jf.dexlib2.iface.ClassDef;
38import org.junit.Assert;
39
40import javax.annotation.Nonnull;
41import java.io.File;
42import java.io.IOException;
43
44/**
45 * A base test class for performing a disassembly on a dex file and verifying the results
46 *
47 * The test accepts a single-class dex file as input, disassembles it, and  verifies that
48 * the result equals a known-good output smali file.
49 *
50 * By default, the input and output files should be resources at [testDir]/[testName]Input.dex
51 * and [testDir]/[testName]Output.smali respectively
52 */
53public class DisassemblyTest {
54    protected final String testDir;
55
56    protected DisassemblyTest(@Nonnull String testDir) {
57        this.testDir = testDir;
58    }
59
60    protected DisassemblyTest() {
61        this.testDir = this.getClass().getSimpleName();
62    }
63
64    @Nonnull
65    protected String getInputFilename(@Nonnull String testName) {
66        return String.format("%s%s%sInput.dex", testDir, File.separatorChar, testName);
67    }
68
69    @Nonnull
70    protected String getOutputFilename(@Nonnull String testName) {
71        return String.format("%s%s%sOutput.smali", testDir, File.separatorChar, testName);
72    }
73
74    protected void runTest(@Nonnull String testName) {
75        runTest(testName, new baksmaliOptions());
76    }
77
78    protected void runTest(@Nonnull String testName, @Nonnull baksmaliOptions options) {
79        try {
80            // Load file from resources as a stream
81            String inputFilename = getInputFilename(testName);
82            byte[] inputBytes = BaksmaliTestUtils.readResourceBytesFully(inputFilename);
83
84            DexBackedDexFile inputDex = new DexBackedDexFile(Opcodes.forApi(options.apiLevel), inputBytes);
85            Assert.assertEquals(1, inputDex.getClassCount());
86            ClassDef inputClass = Iterables.getFirst(inputDex.getClasses(), null);
87            Assert.assertNotNull(inputClass);
88            String input = BaksmaliTestUtils.getNormalizedSmali(inputClass, options, true);
89
90            String output;
91            if (getOutputFilename(testName).equals(inputFilename)) {
92                output = input;
93            } else {
94                output = BaksmaliTestUtils.readResourceFully(getOutputFilename(testName));
95            }
96            output = BaksmaliTestUtils.normalizeSmali(output, true);
97
98            // Run smali, baksmali, and then compare strings are equal (minus comments/whitespace)
99            Assert.assertEquals(output, input);
100        } catch (IOException ex) {
101            Assert.fail();
102        }
103    }
104}
105