trial.interfaces 58/157(36%) line coverage

      
10
20
30
40
50
60
70
80
90
100
110
120
130
140
150
160
170
180
190
200
210
220
230
240
250
260
270
280
290
300
310
320
330
340
350
360
370
380
390
400
410
420
430
440
450
460
470
480
490
500
510
520
530
540
550
560
570
580
590
600
610
620
630
640
650
660
670
680
690
700
710
720
730
740
750
760
770
780
790
800
810
820
830
840
850
860
870
880
890
900
910
920
930
940
950
960
970
980
990
1000
1010
1020
1030
1040
1050
1060
1070
1080
1090
1100
1110
1120
1130
1140
1150
1160
1170
1180
1190
1200
1210
1220
1230
1240
1250
1260
1270
1280
1290
1300
1310
1320
1330
1340
1350
1360
1370
1380
1390
1400
1410
1420
1430
1440
1450
1460
1470
1480
1490
1500
1510
1520
1530
1540
1550
1560
1570
1580
1590
1600
1610
1620
1630
1640
1650
1660
1670
1680
1690
1700
1710
1720
1730
1740
1750
1760
1770
1780
1790
1800
1810
1820
1830
1840
1850
1860
1870
1880
1890
1900
1910
1920
1930
1940
1950
1960
1970
1980
1990
2000
2010
2020
2030
2040
2050
2060
2070
2080
2090
2100
2110
2120
2130
2140
2150
2160
2170
2180
2190
2200
2210
2220
2230
2240
2250
2260
2270
2280
2290
2300
2310
2320
2330
2340
2350
2360
2370
2380
2390
2400
2410
2420
2430
2440
2450
2460
2470
2480
2490
2500
2510
2520
2530
2540
2550
2560
257191
258191
2590
2600
2610
262997
263997
264997
265997
266997
2670
2680
2690
2700
2710
2720
2730
2740
2750
2760
2770
2780
2790
2800
2810
2820
2830
284997
2850
286997
287997
288997
289997
290997
2910
292997
2930
2940
2950
2960
2970
2980
2990
3000
3010
3020
3030
3040
3050
3060
3070
3080
3090
3100
3110
3120
3130
3140
3150
3160
3170
3181
3191
3201
3211
3220
3230
3240
3250
3260
3270
3280
3290
3300
331176
332176
333176
334176
3350
3360
3370
3380
3390
3400
3410
3420
3430
3440
3450
3460
3470
3480
3490
3500
3510
3520
3530
3540
3550
3560
3570
3580
3590
3600
3610
3620
3630
3640
3650
3660
3670
3680
3690
3700
3710
3720
3730
3740
3750
3760
3770
3780
3790
3800
3810
3820
3830
3840
385997
386997
387997
3880
3890
3900
3910
3920
3930
3940
3950
3960
3970
3980
3990
4000
4010
4020
4030
4040
4050
4060
4070
4080
4090
4100
4110
4120
4130
4140
4150
4160
4170
4180
4190
4200
4210
4220
4230
4240
4250
4260
4270
4280
4290
4300
4310
4320
4330
4340
4350
4360
4370
4380
4390
4400
4410
4420
4430
4440
4450
4460
447997
4480
449997
450997
4510
4520
4530
4540
4550
4560
4570
4580
4590
4600
4610
4620
4630
4640
4650
4660
4670
4680
4690
4700
4710
4720
4730
4740
4750
4760
4770
4780
4790
4800
4810
4820
4830
4840
4850
4860
4870
4880
4890
4900
4910
4920
4930
4940
4950
4960
4970
4980
4990
5000
5010
5020
5030
5040
5050
5060
5070
5080
5090
5100
5110
5120
5130
5140
5150
5160
5170
5180
5190
5200
5210
5220
5230
5240
5250
5260
5270
5280
5290
5300
5310
5320
5330
5340
5350
5360
5370
5380
5390
5400
5410
5420
5430
5440
5450
5460
5470
5480
5490
5500
5510
5520
5530
5540
5553
5560
5570
5580
5590
5600
5616
56216
5630
5640
5650
5666
56721
5680
5690
5700
5716
57218
5730
5740
5750
5766
57719
5780
5790
5800
5816
5821
5830
5840
5850
5860
5876
58813
5890
5900
5910
5926
59314
5940
5950
5960
5970
5980
5990
6000
6010
6020
6030
6041995
6050
6060
6070
6080
6095
6100
6110
6120
6130
6145
6150
6160
6170
6180
619528
6200
6210
6220
6230
624528
6250
6260
6270
6280
629997
6304985
6310
6320
6330
6340
635997
6364985
6370
6380
6390
6400
6410
6420
6430
6440
6450
6460
6470
6480
6490
6500
6510
6520
653997
654997
655997
6560
6570
6580
6590
6601
6611
6620
6630
6640
6650
6661
6670
6680
      
