TestIT.Adapter 3.0.1

Test IT TMS Adapter for MsTest/NUnit

Getting Started

Installation

Requirements

• MethodBoundaryAspect.Fody 2.0.148+
• Microsoft.NET.Test.Sdk 17.5.0+
• MSTest.TestAdapter 3.0.2 (only for MSTest)
• MSTest.TestFramework 3.0.2 (only for MSTest)

NuGet CLI

Install-Package TestIt.Adapter

.NET CLI

dotnet package add TestIt.Adapter

Usage

Configuration

File

Create Tms.config.json file in the project directory:

{
  "url": "URL",
  "privateToken": "USER_PRIVATE_TOKEN",
  "projectId": "PROJECT_ID",
  "configurationId": "CONFIGURATION_ID",
  "testRunId": "TEST_RUN_ID",
  "testRunName": "TEST_RUN_NAME",
  "testRunTags": ["smoke", "nightly"],
  "testRunLinks": [
    {
      "url": "https://gitlab.example.com/group/project/-/jobs/12345",
      "title": "CI Job",
      "type": "Related"
    }
  ],
  "adapterMode": ADAPTER_MODE,
  "automaticCreationTestCases": AUTOMATIC_CREATION_TEST_CASES,
  "automaticUpdationLinksToTestCases": AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES,
  "certValidation": CERT_VALIDATION,
  "ignoreParameters": IGNORE_PARAMETERS,
  "certValidation": CERT_VALIDATION,
  "rerunTestsCount": RERUN_TESTS_COUNT,
  "importRealtime": true,
  "syncStoragePort": 49152
}

Examples

NOTE: To run tests, you must use the TmsRunner utility.

TmsRunner --runner "/usr/local/share/dotnet/sdk/6.0.302/vstest.console.dll" --testassembly "/tests/MsTest.dll" --tmsUrl=http://localhost:8080 --tmsPrivateToken=Token --tmsProjectId=f5da5bab-380a-4382-b36f-600083fdd795 --tmsConfigurationId=3a14fa45-b54e-4859-9998-cc502d4cc8c6
-tmsAdapterMode=0 --tmsTestRunId=a17269da-bc65-4671-90dd-d3e3da92af80 --tmsTestRunName=Regress --tmsAutomaticCreationTestCases=true --tmsAutomaticUpdationLinksToTestCases=true --tmsCertValidation=true --tmsLabelsOfTestsToRun smoke,regress --tmsIgnoreParameters=true --debug --tmsRerunTestsCount=2

• runner - path to vstest.console.dll or vstest.console.exe
• testassembly - path to dll with tests
• debug - enable debug logs

Test run link types

Supported values for testRunLinks[].type (default: Related):

• Related
• BlockedBy
• Defect
• Issue
• Requirement
• Repository

Example with CI job URL:

export TMS_TEST_RUN_LINKS='[{"url":"'"$CI_JOB_URL"'","title":"CI Job","type":"Related"}]'
export TMS_TEST_RUN_TAGS='smoke,nightly'

Attributes

Use attributes to specify information about autotest.

Description of attributes:

• WorkItemIds - a method that links autotests with manual tests. Receives the array of manual tests' IDs
• DisplayName - internal autotest name (used in Test IT)
• ExternalId - unique internal autotest ID (used in Test IT)
• Title - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
• Description - autotest description specified in the autotest card
• Labels - labels listed in the autotest card
• Tags - tags listed in the autotest card
• Links - links listed in the autotest card
• Step - the designation of the step

Description of methods:

• Adapter.AddLinks - add links to the autotest result.
• Adapter.AddAttachments - add attachments to the autotest result.
• Adapter.AddMessage - add message to the autotest result.

Examples

Simple test

using Tms.Adapter;
using Tms.Adapter.Attributes;
using Tms.Adapter.Models;
using Atr = Tms.Adapter.Attributes;

public class SampleTests {

    [Step]
    public void CreateProject()
    {
        Assert.IsTrue(true);
    }

    [Step]
    [Title("Enter project title")]
    [Atr.Description("Enter project description")]
    public void EnterProject()
    {
        Assert.IsTrue(true);
    }

    [Step]
    public void CreateSection() 
    {
        Assert.IsTrue(true);
        Adapter.AddAttachments("/Users/user/screen.json");
    }

    [TestMethod]
    [WorkItemIds("1523344")]
    [ExternalId("all_annotations_test")]
    [Title("All Annotations Test Title")]
    [DisplayName("All Annotations Test Display Name")]
    [Tags("tag01", "tag02")]
    [Atr.Description("All Annotations Test Description")]
    [Links(url: "https://testit.ru/", LinkType.Related, "TestTitle", "TestDescr")]
    [Links(url: "https://testit.ru/", LinkType.Defect)]
    public void AllAnnotationsTest()
    {
        Adapter.AddLinks("https://testit.ru/", "Test 4", "Desc 4", LinkType.Related);
        CreateProject();
        EnterProject();
        CreateSection();
    }
}

Parameterized test

using Tms.Adapter.Attributes;

public class ParameterizedTests {

    [Parameterized]
    [DataRow(MsTest.TestType.Parameter)]
    [DataRow(MsTest.TestType.Simple)]
    [ExternalId("TestType_{testType}")]
    [Title("Title {testType}")]
    [DisplayName("Display Name {testType}")]
    [TestMethod]
    public async Task TestType(TestType testType)
    {
        Assert.AreEqual(testType, testType);
    }

    [Parameterized]
    [DataRow(1,1,2)]
    [DataRow(2,2,4)]
    [ExternalId("Sum_{a}_{b}_{c}")]
    [Title("Title {a} {b} {c}")]
    [DisplayName("Display Name {a} {b} {c}")]
    [TestMethod]
    public async Task Sum(int a, int b, int c)
    {
        Assert.AreEqual(c, a + b);
    }
}

Contributing

You can help to develop the project. Any contributions are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or create a direct pull request after you edit the README.md file with necessary changes.
• Make sure to check your spelling and grammar.
• Create individual PR for each suggestion.
• Read the Code Of Conduct before posting your first idea as well.

License

Distributed under the Apache-2.0 License. See LICENSE for more information.