HTTP

Provides helpers for making HTTP requests and polling endpoints.

Usage

include:
  - project: hosstio/gitlab-pipelines
    file: helpers/http.yaml

Variables

Variable	Default	Description
HTTP_STATUS_CHECK_CODE	200	Expected HTTP status code
HTTP_STATUS_CHECK_HOST		Host to poll
HTTP_STATUS_CHECK_PATH	/	Path to poll
HTTP_STATUS_CHECK_HEADERS	""	Extra request headers
HTTP_STATUS_CHECK_TIMEOUT	60s	Maximum time to wait
HTTP_STATUS_CHECK_INTERVAL	3	Seconds between polls

POST request (.http_post)

Sends an HTTP POST request.

Variables

Variable	Default	Description
HTTP_POST_HOST		Host to send the request to
HTTP_POST_PATH		Request path
HTTP_POST_HEADERS		Extra request headers
HTTP_POST_DATA		POST body data

Examples

webhook:
  extends: .http_post
  variables:
    HTTP_POST_HOST: https://example.com
    HTTP_POST_PATH: /hooks/deploy
    HTTP_POST_DATA: "ref=$CI_COMMIT_REF_NAME"

Status check (.http_status_check)

Polls a URL every HTTP_STATUS_CHECK_INTERVAL seconds until it returns HTTP_STATUS_CHECK_CODE or the timeout is reached.

Examples

smoke-test:
  extends: .http_status_check
  stage: live
  variables:
    HTTP_STATUS_CHECK_HOST: https://example.com
    HTTP_STATUS_CHECK_PATH: /healthz
    HTTP_STATUS_CHECK_TIMEOUT: 120s