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 32 package org.jf.baksmali; 33 34 import org.antlr.runtime.RecognitionException; 35 import org.junit.Assert; 36 37 import javax.annotation.Nonnull; 38 import java.io.File; 39 import java.io.IOException; 40 41 /** 42 * A base test class for performing a roundtrip assembly/disassembly 43 * 44 * The test accepts a smali file as input, performs a smali -> dex -> smali roundtrip, and 45 * verifies that the result equals a known-good output smali file. 46 * 47 * By default, the input and output files should be resources at [testDir]/[testName]Input.smali 48 * and [testDir]/[testName]Output.smali respectively 49 */ 50 public abstract class RoundtripTest { 51 protected final String testDir; 52 RoundtripTest(@onnull String testDir)53 protected RoundtripTest(@Nonnull String testDir) { 54 this.testDir = testDir; 55 } 56 RoundtripTest()57 protected RoundtripTest() { 58 this.testDir = this.getClass().getSimpleName(); 59 } 60 61 @Nonnull getInputFilename(@onnull String testName)62 protected String getInputFilename(@Nonnull String testName) { 63 return String.format("%s%s%sInput.smali", testDir, File.separatorChar, testName); 64 } 65 66 @Nonnull getOutputFilename(@onnull String testName)67 protected String getOutputFilename(@Nonnull String testName) { 68 return String.format("%s%s%sOutput.smali", testDir, File.separatorChar, testName); 69 } 70 runTest(@onnull String testName)71 protected void runTest(@Nonnull String testName) { 72 runTest(testName, new BaksmaliOptions()); 73 } 74 runTest(@onnull String testName, @Nonnull BaksmaliOptions options)75 protected void runTest(@Nonnull String testName, @Nonnull BaksmaliOptions options) { 76 try { 77 // Load file from resources as a stream 78 String inputFilename = getInputFilename(testName); 79 String input = BaksmaliTestUtils.readResourceFully(getInputFilename(testName)); 80 String output; 81 if (getOutputFilename(testName).equals(inputFilename)) { 82 output = input; 83 } else { 84 output = BaksmaliTestUtils.readResourceFully(getOutputFilename(testName)); 85 } 86 87 // Run smali, baksmali, and then compare strings are equal (minus comments/whitespace) 88 BaksmaliTestUtils.assertSmaliCompiledEquals(input, output, options, true); 89 } catch (IOException ex) { 90 Assert.fail(); 91 } catch (RecognitionException ex) { 92 Assert.fail(); 93 } 94 } 95 } 96