Horreum Client Plugin

This plugin uploads a structured payload to a Horreum server.

Using the plugin

Build the container:

docker build . -t arcaflow-plugin-horreum-client

Run with the provided sample input:

cat inputs/sample-input.yaml | docker run -i --rm arcaflow-plugin-horreum-client -f -

Autogenerated Input/Output Documentation by Arcaflow-Docsgen Below

Horreum Client (horreum-client)

Uploads an object to the Horreum server

Input

Type:	scope
Root object:	InputParams
Properties	data_object (map[string,any]) Name: data object for upload Description: Data object to be uploaded to the Horreum server. Required: Yes Type: map[string,any] Key type Type: string Value type Type: any horreum_keycloak_url (string) Name: Horreum Keycloak URL Description: The complete base URL for the Horreum Keycloak server, such as 'https://keycloak.example.com'. Required: Yes Type: string Must match pattern: (https?:\/\/)?[a-zA-Z0-9_-]{1,63}(\.[a-zA-Z0-9_-]{1,63})*(:[0-9]{1,5})?\/? horreum_password (string) Name: Horreum password Description: Password for the Horreum server. Required: Yes Type: string horreum_url (string) Name: Horreum URL Description: The complete base URL for the Horreum server, such as 'https://horreum.example.com'. Required: Yes Type: string Must match pattern: (https?:\/\/)?[a-zA-Z0-9_-]{1,63}(\.[a-zA-Z0-9_-]{1,63})*(:[0-9]{1,5})?\/? horreum_username (string) Name: Horreum username Description: Username for the Horreum server. Required: Yes Type: string test_access_rights (enum[string]) Name: test access rights Description: Access rights for the object being uploaded. Required: Yes Type: enum[string] Values PRIVATE: PRIVATE PROTECTED: PROTECTED PUBLIC: PUBLIC test_name (string) Name: test name Description: Name of the target test in Horreum for the object being uploaded. Required: Yes Type: string test_owner (string) Name: test owner Description: Owner of the object being uploaded. Required: Yes Type: string test_start_time (string) Name: test start time Description: Datetime formatted start time for the object being uploaded. Can also be provided as a JSONPath to a key in the document. Required: Yes Type: string test_stop_time (string) Name: test stop time Description: Datetime formatted stop time for the object being uploaded. Can also be provided as a JSONPath to a key in the document. Required: Yes Type: string tls_verify (bool) Name: TLS verify Description: For development and testing pruposes, this can be set to False to disable TLS verification for connections to Keycloak and Horreum services. Required: No Default (JSON encoded): true Type: bool
Objects InputParams (object) Type: object Properties data_object (map[string,any]) Name: data object for upload Description: Data object to be uploaded to the Horreum server. Required: Yes Type: map[string,any] Key type Type: string Value type Type: any horreum_keycloak_url (string) Name: Horreum Keycloak URL Description: The complete base URL for the Horreum Keycloak server, such as 'https://keycloak.example.com'. Required: Yes Type: string Must match pattern: (https?:\/\/)?[a-zA-Z0-9_-]{1,63}(\.[a-zA-Z0-9_-]{1,63})*(:[0-9]{1,5})?\/? horreum_password (string) Name: Horreum password Description: Password for the Horreum server. Required: Yes Type: string horreum_url (string) Name: Horreum URL Description: The complete base URL for the Horreum server, such as 'https://horreum.example.com'. Required: Yes Type: string Must match pattern: (https?:\/\/)?[a-zA-Z0-9_-]{1,63}(\.[a-zA-Z0-9_-]{1,63})*(:[0-9]{1,5})?\/? horreum_username (string) Name: Horreum username Description: Username for the Horreum server. Required: Yes Type: string test_access_rights (enum[string]) Name: test access rights Description: Access rights for the object being uploaded. Required: Yes Type: enum[string] Values PRIVATE: PRIVATE PROTECTED: PROTECTED PUBLIC: PUBLIC test_name (string) Name: test name Description: Name of the target test in Horreum for the object being uploaded. Required: Yes Type: string test_owner (string) Name: test owner Description: Owner of the object being uploaded. Required: Yes Type: string test_start_time (string) Name: test start time Description: Datetime formatted start time for the object being uploaded. Can also be provided as a JSONPath to a key in the document. Required: Yes Type: string test_stop_time (string) Name: test stop time Description: Datetime formatted stop time for the object being uploaded. Can also be provided as a JSONPath to a key in the document. Required: Yes Type: string tls_verify (bool) Name: TLS verify Description: For development and testing pruposes, this can be set to False to disable TLS verification for connections to Keycloak and Horreum services. Required: No Default (JSON encoded): true Type: bool

Outputs

error

Type:	scope
Root object:	ErrorOutput
Properties	error (string) Name: error Description: An error has occured. Required: Yes Type: string
Objects ErrorOutput (object) Type: object Properties error (string) Name: error Description: An error has occured. Required: Yes Type: string

success

Type:	scope
Root object:	SuccessOutput
Properties	horreum_run_id (int) Name: Horreum run id Description: Integer ID for run of test uploaded into Horreum. Required: Yes Type: int
Objects SuccessOutput (object) Type: object Properties horreum_run_id (int) Name: Horreum run id Description: Integer ID for run of test uploaded into Horreum. Required: Yes Type: int