Version 1.6.3 Release changes

.gitignore

@@ -16,11 +16,11 @@ Sources/BusEmulation/BusEmulation.h
 Sources/BusEmulation/BusEmulation_i.c
 Sources/BusEmulation/BusEmulation_p.c
 Sources/BusEmulation/dlldata.c
-Sources/DmGraph/DMGraph.h
-Sources/DmGraph/DMGraph.tlb
-Sources/DmGraph/DMGraph_i.c
-Sources/DmGraph/DMGraph_p.c
-Sources/DmGraph/dlldata.c
+EXTERNAL_SOURCE/DmGraph/DMGraph.h
+EXTERNAL_SOURCE/DmGraph/DMGraph.tlb
+EXTERNAL_SOURCE/DmGraph/DMGraph_i.c
+EXTERNAL_SOURCE/DmGraph/DMGraph_p.c
+EXTERNAL_SOURCE/DmGraph/dlldata.c
 Sources/Format Converter/AscLogConverter/Asc_Log_Lexer.c
 Sources/Format Converter/AscLogConverter/asc_log_parser.c
 Sources/Format Converter/AscLogConverter/asc_log_parser.h
@@ -46,7 +46,7 @@ Sources/ConfigDialogsDIL/Release
 Sources/DataTypes/Release
 Sources/DIL_Interface/Release
 Sources/DIL_J1939/Release
-Sources/DmGraph/ReleaseUMinSize
+EXTERNAL_SOURCE/DmGraph/ReleaseUMinSize
 Sources/Filter/Release
 Sources/Format Converter/*/Release
 Sources/FrameProcessor/Release
@@ -78,7 +78,7 @@ Sources/ConfigDialogsDIL/Debug
 Sources/DataTypes/Debug
 Sources/DIL_Interface/Debug
 Sources/DIL_J1939/Debug
-Sources/DmGraph/DebugU
+EXTERNAL_SOURCE/DmGraph/DebugU
 Sources/Filter/Debug
 Sources/Format Converter/*/Debug
 Sources/FrameProcessor/Debug

Documents/1 Development Environment/development_environment.ditamap

@@ -12,7 +12,6 @@
   <topicref href="topics/license_information.dita" type="topic" toc="no"/>
   <topichead navtitle="Download">
     <topicref href="topics/git.dita" type="topic"/>
-    <topicref href="topics/wget.dita" type="topic"/>
   </topichead>
   <topichead navtitle="Build">
     <topicref href="topics/msbuild.dita" type="topic"/>
@@ -33,4 +32,7 @@
   <topichead navtitle="Installation">
     <topicref href="topics/nsis.dita" type="topic"/>
   </topichead>
+  <topichead navtitle="Continuous Integration Server">
+    <topicref href="topics/jenkins.dita" type="topic"/>
+  </topichead>
 </map>

Documents/1 Development Environment/topics/astyle.dita

@@ -20,27 +20,48 @@
     </section>
     <section>
       <title>Installation</title>
-      <p>Extract the <filepath>AStyle_2.02_windows.zip</filepath> file. It will create the following folders:</p>
+      <p>Extract the <filepath>AStyle_2.02_windows.zip</filepath> file to <filepath>%ProgramFiles%\AStyle</filepath>. It will create the following folders:</p>
       <ul>
         <li><filepath>bin</filepath>: Contains the program <filepath>AStyle.exe</filepath>.</li>
         <li><filepath>build</filepath> : Contains files to build the source code of AStyle. This is not necessary for BUSMASTER.</li>
         <li><filepath>doc</filepath>: Contains the documentation, which could be helpful for the usage.</li>
         <li><filepath>src</filepath>: Contains the source code of AStyle. This is not necessary for BUSMASTER.</li>
       </ul>
-      <p>Only the program <filepath>AStyle.exe</filepath> is necessary for the usage with BUSMASTER. It&apos;s recommended to copy to an existing folder that is in your %PATH% environmental variable.</p>
+      <p>Only the program <filepath>AStyle.exe</filepath> is necessary for the usage with BUSMASTER. It&apos;s recommended to add the <filepath>bin</filepath> folder to your %PATH% environmental variable.</p>
     </section>
     <section>
       <title>Configuration</title>
