Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: a562870a5e6e671215f64ece26ca57995a8d50c6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/*******************************************************************************
* Copyright (c) 2009, 2017 EclipseSource and others.
 *
 * This
* program and the accompanying materials are made available under the terms of
* the Eclipse Public License 2.0 which accompanies this distribution, and is
* available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
*
* Contributors:
*   EclipseSource - initial API and implementation
******************************************************************************/
package org.eclipse.equinox.p2.tests.metadata.repository;

import java.io.*;
import java.lang.reflect.Field;
import java.net.URI;
import java.util.*;
import org.eclipse.core.runtime.*;
import org.eclipse.equinox.internal.p2.metadata.repository.LocalMetadataRepository;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.metadata.Version;
import org.eclipse.equinox.p2.query.QueryUtil;
import org.eclipse.equinox.p2.repository.IRunnableWithProgress;
import org.eclipse.equinox.p2.repository.metadata.IMetadataRepositoryManager;
import org.eclipse.equinox.p2.tests.AbstractProvisioningTest;

/**
 * This tests Batch Execution for Metadata Repositories
 */
public class BatchExecuteMetadataRepositoryTest extends AbstractProvisioningTest {

	//metadata repository to remove on tear down
	private File repositoryFile = null;
	private URI repositoryURI = null;

	protected Collection<IInstallableUnit> createIUInCollection(String id, Version version) {
		IInstallableUnit iu = createIU(id, version);
		Collection<IInstallableUnit> result = new ArrayList<>(1);
		result.add(iu);
		return result;
	}

	boolean fileContainsString(URI location, String string) throws IOException {
		StringBuilder buffer = new StringBuilder();
		try (BufferedReader reader = new BufferedReader(new FileReader(new File(location)));) {
			while (reader.ready())
				buffer.append(reader.readLine());
			return buffer.toString().contains(string);
		}
	}

