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.dexbacked.DexBackedDexFile;
36import org.jf.dexlib2.iface.ClassDef;
37import org.junit.Assert;
38
39import javax.annotation.Nonnull;
40import java.io.File;
41import java.io.IOException;
42
43/**
44 * A base test class for performing a disassembly on a dex file and verifying the results
45 *
46 * The test accepts a single-class dex file as input, disassembles it, and  verifies that
47 * the result equals a known-good output smali file.
48 *
49 * By default, the input and output files should be resources at [testDir]/[testName]Input.dex
50 * and [testDir]/[testName]Output.smali respectively
51 */
52public class DisassemblyTest extends DexTest {
53
54    @Nonnull
55    protected String getOutputFilename(@Nonnull String testName) {
56        return String.format("%s%s%sOutput.smali", testDir, File.separatorChar, testName);
57    }
58
59    protected void runTest(@Nonnull String testName) {
60        runTest(testName, new baksmaliOptions());
61    }
62
63    protected void runTest(@Nonnull String testName, @Nonnull baksmaliOptions options) {
64        try {
65            DexBackedDexFile inputDex = getInputDexFile(testName, options);
66            Assert.assertEquals(1, inputDex.getClassCount());
67            ClassDef inputClass = Iterables.getFirst(inputDex.getClasses(), null);
68            Assert.assertNotNull(inputClass);
69            String input = BaksmaliTestUtils.getNormalizedSmali(inputClass, options, true);
70
71            String output = BaksmaliTestUtils.readResourceFully(getOutputFilename(testName));
72            output = BaksmaliTestUtils.normalizeSmali(output, true);
73
74            // Run smali, baksmali, and then compare strings are equal (minus comments/whitespace)
75            Assert.assertEquals(output, input);
76        } catch (IOException ex) {
77            Assert.fail();
78        }
79    }
80}
81