-      <p>There is no specific configuration necessary. Everything can be done on the command line.</p>
+      <p>For BUSMASTER certain AStyle options have been selected based on the ETAS profile:</p>
+      <p><codeblock># Bracket Style Options
+--style=ansi
+
+# Tab Options
+
+# Indentation Options
+--indent-switches
+#--indent-namespaces# deleted from ETAS profile
+--indent-preprocessor
+--indent-col1-comments# added to BUSMASTER profile
+
+# Padding Options
+--break-blocks
+--delete-empty-lines
+
+# Formatting Options
+--add-brackets
+--convert-tabs
+--align-pointer=type
+
+# Other Options</codeblock></p>
     </section>
+    <p>Options can either be given on the command line or via an options file.</p>
+    <p>AStyle is also used as part of the static code test bench. The options file with the contents given above is located at <filepath>Tests/AStyle/astyle.txt</filepath>.</p>
     <section>
       <title>Usage</title>
-      <p>Go to your command line (e.g. by executing <filepath>cmd</filepath> in the start menu). And type:</p>
-      <p><cmdname>astyle -r -s4 -S *.cpp *.h</cmdname></p>
-      <p>This will recursively run over all source code files of BUSMASTER and will adjust the style as necessary. The modifications will directly done in the respective file. The original unmodified files are available with the file name extension <filepath>.orig</filepath>.</p>
-      <p>Before you commit these file to the project repository, make sure that the modifications are useful and adjust them if necessary. This could be necessary, e.g. in case you want to define an <codeph>enum</codeph> with &quot;<codeph>=</codeph>&quot; signs all in a row.</p>
-      <p>The recommended options for C++ software at ETAS are:</p>
-      <p><cmdname>astyle --style=ansi --delete-empty-lines --break-blocks --add-brackets --indent-namespaces --indent-preprocessor --indent-switches --convert-tabs --align-pointer=type *.cpp *.h</cmdname></p>
+      <p>Go to your command line (e.g. by executing <filepath>cmd</filepath> in the start menu) and type (path to options file need to be adapted):</p>
+      <p><cmdname>astyle --options=astyle.txt --recursive *.cpp *.h</cmdname></p>
+      <p>This will recursively run over all source code files of BUSMASTER and will adjust the style as necessary. The modifications will be directly done in the respective file. The original unmodified files are available with the file name extension <filepath>.orig</filepath>.</p>
+      <p>Before you commit these file to the project repository, make sure that the modifications are useful or adjust them if necessary.</p>
     </section>
   </body>
 </topic>

Documents/1 Development Environment/topics/autoit.dita

@@ -15,7 +15,7 @@
       <p>AutoIt v3 is a freeware BASIC-like scripting language designed for automating the Windows GUI and general scripting.</p>
       <p>It uses a combination of simulated keystrokes, mouse movement and window/control manipulation in order to automate tasks.</p>
       <p>AutoIt is also very small, self-contained and will run on all versions of Windows out-of-the-box with no annoying &quot;runtimes&quot; required!</p>
-      <p>Features</p>
+      <p>Features (as described on their homepage):</p>
       <ul>
         <li>Easy to learn BASIC-like syntax</li>
         <li>Simulate keystrokes and mouse movements</li>
@@ -43,48 +43,35 @@
     </section>
     <section>
       <title>Installation</title>
-      <p>Just execute the installer <filepath>autoit-v3-setup.exe</filepath>. The standard installation folder is C:\Program Files\AutoIt3.</p>
+      <p>Just execute the installer <filepath>autoit-v3-setup.exe</filepath>. The standard installation folder is <filepath>%ProgramFiles%\AutoIt3</filepath>.</p>
     </section>
     <section>
       <title>Configuration</title>
       <p>The is no specific configuration necessary.</p>
     </section>
     <section>
       <title>Usage</title>
-      <p>BUSMASTER provides Test Script in the AutoIt format in the folder and subfolders at <filepath>Test Artifacts\Test Scripts</filepath>. The file type is <filepath>.au3</filepath>. If a <filepath>DataPrep.txt</filepath> file is provided in the same folder, it describes the requirements prior to executing the corresponding test script.</p>
+      <p>BUSMASTER provides test script in the AutoIt format in the folder <filepath>Tests\AutoIt</filepath>. Their is a sub folder for each test group, e.g. <filepath>Tests\AutoIt\Installer</filepath>. The central <filepath>build.bat</filepath> script executes all tests and summarizes failures in an HTML report.</p>
       <p>If you intend to develop further AutoIt test scripts, please follow the following general guidelines to   make the usage of the AutoIt tool for our application testing more maintainable:</p>
       <ul>
