Testing Farm API (0.1)

Download OpenAPI specification:Download

Miroslav Vadkerti: mvadkert@redhat.com License: Apache 2.0

Testing Farm API

Request a New Test

Request Body schema: application/json

Test request details

api_key required	string (api_key) An unique identifier used to authenticate a client.
required	object (test) Details about the test to run. Only one test type can be specified. If the user needs to run multiple tests, it should do it in separate requests.
	Array of objects (environment_requested) List of test environments to provision.
	object (notification) Request update notification settings.

Responses

Request samples

Payload

Content type

application/json

{"api_key": "692f43c8636b1f1e2ab04c9881b4ab4e68088c9e",
"test": {"fmf": {"url": "https://github.com/psss/fmf",
"ref": "0.10",
"path": "/examples/wget",
"name": "/download/test",
"settings": {"recognize-errors": true
}
},
"script": {"url": "https://src.osci.redhat.com/rpms/cpio",
"ref": "f31",
"scripts": ["tests/test.sh"
]
},
"sti": {"url": "https://src.osci.redhat.com/rpms/cpio",
"ref": "f31",
"playbooks": ["tests/tests*.yml"
],
"extra_variables": {"foo": "some-foo-value",
"boo": "some-boo-value"
}
}
},
"environments": [{"arch": "x86_64",
"os": {"compose": "Fedora"
},
"pool": "aws-pool-01",
"variables": {"FOO": "some-value",
"BOO": "other-value"
},
"artifacts": [{"id": 43054146,
"type": "fedora-koji-build",
"packages": ["openssh"
]
}
],
"settings": {"reboot": true
},
"tmt": {"context": {"distro": "fedora-33",
"arch": "x86_64",
"trigger": "code"
}
}
}
],
"notification": {"webhook": {"url": "string",
"token": "string"
}
}
}

Response samples

201
400
403
423
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "2020-12-18T20:46:00.392Z"
}

Test Request Details

path Parameters

request_id

required

string <uuid> (request_id)

Provide request_id you are interested in.

Responses

Response samples

200
404
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "2020-12-18T20:46:00.392Z",
"updated": "2020-12-18T20:46:00.392Z",
"environments": [{"arch": "x86_64",
"os": {"compose": "Fedora-32-20200414.0"
},
"pool": "aws",
"variables": {"FOO": "some-value",
"BOO": "other-value"
}
}
],
"state": "queued",
"notes": [{"level": "info",
"message": "string"
}
],
"result": {"summary": "Installation of the artifact failed. See https://artifacts.testing-farm.io/4b1b77bd-8861-40d1-bda1-849728b49aaa/stages/artifact-installation/log.txt for more information.",
"overall": "passed",
"xunit": "https://artifacts.testing-farm.io/4b1b77bd-8861-40d1-bda1-849728b49aaa/xunit.xml\n"
},
"run": {"console": "https://console.testing-farm.io/baa1ba84-f62c-40c3-b3b9-fa0ce3c478a4",
"stages": [{"name": "pre-artifact-installation",
"notes": [{"level": "info",
"message": "string"
}
],
"result": "passed",
"log": "https://artifacts.testing-farm.io/baa1ba84-f62c-40c3-b3b9-fa0ce3c478a4/stages/artifact-installation/"
}
],
"artifacts": "https://artifacts.testing-farm.io/baa1ba84-f62c-40c3-b3b9-fa0ce3c478a4/"
}
}

Supported Composes

Responses

Response samples

200
401
403
default

Content type

application/json

{"composes": [{"name": "Fedora-Rawhide"
}
]
}

About Testing Farm

Responses

Response samples

200
default

Content type

application/json

{"api_version": "string"
}