	/*
	 * This tests that in the normal case, the batch process runs fine
	 */
	public void testAdd() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			final URI contentXML = new URI(repositoryFile.toURI().toString() + "/content.xml");
			IStatus status = repo.executeBatch(monitor -> {
				repo.addInstallableUnits(createIUInCollection("foo", Version.emptyVersion));
				try {
					assertFalse("1.0", fileContainsString(contentXML, "foo"));
				} catch (IOException e) {
					fail("0.99");
				}
			}, new NullProgressMonitor());
			assertTrue(status.isOK());
			assertTrue("1.0", fileContainsString(contentXML, "foo"));
			assertEquals("2.0", 1, repo.query(QueryUtil.createIUQuery("foo"), new NullProgressMonitor()).toSet().size());
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This tests 3 adds
	 */
	public void testMultiAdd() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			final URI contentXML = new URI(repositoryFile.toURI().toString() + "/content.xml");
			IStatus status = repo.executeBatch(monitor -> {
				repo.addInstallableUnits(createIUInCollection("foo", Version.emptyVersion));
				repo.addInstallableUnits(createIUInCollection("bar", Version.emptyVersion));
				repo.addInstallableUnits(createIUInCollection("baz", Version.emptyVersion));
				try {
					assertFalse("1.0", fileContainsString(contentXML, "foo"));
					assertFalse("1.0", fileContainsString(contentXML, "bar"));
					assertFalse("1.0", fileContainsString(contentXML, "baz"));
				} catch (IOException e) {
					fail("0.99");
				}
			}, new NullProgressMonitor());
			assertTrue(status.isOK());
			assertEquals("1.0", 1, repo.query(QueryUtil.createIUQuery("foo"), new NullProgressMonitor()).toSet().size());
			assertEquals("1.1", 1, repo.query(QueryUtil.createIUQuery("bar"), new NullProgressMonitor()).toSet().size());
			assertEquals("1.2", 1, repo.query(QueryUtil.createIUQuery("baz"), new NullProgressMonitor()).toSet().size());
			assertTrue("2.0", fileContainsString(contentXML, "foo"));
			assertTrue("2.1", fileContainsString(contentXML, "bar"));
			assertTrue("2.2", fileContainsString(contentXML, "baz"));
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This tests multiple adds with an exception thrown. Makes sure that the descriptors are added
	 */
	public void testMultiAddWithException() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			final URI contentXML = new URI(repositoryFile.toURI().toString() + "/content.xml");
			IStatus status = repo.executeBatch(monitor -> {
				repo.addInstallableUnits(createIUInCollection("foo", Version.emptyVersion));
				repo.addInstallableUnits(createIUInCollection("bar", Version.emptyVersion));
				throw new RuntimeException();
			}, new NullProgressMonitor());
			assertFalse(status.isOK());
			assertEquals("1.0", 1, repo.query(QueryUtil.createIUQuery("foo"), new NullProgressMonitor()).toSet().size());
			assertEquals("1.1", 1, repo.query(QueryUtil.createIUQuery("bar"), new NullProgressMonitor()).toSet().size());
			assertTrue("2.0", fileContainsString(contentXML, "foo"));
			assertTrue("2.1", fileContainsString(contentXML, "bar"));
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This tests multiple adds with an exception thrown. Makes sure that the descriptors are added
	 */
	public void testAddAndRemove() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			final URI contentXML = new URI(repositoryFile.toURI().toString() + "/content.xml");
			IStatus status = repo.executeBatch(monitor -> {
				Collection<IInstallableUnit> foo = createIUInCollection("foo", Version.emptyVersion);
				repo.addInstallableUnits(foo);
				repo.addInstallableUnits(createIUInCollection("bar", Version.emptyVersion));
				repo.removeInstallableUnits(foo);
			}, new NullProgressMonitor());
			assertTrue(status.isOK());
			assertEquals("1.0", 0, repo.query(QueryUtil.createIUQuery("foo"), new NullProgressMonitor()).toSet().size());
			assertEquals("1.1", 1, repo.query(QueryUtil.createIUQuery("bar"), new NullProgressMonitor()).toSet().size());
			assertFalse("2.0", fileContainsString(contentXML, "foo"));
			assertTrue("2.1", fileContainsString(contentXML, "bar"));
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This tests multiple adds with an exception thrown. Makes sure that the descriptors are added
	 */
	public void testMultiAddAndRemove() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			final URI contentXML = new URI(repositoryFile.toURI().toString() + "/content.xml");
			IStatus status = repo.executeBatch(monitor -> {
				repo.addInstallableUnits(createIUInCollection("1", Version.emptyVersion));
				repo.addInstallableUnits(createIUInCollection("2", Version.emptyVersion));
				repo.addInstallableUnits(createIUInCollection("3", Version.emptyVersion));
				Collection<IInstallableUnit> foo = createIUInCollection("foo", Version.emptyVersion);
				repo.addInstallableUnits(foo);
				repo.addInstallableUnits(createIUInCollection("bar", Version.emptyVersion));
				repo.removeInstallableUnits(foo);
			}, new NullProgressMonitor());
			assertTrue(status.isOK());
			assertEquals("1.0", 4, repo.query(QueryUtil.createIUAnyQuery(), new NullProgressMonitor()).toSet().size());
			assertFalse("2.0", fileContainsString(contentXML, "foo"));
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This tests that in the normal case, the batch process runs fine
	 */
	public void testBatchProcessingOK() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			IStatus status = repo.executeBatch(monitor -> {
				// empty
			}, new NullProgressMonitor());
			assertTrue(status.isOK());
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	class FailingSimpleMetadataRepository extends LocalMetadataRepository {
		boolean executeBatch = false;

		/**
		 * @param repositoryName
		 * @param location
		 * @param properties
		 */
		public FailingSimpleMetadataRepository() {
			super(getAgent());
		}

		@Override
		public IStatus executeBatch(IRunnableWithProgress runnable, IProgressMonitor monitor) {
			executeBatch = true;
			return super.executeBatch(runnable, monitor);
		}

		@Override
		public void save() {
			if (executeBatch)
				throw new RuntimeException("foo");
		}
	}