module trial.interfaces;

import std.datetime;
import std.algorithm;
import std.array;
import std.functional;
import std.conv;
import std.file;
import std.path;
import std.uuid;
import std.exception;
import std.json;
import std.algorithm;


alias TestCaseDelegate = void delegate() @system;
alias TestCaseFunction = void function() @system;


interface ILifecycleListener
{

  void begin(ulong testCount);


  void update();


  void end(SuiteResult[]);
}


string toJsonString(Throwable throwable) {
  if(throwable is null) {
    return "{}";
  }

  string fields;

  fields ~= `"file":"` ~ throwable.file.escapeJson ~ `",`;
  fields ~= `"line":"` ~ throwable.line.to!string.escapeJson ~ `",`;
  fields ~= `"msg":"` ~ throwable.msg.escapeJson ~ `",`;
  fields ~= `"info":"` ~ throwable.info.to!string.escapeJson ~ `",`;
  fields ~= `"raw":"` ~ throwable.toString.escapeJson ~ `"`;

  return "{" ~ fields ~ "}";
}



interface ITestDiscovery {

  TestCase[] getTestCases();
}


interface ITestDescribe {

  TestCase[] discoverTestCases(string file);
}


interface ITestExecutor
{

  SuiteResult[] beginExecution(ref const(TestCase)[]);


  SuiteResult[] execute(ref const(TestCase));


  SuiteResult[] endExecution();
}


interface ISuiteLifecycleListener
{

  void begin(ref SuiteResult);


  void end(ref SuiteResult);
}


interface IAttachmentListener
{

  void attach(ref const Attachment);
}


interface ITestCaseLifecycleListener
{

  void begin(string suite, ref TestResult);


  void end(string suite, ref TestResult);
}


interface IStepLifecycleListener
{

  void begin(string suite, string test, ref StepResult);


  void end(string suite, string test, ref StepResult);
}


struct Label {

  string name;


  string value;


  string toString() inout {
    return `{ "name": "` ~ name.escapeJson ~ `", "value": "` ~ value.escapeJson ~ `" }`;
  }


  static Label[] fromJsonArray(string value) {
    return parseJSON(value).array.map!(a => Label(a["name"].str, a["value"].str)).array;
  }


  static Label fromJson(string value) {
    auto parsedValue = parseJSON(value);

    return Label(parsedValue["name"].str, parsedValue["value"].str);
  }
}





struct Attachment {

  string name;


  string file;


  string mime;



  static string destination;


  static Attachment fromFile(const string name, const string path, const string mime) {
    auto fileDestination = buildPath(destination, randomUUID.toString ~ "." ~ path.baseName);
    copy(path, fileDestination);

    auto a = const Attachment(name, fileDestination, mime);

    if(LifeCycleListeners.instance !is null) {
      LifeCycleListeners.instance.attach(a);
    }

    return a;
  }


  static Attachment fromString(const string content) {
    ulong index;
    string fileDestination = buildPath(destination, randomUUID.toString ~ ".txt");
    fileDestination.write(content);

    auto a = const Attachment("unknown", fileDestination, "text/plain");

    if(LifeCycleListeners.instance !is null) {
      LifeCycleListeners.instance.attach(a);
    }

    return a;
  }


  string toString() inout {
    string fields;
    fields ~= `"name":"` ~ name ~ `",`;
    fields ~= `"file":"` ~ file ~ `",`;
    fields ~= `"mime":"` ~ mime ~ `"`;

    return "{" ~ fields ~ "}";
  }
}




struct SourceLocation {

  string fileName;


  size_t line;


  string toString() inout {
    return `{ "fileName": "` ~ fileName.escapeJson ~ `", "line": ` ~ line.to!string ~ ` }`;
  }
}



private string escapeJson(string value) {
  return value.replace(`"`, `\"`).replace("\r", `\r`).replace("\n", `\n`).replace("\t", `\t`);
}


struct TestCase
{

  string suiteName;


  string name;


  TestCaseDelegate func;


  Label[] labels;


  SourceLocation location;


  this(const TestCase testCase) {
    suiteName = testCase.suiteName.dup;
    name = testCase.name.dup;
    func = testCase.func;
    location = testCase.location;
    labels.length = testCase.labels.length;

    foreach(key, val; testCase.labels) {
      labels[key] = val;
    }
  }


