Information about using analysis tools

Every node in Knime has its help page. It can be seen after clicking on choosen node or you can display it choosing Configure and then ? in the bottom of the window. This is the place where you can find a lot of useful tips and information as well as gain knowledge about the tool you are using.

SVN

SVN is a software versioning and revision control system.

• Offline
  SVN is a command line tool. To generate a needed report, you need an offline copy of your project on your computer. DePress uses a xml file generated using command like this: svn log --xml --verbose --use-merge-history repository_url > result.xml (where repository_url is a path to your local folder with your project). You can add any needed additional commands when you would like to get more specified report. For example command svn log --xml --verbose -r {2014-01-01}:{2014-03-01} --use-merge-history repository_url > result.xml extracts data about changes made between 1.01.2014 and 1.03.2014. For more information visit the SVN's page.
• Online
  In an online version of node it is needed to insert a direct link to the repository with your project and also add information about login and password. If you can retrieve data without logging you can leave these boxes empty. In some cases there could appear a problem with the link. It happens when there is viewvc in your link. Change it then to svn, it should help.

In both cases you can choose which information should appear in the result of node's work. You can type formats of files which you're interested in. For example when you would like to get information only about changes made on xml files, you can get it just by typing xml. If you leave this box empty or with a * in it, in the result all formats will be displayed. You can also choose a package in the Advanced tab. If you don't know what it is, leave it empty.
Information which you get depends only on your choise or interests. You can switch options as you want. Only you know what is needed in your project's analysis.

GIT

GIT is a distributed revision control and source code management (SCM) system.
In DePress you can use it in as well offline as online version.

• Offline
  First of all, to generate a needed report, you need an offline copy of your project on your computer. Then visit the GIT page and download the tool. In this tool go into your folder(command line commands). Here you can generate needed report typing a command git log --pretty=format:"%H%n%ct%n%an%n%B%n%H" --raw --no-merges --abbrev=40. The txt file with the result is all you need to use the GIT's node in Knime.
• Online
  As an url insert a link to your online repository. In GitHub it can be found in the left column. It ends with .git.

In both cases you can choose which information should appear in the result of node's work. You can type formats of files which you're interested in. For example when you would like to get information only about changes made on xml files, you can get it just by typing xml. If you leave this box empty or with a * in it, in the result all formats will be displayed. You can also choose a package in the Advanced tab. If you don't know what it is, leave it empty.
Information which you get depends only on your choise or interests. You can switch options as you want. Only you know what is needed in your project's analysis.

JIRA

JIRA is a proprietary issue tracking product, developed by Atlassian. It provides bug tracking, issue tracking, and project management functions.

• Offline
  In DePress you use a xml report showing changes made in your project. To obtain such file, you need to visit yours project JIRA page and switch view to XML in Issue Navigator section, and save the XML shown to a file on your local disk. Here you can first use a filter if you would like to specify the report(it depends on your requirement). What is important, JIRA by default limits the number of events to 100. You can switch this manually in the link to your result(change the number 100 to 200), but to get more, you have to use admin view(for more information look in the Internet).
  Then enter path to the file into node’s input field in configuration dialog.
• Online
  You only have to insert JIRA repository url (e.g. "https://depress.atlassian.net").

CKJM

The program ckjm calculates Chidamber and Kemerer object-oriented metrics by processing the bytecode of compiled Java files.
In DePress you need the report generated using ckjm program. To get it, you can run ckjm as a Ant task(about Ant read more here. To do so, add needed information to the build.xml file as written here and run Ant using command line. If you have problem and Ant fails, check if you have the right class directory (it has to lead to .class files (not .java)).
When you have needed report, just add the path in the node's options.

JaCoCo

JaCoCo is an open source toolkit for measuring and reporting Java code coverage.
You can use it as Maven tool(about Maven read more here). You have to change pom.xml file as written here. Run JaCoCo typing in a command line mvn org.jacoco:jacoco-maven-plugin (you have to be in the folder where pom.xml is). If you have any problem with Maven, try typing "mvn clean", then "mvn install" and run your task again. To have needed by DePress xml file, your JaCoCo configuration should look similar to this:

<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.7.2.201409121644</version>
<configuration>
<formats>
<format>xml</format>
</formats>
</configuration>
</plugin>

Help

Solve most popular problems

• Missing XLS node
  You have to install needed plugin. To do so go in Knime to Help -> Install new software -> In the list next to Work with choose KNIME Update Site -> in the filter below type xls -> uncheck "Show only the latest version" and choose from the list Knime Extension XLS Support with the same version as yours Knime. Then click on finish and follow Knime instructions.
• Missing DePress's node
  Check the version of your DePress plugin. Some nodes are only available in the newest version.
• Can not choose older version of DePress
  During the installation select the option "Show only the latest version"
• DePress installation takes forever
  During installation select the option "Contact all update sites...".
• Jira node throws error about jqlQuery
  Go to your report file. In one of the first lines you should see the link to your Jira website. Remove from this link everything which goes after "jqlQuery"(together with "jqlQuery" word). Save the file and run the node again.
• JaCoCo node throws an error
  Check if there is a report.dtd file next to your result file. You can download one from jacoco website.
• Running Pitest Maven founds no mutation
  Type "mvn clean" then "mvn install" and try again.