	/*
	 * This tests that exceptions are properly propagated for a SimpleMetadataRepository
	 */
	public void testBatchProcessingExceptionsSimple() {
		try {
			LocalMetadataRepository simpleMetadataRepository = new FailingSimpleMetadataRepository();

			IStatus status = simpleMetadataRepository.executeBatch(monitor -> {
				throw new RuntimeException("bar");
			}, new NullProgressMonitor());
			assertFalse(status.isOK());
			assertEquals("foo", status.getException().getMessage());
			assertEquals(1, status.getChildren().length);
			assertEquals("bar", status.getChildren()[0].getMessage());
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This tests that exceptions are properly propagated for a SimpleMetadataRepository
	 */
	public void testBatchProcessingSaveExceptionSimple() {
		try {
			LocalMetadataRepository simpleMetadataRepository = new FailingSimpleMetadataRepository();

			IStatus status = simpleMetadataRepository.executeBatch(monitor -> {
				// empty
			}, new NullProgressMonitor());
			assertFalse(status.isOK());
			assertEquals("foo", status.getException().getMessage());
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	class TrackSavignSimpleMetadataRepository extends LocalMetadataRepository {
		boolean executeBatch = false;
		public boolean didSave = false;

		/**
		 * @param repositoryName
		 * @param location
		 * @param properties
		 */
		public TrackSavignSimpleMetadataRepository() {
			super(getAgent());
		}

		@Override
		public IStatus executeBatch(IRunnableWithProgress runnable, IProgressMonitor monitor) {
			executeBatch = true;
			return super.executeBatch(runnable, monitor);
		}

		@Override
		public void save() {
			if (executeBatch)
				didSave = true;
		}
	}

	/*
	 * This test ensure that a repository did in fact save the results,
	 * if there was no exception
	 */
	public void testBatchProcessingTrackSaving() {
		try {
			TrackSavignSimpleMetadataRepository simpleMetadataRepository = new TrackSavignSimpleMetadataRepository();
			simpleMetadataRepository.executeBatch(monitor -> {
				//do nothing;
			}, new NullProgressMonitor());
			assertTrue(simpleMetadataRepository.didSave);
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This test ensures that a repository did in fact save the results, even
	 * if there was an exception
	 */
	public void testBatchProcessingTrackSavingException() {
		try {
			TrackSavignSimpleMetadataRepository simpleMetadataRepository = new TrackSavignSimpleMetadataRepository();
			simpleMetadataRepository.executeBatch(monitor -> {
				throw new RuntimeException();
			}, new NullProgressMonitor());
			assertTrue(simpleMetadataRepository.didSave);
		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This test ensures that the simple repository resets the disableSave flag
	 * even if there is an exception
	 */
	public void testDisableSaveFlagResetSimple() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			repo.executeBatch(monitor -> {
				throw new RuntimeException();
			}, new NullProgressMonitor());
			Field field = LocalMetadataRepository.class.getDeclaredField("disableSave");
			field.setAccessible(true);
			boolean disableSave = field.getBoolean(repo);
			assertFalse("1.0", disableSave);

		} catch (Exception e) {
			fail("Test failed", e);
		}
	}

	/*
	 * This test ensure that the simple metadata repository disables the
	 * save flag during the batch process
	 */
	public void testDisableSaveFlagDuringExecutionSimple() {
		try {
			repositoryFile = getTempFolder();
			repositoryURI = repositoryFile.toURI();
			Map<String, String> properties = new HashMap<>();
			final LocalMetadataRepository repo = (LocalMetadataRepository) getMetadataRepositoryManager().createRepository(repositoryURI, "My Repo", IMetadataRepositoryManager.TYPE_SIMPLE_REPOSITORY, properties);
			repo.executeBatch(monitor -> {
				Field field;
				try {
					field = LocalMetadataRepository.class.getDeclaredField("disableSave");
					field.setAccessible(true);
					boolean disableSave = field.getBoolean(repo);
					assertTrue("1.0", disableSave);
				} catch (SecurityException e1) {
					fail("1.1" + e1.getMessage());
				} catch (NoSuchFieldException e2) {
					// TODO Auto-generated catch block
					fail("1.2" + e2.getMessage());
				} catch (IllegalArgumentException e3) {
					fail("1.2" + e3.getMessage());
				} catch (IllegalAccessException e4) {
					fail("1.2" + e4.getMessage());
				}
			}, new NullProgressMonitor());

		} catch (Exception e) {
			fail("Test failed", e);
		}
	}
}

Back to the top