/* * Copyright (C) 2014 The Android Open Source Project * * 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 * * http://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 com.android.manifmerger; import static com.android.manifmerger.ManifestMergerTestUtil.loadTestData; import static com.android.manifmerger.ManifestMergerTestUtil.transformParameters; import static com.android.manifmerger.MergingReport.Record; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.fail; import com.android.annotations.Nullable; import com.android.utils.StdLogger; import com.google.common.base.Optional; import com.google.common.base.Strings; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.Parameterized; import java.io.BufferedReader; import java.io.FileWriter; import java.io.IOException; import java.io.StringReader; import java.util.ArrayList; import java.util.Collection; import java.util.List; import java.util.Map; import java.util.logging.Logger; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * Tests for the {@link com.android.manifmerger.ManifestMerger2} class */ @RunWith(Parameterized.class) public class ManifestMerger2Test { private static final String TEST_DATA_DIRECTORY = "data2"; @SuppressWarnings("SpellCheckingInspection") private static final String[] DATA_FILES = new String[]{ "00_noop", "03_inject_attributes.xml", "05_inject_package.xml", "05_inject_package_placeholder.xml", "05_inject_package_with_overlays.xml", "06_inject_attributes_with_specific_prefix.xml", "05_inject_applicationid_not_provided.xml", "07_no_package_provided.xml", "08_no_library_package_provided.xml", "09_overlay_package_provided.xml", "08b_library_injection.xml", "09b_overlay_package_different.xml", "09c_overlay_package_not_provided.xml", "10_activity_merge", "11_activity_dup", "12_alias_dup", "13_service_dup", "14_receiver_dup", "15_provider_dup", "16_fqcn_merge", "17_fqcn_conflict", "18_fqcn_success", "20_uses_lib_merge", "21_uses_main_errors", "22_uses_lib_errors", "25_permission_merge", "26_permission_dup", "28_uses_perm_merge", "29_uses_perm_selector", "29b_uses_perm_invalidSelector", "30_uses_sdk_ok", "32_uses_sdk_minsdk_ok", "33_uses_sdk_minsdk_conflict", "33b_uses_sdk_minsdk_override.xml", "33c_uses_sdk_minsdk_override_and_conflict.xml", "34_inject_uses_sdk_no_dup.xml", "36_uses_sdk_targetsdk_warning", "40_uses_feat_merge", "41_uses_feat_errors", "45_uses_feat_gles_once", "47_uses_feat_gles_conflict", "50_uses_conf_warning", "52_support_screens_warning", "54_compat_screens_warning", "56_support_gltext_warning", "60_merge_order", "65_override_app", "66_remove_app", "67_override_activities", "68_override_uses", "69_remove_uses", "70_expand_fqcns", "71_extract_package_prefix", "75_app_metadata_merge", "76_app_metadata_ignore", "77_app_metadata_conflict", "78_removeAll", "78b_removeAllActivities", "79_custom_node.xml", }; @Parameterized.Parameters(name = "{0}") public static Collection getParameters() { return transformParameters(DATA_FILES); } private final String fileName; public ManifestMerger2Test(String fileName) { this.fileName = fileName; } @Test public void processTestFiles() throws Exception { ManifestMergerTestUtil.TestFiles testFiles = loadTestData(TEST_DATA_DIRECTORY, fileName, getClass().getSimpleName()); StdLogger stdLogger = new StdLogger(StdLogger.Level.VERBOSE); ManifestMerger2.Invoker invoker = ManifestMerger2.newMerger(testFiles.getMain(), stdLogger, ManifestMerger2.MergeType.APPLICATION) .addLibraryManifests(testFiles.getLibs()) .addFlavorAndBuildTypeManifests(testFiles.getOverlayFiles()) .withFeatures(ManifestMerger2.Invoker.Feature.KEEP_INTERMEDIARY_STAGES, ManifestMerger2.Invoker.Feature.REMOVE_TOOLS_DECLARATIONS); if (!Strings.isNullOrEmpty(testFiles.getPackageOverride())) { invoker.setOverride(ManifestSystemProperty.PACKAGE, testFiles.getPackageOverride()); } for (Map.Entry injectable : testFiles.getInjectAttributes().entrySet()) { ManifestSystemProperty manifestSystemProperty = getSystemProperty(injectable.getKey()); if (manifestSystemProperty != null) { invoker.setOverride(manifestSystemProperty, injectable.getValue()); } else { invoker.setPlaceHolderValue(injectable.getKey(), injectable.getValue()); } } MergingReport mergeReport = invoker.merge(); // this is obviously quite hacky, refine once merge output is better defined. boolean notExpectingError = !isExpectingError(testFiles.getExpectedErrors()); mergeReport.log(stdLogger); if (mergeReport.getResult().isSuccess()) { String xmlDocument = mergeReport.getMergedDocument( MergingReport.MergedManifestKind.MERGED); assertNotNull(xmlDocument); stdLogger.info(xmlDocument); if (testFiles.getActualResult() != null) { FileWriter writer = new FileWriter(testFiles.getActualResult()); try { writer.append(xmlDocument); } finally { writer.close(); } } if (!notExpectingError) { fail("Did not get expected error : " + testFiles.getExpectedErrors()); } XmlDocument expectedResult = TestUtils.xmlDocumentFromString( TestUtils.sourceFile(getClass(), testFiles.getMain().getName()), testFiles.getExpectedResult()); XmlDocument actualResult = TestUtils.xmlDocumentFromString( TestUtils.sourceFile(getClass(), testFiles.getMain().getName()), xmlDocument); Optional comparingMessage = expectedResult.compareTo(actualResult); if (comparingMessage.isPresent()) { Logger.getAnonymousLogger().severe(comparingMessage.get()); fail(comparingMessage.get()); } // process any warnings. if (mergeReport.getResult() == MergingReport.Result.WARNING) { compareExpectedAndActualErrors(mergeReport, testFiles.getExpectedErrors()); } } else { for (Record record : mergeReport.getLoggingRecords()) { Logger.getAnonymousLogger().info("Returned log: " + record); } compareExpectedAndActualErrors(mergeReport, testFiles.getExpectedErrors()); assertFalse(notExpectingError); } } private static boolean isExpectingError(String expectedOutput) throws IOException { StringReader stringReader = new StringReader(expectedOutput); BufferedReader reader = new BufferedReader(stringReader); try { String line; while ((line = reader.readLine()) != null) { if (line.startsWith("ERROR")) { return true; } } return false; } finally { reader.close(); } } private static void compareExpectedAndActualErrors( MergingReport mergeReport, String expectedOutput) throws IOException { StringReader stringReader = new StringReader(expectedOutput); List records = new ArrayList(mergeReport.getLoggingRecords()); BufferedReader reader = new BufferedReader(stringReader); try { String line = reader.readLine(); while (line != null) { if (line.startsWith("WARNING") || line.startsWith("ERROR")) { String message = line; do { line = reader.readLine(); if (line != null && line.startsWith(" ")) { message = message + "\n" + line; } } while (line != null && line.startsWith(" ")); // next might generate an exception which will make the test fail when we // get unexpected error message. if (!findLineInRecords(message, records)) { StringBuilder errorMessage = new StringBuilder(); dumpRecords(records, errorMessage); errorMessage.append("Cannot find expected error : \n").append(message); fail(errorMessage.toString()); } } } } finally { reader.close(); } // check that we do not have any unexpected error messages. if (!records.isEmpty()) { StringBuilder message = new StringBuilder(); dumpRecords(records, message); message.append("Unexpected error message(s)"); fail(message.toString()); } } private static boolean findLineInRecords(String errorLine, List records) { String severity = errorLine.substring(0, errorLine.indexOf(':')); String message = errorLine.substring(errorLine.indexOf(':') + 1); for (Record record : records) { int indexOfSuggestions = record.getMessage().indexOf("\n\tSuggestion:"); String messageRecord = indexOfSuggestions != -1 ? record.getMessage().substring(0, indexOfSuggestions) : record.getMessage(); Pattern pattern = Pattern.compile(message); Matcher matcher = pattern.matcher(messageRecord.replaceAll("\t", " ")); if (matcher.matches() && record.getSeverity() == Record.Severity.valueOf(severity)) { records.remove(record); return true; } } return false; } @Nullable private static ManifestSystemProperty getSystemProperty(String name) { for (ManifestSystemProperty manifestSystemProperty : ManifestSystemProperty.values()) { if (manifestSystemProperty.toCamelCase().equals(name)) { return manifestSystemProperty; } } return null; } private static void dumpRecords(List records, StringBuilder stringBuilder) { stringBuilder.append("\n------------ Records : \n"); for (Record record : records) { stringBuilder.append(record.toString()); stringBuilder.append("\n"); } stringBuilder.append("------------ End of records.\n"); } }