Skip to content

Latest commit

 

History

History
39 lines (34 loc) · 2.49 KB

ValidationProcedure.md

File metadata and controls

39 lines (34 loc) · 2.49 KB
Raw

ValidationProcedure

Defines the procedure to evaluate whether a test is successful.

Properties

  • timeout_seconds (number)
  • clean_configs (array): List of operation defining the clean-up procedure. Default: [].
  • check_pods (array): List of checks on the pod status. Default: [].
  • check_logs (array): List of checks on the logs of pods. Default: [].

Definitions

  • CheckLogs (object): Descrive a test on the logs. Cannot contain additional properties.
    • name (string, required): Name of the Pod.
    • namespace (string, required): Namespace where the Pod is defined.
    • regex (string, required): Regular expression to be applied to the log.
    • operator (string): Operation to be applied on the output of the regular expression. Must be one of: ["Exists", "CountAtLeast", "CountAtMost", "CountExactly", "Is"]. Default: "Exists".
    • container: Name of the container. Mandatory for multi-container pods. Default: null.
      • Any of
        • string
        • null
    • value: Value to check the result of the regex agains. Optional for Exists operator. Default: null.
      • Any of
        • string
        • integer
        • null
  • CheckPod (object): Describe a test on the status of a pod or of its containers. Cannot contain additional properties.
    • name (string, required): Name of the Pod.
    • namespace (string, required): Namespace where the Pod is defined.
    • status (string): Status of the pod for the test to succeed. Must be one of: ["Pending", "Running", "Succeeded", "Failed", "Unknown"]. Default: "Succeeded".
  • CleanConfig (object): Define the procedure to clean up things once the test is over. Cannot contain additional properties.
    • type (string, required): Kubernetes object to delete as part of the clean-up. Must be one of: ["pod", "namespace", "service", "config_map", "secret"].
    • name (string, required): Name of the pod.
    • namespace (string, required): Namespace where to look for the pod.
    • condition (string): Condition upon which. Must be one of: ["always", "never", "onSuccess", "onFailure"]. Default: "always".