User Manual

Upon installation of SMIT TestCaseHub a new hub is created in your projects. Two new work item types 'SMIT Test Case' and 'SMIT Test Step' are created too. 

A click on the SMIT TestCaseHub will open the SMIT TestCaseHub page. This page consists of two parts: 

1. A tree view on the left side, and 
2. an SMIT Test Case preview on the right side.

In the following cases the extension will show a dialog providing help and contact information:

• A license is not available
• A previous trial license ended
• The current user is not activated and no free users are available within the license

After installation of the SMIT TestCaseHub a set of free test cases is added to the tree view. You can download the test cases by clicking on the button Free download and start using them. If you want to hide the tree view node you can click on the Hide button. 

Hiding a tree view node can be made undone from within the user settings as shown on the second image.

At the top of the tree view the node Test cases by assignment contains all SMIT Test Case work items grouped into the following three nodes:

• My test cases – shows all test cases which are assigned to the user who is currently logged in
• Others' test cases – shows all test cases which are assigned to a user but not to the user who is currently logged in and
• Unassigned test cases – shows all test cases which are not assigned to a user

The test cases can be filtered using the text input field ‘Search test case’ and sorted by using the icon in the menu bar.

The tree view displays the name of the tree view and the number of test cases inside the tree view.

A click on an SMIT Test Case will open the SMIT Test Case preview on the right side.

A double click on the SMIT Test Case will open the SMIT Test Case in the standard work item modification view.

The following actions are available in the menu bar above the tree view:

• Refresh – updates the tree view manually
• New – adds a new SMIT Test Case or a new tree view node
• Import – provides the possibility to import test cases via XML template or via the SMIT TestKit Shop
• Convert – creates standard Test Case work items from the selected SMIT Test Case work items for the actual test runs
• Sort – supports four modes which can be switched by clicking the icon multiple times
• Boards - forwards you to the Azure DevOps board for SMIT Test Case work items or the SMIT TestCaseHub queries
• Settings - provides the possibility to change user specific configurations

The state of test cases is shown in the tree view for each test case. Additionally it is highlighted in the color which is configured in the Azure DevOps process model.

The following functions exists for working with tree view nodes:

• Create new test case or treeview node
• Add existing test case
• Convert the tree view node to test plan
• Rename tree view node
• Delete tree view node
  

By default the first three functions are placed in the fast access area.

The other ones are placed in the options menu.

The following functions exist for the test cases:

• Remove from treeview node
• Move to tree view node
• Add to tree view node
• Convert
• Duplicate test case
• Edit fields
• Add link
• Add tags
• Download parameters

By default, the following functions are placed in the fast access area. 

• Remove from treeview node
• Convert
• Duplicate test case
  

The other ones are placed in the options menu.

It is possible to change this via the user settings.

In the preview area, the header of the SMIT Test Case selected in the tree view is shown, as well as a summary of the SMIT Test Steps and the parameters required for the test case. 
Parameters in the SMIT TestCaseHub extension are identified in the same way as in the Azure DevOps default test case work item. Only the first occurrence of a parameter will be displayed in the parameter list. The parameters are sorted by appearance. 

Custom tree view nodes have a button which can be used to convert the tree view node into a test plan. 

After clicking the button a dialog is shown where the name of the test plan, the area path and the iteration path can be selected. 

The test cases of the tree view node are added to the new test plan in the order in which they are shown in the tree view. It is also possible to select an existing test plan in the dialog instead of creating a new plan.

On the next page parameters can be added to the converted test cases.

The user receives a link to the converted testplan in the test plan convert info message. The test plan is opened in a new browser tab.

By default, test cases and tree view nodes in the tree view are sorted in the order of creation. You can change this order by using drag and drop to reorder items in the tree view. You can use drag and drop to move multiple test cases from the same tree view node to another tree view node. You can also drag and drop whole tree view nodes containing a set of test cases or other tree view nodes. The tree view nodes will be removed from the old tree view node and added to the new tree view node.

It is possible to drag and drop test cases from the nodes by assignment to custom tree view nodes. Drag and drop test cases or custom tree view nodes into nodes by assignment is prohibited.

