chr
2026-04-05 fe750b791d5b517cc4e9bc8e99a9a75139a0cfba
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
//            Copyright Keysight Technologies 2012-2019
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, you can obtain one at http://mozilla.org/MPL/2.0/.
using System;
using System.ComponentModel;
using NUnit.Framework;
using System.IO;
using System.Linq;
 
namespace OpenTap.Engine.UnitTests
{
    [TestFixture]
    public class UserCodeTest 
    {
        [Test]
        public void ResultListeners()
        {
            resultListenerCrash[] crashers = new resultListenerCrash[]{
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.PlanRunStart},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.StepRunStart},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.Result},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.StepRunCompleted},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.PlanRunCompleted},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.Open},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.Close}
            };
 
            TestPlan testplan = new TestPlan();
            testplan.Steps.Add(new TestStepTest());
            foreach (var crasher in crashers)
            {
                testplan.Execute(new IResultListener[] { crasher });
            }
        }
 
        [Test]
        [Ignore("Since the result thread is not synced with the test plan thread, the test plan might complete before the abort is used from the result listeners.")]
        public void ResultListenerAbortPlan()
        {
            // since the 
 
            resultListenerCrash[] crashers = new resultListenerCrash[]{
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.PlanRunStart, AbortPlan = true},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.StepRunStart, AbortPlan = true},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.Result, AbortPlan = true},
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.StepRunCompleted, AbortPlan = true},
                // The plan cannot be aborted on PlanRunCompleted. The at that point it will be ignored.
                new resultListenerCrash{CrashResultPhase = resultListenerCrash.ResultPhase.PlanRunCompleted, AbortPlan = true}
            };
 
            TestPlan testplan = new TestPlan();
            testplan.Steps.Add(new TestStepTest());
            foreach (var c in crashers)
            {
                c.FinalVerdict = Verdict.NotSet;
                var expectedVerdict = Verdict.Aborted;
 
                if (c.CrashResultPhase != resultListenerCrash.ResultPhase.PlanRunStart)
                    expectedVerdict = Verdict.Pass;
 
                // Simply running the plan.
                var planrun = testplan.Execute(new IResultListener[] { c });
                Assert.AreEqual(expectedVerdict, planrun.Verdict);
                Assert.AreEqual(expectedVerdict, c.FinalVerdict);
 
                // Test that it works in composite runs.
                // Here it's important that the abort does not spill into the next run.
                // Which is why the plan is run twice.
                testplan.Open(new IResultListener[] { c });
                c.FinalVerdict = Verdict.NotSet;
                Assert.AreEqual(expectedVerdict, testplan.Execute(new IResultListener[] { c }).Verdict);
                Assert.AreEqual(expectedVerdict, c.FinalVerdict);
                c.CrashResultPhase = resultListenerCrash.ResultPhase.None;
                c.FinalVerdict = Verdict.NotSet;
                Assert.AreEqual(Verdict.Pass, testplan.Execute(new IResultListener[] { c }).Verdict);
                Assert.AreEqual(Verdict.Pass, c.FinalVerdict);
                testplan.Close();
            }
            
 
        }
        
 
        [Test]
        public void VersionProperties()
        {
            TestPlan tp = new TestPlan();
            tp.ChildTestSteps.Add(new Plugins.BasicSteps.DelayStep());
            var tpr = tp.Execute();
 
            Assert.IsTrue(tpr.Parameters.Any(p => p.Group == "Version" && p.Name == "OpenTap"), "No engine version parameter found");
        }
 
        [Test]
        public void InstrumentTestMethod()
        {
            InstrumentTest openCrash = new InstrumentTest { CrashPhase = InstrumentTest.InstrPhase.Open };
            InstrumentTest closeCrash = new InstrumentTest { CrashPhase = InstrumentTest.InstrPhase.Close };
            foreach (var instr in new IInstrument[] { openCrash, closeCrash })
            {
                InstrumentTestStep step = new InstrumentTestStep { Instrument = instr };
                TestPlan plan = new TestPlan();
                plan.Steps.Add(step);
                plan.Execute();
            }
        }
 
        [Test]
        public void DutInheritingFromIDut()
        {
            try
            {
                var dut = new InterfaceTestDut();
                DutSettings setting = new DutSettings();
                setting.Add(dut);
            }
            catch (Exception ex)
            {
                Assert.Fail("Unit test for duts inheriting from the IDut interface has trown an exception: " + ex.Message);
            }
        }
 
        [Test]
        public void ResultListenerInheritingFromIResultListener()
        {
            try
            {
                var resultListener = new InterfaceTestResultListenser();
                var setting = new ResultSettings();
                setting.Add(resultListener);
            }
            catch (Exception ex)
            {
                Assert.Fail("Unit test for result listener inheriting from the IResultListener interface has trown an exception: " + ex.Message);
            }
        }
 
        public void InstrumentInheritingFromIInstrument()
        {
            try
            {
                var instrument = new InterfaceTestInstrument();
                var setting = new InstrumentSettings();
                setting.Add(instrument);
            }
            catch (Exception ex)
            {
                Assert.Fail("Unit test for instruments inheriting from the IInstrument interface has trown an exception: " + ex.Message);
            }
        }
    }
 
    public class InstrumentTestStep : TestStep
    {
        public IInstrument Instrument { get; set; }
        public override void Run()
        {
            Assert.IsTrue(Instrument.IsConnected);
        }
    }
 
    public class InstrumentTest : Instrument
    {
        public InstrumentTest()
        {
            Name = "InstrTest";
        }
 
        public enum InstrPhase
        {
            Open,
            Close
        }
 
        public InstrPhase CrashPhase { get; set; }
 
        public override void Open()
        {
            base.Open();
            tryCrash(InstrPhase.Open);
        }
 
        public override void Close()
        {
            base.Close();
            tryCrash(InstrPhase.Close);
        }
 
        void tryCrash(InstrPhase phase)
        {
            if (phase == CrashPhase)
            {
                throw new Exception("Intended Crash: " + phase.ToString());
            }
        }
    }
 
    [DisplayName("Test\\Crash")]
    public class resultListenerCrash : ResultListener
    {
        public enum ResultPhase
        {
            PlanRunStart,
            PlanRunCompleted,
            StepRunStart,
            StepRunCompleted,
            Result,
            Close,
            Open,
            None
        }
 
        public bool AbortPlan { get; set; }
 
        public ResultPhase CrashResultPhase { get; set; }
        public Verdict FinalVerdict { get; set; }
        public resultListenerCrash()
        {
            Name = "CRSH";
            CrashResultPhase = ResultPhase.PlanRunStart;
        }
 
        public override void Close()
        {
            base.Close();
            if (CrashResultPhase == ResultPhase.Close)
            {
                throw new Exception("Intended Close Crash");
            }
        }
 
        public override void Open()
        {
            base.Open();
            if (CrashResultPhase == ResultPhase.Open)
            {
                throw new Exception("Intended Open Crash");
            }
        }
 
        TestPlanRun planrun;
        public override void OnTestPlanRunStart(TestPlanRun planRun)
        {
            this.planrun = planRun;
            if (CrashResultPhase == ResultPhase.PlanRunStart)
            {
                if (AbortPlan)
                    TapThread.Current.Abort();
                else
                    throw new Exception("Intended");
            }
        }
 
        public override void OnTestPlanRunCompleted(TestPlanRun planRun, System.IO.Stream logStream)
        {
            FinalVerdict = planrun.Verdict;
            if (CrashResultPhase == ResultPhase.PlanRunCompleted)
            {
                if (AbortPlan)
                    TapThread.Current.Abort();
                else
                    throw new Exception("Intended");
            }
            planrun = null;
        }
 
        /// <summary>
        /// Called just before a test step is started.
        /// </summary>
        /// <param name="stepRun"></param>
        public override void OnTestStepRunStart(TestStepRun stepRun)
        {
            if (CrashResultPhase == ResultPhase.StepRunStart)
            {
                if (AbortPlan)
                    TapThread.Current.Abort();
                else
                    throw new Exception("Intended");
            }
        }
 
        public override void OnTestStepRunCompleted(TestStepRun stepRun)
        {
            if (CrashResultPhase == ResultPhase.StepRunCompleted)
            {
                if (AbortPlan)
                    TapThread.Current.Abort();
                else
                    throw new Exception("Intended");
            }
        }
 
        public override void OnResultPublished(Guid stepRunId, ResultTable result)
        {
            if (CrashResultPhase == ResultPhase.Result)
            {
                if (AbortPlan)
                    TapThread.Current.Abort();
                else
                    throw new Exception("Intended");
            }
        }
    }
 
    public class InterfaceTestDut : ValidatingObject, IDut
    {
        private bool isConnected = true;
        public bool IsConnected
        {
            get { return isConnected; }
            set
            {
                if (value == IsConnected) return;
                isConnected = value;
                OnPropertyChanged("IsConnected");
            }
        }
 
        string _shortName = "";
        public string Name
        {
            get
            {
                return _shortName;
            }
            set
            {
                if (_shortName != value)
                {
                    _shortName = value;
                    OnPropertyChanged("Name");
                }
            }
        }
 
        public event EventHandler<EventArgs> ActivityStateChanged;
 
        public void Close()
        {
 
        }
 
        public void Dispose()
        {
 
        }
 
        public void OnActivity()
        {
            if (ActivityStateChanged != null)
            {
                ActivityStateChanged.Invoke(this, new EventArgs());
            }
        }
 
        public void Open()
        {
 
        }
    }
 
    public class InterfaceTestResultListenser : ValidatingObject, IResultListener
    {
        private bool isConnected = true;
        public bool IsConnected
        {
            get { return isConnected; }
            set
            {
                if (value == isConnected) return;
                isConnected = value;
                OnPropertyChanged("IsConnected");
            }
        }
 
        string _shortName = "InterfaceTestResultListener";
        public string Name
        {
            get
            {
                return _shortName;
            }
            set
            {
                if (_shortName != value)
                {
                    _shortName = value;
                    OnPropertyChanged("Name");
                }
            }
        }
        
        public event EventHandler<EventArgs> ActivityStateChanged;
 
        public void OnResultPublished(Guid stepRun, ResultTable result)
        {
 
        }
 
        public void Close()
        {
 
        }
 
        public void Dispose()
        {
 
        }
 
        public void OnActivity()
        {
            if (ActivityStateChanged != null)
            {
                ActivityStateChanged.Invoke(this, new EventArgs());
            }
        }
 
        public void OnTestPlanRunCompleted(TestPlanRun planRun, Stream logStream)
        {
 
        }
 
        public void OnTestPlanRunStart(TestPlanRun planRun)
        {
 
        }
 
        public void OnTestStepRunCompleted(TestStepRun stepRun)
        {
 
        }
 
        public void OnTestStepRunStart(TestStepRun stepRun)
        {
 
        }
 
        public void Open()
        {
 
        }
    }
 
    [DisplayName("InterfaceTestInstrument")]
    public class InterfaceTestInstrument : IInstrument
    {
        private bool isConnected = false;
        public bool IsConnected
        {
            get { return isConnected; }
            set
            {
                if (value == isConnected) return;
                isConnected = value;
                OnPropertyChanged("IsConnected");
            }
        }
 
        private void OnPropertyChanged(string v)
        {
            if (PropertyChanged != null)
            {
                PropertyChanged.Invoke(this, new PropertyChangedEventArgs(v));
            }
        }
 
        string _shortName = "InterfaceTestInstrument";
        public string Name
        {
            get
            {
                return _shortName;
            }
            set
            {
                if (_shortName != value)
                {
                    _shortName = value;
                    OnPropertyChanged("Name");
                }
            }
        }
 
        public event EventHandler<EventArgs> ActivityStateChanged;
        public event PropertyChangedEventHandler PropertyChanged;
 
        public void Close()
        {
            IsConnected = false;
        }
 
        public void Dispose()
        {
 
        }
 
        public void OnActivity()
        {
            if (ActivityStateChanged != null)
            {
                ActivityStateChanged.Invoke(this, new EventArgs());
            }
        }
 
        public void Open()
        {
            IsConnected = true;
        }
    }
 
    public class QuickTestStep : TestStep
    {
        public InterfaceTestInstrument Instrument { get; set; }
 
        public override void Run()
        {
 
        }
    }
}