use case: custom controller to simplify api testing

[AmitKumarDas]

ProblemStatement: As an automation engineer I want to verify my use case by testing its REST APIs. Most of the times, a feature consists of one or more invocations to REST APIs. Some of these APIs need to parse output from previous API invocations. All of these APIs need some kind of authentication to succeed.

[AmitKumarDas]

Design Draft 0

Brief Schema

kind: HTTPPipe
spec:
  steps:
  - call: # invoke http API
  - buildNext: # build http body to be used by next http invocation

Expanded Schema

kind: HTTPPipe
spec:
  # a series of http invocations interspersed with building json body
  # required to invoke the immediate http call
  steps:
  - name: # name to uniquely identify the step; defaults to step-index e.g. step-0
    call:
      url:
      method:
      pathParams:
      - key:
        value:
      queryParams:
      - key:
        value:
  - name: # name to uniquely identify the step; defaults to step-1
    buildNext: # builds the body for next http call
    - key: 
      value:
    - keyNested: # e.g. employee.name
      valueFrom: # extract value from some previous response
    - yaml: # body in yaml; merged with all key:value pairs found inside build
  - call:
  - buildNext:
  - call:
  - call:

NOTE: Each step's http call results in kind: HTTP resource

[AmitKumarDas]

Design Draft 1

Brief Schema

kind: HTTPPipe
spec:
  given: # holds key value pairs
  begin: # first http invocation
    request:
    onResponse: # optional
  then: # subsequent http requests
  - request:
    onResponse: # optional

Expanded Schema

kind: HTTPPipe
spec:
  given: # holds key value pairs
  - key:
    value:

  begin: # first http invocation
    name: # unique name given to this http request
    request:
      enabled:
        when: # always / once / never
      url:
      pathParams:
      queryParams:
      data:
      - key: # direct or nested field path
        value: 
      - key: # direct or nested field path
        valueFrom: # jsonpath that returns a value 
        default:
    recheck:
      onError:
      onMismatch:
      onMismatchExpressions:
      maxCount:

  then: # subsequent http request(s)
  - name: # unique name given to this http request
    request:
      enabled:
        when: # always / once / never
      url:
      pathParams:
      queryParams:
      data:
      - key: # direct or nested field path
        value: 
      - key: # direct or nested field path
        valueFrom: # jsonpath that returns a value
        default:  # if jsonpath returns no value
    onResponse:
      buildData:
      - name: 
        value: # jsonpath that returns a value
      - name: 
        value: # jsonpath that returns a value
        default: # if jsonpath returns no value
    recheck:
      onError:
      onMismatch:
      onMismatchExpressions:
      maxCount:

NOTE: Each http request results in kind: HTTP resource