The ‘Details’ tab of the SMIT Test Case work item contains the header of the test case with all the required preconditions and postconditions of the test case.

In the 'Additional Information' group you can add further information about the validity of the test case, its average duration and complexity.

A direct link to any test steps is provided in the 'Related Work' group.

The user can select a test case from the tree view and duplicate it. The duplicated test case includes all SMIT Test Case related fields, the test steps and the work item relations.
The test case is added to one of the three default tree view nodes and is opened in the work item form modification view.

The work items of type SMIT Test Case are not accessible within the Azure DevOps test functionality. To use them there you need to convert the work items to standard Test Case work items.

Clicking the button 'Convert' in the tree view menu bar or the 'Convert SMIT Test Case to test case work item' button opens the conversion area with the selected test case. The button 'Convert the tree view node to test plan' opens the conversion area with all SMIT Test Cases in the tree view node.

Additionally, it associates the created Test Case work items with a test suite which needs to be specified before the conversion can be started.

The SMIT Test Cases you would like to convert can be selected by clicking the test cases in the tree view. To remove a test case from the selection you can click on a selected test case in the tree view again or you click the ‘Remove test case’ button in the ‘Selected test cases’ table on the right side of the page.

The SMIT Test Step work item provides a template for the structured creation of logical test steps.

The 'Details' page contains the SMIT Test Step fields based on the PIPO principle and the option to add screenshots for the input and output.

Additionally, it contains a description field to add further details about the test step.

The details page of the SMIT Test Step work item contains entry fields for:

• Precondition – the conditions relevant before conducting the test step
• Input – the input required to conduct the test step
• Input screenshot – a screenshot detailing the necessary action to conduct the test step
• Postcondition – the conditions relevant after conducting the test step
• Output – the expected output of the test step
• Output screenshot – a screenshot detailing the expected outcome of the test step
• Description – further details about the test step

It is possible to sort test steps using either the 'Move up' or 'Move down' buttons on each test step row or by using drag and drop. 
The buttons move the test step up or down by one position.

To delete an SMIT Test Step within an SMIT Test Case click the red X icon of the test step.

After clicking the icon, a dialog is shown in which the deletion needs to be confirmed. Clicking ‘Yes’ deletes the test step and clicking ‘No’ keeps the test step intact.

Deleted work items can be restored using the default functions in Azure DevOps. When the work item link is restored, the test step is added to the SMIT Test Case as the last test step and not in the position where it was before.

In the SMIT Test Case work item form multiple test steps can be selected by clicking on a checkbox in front of the test step row.

If one or more test step is selected the user can click on a button in the menu bar of the test step list to delete the selected test steps. 

For copying an SMIT Test Step, the Azure Dev Ops standard functionality applies.

If you want to create a copied test step which is added as a test step to the same test case as the original test step, you need to check the checkbox ‘Include existing links’. If this checkbox is checked, the test step is added to the bottom of the test steps list.

An SMIT Test Step can be duplicated by clicking on the duplicate button in the Test Steps tab of the SMIT Test Case work item form. The duplicated test step is inserted into the test step list below the original test step.

In the SMIT Test Case work item form multiple test steps can be selected by clicking on a checkbox in front of the test step row.

If one or more test step is selected the user can click on a button in the menu bar of the test step list to copy the selected test steps. The copied test steps are added to the back of the test step list.

Test cases can be imported using the XML import format which is defined below.

To import test cases via XML you need to click on ‘Import’ and then on ‘Import via XML file’ in the menu bar.

A dialog opens in the preview area of the SMIT TestCaseHub.

You can import multiple XML files simultaneously. 

After confirmation, a list of successfully imported test cases is displayed in the 'import completed' dialog.

To cancel the import workflow, click on the button 'Cancel' in the menu bar.

XML format:

<?xml version="1.0" encoding="utf-8"?>