+        <li>Test cases have the file extension <filepath>.au3</filepath>. The base name of the script and all necessary files should be identical and reflect the name of the test.</li>
+        <li>Test cases should run independently from each other. Thus a tester is able to execute specific individual test cases.</li>
+        <li>Test cases should run on different system, e.g. different working directory, language environments. Thus don&apos;t use absolute paths in AutoIt scripts. Instead use the AutoIt global variables, e.g. <cmdname>@ScriptDir</cmdname>, <cmdname>@ScriptName</cmdname>, <cmdname>@ProgramFilesDir</cmdname>.</li>
+        <li>Files that get generated during the test execution should be placed in <filepath>out</filepath> folders, e.g. <filepath>Tests\AutoIt\Format Converter\out</filepath>. This makes it easier for the central <filepath>.gitignore</filepath> file to keep such results out of the source code management system.</li>
+        <li>Informations during the test run should be reported to the <filepath>stdout</filepath>. Use the <cmdname>ConsoleWrite</cmdname> command for it.</li>
+        <li>Errors during the test run should be reported to <filepath>stderr</filepath>. Use the <cmdname>ConsoleWriteError</cmdname> command for it. If anything goes to <filepath>stderr</filepath> the test case is assumed as failed.</li>
         <li>
-          <p>Avoid Absolute paths usage</p>
-          <p>Try to avoid using absolute paths in Auto It scripts as much as possible. Instead use some GUI through the scripts will accept the paths required wherever necessary.</p>
+          <p>Try to avoid using absolute paths in AutoIt scripts as much as possible. Instead use the AutoIt global variables to determine path information.</p>
         </li>
+        <li>Try to avoid runtime specific behavior. Thus try to avoid using the <cmdname>Sleep</cmdname> command, but try to use the <cmdname>WinWaitActive</cmdname> command instead.</li>
         <li>
-          <p>Module wise Scripting</p>
-          <p>Develop a script for each module based on its UTS document. In this way, each module will have its own script file (<filepath>.au3</filepath> file). This allows the user to perform automation testing module-wise. For system testing, there should be a master script which hosts all the module wise scripts.</p>
-        </li>
-        <li>
-          <p>Test Case Result File</p>
-          <p>Store the test case results generated through script running into a <filepath>.csv</filepath> file which will allow for easy readability. Also, try to store only the failed test case results thereby ensuring the necessary and sufficient principle. Alternatively, the results can be stored in a MS excel file with different tabs containing test results of each modules. They can be preceded by a test summary tab. This automation can be achieved through COM.</p>
-        </li>
-        <li>
-          <p>Use Manual Testing wisely</p>
-          <p>There may be a situation while testing using the automation scripts where a user action is required to manually verify the test case results. For an instance, a case may arise where a user needs to verify the graph data to check for its correct plotting. In such cases, use GUI scripting concept, by introducing dialog box which looks like <image href="../images/autoit_interaction.png" placement="break"/></p>
-          <p>This way, the user can choose <uicontrol>Yes</uicontrol> or <uicontrol>No</uicontrol> thus accounting for some manual intervention which makes the life easy for script developer.</p>
-        </li>
-        <li>
-          <p>Division of Testing</p>
-          <p>The testing with AutoIt automation can be divided into two varieties:<ul>
-              <li>Fully Automatic: The testing is fully automated in this case. No manual testing is allowed in this.</li>
-              <li>Semi Automatic: Involves some manual testing mentioned in preceding guideline.</li>
-            </ul></p>
-        </li>
-        <li>
-          <p>Identify Test Case dependencies</p>
-          <p>While automating test cases for a particular module using AutoIt scripts, it is quite possible that test cases depend upon their predecessors and the execution of test cases can be skipped if the dependent test case fails.</p>
-          <p>Consider a sample test case where a dialog visibility should be checked upon certain action. If the dialog is visible, then the other test cases like carrying some operations in that dialog can be executed. If the dialog is not visible, then there is no point in executing the remaining test cases.</p>
-          <p>So, as explained in the example, while developing scripts for test cases, script developer should identify the dependencies and ensure skipping the execution of test cases accordingly.</p>
+          <p>Add your test case to the central <filepath>Tests\AutoIt\build.bat</filepath> script, if you feel confident that all aforementioned points are fulfilled.</p>
         </li>
       </ul>
+      <p>The testing with AutoIt automation can be divided into two varieties:<ul>
+          <li>Fully Automatic testing requires no manual interaction and is based on the Simulation interface.</li>
+          <li>Semi Automatic System Testing: Involves some manual procedures (e.g. attaching hardware devices) mentioned in related guideline.</li>
+        </ul></p>
     </section>
   </body>
 </topic>

