Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarvin Mueller2017-12-12 08:04:58 -0500
committerMarvin Mueller2017-12-14 08:11:56 -0500
commite7ad459576ec37c9f5b34c6de77236bf7b60618c (patch)
tree93c6af18647a5392b46ea6cd1f021d22f77e7a0d
parentfabc92bcf7828596a5055f7c692770f49150685d (diff)
downloadorg.eclipse.jubula.core-e7ad459576ec37c9f5b34c6de77236bf7b60618c.tar.gz
org.eclipse.jubula.core-e7ad459576ec37c9f5b34c6de77236bf7b60618c.tar.xz
org.eclipse.jubula.core-e7ad459576ec37c9f5b34c6de77236bf7b60618c.zip
Add Teststyle to get TODO strings as problems in the problem view
The TODO teststyle is doing a contains in search in the name of persistenobjects. Also adjusted the quick fix that the problem which is shown is selected. Change-Id: I1e8504cae49dab985ae27c48c7e2763767879489
-rw-r--r--org.eclipse.jubula.client.teststyle.impl.standard/META-INF/MANIFEST.MF2
-rw-r--r--org.eclipse.jubula.client.teststyle.impl.standard/plugin.properties5
-rw-r--r--org.eclipse.jubula.client.teststyle.impl.standard/plugin.xml58
-rw-r--r--org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/checks/TodoCheck.java103
-rw-r--r--org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/Messages.java1
-rw-r--r--org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/messages.properties3
-rw-r--r--org.eclipse.jubula.client.teststyle/schema/define.exsd19
-rw-r--r--org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/checks/contexts/CommentContext.java89
-rw-r--r--org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/Messages.java2
-rw-r--r--org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/messages.properties2
-rw-r--r--org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/quickfix/QuickfixFactory.java10
-rw-r--r--org.eclipse.jubula.documentation/releasenotes/en/docbook/8.6.0/features.xml14
-rw-r--r--org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/content.xml1
-rw-r--r--org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/sectionadditionalInformation.xml22
-rw-r--r--org.eclipse.jubula.project.configuration/checkstyle.xml9
15 files changed, 332 insertions, 8 deletions
diff --git a/org.eclipse.jubula.client.teststyle.impl.standard/META-INF/MANIFEST.MF b/org.eclipse.jubula.client.teststyle.impl.standard/META-INF/MANIFEST.MF
index ea93437ad..aca9e96c7 100644
--- a/org.eclipse.jubula.client.teststyle.impl.standard/META-INF/MANIFEST.MF
+++ b/org.eclipse.jubula.client.teststyle.impl.standard/META-INF/MANIFEST.MF
@@ -7,6 +7,8 @@ Bundle-Activator: org.eclipse.jubula.client.teststyle.impl.standard.Activator
Bundle-Vendor: Eclipse Jubula
Bundle-Localization: plugin
Require-Bundle: org.eclipse.core.runtime,
+ org.apache.commons.lang;bundle-version="[2.4.0,3.0.0)",
+ org.eclipse.jubula.tools;bundle-version="[4.0.0,5.0.0)",
org.eclipse.jubula.client.teststyle;bundle-version="[6.0.0,7.0.0)",
org.eclipse.jubula.client.core;bundle-version="[6.0.0,7.0.0)",
org.eclipse.jubula.client.ui.rcp;bundle-version="[6.0.0,7.0.0)"
diff --git a/org.eclipse.jubula.client.teststyle.impl.standard/plugin.properties b/org.eclipse.jubula.client.teststyle.impl.standard/plugin.properties
index 3707665df..373b3a851 100644
--- a/org.eclipse.jubula.client.teststyle.impl.standard/plugin.properties
+++ b/org.eclipse.jubula.client.teststyle.impl.standard/plugin.properties
@@ -5,3 +5,8 @@
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
###############################################################################
+check.todo.name=show comments with a special naming(text)
+check.todo.description=Looks for a specific text in the selected context
+check.todo.annotation.description=Text to search for
+check.todo.case.sensitive.description=Should the search be case sensitive
+check.todo.inactive.nodes.description=Should inactive nodes be considered
diff --git a/org.eclipse.jubula.client.teststyle.impl.standard/plugin.xml b/org.eclipse.jubula.client.teststyle.impl.standard/plugin.xml
index 20ec3c1e9..9b91d2381 100644
--- a/org.eclipse.jubula.client.teststyle.impl.standard/plugin.xml
+++ b/org.eclipse.jubula.client.teststyle.impl.standard/plugin.xml
@@ -34,6 +34,64 @@
<attributes></attributes>
</check>
</category>
+ <category
+ description="ToDo Rules"
+ name="ToDo Rules">
+ <check
+ activeByDefault="false"
+ class="org.eclipse.jubula.client.teststyle.impl.standard.checks.TodoCheck"
+ defaultSeverity="INFO"
+ description="%check.todo.description"
+ id="org.eclipse.jubula.client.teststyle.impl.standard.checks.TodoCheck"
+ name="%check.todo.name">
+ <contexts>
+ <ExecTestCase
+ id="ExecTestCaseContext">
+ </ExecTestCase>
+ <Caps
+ id="CapContext">
+ </Caps>
+ <EventHandler
+ id="EventHandlerContext">
+ </EventHandler>
+ <TestSuites
+ id="TestSuiteContext">
+ </TestSuites>
+ <TestJobs
+ id="TestJobContext">
+ </TestJobs>
+ <SpecTestCases
+ id="SpecTestCaseContext">
+ </SpecTestCases>
+ <ObjectMappingCategory
+ id="ObjectMappingCategoryContext">
+ </ObjectMappingCategory>
+ <Categories
+ id="CategoryContext">
+ </Categories>
+ <Comment
+ id="CommentContext">
+ </Comment>
+ </contexts>
+ <attributes>
+ <Attribute
+ defaultValue="#TODO"
+ description="%check.todo.annotation.description"
+ name="annotation">
+ </Attribute>
+ <Attribute
+ defaultValue="true"
+ description="%check.todo.case.sensitive.description"
+ name="caseSensitive">
+ </Attribute>
+ <Attribute
+ defaultValue="false"
+ description="%check.todo.inactive.nodes.description"
+ name="inactive">
+ </Attribute>
+ </attributes>
+ </check>
+ </category>
</extension>
</plugin>
diff --git a/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/checks/TodoCheck.java b/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/checks/TodoCheck.java
new file mode 100644
index 000000000..f6b5a0865
--- /dev/null
+++ b/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/checks/TodoCheck.java
@@ -0,0 +1,103 @@
+/*******************************************************************************
+ * Copyright (c) 2017 BREDEX GmbH. All rights reserved. This program and the
+ * accompanying materials are made available under the terms of the Eclipse
+ * Public License v1.0 which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors: BREDEX GmbH - initial API and implementation and/or initial
+ * documentation
+ *******************************************************************************/
+/**
+ *
+ */
+package org.eclipse.jubula.client.teststyle.impl.standard.checks;
+
+import org.apache.commons.lang.StringUtils;
+import org.eclipse.jubula.client.core.model.INodePO;
+import org.eclipse.jubula.client.core.model.IPersistentObject;
+import org.eclipse.jubula.client.teststyle.checks.BaseCheck;
+import org.eclipse.jubula.client.teststyle.impl.standard.i18n.Messages;
+import org.eclipse.jubula.tools.internal.constants.StringConstants;
+import org.eclipse.osgi.util.NLS;
+
+/**
+ * @author BREDEX GmbH
+ *
+ */
+// CHECKSTYLE:OFF: mustdo
+public class TodoCheck extends BaseCheck {
+ // CHECKSTYLE:ON: mustdo
+ /** inactive attribute name - should also inactive nodes be checked */
+ private static final String INACTIVE = "inactive"; //$NON-NLS-1$
+ /** annotation attribute name - the String to search for in the names */
+ private static final String ANNOTATIONSTRING = "annotation"; //$NON-NLS-1$
+ /**
+ * case sensitive attribute name - should the string be search cases
+ * sensitive or not
+ */
+ private static final String CASESENSITIVE = "caseSensitive"; //$NON-NLS-1$
+ /** the Seperator used for multiple searches */
+ private static final String SEPERATORCHAR = ";"; //$NON-NLS-1$
+ /** name of the node for the description */
+ private String m_nodeName;
+
+ @Override
+ public String getDescription() {
+ // CHECKSTYLE:OFF: mustdo
+ return NLS.bind(Messages.ToDoCheckDescription, m_nodeName);
+ // CHECKSTYLE:ON: mustdo
+ }
+
+ @Override
+ public boolean hasError(Object obj) {
+ if (obj instanceof IPersistentObject) {
+ IPersistentObject node = (IPersistentObject) obj;
+ boolean isActive = true;
+ if (node instanceof INodePO) {
+ isActive = ((INodePO) node).isActive();
+ }
+ if (isActive || getInactive()) {
+ String name = node.getName();
+ String annotation = getAnnotationString();
+ String[] split = StringUtils.split(annotation, SEPERATORCHAR);
+ m_nodeName = name;
+ for (String searchString : split) {
+ if (StringUtils.isBlank(searchString)) {
+ continue;
+ }
+ if (getCaseSensitive()
+ && StringUtils.contains(name, searchString)) {
+ return true;
+ } else if (!getCaseSensitive() && StringUtils
+ .containsIgnoreCase(name, searchString)) {
+ return true;
+ }
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * @return value if inactive nodes should be checked
+ */
+ private boolean getInactive() {
+ return Boolean.parseBoolean(getAttributeValue(INACTIVE));
+ }
+
+ /**
+ * @return value if the name should be checked case sensitive
+ */
+ private boolean getCaseSensitive() {
+ return Boolean.parseBoolean(getAttributeValue(CASESENSITIVE));
+ }
+
+ /**
+ * @return the String to search for
+ */
+ private String getAnnotationString() {
+ return StringUtils.defaultIfBlank(getAttributeValue(ANNOTATIONSTRING),
+ StringConstants.EMPTY);
+ }
+
+}
diff --git a/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/Messages.java b/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/Messages.java
index 85292749c..c8e88cb42 100644
--- a/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/Messages.java
+++ b/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/Messages.java
@@ -21,6 +21,7 @@ public class Messages extends NLS {
public static String NoEmptyTestSuitesProblemDescription;
public static String TestSuiteHasAUTProblemDescription;
+ public static String ToDoCheckDescription;
static {
// initialize resource bundle
diff --git a/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/messages.properties b/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/messages.properties
index a18afec88..5d90edf67 100644
--- a/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/messages.properties
+++ b/org.eclipse.jubula.client.teststyle.impl.standard/src/org/eclipse/jubula/client/teststyle/impl/standard/i18n/messages.properties
@@ -6,4 +6,5 @@
# http://www.eclipse.org/legal/epl-v10.html
##############################################################################
TestSuiteHasAUTProblemDescription=Each Test Suite requires an AUT setting for Execution.
-NoEmptyTestSuitesProblemDescription=Add specified Test Cases to Test Suite. \ No newline at end of file
+NoEmptyTestSuitesProblemDescription=Add specified Test Cases to Test Suite.
+ToDoCheckDescription=TODO: {0}
diff --git a/org.eclipse.jubula.client.teststyle/schema/define.exsd b/org.eclipse.jubula.client.teststyle/schema/define.exsd
index 60f99fcb7..9d9c58c0c 100644
--- a/org.eclipse.jubula.client.teststyle/schema/define.exsd
+++ b/org.eclipse.jubula.client.teststyle/schema/define.exsd
@@ -206,6 +206,7 @@
<element ref="ExecTestCase" minOccurs="0" maxOccurs="1"/>
<element ref="EventHandler" minOccurs="0" maxOccurs="1"/>
<element ref="ObjectMappingCategory" minOccurs="0" maxOccurs="1"/>
+ <element ref="Comment" minOccurs="0" maxOccurs="1"/>
</sequence>
</complexType>
</element>
@@ -430,6 +431,24 @@
</attribute>
</complexType>
</element>
+
+ <element name="Comment">
+ <complexType>
+ <attribute name="id" use="required">
+ <annotation>
+ <documentation>
+
+ </documentation>
+ </annotation>
+ <simpleType>
+ <restriction base="string">
+ <enumeration value="CommentContext">
+ </enumeration>
+ </restriction>
+ </simpleType>
+ </attribute>
+ </complexType>
+ </element>
<element name="Categories">
<complexType>
diff --git a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/checks/contexts/CommentContext.java b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/checks/contexts/CommentContext.java
new file mode 100644
index 000000000..4bbfe9a5a
--- /dev/null
+++ b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/checks/contexts/CommentContext.java
@@ -0,0 +1,89 @@
+/*******************************************************************************
+ * Copyright (c) 2017 BREDEX GmbH.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * BREDEX GmbH - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+/**
+ *
+ */
+package org.eclipse.jubula.client.teststyle.checks.contexts;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.jubula.client.core.businessprocess.db.TestJobBP;
+import org.eclipse.jubula.client.core.businessprocess.db.TestSuiteBP;
+import org.eclipse.jubula.client.core.model.ICommentPO;
+import org.eclipse.jubula.client.core.model.INodePO;
+import org.eclipse.jubula.client.core.model.IProjectPO;
+import org.eclipse.jubula.client.core.model.ITestJobPO;
+import org.eclipse.jubula.client.core.model.ITestSuitePO;
+import org.eclipse.jubula.client.core.persistence.GeneralStorage;
+import org.eclipse.jubula.client.teststyle.i18n.Messages;
+
+/**
+ * @author BREDEX GmbH
+ *
+ */
+public class CommentContext extends BaseContext {
+
+ /**
+ * the class the context is for
+ */
+ public CommentContext() {
+ super(ICommentPO.class);
+ }
+ @Override
+ public String getName() {
+ return Messages.ContextCommentName;
+ }
+
+ @Override
+ public String getDescription() {
+ return Messages.ContextCommentDescription;
+ }
+
+ @Override
+ public List<? extends Object> getAll() {
+ List<Object> tmp = new ArrayList<Object>();
+ IProjectPO project = GeneralStorage.getInstance().getProject();
+ for (INodePO p : project.getUnmodSpecList()) {
+ tmp.addAll(getComments(p));
+ }
+ for (ITestSuitePO p : TestSuiteBP.getListOfTestSuites(project)) {
+ tmp.addAll(getComments(p));
+ }
+ for (ITestJobPO p : TestJobBP.getListOfTestJobs(project)) {
+ tmp.addAll(getComments(p));
+ }
+ return tmp;
+ }
+
+ /**
+ * Recursive method to get all {@link ICommentPO} nodes from a node like a category.
+ * Will be called recursively because some categories have categories on
+ * their own that must be searched for test cases.
+ *
+ * @param root
+ * The node that will be checked with its children.
+ * @return the list of the comments of this node.
+ */
+ private List<Object> getComments(Object root) {
+ List<Object> tmp = new ArrayList<Object>();
+ if (root instanceof ICommentPO) {
+ tmp.add(root);
+ } else if (root instanceof INodePO) {
+ INodePO node = (INodePO) root;
+ for (Object o : node.getUnmodifiableNodeList()) {
+ tmp.addAll(getComments(o));
+ }
+ }
+ return tmp;
+ }
+
+}
diff --git a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/Messages.java b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/Messages.java
index 2edd4722b..2c4319cb1 100644
--- a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/Messages.java
+++ b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/Messages.java
@@ -26,6 +26,8 @@ public class Messages extends NLS {
public static String ContextCapDescription;
public static String ContextCentralTestDataName;
public static String ContextCentralTestDataDescription;
+ public static String ContextCommentName;
+ public static String ContextCommentDescription;
public static String ContextComponentName;
public static String ContextComponentDescription;
public static String ContextEventHandlerName;
diff --git a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/messages.properties b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/messages.properties
index 6fe4abdb8..dbbf738f3 100644
--- a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/messages.properties
+++ b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/i18n/messages.properties
@@ -11,6 +11,8 @@ ContextCategoryName=Categories
ContextCategoryDescription=The categories as seen in the Test Case Browser
ContextCentralTestDataName=Central Test Data
ContextCentralTestDataDescription=Any central test data sets created in the project
+ContextCommentName=Comments
+ContextCommentDescription=The comment Node
ContextComponentName=Component names
ContextComponentDescription=The component names as seen in the Object Mapping Editor and Component Name Browser
ContextEventHandlerName=Event Handler
diff --git a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/quickfix/QuickfixFactory.java b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/quickfix/QuickfixFactory.java
index 81936fe9a..b5d2d9a64 100644
--- a/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/quickfix/QuickfixFactory.java
+++ b/org.eclipse.jubula.client.teststyle/src/org/eclipse/jubula/client/teststyle/quickfix/QuickfixFactory.java
@@ -14,6 +14,7 @@ import org.eclipse.core.resources.IMarker;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jubula.client.core.events.InteractionEventDispatcher;
import org.eclipse.jubula.client.core.model.ICategoryPO;
+import org.eclipse.jubula.client.core.model.ICommentPO;
import org.eclipse.jubula.client.core.model.IExecTestCasePO;
import org.eclipse.jubula.client.core.model.INodePO;
import org.eclipse.jubula.client.core.model.IPersistentObject;
@@ -70,9 +71,10 @@ public class QuickfixFactory {
*/
public void run(IMarker marker) {
Object obj = getObject(marker);
- if (obj instanceof IExecTestCasePO) {
- IExecTestCasePO execTestCase = (IExecTestCasePO) obj;
- AbstractOpenHandler.openEditor(execTestCase.getSpecAncestor());
+ if (obj instanceof INodePO) {
+ INodePO execTestCase = (INodePO) obj;
+ AbstractOpenHandler.openEditorAndSelectNode(
+ execTestCase.getSpecAncestor(), execTestCase);
} else {
AbstractOpenHandler.openEditor((IPersistentObject)obj);
}
@@ -247,6 +249,8 @@ public class QuickfixFactory {
return new Quickfix[] { new QuickfixOpenTestJob() };
} else if (obj instanceof IExecTestCasePO) {
return new Quickfix[] { new QuickfixOpenTestCase() };
+ } else if (obj instanceof ICommentPO) {
+ return new Quickfix[] { new QuickfixOpenTestCase() };
}
return new Quickfix[] { };
}
diff --git a/org.eclipse.jubula.documentation/releasenotes/en/docbook/8.6.0/features.xml b/org.eclipse.jubula.documentation/releasenotes/en/docbook/8.6.0/features.xml
index 261be377f..a13b7a386 100644
--- a/org.eclipse.jubula.documentation/releasenotes/en/docbook/8.6.0/features.xml
+++ b/org.eclipse.jubula.documentation/releasenotes/en/docbook/8.6.0/features.xml
@@ -12,7 +12,20 @@
xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xl="http://www.w3.org/1999/xlink">
<title>New Features and Developments</title>
+ <para>
+ <emphasis role="strong">New Teststyle to gather TODO's in the problems view</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
<para>
+ The Teststyle searches for a specific text (default <literal>#TODO</literal>) in names of nodes e.g. Test Cases.
+ It can be adjusted to search for other text, in specific context, cases sensitive or also in inactive Nodes.
+ See the documentation for more information.
+ </para>
+ </listitem>
+</itemizedlist>
+
+ <para>
<emphasis role="strong">UI improvements</emphasis>
</para>
<itemizedlist>
@@ -29,6 +42,7 @@
</para>
</listitem>
</itemizedlist>
+
<para>
<emphasis role="strong">Removed support to import xml files</emphasis>
</para>
diff --git a/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/content.xml b/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/content.xml
index af4edaebd..853b10bbb 100644
--- a/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/content.xml
+++ b/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/content.xml
@@ -17,5 +17,6 @@
<xi:include href="sectionActivatingTeststyleForAProject.xml"/>
<xi:include href="sectionConfiguringTeststyleForAProject.xml"/>
<xi:include href="sectionWorkingWithTheProblemsViewToViewAndFixTeststyleProblems.xml"/>
+ <xi:include href="sectionadditionalInformation.xml"/>
</section> \ No newline at end of file
diff --git a/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/sectionadditionalInformation.xml b/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/sectionadditionalInformation.xml
new file mode 100644
index 000000000..ff18cd350
--- /dev/null
+++ b/org.eclipse.jubula.documentation/userManual/en/docbook/tasks/workWithTeststyleGuidelines/sectionadditionalInformation.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2014 BREDEX GmbH.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+-->
+
+<section xml:id="additional-information-for-specific-teststyles" version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xl="http://www.w3.org/1999/xlink" >
+ <title>Additional information for Teststyles</title>
+ <section xml:id="todo-teststyle">
+ <title>TODO Teststyle</title>
+ <para>The Todo Testyle is searching for a text in the name of
+ nodes in the specified context. It cannot be searched for ”<emphasis>;</emphasis>” since this is used to split into multiple search text.</para>
+ <para>If you want to search for multiple texts at the same time you can divide them by using a semicolon ”<emphasis>;</emphasis>”.
+ If this is done e.g. ”<emphasis>#TODO;%TODO</emphasis>” for both of the texts is searched.
+ That means one of them must exist in the name and a problem will be generated for it so you see it in the problems view.</para>
+ </section>
+</section> \ No newline at end of file
diff --git a/org.eclipse.jubula.project.configuration/checkstyle.xml b/org.eclipse.jubula.project.configuration/checkstyle.xml
index 4a78ff5c2..118fa9d3a 100644
--- a/org.eclipse.jubula.project.configuration/checkstyle.xml
+++ b/org.eclipse.jubula.project.configuration/checkstyle.xml
@@ -13,6 +13,7 @@
<module name="TreeWalker">
<module name="FileContentsHolder"/>
<module name="Regexp">
+ <property name="id" value="mustdo"/>
<property name="severity" value="error"/>
<property name="format" value="(?i)to *do"/>
<property name="message" value="Keine Todo's im Code!"/>
@@ -191,11 +192,11 @@
</module>
</module>
<module name="SuppressionCommentFilter">
- <property name="offCommentFormat" value="DOTNETDECLARE\:BEGIN"/>
- <property name="onCommentFormat" value="DOTNETDECLARE\:END"/>
- <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Allow public property variables in Message classes"/>
+ <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Sometimes API names force a line length violation"/>
</module>
<module name="SuppressionCommentFilter">
- <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Sometimes API names force a line length violation"/>
+ <property name="offCommentFormat" value="CHECKSTYLE\:OFF\: ([\w\|]+)"/>
+ <property name="onCommentFormat" value="CHECKSTYLE\:ON\: ([\w\|]+)"/>
+ <property name="checkFormat" value="$1"/>
</module>
</module>

Back to the top