| /******************************************************************************* |
| * Copyright (c) 2006, 2011 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.ua.tests.help.util; |
| |
| import java.io.IOException; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| |
| import junit.framework.Test; |
| import junit.framework.TestCase; |
| import junit.framework.TestSuite; |
| |
| import org.eclipse.core.runtime.IConfigurationElement; |
| import org.eclipse.core.runtime.IExtension; |
| import org.eclipse.core.runtime.IExtensionPoint; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.help.internal.HelpPlugin; |
| import org.eclipse.help.internal.toc.TocFile; |
| import org.eclipse.help.ui.internal.HelpUIPlugin; |
| |
| /* |
| * A utility for regenerating the _expected.txt files that contain the expected |
| * result for the TOC model when serialized. This reads all the TOC content from |
| * the plugin manifest (for this test plugin only), constructs the model, then |
| * serializes the model to a text file, which is stored in the same directory as the |
| * TOC xml file, as <original_name>_expected.txt. |
| * |
| * These files are used by the JUnit tests to compare the result with the expected |
| * result. |
| * |
| * Usage: |
| * |
| * 1. Run this test as a JUnit plug-in test. |
| * 2. Right-click in "Package Explorer -> Refresh". |
| * |
| * The new files should appear. |
| */ |
| public class TocModelSerializerTest extends TestCase { |
| |
| /* |
| * Returns an instance of this Test. |
| */ |
| public static Test suite() { |
| return new TestSuite(TocModelSerializerTest.class); |
| } |
| |
| /* |
| * Ensure that org.eclipse.help.ui is started. It contributes extra content |
| * filtering that is used by this test. See UIContentFilterProcessor. |
| */ |
| @Override |
| protected void setUp() throws Exception { |
| HelpUIPlugin.getDefault(); |
| } |
| |
| public void testRunSerializer() throws IOException { |
| /* |
| Collection tocFiles = getTocFiles(); |
| TocBuilder builder = new TocBuilder(); |
| builder.build(tocFiles); |
| Collection builtTocs = builder.getBuiltTocs(); |
| |
| Iterator iter = builtTocs.iterator(); |
| while (iter.hasNext()) { |
| Toc toc = (Toc)iter.next(); |
| TocFile file = toc.getTocFile(); |
| |
| String pluginRoot = UserAssistanceTestPlugin.getDefault().getBundle().getLocation().substring("update@".length()); |
| String relativePath = file.getHref(); |
| String absolutePath = pluginRoot + relativePath; |
| String resultFile = FileUtil.getResultFile(absolutePath); |
| |
| PrintWriter out = new PrintWriter(new FileOutputStream(resultFile)); |
| out.print(TocModelSerializer.serialize(toc)); |
| out.close(); |
| } |
| */ |
| } |
| |
| /** |
| * Find all the TOC files to use for this test. |
| */ |
| public static Collection<TocFile> getTocFiles() { |
| Collection<TocFile> tocFiles = new ArrayList<TocFile>(); |
| IExtensionPoint xpt = Platform.getExtensionRegistry().getExtensionPoint(HelpPlugin.PLUGIN_ID, "toc"); |
| IExtension[] extensions = xpt.getExtensions(); |
| for (IExtension extension : extensions) { |
| String pluginId = extension.getContributor().getName(); |
| if (pluginId.equals("org.eclipse.ua.tests")) { |
| IConfigurationElement[] configElements = extension.getConfigurationElements(); |
| for (IConfigurationElement configElement : configElements) { |
| if (configElement.getName().equals("toc")) { |
| // only get files in data/help/toc/ |
| String href = configElement.getAttribute("file"); //$NON-NLS-1$ |
| if (href.startsWith("data/help/toc/")) { |
| boolean isPrimary = "true".equals(configElement.getAttribute("primary")); //$NON-NLS-1$ |
| String extraDir = configElement.getAttribute("extradir"); //$NON-NLS-1$ |
| String categoryId = configElement.getAttribute("category"); //$NON-NLS-1$ |
| tocFiles.add(new TocFile(pluginId, href, isPrimary, Platform.getNL(), extraDir, categoryId)); |
| } |
| } |
| } |
| } |
| } |
| return tocFiles; |
| } |
| } |