Project Files Introduction

What is CAT project file?

CAT is a system that helps you to easily create, execute, maintain and automate tests. It has to know somehow what you are after, it needs some input from you. That’s where a CAT project file comes in.

CAT project file is a simple text file in YAML format.

🐱

CAT project files must have extension .cat.yaml.

Reading and executing files with other extensions is not supported.

In a CAT project file you can:

define your data sources
define your tests

or alternatively

instruct CAT from where to read data sources
instruct CAT from where to read tests

You can also:

define desired output formats (JSON, XLSX etc.)

CAT project files use YAML syntax. It is easy to learn, easy on eyes and you can very simply insert your SQL queries without worrying about escaping. If you struggle with YAML or need to check something specific, we recommend this introduction: https://www.cloudbees.com/blog/yaml-tutorial-everything-you-need-get-started