tests/org.eclipse.ease.test/src/org/eclipse/ease/AbstractCodeParserTest.java

/*******************************************************************************
 * Copyright (c) 2016 Christian Pontesegger and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License_Identifier: EPL-2.0
 *
 * Contributors:
 *     Christian Pontesegger - initial API and implementation
 *******************************************************************************/
package org.eclipse.ease;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.util.Map;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class AbstractCodeParserTest {

	// classic implementation of a HeaderParser
	private static class HeaderParser extends AbstractCodeParser {

		@Override
		protected boolean hasBlockComment() {
			return true;
		}

		@Override
		protected String getBlockCommentEndToken() {
			return "*/";
		}

		@Override
		protected String getBlockCommentStartToken() {
			return "/*";
		}

		@Override
		protected String getLineCommentToken() {
			return "//";
		}

		@Override
		protected String stripCommentLine(String commentLine) {
			if (commentLine.startsWith("* "))
				return commentLine.substring(2);

			return super.stripCommentLine(commentLine);
		}

		@Override
		public ICompletionContext getContext(IScriptEngine scriptEngine, Object resource, String contents, int position, int selectionRange) {
			return null;
		}
	}

	// @formatter:off
	private static final String TEMPLATE_BLOCK_HEADER =
			  "/**\n"
			+ " * This is a block comment with a keyword.\n"
			+ " * \n"
			+ " * key: word\n"
			+ " * menu: no menu selected\n"
			+ " * multi: this is a multi\n"
			+ " * line keyword\n"
			+ " **/\n";

	private static final String TEMPLATE_LINE_HEADER =
			  "//\n"
			+ "// This is a block comment with a keyword.\n"
			+ "// \n"
			+ " // key: word\n"
			+ "// menu: no menu selected\n"
			+ "// multi: this is a multi\n"
			+ "// line keyword\n"
			+ "//\n";

	private static final String TEMPLATE_NO_COMMENT =
			  "var a = 13;\n"
			+ TEMPLATE_BLOCK_HEADER;

	private static final String TEMPLATE_WHITESPACE_BEFORE_BLOCK_HEADER =
			  "\n"
			+ "\t\t\n"
			+ "        \n"
			+ "     "
			+ TEMPLATE_BLOCK_HEADER;
	// @formatter:on

	private HeaderParser fParser;

	@BeforeEach
	public void setUp() throws Exception {
		fParser = new HeaderParser();
	}

	@Test
	public void parseEmpty() {
		assertTrue(fParser.getHeaderComment(toStream("")).isEmpty());
	}

	@Test
	public void parseCode() {
		assertTrue(fParser.getHeaderComment(toStream(TEMPLATE_NO_COMMENT)).isEmpty());
	}

	@Test
	public void parseLineHeader() {
		final Map<String, String> keywords = AbstractCodeParser.extractKeywords(fParser.getHeaderComment(toStream(TEMPLATE_LINE_HEADER)));
		assertEquals(3, keywords.size());
		assertEquals("word", keywords.get("key"));
		assertEquals("no menu selected", keywords.get("menu"));
		assertEquals("this is a multi line keyword", keywords.get("multi"));
	}

	@Test
	public void parseBlockHeader() {
		final Map<String, String> keywords = AbstractCodeParser.extractKeywords(fParser.getHeaderComment(toStream(TEMPLATE_BLOCK_HEADER)));
		assertEquals(3, keywords.size());
		assertEquals("word", keywords.get("key"));
		assertEquals("no menu selected", keywords.get("menu"));
		assertEquals("this is a multi line keyword", keywords.get("multi"));
	}

	@Test
	public void parseBlockAfterWhitespace() {
		final Map<String, String> keywords = AbstractCodeParser.extractKeywords(fParser.getHeaderComment(toStream(TEMPLATE_WHITESPACE_BEFORE_BLOCK_HEADER)));
		assertEquals(3, keywords.size());
		assertEquals("word", keywords.get("key"));
		assertEquals("no menu selected", keywords.get("menu"));
		assertEquals("this is a multi line keyword", keywords.get("multi"));
	}

	private static InputStream toStream(String data) {
		return new ByteArrayInputStream(data.getBytes());
	}
}