Guidelines for compiling a .Net library for TestShell Studio

[Quali-Community]

Attached is the basic guidelines for .Net developers who wish to compile a .dll library that will work with TestShell Studio.

Please note that certain elements are not explained thoroughly since they require more in-depth knowledge (Such as Error-handling and Canceling) if a user wishes to add those elements some support from QualiSystems will be required. 

The purpose of this document is to provide the basic guidelines on how to write a TestShell Library (version 4.7 and above) from MS Visual Studio 2010 and above.

 

Steps

1. Create a .NET DLL solution. 
   
   
2. Add LibraryAttributes.cs (can be found under: "C:\Program Files (x86)\QualiSystems\TestShell\DriverBuilder\LibraryAttributes.cs") to your project. It holds all the TestShell specific attributes. 
   
   
3. Use a public class to define your list of methods. The class name is the name of the session type in TestShell Studio, Do not use an existing TestShell session type (Dll, SSH, GUI etc...).
   
   
4. Optional: Inherit the class from ICancelable if required. This interface should be implemented to gracefully end session operations (requires additional method to be implemented under ICancelable).
    
5. In the AssmeblyInfo.cs: 

1. Verify that [assembly: AssemblyVersion("1.0.0.1")] has the proper version.
2. Add this attribute [assembly: Library(typeof(ClassName), "StudioStencil")]. An example for a stencil we are using is "Traffic".

Method guidelines:

1. Use primitive variables. 
2. You can use ENUM variables (numeric and string only). 
3. For a string vector use string[], for a numeric vector use double[]. 
4. For a string matrix use string[,], for a numeric matrix use double[,]. 
5. Useoutparameters if you have several parameters that you would like the method to return. 
6. Throw and exception of type ErrorException providing the following information: 

1. Error name
2. Description 
3. Originating step (can be empty)
4. Parameters (will be represented as a string matrix in TestShell Studio for the user to extract required information). 
   
   

Method attributes: 

1. [Folder("Execution")] 
   Specify the folder that will be displayed in TestShell Studio. The folder can be a hierarchy (e.g. "Folder1\Folder2\Folder3"). 
2. [Description("write the method description here")] 
   Optional. Provide the method description that will be displayed in TestShell Studio. When using the description, add this using line: using System.ComponentModel;
3. [Alias("Method Alias")] 
   Optional. Provide the method alias that will be displayed in TestShell Studio. This string can have spaces in it as opposed to the .net method name. 
4. [StartSession] 
   Optional. Add the attribute to specify a method to be called when a Studio session is created. All the method parameters will appear in the session section. Common usage of for this method is for connection functions. 
5. [EndSession] 
   Optional. Add the attribute to specify a method to be called when a Studio session ends. 
6. [Hidden] 
   Optional. Add this attribute when you wouldn’t want the method to be exposed to the user. 
7. [Cancelable] 
   Optional. Specify the method is cancelable. Add this attribute if you’ve implemented the ICancelable interface. 
   
   

Parameter attributes: 

1. General usage – add the below before the parameter 
   [Description("The parameter description"), Mandatory, Alias("A parameter description"), ParameterDefaultValue("True")] 
2. Description 
   Optional. Provide the variable description. 
3. Mandatory 
   Optional. Add this attribute if the parameter is mandatory. 
4. Alias 
   Optional. Provide the variable alias. This alias can contain spaces. 
5. ParameterDefaultValue 
   Optional. When required add a default value.

 Attachments:

TestShell_Library_Development_Guidelines.pdf [318KB]

---

 Dan Michlin (Dan.M) - 03/20/2014 10:41 AM

·  2698  ·

[Quali-Community]

do we have any example which shows that how can we get dropdown box for user input for specific values

---

(Quali) - 12/26/2014 11:06 AM

·  2700  ·

[Quali-Community]

To get a dropdown, you need to define an enum and use it in the function header.

You can add alias to each value of the enum as well.

 

For example, the enum definition would be (with alias on some of them)

public enumPossibleValues
{
[Alias("First Value")]
Value1,
[Alias("Second Value")]
Value2,
Value3
}

and the function will use it this way:

public void Function1(
[ParameterDefaultValue("Value2"), Description("Select one of the values.")]PossibleValuesvalue)
{ switch (value) {   case Value1:
    break;
  case Value2:
    break;
  case Value3:
    break;
  default:
    break;
}
}

---

Yaniv Kalsky (Yaniv.K) - 01/07/2015 08:44 AM

·  2699  ·

[JosefTestonG]

Thank you for providing the guidelines for .Net developers who wish to compile a .dll library that will work with TestShell Studio. It seems like a comprehensive document with detailed steps and guidelines. As you mentioned, some elements require more in-depth knowledge and support from QualiSystems. It's great to have such resources available for developers to help them create TestShell Libraries.