BizUnit 4.0 TestStep for MQSC (Ibm Websphere Message Queue).

///Himanshu Thawait
///Test step to work with MQSC. using amqmdnet.dll and MQSeriesHelper.cs

using System;
using System.Collections.ObjectModel;
using System.IO;
using BizUnit.TestSteps.Common;
using BizUnit.Xaml;

namespace BizUnit.TestSteps.MQSCStepHT
{

    public class MQSCGetStepHT : TestStepBase
    {
        private string message;

        /// <summary>
        /// Que Manager details server (port)
        /// </summary>
        public string queueManager { get; set; }
        /// <summary>
        /// Query name
        /// </summary>
        public string queue { get; set; }
        /// <summary>
        /// Wait time out
        /// </summary>
        public int waitTimeout { get; set; }

        /// <summary>
        /// Used for Sub steps
        /// </summary>
        public MQSCGetStepHT()
        {
            SubSteps = new Collection<SubStepBase>();
        }

        /// <summary>
        /// Read the data from MQ
        /// </summary>
        /// <param name="context"></param>
        public override void Execute(Context context)
        {
            context.LogInfo("Reading queue: {0}, search queueManager: {1}", queue, queueManager);
            message = MQSeriesHelper.ReadMessage(queueManager, queue, waitTimeout, context);
            context.LogData("MQSeries output message:", message);

            // SubSteps
            // Check it against the validate steps to see if it matches one of them
            foreach (var subStep in SubSteps)
            {
                try
                {
                    Stream fileData = StreamHelper.LoadMemoryStream(message);
                    // Try the validation and catch the exception
                    fileData = subStep.Execute(fileData, context);
                }
                catch (Exception ex)
                {
                    context.LogException(ex);
                    throw;
                }
            }
        }

        /// <summary>
        /// Validation on MQ and Data  data
        /// </summary>
        /// <param name="context"></param>
        public override void Validate(Context context)
        {
            if (string.IsNullOrEmpty(queueManager))
            {
                throw new StepValidationException("queueManager may not be null or empty", this);
            }

            if (string.IsNullOrEmpty(queue))
            {
                throw new StepValidationException("queue may not be null or empty", this);
            }

        }
    }
}

Code of MQSeriesHelper.cs

Build

Project: Test project 

Finally we are all set to write test case for MQSC. This test project will going to use the same file drop location, Schema and XML file of BizTalk MQSC project (obviously as we going to test that project).

• File drop location: \\FileServer\Share\HT1\IN_MQ\ same location that is being used by BizTalk MQSC project
• Input files: IN_MQ.xml
• Schma :  SchOUT.xsd same schema of out message (MF Schema) of BizTalk MQSC

Code of HT1_MQ.cs

We have two test cases on this class. One is for copying the xml file in BizTalk pickup location using BizUnit.TestSteps.File (out of the box test step) and other is to read data from MQSC using our BizUnit.TestSteps.MQSCStepHT. 

Things to remember here is:

RunTest() is a key here, what ever code you have written (in MQSCStepHT) is not going to actually execute until this RunTest() get called. So, if you going to debug the code then wait this function get call then your breakpoint will hit (in MQSCStepHT)

To know about the BizUnit Test steps read: “BizUnit Getting Started Guide.pdf” Which come with BizUnit 4.0 install. Default location C:\Program Files\BizUnit\BizUnit 4.0

In my test case I decided to label the code in 6 steps.  

• Step 1: create object of TestCase, that is actually the test case which is going to have many thing.
• Step 2: Preparation step where you setup thing to assign into Execution step. Like setup file drop location and assign source file path. 
• Step 3: Execution step where you assign the step 2 to step 1 testcase.
• Step 4: Is an optional step where you can save you test case in XMAL file format. As BizUnit can also work pretty well with XMAL base test steps.
• Step 5: Create BizUnit instance to run. Assign the step 1 test case in to BizUnit object.
• Step 6: Actually run the test by RunTest().

Here is the complete code: 

using BizUnit.TestSteps.Common;
using BizUnit.TestSteps.DataLoaders.File;
using BizUnit.TestSteps.File;
using BizUnit.TestSteps.MQSCStepHT;
using BizUnit.TestSteps.ValidationSteps.Xml;
using BizUnit.Xaml;
using Microsoft.VisualStudio.TestTools.UnitTesting;


