Ycode.TestRailClient.V2 1.0.0-beta.1

TestRail Client for Test Code

Ycode.TestRailClient.V2 provides a TestRail API v2 client dedicated to the usage in test code.

This library implements functionalities typically required to integrate your test code with TestRail. For this sake, it never tries to cover all the TestRail API v2.

Code Sample

var client = new TestRailClient(
    new TestRailClientConfiguration
    {
        Url = "https://localhost:62182",
        UserName = "taro.yamada",
        AppKey = "aiueo-kakikukeko-sasisuseso",
        CaseFilters =
        {
            new TestRailPriorityCaseFilter("P2"),
        },
    });

await client.StartTestRunAsync(
    new TestRailRunInfo
    {
        ProjectId = 10000,
        SuiteId = 100,
        Name = "Test Run Sample",
        Description = "This is just a sample. Take it easy~.",
        IncludeAll = true,
    });

var targetCaseIds = new[] { 789, 790, 791 };

string testStatus = null;
if (client.IsTestRequiredFor(targetCaseIds))
{
    // Execute a test
    testStatus = "Failed";
}

foreach (var (isFilteredCases, caseIds) in client.SplitCaseIdsByFilter(targetCaseIds))
{
    await client.RecordResultAsync(
        caseIds,
        new TestResult
        {
            Status = isFilteredCases ? testStatus : "Blocked",
            Version = "v2.3.1",
            Comment = "This test failed. The actual result was ...",
            Defects = { "ASD-8437", "ADS-9852" },
            Elapsed = TimeSpan.FromMilliseconds(2938),
        });
}


await client.EndTestRunAsync();