<TestCase>

            <Description>Test case description</Description>

            <Postcondition>Test case post condition</Postcondition>

            <Precondition>Test case precondition</Precondition>

            <Title>Test case title</Title>

            <Language>de-DE</Language>

            <FirstSoftwareVersion>First software version text</FirstSoftwareVersion>

            <LastSoftwareVersion>First software version text</LastSoftwareVersion>

            <Risk>High / Middle / Low</Risk>    <!-- One of the 3 values High, Middle or Low -->

    <Priority>High / Middle / Low</Priority>    <!-- One of the 3 values High, Middle or Low -->

    <Complexity>High / Middle / Low</Complexity>    <!-- One of the 3 values High, Middle or Low -->

    <Duration>10</Duration>

            <TestSteps>

                <!-- Each test step block represents one test step -->

                        <TestStep>

                                    <LineNum>1</LineNum>   <!-- Order in which the test steps are added to the test case (no number should be used twice) -->

                                   <Title>Test step title</Title>

                                   <Precondition>Precondition text</Precondition>

                                   <Input>Input text</Input>

                        <InputScreenshot>

                                               <Bitmap>base64 encoded png</Bitmap>

                                   </InputScreenshot>

                                    <Postcondition>Postcondition text</Postcondition>

                                   <Output>Output text</Output>

                                   <OutputScreenshot>

                                               <Bitmap>base64 encoded bitmap</Bitmap>

                                   </OutputScreenshot>

                        </TestStep>

            </TestSteps>

</TestCase>

Please note: If your TFS or Azure DevOps Server installation uses an XML process model you need to use 'Hoch', 'Mittel', 'Niedrig' instead of 'High', 'Medium', 'Low' if your work item installation language is German.

To import an SMIT TestKit Test Case for Microsoft Dynamics 365 Finance and Operation or Microsoft Dynamics AX 2012 from the SMIT TestKit Marketplace, select 'Import via SMIT TestKit Marketplace' in the import drop down. The extension SMIT TestCaseHub will automatically do the SMIT TestKit Marketplace login using your license key. 

After the login is finished you can select one, multiple or all test cases in the shown table. The currently selected number of test cases is shown within the button 'Number of selected test cases'. Clicking on 'Download selected test cases' or on 'Download' in the table row of a single test case will open a dialog where you have to confirm that the selected test cases should be downloaded.

In the last step you need to confirm that the selected test cases should be imported. Clicking ‘Yes’ will download and create the selected test cases in your system. This includes all screenshots, test steps and the test cases. A progress bar indicates the progress of the download after it was started. While the import is running you need to stay on the page until it is finished but in the mean time you can continue to browse through the available test cases.

If you already imported test cases from the SMIT TestKit Marketplace you will see an icon next to the test case id. You can still download the test case again in case a newer version is available or you changed the test case. The import always creates new SMIT Test Case work items. Therefore, already imported test cases will never be overwritten if the same SMIT TestKit Marketplace test case is imported again.

To go back to the tree view, click the button 'Back to the tree view' in the menu bar.

If you have a paid license activated you have two additional buttons. 

Clicking 'Change contract and payment information' will open a page where you can change your personal and payment information.

The button 'Change number of licenses' opens a new (the second) group which can be used to change the number of user licenses for your current plan.

To increase the number of users you can specify a number in the field quantity and then click on the button 'Add user licenses'. A pop-up appears asking you to confirm the new quantity.

You can also click on 'Increase quantity' next to a current subscription. If the column 'New quantity' shows the correct number you can click on 'Order new quantity'. New user licenses start directly.

To decrease the number of users you can click on 'Decrease quantity' next to a current subscription and specify the number of new users for this subscription. If the column 'New quantity' shows the correct number you can click on 'Order new quantity'. This will end the subscription to the next billing period and starts a new subscription with the decreased quantity starting at the next billing period.

To end a subscription you can click on 'End subscription to next billing period'.

If you have a paid license which includes the unlimited users component you won't have the button to change the number of licenses. You will see that your current plan includes an unlimited number of licenses and therefore no license assignment is required for this plan.

The group 'Activated users' manages the users which are associated to the current plan. Only users that are shown in the list can use the extension. Users can be added by clicking in the input field 'Enter user name' and then selecting one of the users from the proposed list. You can filter the list by entering a name in the 'Enter user name' field. To remove users you can click on the button 'Remove' for the corresponding user.