mirror of https://github.com/tektoncd/catalog.git synced 2024-11-21 05:55:35 +00:00

History

Quan Zhang e294e1246b [TEP-0110] Update Tekton Catalog installation instructions Prior to this change, the installation instructions directly use the resource urls in the Catalog repo, which results in tight coupling between the organization and how users fetch resources (as described in TEP-0110). This commit updates the installation guide to install Tekton Catalog resources via Tekton Hub Api: https://github.com/tektoncd/hub/pull/539 This change decouples the Tekton Catalog organization from resouces resolution, which enables Tekton Catalog reorganization.		2022-08-16 16:25:52 +01:00
..
tests	Add Robot Framework Task	2021-10-26 11:12:37 +01:00
README.md	[TEP-0110] Update Tekton Catalog installation instructions	2022-08-16 16:25:52 +01:00
robot-framework.yaml	Add linux/amd64 platform annotation to the rest of the tasks	2021-10-29 17:08:38 +01:00

README.md

Robot Framework

This task runs Robot Framework tests that are provided in the source workspace. Additional configuration is possible with a variable file.

Install the Task

kubectl apply -f https://api.hub.tekton.dev/v1/resource/tekton/task/robot-framework/0.1/raw

Workspaces

source: A workspace containing Robot Framework tests. Results are written to /reports.
variables-file: An optional workspace to add a variable file. Useful if you have want to use a secret for credentials, url's, etc.

Parameters

IMAGE: Optional: Default uses a basic python image and installs test requirements during runtime. It's also possible to use your own image which has requirements pre-installed.
REQUIREMENTS_FILE: Optional: Requirements file to use for installing test requirements
ROBOT_OPTIONS: Optional: Arguments to use with the robot command
TEST_DIR: Directory that contains robot tests
VARIABLES_FILE: Optional: Name of the variable file provided in the workspace. A .py extension is necessary.

Platforms

The Task can be run on linux/amd64 platform.

Usage

Basic usage without installing extra requirements or using a variables file:

apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  name: example-run
spec:
  taskRef:
    name: robot-framework
  params:          
    - name: TEST_DIR
      value: ./rf-tests
  workspaces:
  - name: source
    persistentVolumeClaim:
      claimName: my-source

Using a secret that contains a variable file (called variables.py):

apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  name: example-run
spec:
  taskRef:
    name: robot-framework
  params:          
    - name: TEST_DIR
      value: ./rf-tests
    - name: VARIABLES_FILE
      value: variables.py
  workspaces:
  - name: source
    persistentVolumeClaim:
      claimName: my-source
  - name: variables-file
    secret:
      secretName: variables

Result files are written to /reports in the source workspace. If you want to store the files long-term make sure to upload them to S3 or something similar.