// 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;
|
|
namespace OpenTap.Plugins.BasicSteps
|
{
|
[Display("If Verdict", Group: "OpenTap", Description: "Runs its child steps only when the verdict of another step has a specific value.", Order:1)]
|
[AllowAnyChild]
|
public class IfStep : TestStep
|
{
|
public enum IfStepAction
|
{
|
[Display("Run Children")]
|
RunChildren,
|
[Display("Break Loop", "Break out of the current loop")]
|
BreakLoop,
|
[Display("Continue Loop", "Skip steps until the parent loop step regains control.")]
|
ContinueLoop,
|
[Display("Abort Test Plan")]
|
AbortTestPlan,
|
[Display("Wait For User")]
|
WaitForUser
|
}
|
|
#region Settings
|
[Display("If", Order: 1)]
|
public Input<Verdict> InputVerdict { get; set; }
|
[Display("Equals", Order: 2)]
|
public Verdict TargetVerdict { get; set; }
|
[Display("Then", Order: 3)]
|
public IfStepAction Action { get; set; }
|
#endregion
|
|
public IfStep()
|
{
|
InputVerdict = new Input<Verdict>();
|
Rules.Add(() => InputVerdict.Step != null, "Input property must be set.", nameof(InputVerdict));
|
Rules.Add(() => Action != IfStepAction.ContinueLoop || GetParent<LoopTestStep>() != null, "Continue Loop only works when this step is a child of a loop-type step, e.g Repeat or Sweep Steps.", nameof(Action));
|
Rules.Add(() => Action != IfStepAction.BreakLoop || GetParent<LoopTestStep>() != null, "Break Loop only works when this step is a child of a loop-type step, e.g Repeat or Sweep Steps.", nameof(Action));
|
}
|
|
|
class Request
|
{
|
public string Name => "Waiting for user input";
|
[Browsable(true)]
|
[Layout(LayoutMode.FullRow)]
|
public string Message { get; private set; } = "Continue?";
|
[Submit]
|
[Layout(LayoutMode.FloatBottom | LayoutMode.FullRow)]
|
|
public WaitForInputResult1 Response { get; set; } = WaitForInputResult1.Yes;
|
}
|
|
public override void Run()
|
{
|
// Get the targetStep
|
if (InputVerdict == null)
|
throw new ArgumentException("Could not locate target test step");
|
|
if (InputVerdict.Value == TargetVerdict)
|
{
|
switch (Action)
|
{
|
case IfStepAction.RunChildren:
|
Log.Info("Condition is true, running childSteps");
|
RunChildSteps();
|
break;
|
case IfStepAction.AbortTestPlan:
|
Log.Info("Condition is true, aborting TestPlan run.");
|
string msg = String.Format("TestPlan aborted by \"If\" Step ({2} of {0} was {1})", InputVerdict.Step.Name, InputVerdict.Value, InputVerdict.PropertyName);
|
PlanRun.MainThread.Abort();
|
break;
|
case IfStepAction.ContinueLoop:
|
StepRun.SuggestedNextStep = GetParent<LoopTestStep>()?.Id;
|
if (StepRun.SuggestedNextStep != null)
|
Log.Info("Condition is true, jumping to next loop iteration.");
|
else
|
Log.Error("Condition is true, but no loop parent step was found.");
|
break;
|
case IfStepAction.WaitForUser:
|
Log.Info("Condition is true, waiting for user input.");
|
var req = new Request();
|
UserInput.Request(req, false);
|
if (req.Response == WaitForInputResult1.No)
|
{
|
Log.Debug("User requested to end test plan execution. Aborting test plan run.");
|
PlanRun.MainThread.Abort();
|
}
|
break;
|
case IfStepAction.BreakLoop:
|
|
var loopStep = GetParent<LoopTestStep>();
|
if(loopStep != null)
|
{
|
Log.Info("Condition is true, breaking loop.");
|
loopStep.BreakLoop();
|
}else{
|
Log.Error("Condition is true, but no loop parent step was found.");
|
}
|
break;
|
default:
|
throw new NotImplementedException();
|
}
|
}
|
else
|
{
|
Log.Info("Condition is false.");
|
}
|
}
|
|
}
|
}
|