  this(T)(string suiteName, string name, T func, Label[] labels, SourceLocation location) {
    this(suiteName, name, func.toDelegate, labels);
    this.location = location;
  }


  this(string suiteName, string name, TestCaseFunction func, Label[] labels = []) {
    this(suiteName, name, func.toDelegate, labels);
  }


  this(string suiteName, string name, TestCaseDelegate func, Label[] labels = []) {
    this.suiteName = suiteName;
    this.name = name;
    this.func = func;
    this.labels = labels;
  }

  string toString() const {
    string jsonRepresentation = "{ ";

    jsonRepresentation ~= `"suiteName": "` ~ suiteName.escapeJson ~ `", `;
    jsonRepresentation ~= `"name": "` ~ name.escapeJson ~ `", `;
    jsonRepresentation ~= `"labels": [ ` ~ labels.map!(a => a.toString).join(", ") ~ ` ], `;
    jsonRepresentation ~= `"location": ` ~ location.toString;

    return jsonRepresentation ~ " }";
  }
}



TestResult toTestResult(const TestCase testCase) {
  auto testResult = new TestResult(testCase.name.dup);

  testResult.begin = Clock.currTime;
  testResult.end = testResult.begin;
  testResult.labels = testCase.labels.dup;
  testResult.fileName = testCase.location.fileName;
  testResult.line = testCase.location.line;

  return testResult;
}


struct SuiteResult
{

  string name;


  SysTime begin;


  SysTime end;


  TestResult[] tests;


  Attachment[] attachments;


  @disable
  this();


  this(string name) {
    this.name = name;
    begin = SysTime.fromUnixTime(0);
    end = SysTime.fromUnixTime(0);
  }


  this(string name, SysTime begin) {
    this.name = name;
    this.begin = begin;
  }


  this(string name, SysTime begin, SysTime end) {
    this.name = name;
    this.begin = begin;
    this.end = end;
  }


  this(string name, SysTime begin, SysTime end, TestResult[] tests) {
    this.name = name;
    this.begin = begin;
    this.end = end;
    this.tests = tests;
  }


  this(string name, SysTime begin, SysTime end, TestResult[] tests, Attachment[] attachments) {
    this.name = name;
    this.begin = begin;
    this.end = end;
    this.tests = tests;
    this.attachments = attachments;
  }


  string toString() {
    string fields;
    fields ~= `"name":"` ~ name.escapeJson ~ `",`;
    fields ~= `"begin":"` ~ begin.toISOExtString ~ `",`;
    fields ~= `"end":"` ~ end.toISOExtString ~ `",`;
    fields ~= `"tests":[` ~ tests.map!(a => a.toString).join(",") ~ `],`;
    fields ~= `"attachments":[` ~ attachments.map!(a => a.toString).join(",") ~ `]`;

    return "{" ~ fields ~ "}";
  }
}


class StepResult
{

  string name;


  SysTime begin;


  SysTime end;


  StepResult[] steps;


  Attachment[] attachments;

  this() {
    begin = SysTime.min;
    end = SysTime.min;
  }

  protected string fields() {
    string result;

    result ~= `"name":"` ~ name.escapeJson ~ `",`;
    result ~= `"begin":"` ~ begin.toISOExtString ~ `",`;
    result ~= `"end":"` ~ end.toISOExtString ~ `",`;
    result ~= `"steps":[` ~ steps.map!(a => a.toString).join(",") ~ `],`;
    result ~= `"attachments":[` ~ attachments.map!(a => a.toString).join(",") ~ `]`;

    return result;
  }


  override string toString() {
    return "{" ~ fields ~ "}";
  }
}



class TestResult : StepResult
{

  enum Status
  {

    created,

    failure,

    skip,

    started,

    success,

    pending,

    unknown
  }


  string fileName;


  size_t line;


  Status status = Status.created;


  Label[] labels;


  Throwable throwable;


  this(string name)
  {
    this.name = name;
    super();
  }


  override string toString() {
    string result = fields ~ ",";

    result ~= `"fileName":"` ~ fileName.escapeJson ~ `",`;
    result ~= `"line":"` ~ line.to!string ~ `",`;
    result ~= `"status":"` ~ status.to!string ~ `",`;
    result ~= `"labels":[` ~ labels.map!(a => a.toString).join(",") ~ `],`;
    result ~= `"throwable":` ~ throwable.toJsonString;

    return "{" ~ result ~ "}";
  }
}



struct Flaky {


