Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Xtext Release Engineering"

(How do I trigger a build ?)
(Xtext build server)
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
= Xtext build server =
 
= Xtext build server =
  
'''This documentation relates to Xtext version 2 which is currently under development. For Xtext shipped with oAW consult sourceforge.org'''
+
'''This documentation relates to TMF's Xtext which is currently under development. For Xtext shipped with oAW 4.3 consult sourceforge.org'''
  
 
== Build FAQ ==
 
== Build FAQ ==
  
 +
=== How do I add a plug-in ? ===
 +
 +
* Add your plug-in to one of the features. Make sure its dependencies also listed in the feature.
 +
* Add an entry in the maps file
 +
/org.eclipse.xtext.releng/maps/xtext.map
 +
* If your plug-in has additional dependencies to third-party frameworks, make sure to select them on the [http://emft.eclipse.org/modeling/tmf/xtext/build/ Xtext build page].
 +
 +
--[[User:Jan.koehnlein.itemis.de|Jan.koehnlein.itemis.de]] 06:02, 23 July 2008 (EDT)
 
=== How do I trigger a build ? ===
 
=== How do I trigger a build ? ===
  
* Go to the [[http://emft.eclipse.org/modeling/tmf/xtext/build/] Xtext build page].
+
* Go to the [http://emft.eclipse.org/modeling/tmf/xtext/build/ Xtext build page].
 +
* Don't forget to add put your email address.
 +
* Click on build.
 +
--[[User:Jan.koehnlein.itemis.de|Jan.koehnlein.itemis.de]] 06:02, 23 July 2008 (EDT)
  
 
== Test FAQ ==
 
== Test FAQ ==
Line 19: Line 30:
 
* Generate a test suite, e.g. by running the ''Xtext Tools->Create Test Suite'' action, provided by ''org.eclipse.xtext.testcollector''. Make sure the test suite is in an exported package.
 
* Generate a test suite, e.g. by running the ''Xtext Tools->Create Test Suite'' action, provided by ''org.eclipse.xtext.testcollector''. Make sure the test suite is in an exported package.
  
* Add file ''test.xml'' and add it to the binary build by checking it in the ''build.properties'' editor. Copy the contents form an existing test project and adapt plug-in name and classname. There are two kinds of tests:
+
* Add file ''test.xml'' to the root of the test plug-in
** ''ui-test'' plug-in test needing a workbench
+
** Copy the contents from an existing test plug-in.
** ''core-test'' headless plug-in test
+
** Add it to the binary build by checking it in the ''build.properties'' editor.  
 +
** Adapt the properties ''plugin-name'' and ''classname''.
 +
** Choose the right target to run. There are two possibilities:
 +
*** ''ui-test'' plug-in test needing a workbench
 +
*** ''core-test'' headless plug-in test
 +
 
 +
* Add an entry in the target ''tmf'' of the Ant file ''/org.eclipse.xtext.releng/builder/tests/scripts/test.xml'' e.g.
 +
<source lang="xml">
 +
<antcall target="runtests">
 +
  <param name="testPlugin" value="${my.plugin.tests}"/>
 +
  <param name="report" value="my.plugin.tests"/>
 +
</antcall>
 +
</source>
 +
 +
--[[User:Jan.koehnlein.itemis.de|Jan.koehnlein.itemis.de]] 06:05, 23 July 2008 (EDT)
 +
 
 +
=== Why does my test suite fail / not run? ===
 +
* Plug-in dependencies must not be declared using package dependencies.
 +
--[[User:Jan.koehnlein.itemis.de|Jan.koehnlein.itemis.de]] 08:02, 23 July 2008 (EDT)
 +
 
 +
=== Why does my test fail mysteriously on the build server, while it succeeds perfectly on my machine ? ===
 +
* Do you have an encoding problem? The build sever is using a native encoding.
 +
* The build server currently only runs plug-in tests. Make sure your tests run as JUnit Plug-in tests and not as plain JUnit tests only.
 +
--[[User:Jan.koehnlein.itemis.de|Jan.koehnlein.itemis.de]] 08:13, 23 July 2008 (EDT)

Latest revision as of 07:27, 11 August 2008

Xtext build server

This documentation relates to TMF's Xtext which is currently under development. For Xtext shipped with oAW 4.3 consult sourceforge.org

Build FAQ

How do I add a plug-in ?

  • Add your plug-in to one of the features. Make sure its dependencies also listed in the feature.
  • Add an entry in the maps file
/org.eclipse.xtext.releng/maps/xtext.map
  • If your plug-in has additional dependencies to third-party frameworks, make sure to select them on the Xtext build page.

--Jan.koehnlein.itemis.de 06:02, 23 July 2008 (EDT)

How do I trigger a build ?

  • Go to the Xtext build page.
  • Don't forget to add put your email address.
  • Click on build.

--Jan.koehnlein.itemis.de 06:02, 23 July 2008 (EDT)

Test FAQ

How do I add a test plug-in ?

  • Name your plug-in like
<plugin-to-be-tested>.tests
  • Generate a test suite, e.g. by running the Xtext Tools->Create Test Suite action, provided by org.eclipse.xtext.testcollector. Make sure the test suite is in an exported package.
  • Add file test.xml to the root of the test plug-in
    • Copy the contents from an existing test plug-in.
    • Add it to the binary build by checking it in the build.properties editor.
    • Adapt the properties plugin-name and classname.
    • Choose the right target to run. There are two possibilities:
      • ui-test plug-in test needing a workbench
      • core-test headless plug-in test
  • Add an entry in the target tmf of the Ant file /org.eclipse.xtext.releng/builder/tests/scripts/test.xml e.g.
<antcall target="runtests">
   <param name="testPlugin" value="${my.plugin.tests}"/>
   <param name="report" value="my.plugin.tests"/>
</antcall>

--Jan.koehnlein.itemis.de 06:05, 23 July 2008 (EDT)

Why does my test suite fail / not run?

  • Plug-in dependencies must not be declared using package dependencies.

--Jan.koehnlein.itemis.de 08:02, 23 July 2008 (EDT)

Why does my test fail mysteriously on the build server, while it succeeds perfectly on my machine ?

  • Do you have an encoding problem? The build sever is using a native encoding.
  • The build server currently only runs plug-in tests. Make sure your tests run as JUnit Plug-in tests and not as plain JUnit tests only.

--Jan.koehnlein.itemis.de 08:13, 23 July 2008 (EDT)

Back to the top