Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: b7b094b14b89930fb2b25cb28241aa3836ab50b3 (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
/*******************************************************************************
 * Copyright (c) 2009, 2016 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *     Snehasish Paul <snehpaul@in.ibm.com> - Eclipse help public API services
 *******************************************************************************/
package org.eclipse.ua.tests.help.remote;

import static org.junit.Assert.assertEquals;

import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.entityresolver.LocalEntityResolver;
import org.eclipse.help.internal.server.WebappManager;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;

public class TocServletTest {

	private int mode;

	@Before
	public void setUp() throws Exception {
		BaseHelpSystem.ensureWebappRunning();
		mode = BaseHelpSystem.getMode();
		BaseHelpSystem.setMode(BaseHelpSystem.MODE_INFOCENTER);
	}

	@After
	public void tearDown() throws Exception {
		BaseHelpSystem.setMode(mode);
	}

	@Test
	public void testTocServletContainsUAToc() throws Exception {
		Node root = getTocContributions("en");
		Element[] UARoot = findContributionById(root, "/org.eclipse.ua.tests/data/help/toc/root.xml");
		assertEquals(1, UARoot.length);
	}

	@Test
	public void testTocServletContainsFilteredToc() throws Exception {
		Node root = getTocContributions("en");
		Element[] UARoot = findContributionById(root, "/org.eclipse.ua.tests/data/help/toc/filteredToc/toc.xml");
		assertEquals(1, UARoot.length);
	}

	@Test
	public void testTocServletContainsUnlinkedToc() throws Exception {
		Node root = getTocContributions("en");
		Element[] UARoot = findContributionById(root, "/org.eclipse.ua.tests/data/help/toc/filteredToc/nonPrimaryToc.xml");
		assertEquals(1, UARoot.length);
	}

	@Test
	public void testReadEnToc() throws Exception {
		Node root = getTocContributions("en");
		Element[] uaRoot = findContributionById(root, "/org.eclipse.ua.tests/data/help/search/toc.xml");
		assertEquals(1, uaRoot.length);
		Element[] toc = findChildren(uaRoot[0], "toc", "label", "search");
		assertEquals(1, toc.length);
		Element[] topicSearch = findChildren(toc[0], "topic", "label", "search");
		assertEquals(1, topicSearch.length);
		Element[] topicEn = findChildren(topicSearch[0], "topic", "label", "testen.html");
		assertEquals(1, topicEn.length);
		Element[] topicDe = findChildren(topicSearch[0], "topic", "label", "testde.html");
		assertEquals(0, topicDe.length);
	}

	@Test
	public void testReadDeToc() throws Exception {
		Node root = getTocContributions("de");
		Element[] uaRoot = findContributionById(root, "/org.eclipse.ua.tests/data/help/search/toc.xml");
		assertEquals(1, uaRoot.length);
		Element[] toc = findChildren(uaRoot[0], "toc", "label", "search");
		assertEquals(1, toc.length);
		Element[] topicSearch = findChildren(toc[0], "topic", "label", "search");
		assertEquals(1, topicSearch.length);
		Element[] topicEn = findChildren(topicSearch[0], "topic", "label", "testen.html");
		assertEquals(0, topicEn.length);
		Element[] topicDe = findChildren(topicSearch[0], "topic", "label", "testde.html");
		assertEquals(1, topicDe.length);
	}

	private Element[] findContributionById(Node root, String id) {
		return findChildren(root, "tocContribution", "id", id);
	}

	private Element[] findChildren(Node parent, String childKind, String attributeName, String attributeValue) {
		NodeList contributions = parent.getChildNodes();
		List<Node> results = new ArrayList<>();
		for (int i = 0; i < contributions.getLength(); i++) {
			Node next = contributions.item(i);
			if (next instanceof Element) {
				Element nextElement = (Element)next;
				if ( childKind.equals(nextElement.getTagName()) && attributeValue.equals(nextElement.getAttribute(attributeName))) {

					results.add(next);
				}
			}
		}
		return results.toArray(new Element[results.size()]);
	}


	protected Node getTocContributions( String locale)
			throws Exception {
		int port = WebappManager.getPort();
		URL url = new URL("http", "localhost", port, "/help/toc?lang=" + locale);
		try (InputStream is = url.openStream()) {
			InputSource inputSource = new InputSource(is);
			DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
			documentBuilder.setEntityResolver(new LocalEntityResolver());
			Document document = documentBuilder.parse(inputSource);
			Node root = document.getFirstChild();
			assertEquals("tocContributions", root.getNodeName());
			return root;
		}
	}

}

Back to the top