  static Label[] labels() {
    return [Label("status_details", "flaky")];
  }
}



struct Issue {

  private string name;


  Label[] labels() {
    return [ Label("issue", name) ];
  }
}


struct Feature {
  private string name;


  Label[] labels() {
    return [ Label("feature", name) ];
  }
}


struct Story {
  private string name;


  Label[] labels() {
    return [ Label("story", name) ];
  }
}



class PendingTestException : Exception {


  this(string file = __FILE__, size_t line = __LINE__, Throwable next = null)  {
    super("You cannot run pending tests", file, line, next);
  }
}




class LifeCycleListeners {


  static LifeCycleListeners instance;

  private {
    ISuiteLifecycleListener[] suiteListeners;
    ITestCaseLifecycleListener[] testListeners;
    IStepLifecycleListener[] stepListeners;
    ILifecycleListener[] lifecycleListeners;
    ITestDiscovery[] testDiscoveryListeners;
    IAttachmentListener[] attachmentListeners;
    ITestExecutor executor;

    string currentTest;
    bool started;
  }

  @property {


    string runningTest() const nothrow {
      return currentTest;
    }


    bool isRunning() {
      return started;
    }
  }


  TestCase[] getTestCases() {
    return testDiscoveryListeners.map!(a => a.getTestCases).join;
  }


  void add(T)(T listener) {
    static if(!is(CommonType!(ISuiteLifecycleListener, T) == void)) {
      suiteListeners ~= cast(ISuiteLifecycleListener) listener;
      suiteListeners = suiteListeners.filter!(a => a !is null).array;
    }

    static if(!is(CommonType!(ITestCaseLifecycleListener, T) == void)) {
      testListeners ~= cast(ITestCaseLifecycleListener) listener;
      testListeners = testListeners.filter!(a => a !is null).array;
    }

    static if(!is(CommonType!(IStepLifecycleListener, T) == void)) {
      stepListeners ~= cast(IStepLifecycleListener) listener;
      stepListeners = stepListeners.filter!(a => a !is null).array;
    }

    static if(!is(CommonType!(ILifecycleListener, T) == void)) {
      lifecycleListeners ~= cast(ILifecycleListener) listener;
      lifecycleListeners = lifecycleListeners.filter!(a => a !is null).array;
    }

    static if(!is(CommonType!(ITestExecutor, T) == void)) {
      if(cast(ITestExecutor) listener !is null) {
        executor = cast(ITestExecutor) listener;
      }
    }

    static if(!is(CommonType!(ITestDiscovery, T) == void)) {
      testDiscoveryListeners ~= cast(ITestDiscovery) listener;
      testDiscoveryListeners = testDiscoveryListeners.filter!(a => a !is null).array;
    }

    static if(!is(CommonType!(IAttachmentListener, T) == void)) {
      attachmentListeners ~= cast(IAttachmentListener) listener;
      attachmentListeners = attachmentListeners.filter!(a => a !is null).array;
    }
  }


  void attach(ref const Attachment attachment) {
    attachmentListeners.each!(a => a.attach(attachment));
  }


  void update() {
    lifecycleListeners.each!"a.update";
  }


  void begin(ulong testCount) {
    lifecycleListeners.each!(a => a.begin(testCount));
  }


  void end(SuiteResult[] result) {
    lifecycleListeners.each!(a => a.end(result));
  }


  void begin(ref SuiteResult suite) {
    suiteListeners.each!(a => a.begin(suite));
  }


  void end(ref SuiteResult suite) {
    suiteListeners.each!(a => a.end(suite));
  }


  void begin(string suite, ref TestResult test) {
    currentTest = suite ~ "." ~ test.name;
    testListeners.each!(a => a.begin(suite, test));
  }


  void end(string suite, ref TestResult test) {
    currentTest = "";
    testListeners.each!(a => a.end(suite, test));
  }


  void begin(string suite, string test, ref StepResult step) {
    currentTest = suite ~ "." ~ test ~ "." ~ step.name;
    stepListeners.each!(a => a.begin(suite, test, step));
  }


  void end(string suite, string test, ref StepResult step) {
    currentTest = "";
    stepListeners.each!(a => a.end(suite, test, step));
  }


  SuiteResult[] execute(ref const(TestCase) func) {
    started = true;
    scope(exit) started = false;
    return executor.execute(func);
  }


  SuiteResult[] beginExecution(ref const(TestCase)[] tests) {
    enforce(executor !is null, "The test executor was not set.");
    return executor.beginExecution(tests);
  }


  SuiteResult[] endExecution() {
    return executor.endExecution();
  }
}