Bug 405918 - [unity] save persistent data after period of inactivity

Basic tests for immediate, periodic, and no persistence.

1 files changed, 183 insertions, 0 deletions

diff --git a/bundles/org.eclipse.osgi.tests/src/org/eclipse/osgi/tests/bundles/PersistedBundleTests.java b/bundles/org.eclipse.osgi.tests/src/org/eclipse/osgi/tests/bundles/PersistedBundleTests.java
new file mode 100644
index 000000000..f3709bf74
--- /dev/null
+++ b/bundles/org.eclipse.osgi.tests/src/org/eclipse/osgi/tests/bundles/PersistedBundleTests.java
@@ -0,0 +1,183 @@
+/*******************************************************************************
+ * Copyright (c) 2013 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.osgi.tests.bundles;
+
+import java.io.*;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.jar.*;
+import junit.framework.Test;
+import junit.framework.TestSuite;
+import org.eclipse.osgi.launch.Equinox;
+import org.eclipse.osgi.tests.OSGiTestsActivator;
+import org.osgi.framework.BundleException;
+import org.osgi.framework.Constants;
+
+/*
+ * The framework must persist data according to the value of the 
+ * eclipse.stateSaveDelayInterval property. The value is of type long and
+ * represents the number of milliseconds between persists. A positive value
+ * represents the number of milliseconds between persists. A value of zero
+ * indicates data should be immediately persisted with each update. A negative
+ * value disables persistence on update altogether (but data will still be 
+ * persisted on shutdown).
+ * 
+ */
+public class PersistedBundleTests extends AbstractBundleTests {
+	static class BundleBuilder {
+		static class BundleManifestBuilder {
+			private final Manifest manifest = new Manifest();
+
+			public Manifest build() {
+				manifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
+				return manifest;
+			}
+
+			public BundleManifestBuilder symbolicName(String value) {
+				manifest.getMainAttributes().putValue(Constants.BUNDLE_SYMBOLICNAME, value);
+				return this;
+			}
+		}
+
+		private final BundleManifestBuilder manifestBuilder = new BundleManifestBuilder();
+
+		public InputStream build() throws IOException {
+			ByteArrayOutputStream baos = new ByteArrayOutputStream();
+			JarOutputStream jos = new JarOutputStream(baos, manifestBuilder.build());
+			jos.close();
+			return new ByteArrayInputStream(baos.toByteArray());
+		}
+
+		public BundleBuilder symbolicName(String value) {
+			manifestBuilder.symbolicName(value);
+			return this;
+		}
+	}
+
+	private static final String ECLIPSE_STATESAVEDELAYINTERVAL = "eclipse.stateSaveDelayInterval";
+
+	private static final String IMMEDIATE_PERSISTENCE = "0";
+	private static final String NO_PERSISTENCE = "-1";
+	private static final String PERIODIC_PERSISTENCE = "5000";
+
+	protected void setUp() throws Exception {
+		super.setUp();
+	}
+
+	protected void tearDown() throws Exception {
+		super.tearDown();
+	}
+
+	public static Test suite() {
+		return new TestSuite(PersistedBundleTests.class);
+	}
+
+	/*
+	 * Test that a value of zero for eclipse.stateSaveDelayInterval results in
+	 * immediate persistence.
+	 */
+	public void testImmediatePersistence() throws Exception {
+		Map<String, Object> configuration = createConfiguration();
+		configuration.put(ECLIPSE_STATESAVEDELAYINTERVAL, IMMEDIATE_PERSISTENCE);
+		Equinox equinox1 = new Equinox(configuration);
+		initAndStart(equinox1);
+		try {
+			assertNull("Bundle exists", equinox1.getBundleContext().getBundle(getName()));
+			equinox1.getBundleContext().installBundle(getName(), new BundleBuilder().symbolicName(getName()).build());
+			Equinox equinox2 = new Equinox(configuration);
+			initAndStart(equinox2);
+			try {
+				assertNotNull("Bundle does not exist", equinox2.getBundleContext().getBundle(getName()));
+			} finally {
+				stopQuietly(equinox2);
+			}
+		} finally {
+			stopQuietly(equinox1);
+		}
+	}
+
+	/*
+	 * Test that a negative value for eclipse.stateSaveDelayInterval results in
+	 * no persistence.
+	 */
+	public void testNoPersistence() throws Exception {
+		Map<String, Object> configuration = createConfiguration();
+		configuration.put(ECLIPSE_STATESAVEDELAYINTERVAL, NO_PERSISTENCE);
+		Equinox equinox1 = new Equinox(configuration);
+		initAndStart(equinox1);
+		try {
+			assertNull("Bundle exists", equinox1.getBundleContext().getBundle(getName()));
+			equinox1.getBundleContext().installBundle(getName(), new BundleBuilder().symbolicName(getName()).build());
+			Thread.sleep(Long.valueOf(PERIODIC_PERSISTENCE));
+			Equinox equinox2 = new Equinox(configuration);
+			initAndStart(equinox2);
+			try {
+				assertNull("Bundle exists", equinox2.getBundleContext().getBundle(getName()));
+			} finally {
+				stopQuietly(equinox2);
+			}
+		} finally {
+			stopQuietly(equinox1);
+		}
+	}
+
+	/*
+	 * Test that a positive value for eclipse.stateSaveDelayInterval results in
+	 * periodic persistence.
+	 */
+	public void testPeriodicPersistence() throws Exception {
+		Map<String, Object> configuration = createConfiguration();
+		configuration.put(ECLIPSE_STATESAVEDELAYINTERVAL, PERIODIC_PERSISTENCE);
+		Equinox equinox1 = new Equinox(configuration);
+		initAndStart(equinox1);
+		try {
+			assertNull("Bundle exists", equinox1.getBundleContext().getBundle(getName()));
+			equinox1.getBundleContext().installBundle(getName(), new BundleBuilder().symbolicName(getName()).build());
+			Equinox equinox2 = new Equinox(configuration);
+			initAndStart(equinox2);
+			try {
+				assertNull("Bundle exists", equinox2.getBundleContext().getBundle(getName()));
+				stopQuietly(equinox2);
+				Thread.sleep(Long.valueOf(PERIODIC_PERSISTENCE));
+				equinox2 = new Equinox(configuration);
+				initAndStart(equinox2);
+				assertNotNull("Bundle does not exist", equinox2.getBundleContext().getBundle(getName()));
+			} finally {
+				stopQuietly(equinox2);
+			}
+		} finally {
+			stopQuietly(equinox1);
+		}
+	}
+
+	private Map<String, Object> createConfiguration() {
+		File file = OSGiTestsActivator.getContext().getDataFile(getName());
+		Map<String, Object> result = new HashMap<String, Object>();
+		result.put(Constants.FRAMEWORK_STORAGE, file.getAbsolutePath());
+		return result;
+	}
+
+	private void initAndStart(Equinox equinox) throws BundleException {
+		equinox.init();
+		equinox.start();
+	}
+
+	private void stopQuietly(Equinox equinox) {
+		if (equinox == null)
+			return;
+		try {
+			equinox.stop();
+			equinox.waitForStop(5000);
+		} catch (Exception e) {
+			// Ignore
+		}
+	}
+}
\ No newline at end of file