Hello Friends,

In this post, we will discuss downloading the attachments from Test plan module of ALM/QC. Downloading attachments from test plan is little trickier then downloading attachments from requirements module or defects module because we have two distinct places from where we can download attachments, first one is a test case and second is individual design steps.

You can read about downloading attachments from requirements module here and about downloading the attachments from defects here.

Introduction

For downloading test and design step attachments, first, we have to establish the connection to ALM/QC using OTA API, which is explained here.

In this post we will discuss three different approaches, first is downloading all test attachments, second is downloading attachments from a single test and from all its design steps.

Downloading all tests attachments

After you have successfully created the Object of TDConnection, then Copy the following function into your code execute the scripts, all of the test attachments will be downloaded in the desired folder.

public static Boolean DownloadTestAttachments_New(String AttachmentDownloadPath)
 {
 TDAPIOLELib.TestFactory OTestFactory = OQConnection.TestFactory as TDAPIOLELib.TestFactory;
 TDAPIOLELib.TDFilter OTDFilter = OTestFactory.Filter as TDAPIOLELib.TDFilter;
 TDAPIOLELib.List OTestList;

 TDAPIOLELib.AttachmentFactory OAttachmentFactory;
 TDAPIOLELib.ExtendedStorage OExtendedStorage;

 Console.WriteLine("Downloading attachments for the Tests : " + AttachmentDownloadPath);

 try
 {
 //Check if the directory exists
 if ((System.IO.Directory.Exists(AttachmentDownloadPath)) == false)
 {
 Debug.WriteLine("Cannot find the attachments download folder");
 return false;
 }

 OTDFilter["TS_ATTACHMENT"] = "Y";
 OTestList = OTestFactory.NewList(OTDFilter.Text);

 foreach (TDAPIOLELib.Test OTest in OTestList)
 {

 if (OTest.HasAttachment)
 {
 Directory.CreateDirectory(AttachmentDownloadPath + "\\" + OTest.ID.ToString());

 Console.WriteLine("Downloading attachments for the Test : " + OTest.Name.ToString());

 OAttachmentFactory = OTest.Attachments;

 //Download the test attachments
 foreach (TDAPIOLELib.Attachment OAttachment in OAttachmentFactory.NewList("";))
 {
 OExtendedStorage = OAttachment.AttachmentStorage;
 OExtendedStorage.ClientPath = AttachmentDownloadPath + "\\" + OTest.ID.ToString();
 OAttachment.Load(true, OAttachment.Name);
 }
 }
 }

 return true;
 }
 catch (Exception ex)
 {
 Debug.WriteLine("Error occurred while downloading the attachments : " + ex.Message.ToString());
 return false;
 }

 }

How downloading test attachment works

For downloading the attachments from tests, we will use the following objects

• TestFactory : Test Factory object is the test manager class of OTA API. This can be used for creating and managing the tests.
• Test : Test is the actual test object, which will represent a single test at any given point of time.
• TDFilter : TDFiler Object if the Filter type object of the OTA API and can be used for filtering data from any modules.
• AttachmentFactory : Attachment Factory Object is the Attachment manager class of OTA API. This will be used for managing the attachments.
• ExtendedStorage : it is the storage handler object of the OTA API and will be used for downloading the attachment to the desired folder.

For downloading the test attachments, first we have to filter the test with attachments; otherwise, it might take a lot of time for the bigger projects to navigate through all of the tests.

ALM will store value ‘Y’ in the field “TS_ATTACHMENT” and we will use this field to filter the test with attachments.

OTDFilter["TS_ATTACHMENT"] = "Y";

OTestList = OTestFactory.NewList(OTDFilter.Text);

After the execution of the above statements, we will get the list of test objects with attachments in OTestList object.

Now, for each of the listed tests, we will get the attachments object

OAttachmentFactory = OTest.Attachments;

And then we will download the attachments using the extended storage objects.

Downloading attachments from design steps

Downloading attachments from tests is an easy task because we can apply filters on tests, but downloading attachments from design steps is a bit tricky part, to download design steps attachments, we will need design step factory objects which can only be obtained using test object. So, to read the design steps we will have to get the test object and then only we can get information about the design steps.

If you have a bigger project and a lot of random design steps are having the attachments then you will have to figure out a way to filter on the tests from which you want to download the design steps. There is an another easier way of finding the design steps using the query on the DESSTEPS table

Select distinct(DS_TEST_ID) from DESSTEPS where DS_ATTACHMENT = ‘Y’

Note : You will need QC database access to execute this query or you will have to use OTA Command object for executing this query

Once you execute this query you will get the list of tests whose design steps are having attachments.

you can use the below code for downloading the attachments.

public static Boolean DownloadDesignStepsAttachmentsWithTestID_New(String TESTID, String AttachmentDownloadPath)
{
TDAPIOLELib.TestFactory OTestFactory = OQConnection.TestFactory as TDAPIOLELib.TestFactory;
TDAPIOLELib.TDFilter OTDFilter = OTestFactory.Filter as TDAPIOLELib.TDFilter;
TDAPIOLELib.List OTestList;

TDAPIOLELib.AttachmentFactory OAttachmentFactory;
TDAPIOLELib.ExtendedStorage OExtendedStorage;

TDAPIOLELib.DesignStepFactory ODesignStepFactory;
TDAPIOLELib.Test OTest;

Console.WriteLine("Downloading attachments for the Tests : " + AttachmentDownloadPath);

try
{
//Check if the directory exists
if ((System.IO.Directory.Exists(AttachmentDownloadPath)) == false)
{
Debug.WriteLine("Cannot find the attachments download folder"); return false;
}

OTDFilter["TS_TEST_ID"] = TESTID;
OTestList = OTestFactory.NewList(OTDFilter.Text);

if (OTestList != null && OTestList.Count == 1)
{
OTest = OTestList[1];

ODesignStepFactory = OTest.DesignStepFactory;

foreach (TDAPIOLELib.DesignStep ODesignStep in ODesignStepFactory.NewList(""))
{
if (ODesignStep.HasAttachment)
{

OAttachmentFactory = ODesignStep.Attachments;

//Download the Design Step Attachments
foreach (TDAPIOLELib.Attachment OAttachment in OAttachmentFactory.NewList(""))
{
OExtendedStorage = OAttachment.AttachmentStorage;
OExtendedStorage.ClientPath = AttachmentDownloadPath;
OAttachment.Load(true, AttachmentDownloadPath + "\\" + OAttachment.Name);
}
}
}
}

return true;
}
catch (Exception ex)
{
Debug.WriteLine("Error occurred while downloading the attachments : " + ex.Message.ToString());
return false;
}

}

How it works?

For downloading the Design step attachments we will need the reference to the Designstep factory from the test object. So, we will use the passed test ID to filter and get the test object. Once we have the test object reference, then we will get the design step factory reference from it.

Using this design step factory reference we will loop through all of the design steps for finding if the design step is having an attachment.

if (ODesignStep.HasAttachment)

Lastly, we will use the extended storage object for downloading the attachments from the design steps object.

Let me know, if you need any help, I will try to provide the solutions.

Thanks,