namespace HT1.TestData
{
    [TestClass]
    public class HT1_MQ
    {
        [TestMethod]
        public void MQ_TC1_CopyFileToProcess()
        {
            //1. Creat test case
            var TC1 = new TestCase { Name = "H31 TC2", Category = "In Run", Preconditions = "H31 TC1" };

            //2.0 Prepration for **Execution Step**- Copy file to IN folder
            var createStep = new CreateStep();
            createStep.CreationPath = @"\\FileServer\Share\HT1\IN_MQ\IN_MQ.xml";
            //2.3 Source File
            var dataLoder = new FileDataLoader { FilePath = @"\\FileServer\Share\HT1\IN_MQ.xml" };

            createStep.DataSource = dataLoder;


            //3 Execution Step- Copy file
            TC1.ExecutionSteps.Add(createStep);

            //4 Optional steps- Save Test case to XMAL file
            TestCase.SaveToFile(TC1, TC1.Name + ".xmal");

            //5.Create BizUnit instance to run
            var bizunit = new BizUnit.BizUnit(TC1);

            //6.Actually run the test
            bizunit.RunTest();
        }


        [TestMethod]
        public void MQ_TC2_Read()
        {
            //1. Create Test case
            var TC1 = new TestCase { Name = "H31.MQ.TC1", Category = "IN run", Purpose = "Verify MQData" };

            //2.0 Prepration for **Execution Step**- Setup MQSC setting
            var mqscStep = new MQSCGetStepHT();
            mqscStep.queueManager = "MQSCMger";
            mqscStep.queue="MQSC.TEST.IN";


            //2.1 Validate XML again Schems
            var xmlValidationStep = new XmlValidationStep();
            var schemaDefination = new SchemaDefinition
            {
                XmlSchemaPath = @"\\FileServer\Share\HT1\SchOUT.xsd",
                XmlSchemaNameSpace = "http://HT1_MQ.SchOUT"
            };

            //2.2 Adding schemt to validate
            xmlValidationStep.XmlSchemas.Add(schemaDefination);

            //2.3 Validate XML data Using XPath
            var xpathRecCount = new XPathDefinition
            {
                Description = "Checking the GrpPolicyNum",
                XPath = "/*[local-name()='Member' and namespace-uri()='http://HT1_MQ.SchOUT']/*[local-name()='GrpPolicyNum' and namespace-uri()='']",
                Value = "GRP:iGate01"
            };


            //3 Execution Step- check MQ data
            xmlValidationStep.XPathValidations.Add(xpathRecCount);
           
            //3.1 sub step
            mqscStep.SubSteps.Add(xmlValidationStep);

            //3.2 Main step
            TC1.ExecutionSteps.Add(mqscStep);

            //4 Optional steps- Save Test case to XMAL file
            TestCase.SaveToFile(TC1, TC1.Name + ".xmal");

            //5.Create BizUnit instance to run
            var bizunit = new BizUnit.BizUnit(TC1);

            //6.Actually run the test
            bizunit.RunTest();

           
        }
    }
}

MQ_TC2_Read() :

Has some extra thing on Step 2 (2.1, 2.2, 2.3) that is for validation of message format and data in it.

• Step 2.0: we just step the MQSC details
• Step 2.1 & 2.2: We know that data is in XML format and we have the schema of that xml. So, we want to verify MQ data against schema.
• Step 2.3: We also want dig into the node level and verify the value in it. So we are using the xpath query to get node’s value. We got this xpath query from BizTalk schema editor “instance xpath” properties.

To get instance xpath 

Now it’s time to run:

BizUnit test case will run just like any other test case. Jusr select your test case, right click and hit Run

Things to remember: If you want to debug the code and hits the break point then right click on test case and select “Debug Selection”

Test Result:

When you run the test case “Test Result” tab will come in form in bottom of you VS. Here you can see the test case status like pass, failed, Abraded and running. To see in details right click on test result and select “View Test Result Details”

Here is how test details looks like, and let see how to red it:

IT has two parts: 

• Common Result will just give you information about who run when runs which computer etc.
• Standard Console Output: Here you get most of the thing. I marked 4 place and lest see what each of it tell us.

1. Tell us about MQSC config values
2. Tell us what data we have in MQSC
3. Going to verify the Schema and value
4. 3.1: Saying value is as expected. So test got pass 

Each test run will store the complete details in “.trx” file which is “Visual Studio Test Results File” format @ folder “TestResults” Name of file has user who run this test case plus computer name along with date time stamp.

Finally it’s complete hope it will help you.

Next Steps  

History