org.eclipse.xtext.junit4.ui

Class AbstractOutlineTest

java.lang.Object

org.junit.Assert

org.eclipse.xtext.junit4.ui.AbstractWorkbenchTest

org.eclipse.xtext.junit4.ui.AbstractEditorTest

org.eclipse.xtext.junit4.ui.AbstractOutlineTest

public abstract class AbstractOutlineTest
extends AbstractEditorTest

A utility class for testing the outline's tree of Xtext languages. Example:

 @RunWith(XtextRunner)
 @InjectWith(MyLanguageUiInjectorProvider) 
 class OutlineTest extends AbstractOutlineTest {
 
        override protected getEditorId() {
                MyDslActivator.ORG_XTEXT_EXAMPLE_MYDSL
        }
        
        @Test def void myTest() {
          '''
                // DSL code
                Foo bla {
                        Bar b
                        Bar c
                }
          '''.assertAllLabels('''
                bla
                  b
                  c
          '''
        }
  }
 

Since:

2.10

Author:

Jan Koehnlein - Initial contribution and API, Lorenzo Bettini - Adapted to be used for any DSL

Field Summary

Fields

Modifier and Type	Field and Description
protected IXtextDocument	document
protected XtextEditor	editor
protected org.eclipse.core.resources.IFile	file
String	fileExtension
protected static int	TAB_INDENT
protected static String	TEST_PROJECT
protected IOutlineTreeProvider	treeProvider

Constructor Summary

Constructors

Constructor and Description
AbstractOutlineTest()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToStringRepresentation(IOutlineNode node, StringBuffer buffer, int tabs)
protected void	assertAllLabels(CharSequence modelAsText, CharSequence expected) The root node of the outline of the passed program is expanded and a string representation of the tree is built where children are indented of TAB_INDENT number of tabs; this string representation is then compared with the expected representation.
protected void	assertAllLabels(IOutlineNode rootNode, CharSequence expected) The outline node is expanded and a string representation of the tree is built where children are indented of TAB_INDENT number of tabs; this string representation is then compared with the expected representation.
protected org.eclipse.jdt.core.IJavaProject	createjavaProject(String projectName)
protected String	getNodeText(IOutlineNode node)
protected IOutlineNode	getOutlineTree(CharSequence modelAsText)
protected void	indent(StringBuffer buffer, int tabs)
protected String	outlineStringRepresentation(IOutlineNode node)
protected void	outlineStringRepresentation(IOutlineNode node, StringBuffer buffer, int tabs)
void	setFileExtensionProvider(FileExtensionProvider extensionProvider)
void	setUp()
void	tearDown()

Methods inherited from class org.eclipse.xtext.junit4.ui.AbstractEditorTest

getEditorId, openEditor

Methods inherited from class org.eclipse.xtext.junit4.ui.AbstractWorkbenchTest

closeEditors, closeWelcomePage, getActivePage, getWorkbench, getWorkbenchWindow, sleep

Methods inherited from class org.junit.Assert

assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAB_INDENT

protected static int TAB_INDENT

TEST_PROJECT

protected static String TEST_PROJECT

file

protected org.eclipse.core.resources.IFile file

editor

protected XtextEditor editor

document

protected IXtextDocument document

fileExtension

public String fileExtension

treeProvider

@Inject
protected IOutlineTreeProvider treeProvider

Constructor Detail

AbstractOutlineTest

public AbstractOutlineTest()

Method Detail

setFileExtensionProvider

@Inject
public void setFileExtensionProvider(FileExtensionProvider extensionProvider)

setUp

public void setUp()
           throws Exception

Overrides:

setUp in class AbstractWorkbenchTest

Throws:

Exception

createjavaProject

protected org.eclipse.jdt.core.IJavaProject createjavaProject(String projectName)
                                                       throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

tearDown

public void tearDown()
              throws Exception

Overrides:

tearDown in class AbstractWorkbenchTest

Throws:

Exception

getOutlineTree

protected IOutlineNode getOutlineTree(CharSequence modelAsText)
                               throws Exception

Throws:

Exception

assertAllLabels

protected void assertAllLabels(CharSequence modelAsText,
                   CharSequence expected)
                        throws Exception

The root node of the outline of the passed program is expanded and a string representation of the tree is built where children are indented of TAB_INDENT number of tabs; this string representation is then compared with the expected representation.

Parameters:

modelAsText -

expected -

Throws:

Exception

assertAllLabels

protected void assertAllLabels(IOutlineNode rootNode,
                   CharSequence expected)

The outline node is expanded and a string representation of the tree is built where children are indented of TAB_INDENT number of tabs; this string representation is then compared with the expected representation.

Parameters:

rootNode -

expected -

outlineStringRepresentation

protected String outlineStringRepresentation(IOutlineNode node)

outlineStringRepresentation

protected void outlineStringRepresentation(IOutlineNode node,
                               StringBuffer buffer,
                               int tabs)

addToStringRepresentation

protected void addToStringRepresentation(IOutlineNode node,
                             StringBuffer buffer,
                             int tabs)

getNodeText

protected String getNodeText(IOutlineNode node)

indent

protected void indent(StringBuffer buffer,
          int tabs)