Programmable Test Procs

A guide to implementing Programmable Test Procedures to valiidate customer configuration.

Programmable Test Procedures enable you to run an arbitrary Services to validate the same input from the configuration screen and show a friendly error message to the end-user. You can use runtime configuration as input to your Service command and capture the result code and message and format it for display to the end-user.

Example

The following example will check the validity of the password entered by the end-user. The test_proc.custom_command property of the YAML will instruct Replicated to run a service defined in a special YAML file defined with kind test-proc-swarm. The test_proc.results property can be utilized to interpret output from the Service and format it for display to the end-user. Note the reference to the Service spec that has been added to the release yaml with kind test-proc-swarm.

---
# kind: replicated
config:
- name: credentials
  title: Credentials
  items:
  - name: password
    title: Password
    type: text
    test_proc:
      display_name: Check Password Strength
      run_on_save: true
      custom_command:
        id: scheduler
        timeout: 15
        data:
          swarm: # this section is scheduler specific
            service: password-checker
      results:
      - status: success
        message: Success!
        condition:
          status_code: 0
          error: false
      - status: error
        message:
          default_message: '{{.result}}'
          args:
            result: '{{repl .Result }}'
        condition:
          status_code: 123 # custom exit code from the container command
      - status: error # this is a catch-all case
        message:
          default_message: '{{if .error}}{{.error}}{{else}}{{.result}}{{end}}'
          args:
            error: '{{repl .Error }}'
            result: '{{repl .Result }}'
swarm:
  configs:
  - name: password_strength_check
    value: |
      #!/bin/sh
      if [ "${#1}" -lt 8 ]; then
        echo "Password must be at least 8 characters long"
        exit 123
      fi

---
# kind: test-proc-swarm
version: '3.3'
services:
  password-checker:
    image: debian:stretch
    deploy:
      restart_policy:
        condition: none
      command: ['/password-strength.sh', '{{repl ConfigOption "password"}}']
    configs:
    - source: password_strength_check
      target: /password-strength.sh
      mode: 0777
configs:
  password_strength_check:
    external: true

Resource Specification

Programmable Test Procedures are represented with the following properties.

TestProc

The test_proc resource is a sub-resource of a config group or item. When specified, a button will be present inline with the form. The custom validation will be run when clicking the button and optionally on save.

Name Type Required Description
display_name string yes The text to show in the button in the ui.
run_on_save string or boolean no When true this test will run on saving the configuration.
timeout int no Timeout in seconds, default 15 seconds, -1 denotes no timeout
custom_command Command yes The command that will be run
results array[Result] yes An array of result objects that when evaluated will determine success or failure