Documents/1 Development Environment/topics/cppcheck.dita

@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "http://docs.oasis-open.org/dita/v1.1/OS/dtd/topic.dtd" []>
-<topic id="splint" xml:lang="en-us">
+<topic id="cppcheck" xml:lang="en-us">
   <title>Cppcheck - Static Source Code Checker</title>
   <prolog>
     <author>Ratnadip Choudhury</author>
@@ -13,7 +13,6 @@
     <section>
       <title>Description</title>
       <p>There are many static source code checkers available and used by Open Source projects.</p>
-      <p>Splint is probably the most often used checker. It seamlessly  integrates into the Visual C++ IDE. See the following documentation: <xref href="http://www.splint.org/win32.html" scope="external"/>. Unfortunately it is limited to C and is not able to parse C++ code.</p>
       <p>Cppcheck is another Open Source software, which is able to parse C++ code and is therefore used for BUSMASTER.</p>
     </section>
     <section>
@@ -22,15 +21,15 @@
     </section>
     <section>
       <title>Installation</title>
-      <p>Execute the installer. The standard installation folder is <filepath>C:\Program Files\Cppcheck\</filepath>. Cppcheck should automatically be added to your %PATH% environment variable.</p>
+      <p>Execute the installer. The standard installation folder is <filepath>%ProgramFiles%\Cppcheck</filepath>. Cppcheck should automatically be added to your %PATH% environment variable.</p>
     </section>
     <section>
       <title>Configuration</title>
-      <p>There is no specific configuration of Cppcheck necessary.</p>
+      <p>The test script in <filepath>Tests\Cppcheck</filepath> contains all necessary configuration. Beside that no specific configuration necessary.</p>
     </section>
     <section>
       <title>Usage</title>
-      <p>Execute <cmdname>cppcheck -I. --enable=all %SOURCE_FILES%</cmdname> on the respective files. If you have <cmdname>git-bash</cmdname> or <cmdname>cygwin bash</cmdname> installed, you can do it over all <filepath>.cpp</filepath> and <filepath>.h</filepath> files using <cmdname>find -name &quot;*.[cpp|h]&quot; | xargs cppcheck -I. --enable=all *.cpp *.h</cmdname>.</p>
+      <p>Execute the test script in <filepath>Tests\Cppcheck\build.bat</filepath>. It automatically generates an HTML report with the results.</p>
     </section>
   </body>
 </topic>

Documents/1 Development Environment/topics/dita-ot.dita

@@ -71,8 +71,8 @@
     <section>
       <title>Installation</title>
       <p>DITA-OT requires the installation of the Java Development Kit (JDK). It is not sufficient to have the Java Runtime Environment (JRE) installed. The current version (Oct 2011) is 1.6.0_27. The standard installation folder is <filepath>C:\Program Files\Java\jdk1.6.0_27</filepath>.</p>
-      <p>DITA-OT is installed in the old versions 1.3.1 and 1.4 by the authoring tool Serna Free 4.3. They get installed as plugins in the folder <filepath>C:\Program Files\Syntext\Serna Free 4.3\plugins\dita\DITA-OT1.3.1</filepath> and at <filepath>C:\Program Files\Syntext\Serna Free 4.3\plugins\dita\DITA-OT1.4</filepath>.</p>
-      <p>Following the directory structure of Serna, it&apos;s best to install DITA 1.5.3 by un-zipping it to the folder <filepath>C:\Program Files\Syntext\Serna Free 4.3\plugins\dita\DITA-OT1.5.3</filepath>.</p>
+      <p>DITA-OT is installed in the old versions 1.3.1 and 1.4 by the authoring tool Serna Free 4.3. They get installed as plugins in the folder <filepath>%ProgramFiles%\Syntext\Serna Free 4.3\plugins\dita\DITA-OT1.3.1</filepath> and at <filepath>%ProgramFiles%\Syntext\Serna Free 4.3\plugins\dita\DITA-OT1.4</filepath>.</p>
+      <p>Following the directory structure of Serna, it&apos;s best to install DITA 1.5.3 by un-zipping it to the folder <filepath>%ProgramFiles%\Syntext\Serna Free 4.3\plugins\dita\DITA-OT1.5.3</filepath>.</p>
     </section>
     <section>
       <title>Configuration</title>