Eclipse Community Forums: TMF (Xtext) » Test Content-Assist withing maven build

Home » Modeling » TMF (Xtext) » Test Content-Assist withing maven build

Test Content-Assist withing maven build [message #1705465]

Sun, 16 August 2015 05:53

Eclipse User

Hi,
I'm writing tests for a DSL.
One of these should test the content-assist.

I came across a reference which says the following:
Most of the mechanisms of a DSL implemented in Xtext can be tested with plain Java
Junit tests without a UI environment. However, when testing UI features, tests need a running Eclipse

Now, my tests should be part of a maven-build of the language, thus no eclipse running.

Is it possible to test the content-assist? how can i do it? this test is most important to us.

Re: Test Content-Assist withing maven build [message #1705530 is a reply to message #1705465]

Mon, 17 August 2015 08:00

Eclipse User

In addition,
I want to test pre-written files for content-assist proposals. Does somebody knows how can this be done?
All the examples are using hard-coded Strings which are appended to newBuilder.

Re: Test Content-Assist withing maven build [message #1705533 is a reply to message #1705530]

Mon, 17 August 2015 08:00

Eclipse User

do you use tycho surefire?

Re: Test Content-Assist withing maven build [message #1705558 is a reply to message #1705533]

Mon, 17 August 2015 09:30

Eclipse User

yes. the test's project pom.xml has the following plugin:
<plugin>
<groupId>org.eclipse.tycho</groupId>
<artifactId>tycho-surefire-plugin</artifactId>
<version>${tycho-version}</version>
<configuration>
<useUIHarness>false</useUIHarness>
<useUIThread>false</useUIThread>
</configuration>
</plugin>

Re: Test Content-Assist withing maven build [message #1705636 is a reply to message #1705558]

Tue, 18 August 2015 01:44

Eclipse User

My problem is that:
The auto-completion in my language is based also upon the file's name except the grammar.
For example, lets Assume I've the following grammar for a DSL 'mydsl':

Entity:
'entity' name=QualifiedName '{'
(
('fieldA' periodA=INT) &
('filedB' periodB=INT)
)
'}';

QualifiedName:
ValidID('.'ValidID)*;

ValidID:
ID;

now i write a DSL file which is named Entity1.mydsl
I've created a validator which verifies that the filename equals to the name given to the entity (in this case Entity1).
In addition, my content-assist will offer me only the filename as the name for this entity (will be auto-completed).

Now, i want to test this situation when testing the content-assist. The problem is that the newBuilder (ContentAssistProcessorTestBuilder object) allows to append Strings
and then test them, and thus i am not able to change/modify/affect the name of the resource and affect the content of the content-assist.

@RunWith(typeof(XtextRunner))
@InjectWith(typeof(OpusUiInjectorProvider))
class EventContentAssistTest extends AbstractContentAssistTest {

@Test def void testEntityNameCompletion(){
newBuilder.append("entity").assertText("entity1") //this will not work
}
B.T.W. For some reason I don't have access to some of the ContentAssistProcessorTestBuilder methods through
the newBuilder, such as computeCompletionProposals() which may have helped me. And also not able to override getResourceFor(InputStream) of AbstractContentAssistTest.

Suggestions?

Re: Test Content-Assist withing maven build [message #1705637 is a reply to message #1705636]

Tue, 18 August 2015 01:49

Eclipse User

You can always use copy paste adapt

Re: Test Content-Assist withing maven build [message #1705643 is a reply to message #1705637]

Tue, 18 August 2015 02:26

Eclipse User

What do u mean?

Re: Test Content-Assist withing maven build [message #1705661 is a reply to message #1705643]

Tue, 18 August 2015 04:35

Eclipse User

simply copy and paste the superclass and builder class and adopt what you dont like

Re: Test Content-Assist withing maven build [message #1705662 is a reply to message #1705661]

Tue, 18 August 2015 04:37

Eclipse User

but if it simply about the file name: simply override getResourceFor

Re: Test Content-Assist withing maven build [message #1705688 is a reply to message #1705662]

Tue, 18 August 2015 07:50

Eclipse User

It doesn't help me.

I want to test cross-references completion, and completion according to the name of the opus-file.

if this is my grammar:
Parent:
'parent' name=ID '{'
(attributes+=Attribute)*
'}';

Son:
'son' name=ID '(' 'source' ':' source=[Parent] ')' '{'
(

('age' period=INT retentionUnit=TimeSlots) &
(eventTime=Datetime)
//and Datetime is a field within Parent
)
'}';
I want to test the following 3 things:
1. Son.name Content-Assist proposal will be : the opus-filename.
2. Son.source Content-Assist proposal: suggest me some Parent
3. Son.eventTime Content-Assist proposal : Datetime field from Parent

In order to do so i think i need to have resources/files loaded to some ResourceSet, so that when calling newBuilder.assertText() or other methods,
the proposal will reference them.

B.T.W.
the getResourceFor method creates a Resource (named Test.opus)from our String and i do not have any access to other resources i want to reference as proposals. so this does't solve my problem.

Attachment: Debug perspective.jpg
(Size: 55.49KB, Downloaded 148 times)

Re: Test Content-Assist withing maven build [message #1705696 is a reply to message #1705688]

Tue, 18 August 2015 08:26

Eclipse User

the you have to create the other resource as well

http://www.eclipse.org/forums/index.php/t/741750/

Re: Test Content-Assist withing maven build [message #1705699 is a reply to message #1705465]

Tue, 18 August 2015 08:30

Eclipse User

Hi

I don't know if you're referring to something I wrote (I seem to recognize those sentences Wink

but you can test also UI features. What I meant by "tests need a running Eclipse" is that the build tool will have to be configured to run the tests inside a running Eclipse, and Maven Tycho Surefire can do that, as long as

<useUIHarness>true</useUIHarness>

hope this helps
Lorenzo

--
Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino
HOME: http://www.lorenzobettini.it
Xtext Book: http://www.packtpub.com/implementing-domain-specific-languages-with-xtext-and-xtend/book

Re: Test Content-Assist withing maven build [message #1705718 is a reply to message #1705699]

Tue, 18 August 2015 09:56

Eclipse User

Hi,
First, thanks to all of you.
Second, I'm new to Xtext and all its test possibilities, so Pls be patient with me.

At the moment i have 2 issues:
1. Maven build fails on DSL-test project due to the unit-test i wrote to test the
Content-Assist (other tests passed).
Tests in error:
testEventNameCompletion(com.amdocs.bda.opus.tests.events.EventContentAssistTest): Guice provision errors:

Lorenzo, I'm not sure i understand your answer. My goal is that the DSL-Test-project will be part of a full maven-build with the rest of the DSL-projects, on a build server. This environment doesn't have eclipse.
Is it possible? Try to explain me as to a beginner...
B.T.W, The quote is taken from Implementing Domain-Specific Languages with Xtext and Xtend

2. I want to be able to test
2.1. auto-completion based on filename (i write an entity and her name
should match the name of the file)
2.2. auto-completion based upon references. (name of other model
entities or entity's fields)
For this issue i believe i need some-kind of a shared resource-set.
Christian, My test-class extends AbstractContentAssistTest and not the one you used AbstractContentAssistProcessorTest. can i use it for this purpose?
Do i need to use AbstractContentAssistProcessorTest instead and override the implementation of setUp method as you did ?
Can you explain to me what is done in each method in the link you shared ?

Re: Test Content-Assist withing maven build [message #1705727 is a reply to message #1705718]

Tue, 18 August 2015 11:13

Eclipse User

Iwillsee if if ifind the time to dive into this

Re: Test Content-Assist withing maven build [message #1705739 is a reply to message #1705727]

Tue, 18 August 2015 12:46

Eclipse User

Hi,

i isnt that problem to port it

package org.xtext.example.mydsl.tests

import java.io.InputStream
import javax.inject.Inject
import javax.inject.Provider
import org.eclipse.emf.common.util.URI
import org.eclipse.xtext.junit4.InjectWith
import org.eclipse.xtext.junit4.XtextRunner
import org.eclipse.xtext.junit4.ui.util.IResourcesSetupUtil
import org.eclipse.xtext.junit4.ui.util.JavaProjectSetupUtil
import org.eclipse.xtext.resource.XtextResource
import org.eclipse.xtext.resource.XtextResourceSet
import org.eclipse.xtext.ui.XtextProjectHelper
import org.eclipse.xtext.xbase.junit.ui.AbstractContentAssistTest
import org.junit.BeforeClass
import org.junit.Test
import org.junit.runner.RunWith
import org.xtext.example.mydsl.MyDslUiInjectorProvider

@RunWith(typeof(XtextRunner))
@InjectWith(typeof(MyDslUiInjectorProvider))
class ContentAssistTest extends AbstractContentAssistTest {
	
	static val PROJECT_NAME = "contentAssistTest"
	
	@Test def void testImportCompletion() {
		newBuilder.append('Hello You from ').assertText('You','Me','There')
	}
	
	@BeforeClass
	def static void setUp() {
		AbstractContentAssistTest.setUp
		val project = JavaProjectSetupUtil.findJavaProject(PROJECT_NAME);
		IResourcesSetupUtil.addNature(project.getProject(), XtextProjectHelper.NATURE_ID);
		IResourcesSetupUtil.addBuilder(project.getProject(), XtextProjectHelper.BUILDER_ID);
		IResourcesSetupUtil.createFile(PROJECT_NAME + "/src/dummy.mydsl", 
		'''
		Hello Me!
		Hello There!
		''');
		IResourcesSetupUtil.reallyWaitForAutoBuild();
	}
	
	@Inject Provider<XtextResourceSet> resourceSetProvider
	
	override getResourceFor(InputStream stream) {
		val set = resourceSetProvider.get()
		initializeTypeProvider(set)
		val result = set.createResource(URI::createURI("platform:/resource/"+PROJECT_NAME+"/src/Test.mydsl"))
		result.load(stream, null)
		result as XtextResource
	}
	
	
	
}

Re: Test Content-Assist withing maven build [message #1705777 is a reply to message #1705739]

Wed, 19 August 2015 03:03

Eclipse User

Hi,
I tried to do what you suggested, with relevant modifications for my project:

Parent

Son

IResourcesSetupUtil.waitForAutoBuild();

Till Here everything is O.K:
It really creates me a project with the file i want to reference, and Xtext generator generates files as needed.

Now, in my @test testCompletion() method, i create a Son component in a progression way using the newBuilder, append and assertText.
When i try assert for the Parent which is in the file that was created, the computeCompletionProposals returns me an empty array of proposals.
(pic. attached)

Why does it happen?

Attachment: computeCompletionProposals_Result.jpg
(Size: 55.80KB, Downloaded 172 times)

Re: Test Content-Assist withing maven build [message #1705780 is a reply to message #1705777]

Wed, 19 August 2015 03:15

Eclipse User

Please share complete grammar and test

Re: Test Content-Assist withing maven build [message #1705786 is a reply to message #1705780]

Wed, 19 August 2015 04:01

Eclipse User

grammar com.amdocs.bda.opus.Opus with org.eclipse.xtext.common.Terminals

import "http://www.eclipse.org/emf/2002/Ecore" as ecore
import "http://www.eclipse.org/xtext/common/JavaVMTypes"

DomainModel:
package=PackageDeclaration
;

// Start Xbase terminals Add-on ***************************************************************************************
terminal BOOLEAN: ('true' | 'false');

terminal ID : '^'?('a'..'z'|'A'..'Z'|'_')('a'..'z'|'A'..'Z'|'_'|'0'..'9'|'-')*;
terminal INT returns ecore::EInt: ('0'..'9')+;

terminal STRING:
'"' ('\\' ('b' | 't' | 'n' | 'f' | 'r' | 'u' | '"' | "'" | '\\') | !('\\' | '"'))* '"' |
"'" ('\\' ('b' | 't' | 'n' | 'f' | 'r' | 'u' | '"' | "'" | '\\') | !('\\' | "'"))* "'";

Number: INT ('.' INT)? ;

QualifiedName:
ValidID('.'ValidID)*;

QualifiedNameWithWildcard:
QualifiedName '.*'?;

ValidID:
ID;

// End Xbase terminals Add-on ***************************************************************************************

PackageDeclaration:
'package' {PackageDeclaration} name=QualifiedName
imports+=Import*
elements+=AbstractElement+;

Import:
'import' {Import} importedNamespace=QualifiedNameWithWildcard;

AbstractElement:

Parent | Son

;

Parent:
'parent' {Parent} name=QualifiedName ('extends' superType=[Parent])? '{'
(attributes+=ParentAttribute)*
'}';

Son:
'son' {Son} name=QualifiedName '(' 'refer' ':' parent=[Parent] ')' '{'
(
('retention' time=INT units=TimeSlots) &
(sonTime=SonTimeFeature)
)
'}';

SonTimeFeature: {SonTimeFeature} 'sonTime' sonTime=[SimpleAndRefAttribute];

ParentAttribute:
SimpleAndRefAttribute
;

SimpleAndRefAttribute:
SimpleAttribute | SimpleRefAttribute
;

SimpleRefAttribute:
type=[SimpleAttribute] name=QualifiedName;

SimpleAttribute:
type=BasicTypes name=QualifiedName;

enum BasicTypes:
STRING='String' | DOUBLE='Double' | BOOLEAN='Boolean' | DATE_TIME='Datetime';

enum TimeSlots:
MINUTES='minutes' | HOURS='hours';

and my Content-assist test looks something like that:

p

@RunWith(typeof(XtextRunner))
@InjectWith(typeof(MyDslUiInjectorProvider))
class SonContentAssistTest extends AbstractContentAssistTest {

static val PROJECT_NAME = "contentAssistTest"

@BeforeClass
def static void setUp() {
AbstractContentAssistTest.setUp
val project = JavaProjectSetupUtil.findJavaProject(PROJECT_NAME);
IResourcesSetupUtil.addNature(project.getProject(), XtextProjectHelper.NATURE_ID);
IResourcesSetupUtil.addBuilder(project.getProject(), XtextProjectHelper.BUILDER_ID);
IResourcesSetupUtil.createFile(PROJECT_NAME + "/src/Parent1.mydsl",
'''
package com.tests
parent Parent1 {
String s
Datetime time
}
''');
IResourcesSetupUtil.waitForAutoBuild
}

@Inject Provider<XtextResourceSet> resourceSetProvider

override getResourceFor(InputStream stream) {
val set = resourceSetProvider.get()
initializeTypeProvider(set)
val result = set.createResource(URI::createURI("platform:/resource/"+PROJECT_NAME+"/src/Test.mydsl"))
result.load(stream, null)
result as XtextResource
}

@Test
def void testCompletion(){

newBuilder.
assertText("package").
append("package com.kids\n").
append("import com.tests\n").
append("son ").
assertText("Test").
append("son Son1 ( ").
assertText("refer").
append("refer ").
assertText(":").
append(": ").
assertText("Parent1")

}

}

Re: Test Content-Assist withing maven build [message #1705803 is a reply to message #1705786]

Wed, 19 August 2015 05:35

Eclipse User

if i do the test manually i get the same behaviour.
i do not see where you define Test

Re: Test Content-Assist withing maven build [message #1705807 is a reply to message #1705803]

Wed, 19 August 2015 06:29

Eclipse User

If you are referring my problem of filename-auto-completion then the following code segments checks that

It still not what i will want in the future , but my Bigger Problem is to solve the problem of cross referencing.
If you look at the test method, the last assertText call, tries to reference the Parent1 component defined in a file - and its not working.
it returns empty array of proposals.

Parent1

assertText("Parent1")

Re: Test Content-Assist withing maven build [message #1705810 is a reply to message #1705807]

Wed, 19 August 2015 06:48

Eclipse User

Hi,

where is that Test Thing defined ?????????
son son Son1 seems strange to me

[Updated on: Wed, 19 August 2015 06:50] by Moderator

Re: Test Content-Assist withing maven build [message #1705811 is a reply to message #1705810]

Wed, 19 August 2015 06:51

Eclipse User

so please give me a valid son model file

Re: Test Content-Assist withing maven build [message #1705813 is a reply to message #1705811]

Wed, 19 August 2015 06:52

Eclipse User

btw the following works for me

newBuilder.assertText("package").append("package com.kids\n").append("import com.tests.*\n").append("son Son1 ( ").assertText("refer").append("refer ").assertText(":").append(": ").
assertText("Parent1")

Re: Test Content-Assist withing maven build [message #1705824 is a reply to message #1705813]

Wed, 19 August 2015 07:29

Eclipse User

Hi, please don't be mad at me. I'm new to all of this.
I had to change a bit the Grammar - but this is a Grammar equivalent to mine.

For me the last assertText fails, because i expect Parent1, and nothing is returned from the content-assist.

Re: Test Content-Assist withing maven build [message #1705826 is a reply to message #1705824]

Wed, 19 August 2015 07:41

Eclipse User

yes but you

- type son twice
- do not Import com.tests.* but com.tests only

using that Situation it does not work in the IDE
=> It makes no sense to test something that does not work in a model in the IDE

Re: Test Content-Assist withing maven build [message #1705841 is a reply to message #1705826]

Wed, 19 August 2015 08:25

Eclipse User

You are right, i mixed up - now it works. - Big Thanks.
Now i will need to verify i can also reference fields of Parent.

Re: Test Content-Assist withing maven build [message #1705848 is a reply to message #1705841]

Wed, 19 August 2015 09:03

Eclipse User

Hi Christian,

1 more questions if you don't mind:

In the setUp() method I created the file 'Parent1.mydsl' using a String/template-expression. Is it possible to have a pre-written files and load them into this newly project instead of creating them using Strings?

Re: Test Content-Assist withing maven build [message #1705849 is a reply to message #1705848]

Wed, 19 August 2015 09:13

Eclipse User

everything is possible but i doubt the IResourcesSetupUtil api supports that.
sou you would have to write that yourself.

Re: Test Content-Assist withing maven build [message #1707426 is a reply to message #1705465]

Fri, 04 September 2015 12:19

Eclipse User

Hi,
,I did what you suggested, and it did the job.
Now i have another problem which is caused by the scoping which checks that a resource is a physical file to avoid round-inheritance.

To test the content-assist I inherit the AbstractContentAssistTest
and creating a project with Xtext nature and builder at the background, and in this project I create files as resources which I want to cross-reference in my testing.

But I have a problem with the scoping. In the scoping I check that the resource is a physical file, which was a solution to avoid round-inheritance.

On the other hand, the computeProposals() method creates a resource from the newBuilder.append..... using the AbstractContentAssistTest.getResourceFor() method, and this resource is not a physical file, and thus the scoping check fails.

As for now, I'm avoiding this by creating a Degenerate physical-file for this resource on the Xtext-background project, but this is a bad solution as some of my resources could be very complected.

How can I test cross referencing If the scoping (which first get all relevant resources including the one I'm building with newBuilder.append) and its check is a must (to verify no round inheritance)and it test that the resource is a physical file?

Re: Test Content-Assist withing maven build [message #1707432 is a reply to message #1707426]

Fri, 04 September 2015 12:49

Eclipse User

hi,
i dont get that. i think you are already creating physical files? so why so actually loading a physical file in getResourceFor()

Re: Test Content-Assist withing maven build [message #1707490 is a reply to message #1705465]

Sat, 05 September 2015 10:17

Eclipse User

i'll open a new topic - since the title is not relevant anymore.

Re: Test Content-Assist withing maven build [message #1707654 is a reply to message #1707490]

Tue, 08 September 2015 07:51

Eclipse User

see https://www.eclipse.org/forums/index.php/t/1070060/