Test Inputs/Outputs

Table of Contents

1. Overview
2. Defining Inputs
   1. Defining Multiple Inputs
   2. Inputs with List Options
   3. Ordering Inputs
   4. Additional Input Instructions
3. Defining Outputs
4. Handling Complex Objects
5. Behind the Scenes

Overview

Inputs and outputs provide a structured way to pass information into and out of tests. When a user initiates a test run, a modal is displayed allowing them to provide input values. When multiple tests are being run together, the user is not prompted for inputs which can be populated by the output of a previous test in the run. Currently, all inputs and outputs are stored as strings.

Defining Inputs

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.
• description: - a description which is displayed in the UI.
• type: - controls the type of html input element used in the UI. Currently three possible values:
  • 'text' - (default) a regular input field.
  • 'textarea' - for a text area input field.
  • 'radio' - for a radio button singular selection field.
  • 'oauth_credentials' - a complex type for storing OAuth2 credentials. When used by a FHIR client, the access token will automatically refresh if possible.
• default: - default value for the input.
• optional: - (default: false) whether the input is optional.
• options: - possible input option formats based on input type.
  • list_options: - options for input formats that require a list of possible values. An array of hashes with label and value keys.
• locked: - (default: false) whether the user can alter the input’s value. Locking an input can force it to use a value from a previous test’s output, or the default value.

test do
  input :url,
        title: 'FHIR Server Url',
        description: 'The base url for the FHIR server'
        
  run do
    # The input's identifier is :url, so its value is available via `url`
    assert url.start_with?('https'), 'The server must support https'
  end
end

input in the API docs

Defining Multiple Inputs

It is possible to define multiple inputs in a single input call, but not with any of the additional properties listed above. This can be useful when a test uses inputs which have been more completely defined in a parent or sibling.

test do
  input :input1, :input2, :input3, :input4
  ...
end

Inputs with List Options

For the radio input type, a list of options must be provided. The label is displayed to the user, and the value is the actual value that is stored when the user selects that option.

test do
  input :radio_input_example,
        title: 'Example Radio Input',
        options: {
          list_options: [
            {
              label: 'Radio Option 1'
              value: 'option_1'
            },
            {
              label: 'Radio Option 2'
              value: 'option_2'
            }
          ]
        }

  run do
    if radio_input_example == 'option_1'
      # ...
    end

    # ...

    if radio_input_example == 'option_2'
      # ...
    end
  end
end

Ordering Inputs

When a group or suite displays all of its descendants’ inputs, they may be in an unintuitive order. They can be reordered using input_order.

group do
  input_order :input_2, :input_1
  
  test do
    input :input_1
  end
  
  test do
    input :input_2
  end
end

Additional Input Instructions

If a runnable needs extra input instructions, it can define input_instructions which will be displayed above the inputs.

group do
  input_instructions %(
    Register Inferno as a standalone application using the following information:

    * Redirect URI: `#{SMARTAppLaunch::AppRedirectTest.config.options[:redirect_uri]}`

    Enter in the appropriate scope to enable patient-level access to all
    relevant resources. If using SMART v2, v2-style scopes must be used. In
    addition, support for the OpenID Connect (openid fhirUser), refresh tokens
    (offline_access), and patient context (launch/patient) are required.
  )
end

Defining Outputs

The output method defines an output. It is used in a test’s definition block to define which outputs a test provides, and within a test’s run block to assign a value to an output. Multiple outputs can be defined/assigned at once.

test do
  output :value1
  output :value2, :value3
  
  run do
    output value1: 'ABC'
    output value2: 'DEF',
           value3: 'GHI'
  end
end

test do
  # These inputs will automatically get their values from the previous test's
  # outputs.
  input :value1, :value2, :value3
  ...
end

output for defining outputs in the API docs

output for assigning values to outputs in the API docs

Handling Complex Objects

Since inputs and outputs are all stored as strings, special handling is needed if you want to use them to pass complex objects between tests. This can generally be handled using JSON serialization. Ruby hashes and arrays, as well as FHIR model classes support the to_json method turn the object into a JSON string.

test do
  output :complex_object_json
  
  run do
    ...
    output complex_object_json: hash_or_array_or_fhir_resource.to_json
  end
end

test do
  input :complex_object_json
  
  run do
    assert_valid_json(complex_object_json) # For safety

    complex_object = JSON.parse(complex_object_json)
    ...
  end
end

Behind the Scenes

Inputs and outputs work as a single key-value store scoped to a test session. The main differences between them are that an input’s value can not be changed during a test, and inputs support additional metadata for display in the UI (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. However, each test result stores the input/output values that were present for that particular test.