Skip to content
StepTest.md

StepTest

Test that validates step response behavior by connecting a step signal to a terminator.

This component creates a test setup for validating the Step block by connecting its output to a Terminator. The Step block generates a signal that starts at the offset value and jumps by the height value at the start_time. The test case verifies that the signal properly transitions from the initial offset value to the final value (offset + height).

Usage

StepTest()

Behavior

signal.y(t)=terminator.u(t)signal.y(t)=ifelse(tsignal.start_time,signal.height+signal.offset,signal.offset)

Source

dyad
# Test that validates step response behavior by connecting a step signal to a terminator.
#
# This component creates a test setup for validating the `Step` block by connecting its output
# to a `Terminator`. The `Step` block generates a signal that starts at the `offset` value and jumps
# by the `height` value at the `start_time`. The test case verifies that the signal properly
# transitions from the initial offset value to the final value (offset + height).
test component StepTest
  # Terminates a signal connection without passing it further
  terminator = Terminator()
  # Generates a step signal with configurable height, offset and start time
  signal = Step(height=1.4, offset=0.5, start_time=0.5)
relations
  # Connects the step signal output to the terminator input
  connect(signal.y, terminator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 1,
        "expect": {
          "initial": {"signal.y": 0.5},
          "signals": ["signal.y", "terminator.u"],
          "final": {"signal.y": 1.9, "terminator.u": 1.9}
        }
      }
    }
  }
}
end
Flattened Source
dyad
# Test that validates step response behavior by connecting a step signal to a terminator.
#
# This component creates a test setup for validating the `Step` block by connecting its output
# to a `Terminator`. The `Step` block generates a signal that starts at the `offset` value and jumps
# by the `height` value at the `start_time`. The test case verifies that the signal properly
# transitions from the initial offset value to the final value (offset + height).
test component StepTest
  # Terminates a signal connection without passing it further
  terminator = Terminator()
  # Generates a step signal with configurable height, offset and start time
  signal = Step(height=1.4, offset=0.5, start_time=0.5)
relations
  # Connects the step signal output to the terminator input
  connect(signal.y, terminator.u)
metadata {
  "Dyad": {
    "tests": {
      "case1": {
        "stop": 1,
        "expect": {
          "initial": {"signal.y": 0.5},
          "signals": ["signal.y", "terminator.u"],
          "final": {"signal.y": 1.9, "terminator.u": 1.9}
        }
      }
    }
  }
}
end


Test Cases

This is setup code, that must be run before each test case.

julia
using BlockComponents
using ModelingToolkit, OrdinaryDiffEqDefault
using Plots
using CSV, DataFrames

snapshotsdir = joinpath(dirname(dirname(pathof(BlockComponents))), "test", "snapshots")
"/home/actions-runner-10/.julia/packages/BlockComponents/77kIK/test/snapshots"

Test Case case1

julia
@mtkbuild model_case1 = StepTest()
u0_case1 = []
prob_case1 = ODEProblem(model_case1, u0_case1, (0, 1))
sol_case1 = solve(prob_case1)
retcode: Success
Interpolation: 1st order linear
t: 2-element Vector{Float64}:
 0.0
 1.0
u: 2-element Vector{Vector{Float64}}:
 []
 []
julia
df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.signal.y])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "StepTest_case1_sig0.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.signal.y], width=2, label="Actual value of signal.y")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of signal.y")
end
scatter!(plt, [df_case1.t[1]], [0.5], label="Initial Condition for `signal.y`")
scatter!(plt, [df_case1.t[end]], [1.9], label="Final Condition for `signal.y`")

plt

julia
df_case1 = DataFrame(:t => sol_case1[:t], :actual => sol_case1[model_case1.terminator.u])
dfr_case1 = try CSV.read(joinpath(snapshotsdir, "StepTest_case1_sig1.ref"), DataFrame); catch e; nothing; end
plt = plot(sol_case1, idxs=[model_case1.terminator.u], width=2, label="Actual value of terminator.u")
if !isnothing(dfr_case1)
  scatter!(plt, dfr_case1.t, dfr_case1.expected, mc=:red, ms=3, label="Expected value of terminator.u")
end
scatter!(plt, [df_case1.t[end]], [1.9], label="Final Condition for `terminator.u`")

plt