| 1 |
/* |
| 2 |
* Copyright (C) 2015 The Android Open Source Project |
| 3 |
* |
| 4 |
* Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 |
* you may not use this file except in compliance with the License. |
| 6 |
* You may obtain a copy of the License at |
| 7 |
* |
| 8 |
* http://www.apache.org/licenses/LICENSE-2.0 |
| 9 |
* |
| 10 |
* Unless required by applicable law or agreed to in writing, software |
| 11 |
* distributed under the License is distributed on an "AS IS" BASIS, |
| 12 |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 |
* See the License for the specific language governing permissions and |
| 14 |
* limitations under the License. |
| 15 |
*/ |
| 16 |
|
| 17 |
package com.android.manifmerger; |
| 18 |
|
| 19 |
import static org.mockito.Mockito.verify; |
| 20 |
import static org.mockito.Mockito.verifyNoMoreInteractions; |
| 21 |
import static org.mockito.Mockito.when; |
| 22 |
|
| 23 |
import com.android.annotations.NonNull; |
| 24 |
import com.android.sdklib.mock.MockLog; |
| 25 |
import com.android.utils.ILogger; |
| 26 |
import com.android.utils.StdLogger; |
| 27 |
import com.google.common.collect.ImmutableList; |
| 28 |
|
| 29 |
import junit.framework.TestCase; |
| 30 |
|
| 31 |
import org.mockito.Mock; |
| 32 |
import org.mockito.Mockito; |
| 33 |
import org.mockito.MockitoAnnotations; |
| 34 |
|
| 35 |
import java.io.File; |
| 36 |
import java.io.FileNotFoundException; |
| 37 |
import java.io.FileReader; |
| 38 |
import java.io.IOException; |
| 39 |
import java.nio.CharBuffer; |
| 40 |
|
| 41 |
/** |
| 42 |
* Tests for {@link Merger} class |
| 43 |
*/ |
| 44 |
public class MergerTest extends TestCase { |
| 45 |
|
| 46 |
@Mock |
| 47 |
ManifestMerger2.Invoker mInvoker; |
| 48 |
|
| 49 |
@Mock |
| 50 |
MergingReport mMergingReport; |
| 51 |
|
| 52 |
@Override |
| 53 |
protected void setUp() throws Exception { |
| 54 |
super.setUp(); |
| 55 |
MockitoAnnotations.initMocks(this); |
| 56 |
} |
| 57 |
|
| 58 |
private class MergerWithMock extends Merger { |
| 59 |
|
| 60 |
@Override |
| 61 |
protected ManifestMerger2.Invoker createInvoker(@NonNull File mainManifestFile, @NonNull ILogger logger) { |
| 62 |
try { |
| 63 |
when(mMergingReport.getResult()).thenReturn(MergingReport.Result.ERROR); |
| 64 |
when(mMergingReport.getLoggingRecords()).thenReturn( |
| 65 |
ImmutableList.<MergingReport.Record>of()); |
| 66 |
when(mInvoker.merge()).thenReturn(mMergingReport); |
| 67 |
} catch (ManifestMerger2.MergeFailureException e) { |
| 68 |
fail(e.getMessage()); |
| 69 |
} |
| 70 |
return mInvoker; |
| 71 |
} |
| 72 |
|
| 73 |
@Override |
| 74 |
protected File checkPath(@NonNull String path) throws FileNotFoundException { |
| 75 |
return new File(path); // always exists... |
| 76 |
} |
| 77 |
} |
| 78 |
|
| 79 |
public void testMainParameter() throws FileNotFoundException { |
| 80 |
final String[] args = { "--main", "src/main/AndroidManifest.xml" }; |
| 81 |
new MergerWithMock() { |
| 82 |
@Override |
| 83 |
protected ManifestMerger2.Invoker createInvoker(@NonNull File mainManifestFile, @NonNull ILogger logger) { |
| 84 |
assertEquals(args[1], mainManifestFile.getPath()); |
| 85 |
return super.createInvoker(mainManifestFile, logger); |
| 86 |
} |
| 87 |
}.process(args); |
| 88 |
} |
| 89 |
|
| 90 |
public void testDefaultLoggerParameter() throws FileNotFoundException { |
| 91 |
final String[] args = { "--main", "src/main/AndroidManifest.xml" }; |
| 92 |
new MergerWithMock() { |
| 93 |
@Override |
| 94 |
protected ILogger createLogger(@NonNull StdLogger.Level level) { |
| 95 |
assertEquals(StdLogger.Level.INFO, level); |
| 96 |
return super.createLogger(level); |
| 97 |
} |
| 98 |
}.process(args); |
| 99 |
} |
| 100 |
|
| 101 |
public void testLoggerParameter() throws FileNotFoundException { |
| 102 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 103 |
"--log", "VERBOSE" }; |
| 104 |
new MergerWithMock() { |
| 105 |
@Override |
| 106 |
protected ILogger createLogger(@NonNull StdLogger.Level level) { |
| 107 |
assertEquals(StdLogger.Level.VERBOSE, level); |
| 108 |
return super.createLogger(level); |
| 109 |
} |
| 110 |
}.process(args); |
| 111 |
} |
| 112 |
|
| 113 |
public void testLibParameter() |
| 114 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 115 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 116 |
"--libs", "src/lib/AndroidManifest.xml" }; |
| 117 |
new MergerWithMock().process(args); |
| 118 |
verify(mInvoker).addLibraryManifest(new File("src/lib/AndroidManifest.xml")); |
| 119 |
verify(mInvoker).merge(); |
| 120 |
verifyNoMoreInteractions(mInvoker); |
| 121 |
} |
| 122 |
|
| 123 |
public void testLibsParameter() |
| 124 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 125 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 126 |
"--libs", "src/lib1/AndroidManifest.xml" + File.pathSeparator |
| 127 |
+ "src/lib2/AndroidManifest.xml" + File.pathSeparator |
| 128 |
+ "src/lib3/AndroidManifest.xml" }; |
| 129 |
new MergerWithMock().process(args); |
| 130 |
verify(mInvoker).addLibraryManifest(new File("src/lib1/AndroidManifest.xml")); |
| 131 |
verify(mInvoker).addLibraryManifest(new File("src/lib2/AndroidManifest.xml")); |
| 132 |
verify(mInvoker).addLibraryManifest(new File("src/lib3/AndroidManifest.xml")); |
| 133 |
verify(mInvoker).merge(); |
| 134 |
verifyNoMoreInteractions(mInvoker); |
| 135 |
} |
| 136 |
|
| 137 |
public void testOverlayParameter() |
| 138 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 139 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 140 |
"--overlays", "src/flavor1/AndroidManifest.xml" }; |
| 141 |
new MergerWithMock().process(args); |
| 142 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor1/AndroidManifest.xml")); |
| 143 |
verify(mInvoker).merge(); |
| 144 |
verifyNoMoreInteractions(mInvoker); |
| 145 |
} |
| 146 |
|
| 147 |
public void testOverlaysParameter() |
| 148 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 149 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 150 |
"--overlays", "src/flavor1/AndroidManifest.xml" + File.pathSeparator |
| 151 |
+ "src/flavor2/AndroidManifest.xml" + File.pathSeparator |
| 152 |
+ "src/flavor3/AndroidManifest.xml" }; |
| 153 |
new MergerWithMock().process(args); |
| 154 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor1/AndroidManifest.xml")); |
| 155 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor2/AndroidManifest.xml")); |
| 156 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor3/AndroidManifest.xml")); |
| 157 |
verify(mInvoker).merge(); |
| 158 |
verifyNoMoreInteractions(mInvoker); |
| 159 |
} |
| 160 |
|
| 161 |
public void testPropertyParameter() |
| 162 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 163 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 164 |
"--property", "min_sdk_version=19" }; |
| 165 |
new MergerWithMock().process(args); |
| 166 |
verify(mInvoker).setOverride(ManifestSystemProperty.MIN_SDK_VERSION, "19"); |
| 167 |
verify(mInvoker).merge(); |
| 168 |
verifyNoMoreInteractions(mInvoker); |
| 169 |
} |
| 170 |
|
| 171 |
public void testInvalidPropertyParameter() |
| 172 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 173 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 174 |
"--property", "Foo=19" }; |
| 175 |
final MockLog iLogger = new MockLog(); |
| 176 |
Merger merger = new MergerWithMock() { |
| 177 |
@Override |
| 178 |
protected ILogger createLogger(@NonNull StdLogger.Level level) { |
| 179 |
return iLogger; |
| 180 |
} |
| 181 |
}; |
| 182 |
// check that return value marked the failure. |
| 183 |
assertEquals(1, merger.process(args)); |
| 184 |
assertEquals(2, iLogger.getMessages().size()); |
| 185 |
assertTrue(iLogger.getMessages().get(1).startsWith( |
| 186 |
"E Invalid property name Foo, allowed properties are :")); |
| 187 |
} |
| 188 |
|
| 189 |
public void testInvalidFormatPropertyParameter() |
| 190 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 191 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 192 |
"--property", "Foo:19" }; |
| 193 |
final MockLog iLogger = new MockLog(); |
| 194 |
Merger merger = new MergerWithMock() { |
| 195 |
@Override |
| 196 |
protected ILogger createLogger(@NonNull StdLogger.Level level) { |
| 197 |
return iLogger; |
| 198 |
} |
| 199 |
}; |
| 200 |
// check that return value marked the failure. |
| 201 |
assertEquals(1, merger.process(args)); |
| 202 |
assertEquals(1, iLogger.getMessages().size()); |
| 203 |
assertEquals("E Invalid property setting, should be NAME=VALUE format", |
| 204 |
iLogger.getMessages().get(0)); |
| 205 |
} |
| 206 |
|
| 207 |
public void testPlaceholderParameter() |
| 208 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 209 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 210 |
"--placeholder", "foo=bar" }; |
| 211 |
new MergerWithMock().process(args); |
| 212 |
verify(mInvoker).setPlaceHolderValue("foo", "bar"); |
| 213 |
verify(mInvoker).merge(); |
| 214 |
verifyNoMoreInteractions(mInvoker); |
| 215 |
} |
| 216 |
|
| 217 |
public void testInvalidFormatPlaceholderParameter() |
| 218 |
throws FileNotFoundException, ManifestMerger2.MergeFailureException { |
| 219 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 220 |
"--placeholder", "Foo:19" }; |
| 221 |
final MockLog iLogger = new MockLog(); |
| 222 |
Merger merger = new MergerWithMock() { |
| 223 |
@Override |
| 224 |
protected ILogger createLogger(@NonNull StdLogger.Level level) { |
| 225 |
return iLogger; |
| 226 |
} |
| 227 |
}; |
| 228 |
// check that return value marked the failure. |
| 229 |
assertEquals(1, merger.process(args)); |
| 230 |
assertEquals(1, iLogger.getMessages().size()); |
| 231 |
assertEquals("E Invalid placeholder setting, should be NAME=VALUE format", |
| 232 |
iLogger.getMessages().get(0)); |
| 233 |
} |
| 234 |
|
| 235 |
public void testCombinedParameters() |
| 236 |
throws IOException, ManifestMerger2.MergeFailureException { |
| 237 |
|
| 238 |
File outFile = File.createTempFile("test", "merger"); |
| 239 |
|
| 240 |
final String[] args = { "--main", "src/main/AndroidManifest.xml", |
| 241 |
"--libs", "src/lib1/AndroidManifest.xml" + File.pathSeparator |
| 242 |
+ "src/lib2/AndroidManifest.xml" + File.pathSeparator |
| 243 |
+ "src/lib3/AndroidManifest.xml", |
| 244 |
"--overlays", "src/flavor1/AndroidManifest.xml" + File.pathSeparator |
| 245 |
+ "src/flavor2/AndroidManifest.xml" + File.pathSeparator |
| 246 |
+ "src/flavor3/AndroidManifest.xml", |
| 247 |
"--placeholder", "Foo=bar", |
| 248 |
"--property", "max_sdk_version=21", |
| 249 |
"--out", outFile.getAbsolutePath()}; |
| 250 |
Merger merger = new MergerWithMock() { |
| 251 |
@Override |
| 252 |
protected ManifestMerger2.Invoker createInvoker(@NonNull File mainManifestFile, @NonNull ILogger logger) { |
| 253 |
try { |
| 254 |
XmlDocument xmlDocument = Mockito.mock(XmlDocument.class); |
| 255 |
when(mMergingReport.getResult()).thenReturn(MergingReport.Result.SUCCESS); |
| 256 |
when(mMergingReport.getMergedDocument(MergingReport.MergedManifestKind.MERGED)) |
| 257 |
.thenReturn("Pretty combined"); |
| 258 |
when(mInvoker.merge()).thenReturn(mMergingReport); |
| 259 |
} catch (ManifestMerger2.MergeFailureException e) { |
| 260 |
fail(e.getMessage()); |
| 261 |
} |
| 262 |
return mInvoker; |
| 263 |
} |
| 264 |
}; |
| 265 |
merger.process(args); |
| 266 |
verify(mInvoker).addLibraryManifest(new File("src/lib1/AndroidManifest.xml")); |
| 267 |
verify(mInvoker).addLibraryManifest(new File("src/lib2/AndroidManifest.xml")); |
| 268 |
verify(mInvoker).addLibraryManifest(new File("src/lib3/AndroidManifest.xml")); |
| 269 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor1/AndroidManifest.xml")); |
| 270 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor2/AndroidManifest.xml")); |
| 271 |
verify(mInvoker).addFlavorAndBuildTypeManifest(new File("src/flavor3/AndroidManifest.xml")); |
| 272 |
verify(mInvoker).setOverride(ManifestSystemProperty.MAX_SDK_VERSION, "21"); |
| 273 |
verify(mInvoker).setPlaceHolderValue("Foo", "bar"); |
| 274 |
verify(mInvoker).merge(); |
| 275 |
verifyNoMoreInteractions(mInvoker); |
| 276 |
|
| 277 |
// check the resulting file content. |
| 278 |
FileReader fileReader = null; |
| 279 |
try { |
| 280 |
fileReader = new FileReader(outFile); |
| 281 |
CharBuffer buffer = CharBuffer.allocate(256); |
| 282 |
fileReader.read(buffer); |
| 283 |
int endOfRead = buffer.position(); |
| 284 |
assertEquals("Pretty combined", buffer.rewind().toString().substring(0, endOfRead)); |
| 285 |
} finally { |
| 286 |
if (fileReader != null) { |
| 287 |
fileReader.close(); |
| 288 |
} |
| 289 |
} |
| 290 |
assertTrue(outFile.delete()); |
| 291 |
} |
| 292 |
} |