Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .tool-versions
Original file line number Diff line number Diff line change
@@ -1 +1 @@
ruby 3.3.6
ruby 3.3.6
1 change: 1 addition & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ PLATFORMS
arm64-darwin-22
arm64-darwin-23
arm64-darwin-24
arm64-darwin-25

DEPENDENCIES
github-pages (~> 228)
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ a RESTful API to enable third-party integration.

{% include figure.html
file="inferno-deployment.png"
alt="Diagram of Inferno Deployment
alt="Diagram of Inferno Deployment"
caption="A deployment combines Inferno Core and Test Kits into a running instance."
description="Default services in a deployment include nginx, redis, validator services, web and command line interfaces, and database interfaces."
maxwidth="100%"
Expand Down
74 changes: 65 additions & 9 deletions docs/writing-tests/test-inputs-outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,16 @@ The `input` method defines an input. `input` can take several arguments, but
only the identifier is required:
- `identifier` - (**required**) a name for this input. The input value is
available in the run block using this name.
- `title:` - a title which is displayed in the UI.
- `title:` - a title which is displayed in the UI.
- `description:` - a description which is displayed in the UI.
- `type:` - controls the type of HTML input element used in the UI. Currently
there are 5 possible values:
there are 7 possible values:
- `'text'` - (**default**) a regular input field.
- `'textarea'` - for a text area input field.
- `'radio'` - for a radio button singular selection field.
- `'checkbox` - for a checkbox field. In tests, a checkbox input is
- `'checkbox'` - for a checkbox field. In tests, a checkbox input is
represented as an array of the selected values.
- `'select'` - for a select input field.
- `'oauth_credentials'` - a complex type for storing OAuth2 credentials. When
used by a FHIR client, the access token will automatically refresh if
possible.
Expand All @@ -47,6 +48,7 @@ only the identifier is required:
Locking an input can force it to use a value from a previous test's output, or
the default value.
- `hidden:` - (**default: false**) hide the input from the UI. Must be used with either `optional: true` or `locked: true`.
- `enable_when` - (**optional**) adds conditional UI visibility for the input, causing it to be displayed only when the indicated input has the specified value. The value is a hash with keys `input_name` (the controlling input's identifier as a string, e.g. `'get_type'` for `input :get_type`) and `value` (a string matching that input's current value).

Here is a simple example:
```ruby
Expand Down Expand Up @@ -221,6 +223,60 @@ group do
end
```

### Conditional UI visibility for inputs

When a test needs related inputs but only some apply at a time, `enable_when` controls **conditional visibility in the inputs modal only**. It does not change how inputs are defined in the DSL or how values are read in `run` blocks. Use it when several inputs represent **alternative paths** for the same data—showing every field at once would clutter the modal or confuse users. A typical pattern is a single radio or select choice that reveals only the fields relevant to the selected method.

**Semantics:**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to Usage:


- `enable_when: { input_name: '<controlling_input>', value: '<string>' }` — `value` is a string matching the controlling input's stored value (for example, a `list_options` `value` on a radio or select input).
- `input_name` is the controlling input's identifier (the symbol name as a string, e.g. `'get_type'` for `input :get_type`).
- The controlling input should be a **radio** or **select** input (single-valued). **Checkbox** inputs are not supported as controllers.
- Dependent inputs can use any normal input type (`text`, `textarea`, etc.).
- Unlike `hidden:`, which always hides an input, `enable_when` is **dynamic** and updates as the user changes the controlling input.
- Required-field checks in the modal still apply to inputs that are hidden by `enable_when`.

A **select** input works the same way as radio for the controlling field.

The following example is adapted from the inferno-core demo suite. It models supplying a FHIR Bundle in one of three mutually exclusive ways: paste JSON, provide a URL, or run a `$summary` operation (FHIR server URL and patient ID).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update to:

The following example models supplying a FHIR Bundle in one of three mutually exclusive ways: paste JSON, provide a URL, or run a $summary operation (FHIR server URL and patient ID).


```ruby
group do
id 'conditional_group'
title 'Conditional Inputs Group'
optional

test 'Conditional, optional, empty input test' do
input :get_type, title: 'How to get Bundle', type: 'radio', options: {
list_options: [
{ value: 'copy_paste', label: 'Paste JSON' },
{ value: 'url', label: 'URL to FHIR Bundle' },
{ value: 'summary_op', label: '$summary Operation' }
]
}, default: 'copy_paste'
input :bundle_copy_paste, title: 'Paste JSON', type: 'textarea', optional: true,
enable_when: { input_name: 'get_type', value: 'copy_paste' }
input :bundle_url, title: 'URL to FHIR Bundle', type: 'text', optional: true,
enable_when: { input_name: 'get_type', value: 'url' }
input :fhir_server_url, title: 'FHIR Server URL', type: 'text', optional: true,
enable_when: { input_name: 'get_type', value: 'summary_op' }
input :patient_id, title: 'Patient ID', type: 'text', optional: true,
enable_when: { input_name: 'get_type', value: 'summary_op' }

run { pass }
end
end
```

In this example:

1. `:get_type` is the controlling radio input. `default: 'copy_paste'` means the paste field is visible when the modal first opens.
2. `:bundle_copy_paste` is shown only when `get_type` is `'copy_paste'`.
3. `:bundle_url` is shown only when `get_type` is `'url'`.
4. `:fhir_server_url` and `:patient_id` both use the same `enable_when` for `'summary_op'`—multiple dependent inputs can share one condition.
5. All dependent inputs are `optional: true` so hidden fields do not block submitting the modal.
6. The group is `optional` so the entire demo can be skipped, matching the inferno-core demonstration pattern.
Comment on lines +277 to +278
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove list entry 6 - not relevant


## Outputs

### Defining Outputs
Expand Down Expand Up @@ -311,7 +367,7 @@ input :backend_services_auth_info,
}
]
}

# Limit the auth types to those in SMART App Launch v1
input :smart_v1_auth_info,
options: {
Expand All @@ -325,7 +381,7 @@ input :smart_v1_auth_info,
}
]
}

input :smart_auth_info,
options: {
components: [
Expand Down Expand Up @@ -366,7 +422,7 @@ input :auth_info1,
options: {
mode: 'auth'
}

# Use this to make authorized requests
input :auth_info2,
options: {
Expand All @@ -380,9 +436,9 @@ input :auth_info2,
Inputs and outputs work as a single key-value store scoped to a test session.
The main differences between them are:
- An input's value can not be changed
during a test
during a test
- Inputs support additional metadata for display in the UI
(title, description, etc.)
(title, description, etc.)

Since inputs and outputs form a single key-value
store, a value will be overwritten if multiple tests write to the same output.
Expand All @@ -393,7 +449,7 @@ that particular test.

When inputs are defined at multiple levels (e.g., group and test), Inferno merges them. The following rules apply:

- `locked`, `hidden`, and `type` are **not inherited** when merging input definitions between parent and child.
- `locked`, `hidden`, `enable_when`, and `type` are **not inherited** when merging input definitions between parent and child.
- Other attributes such as `title`, `description`, `default`, and `optional` **are inherited**.

This allows different test scopes to override specific input behaviors without affecting others.
Expand Down