Git Integration

It is considered a good practice to store tests and test projects in source control. This way, you can easily work on your tests along with your teammates, share your test cases, revert changes, and so on.

ReadyAPI includes built-in support for Git repositories. This allows you to put your test project files to and get them from a Git repository directly from within the ReadyAPI UI, without using any third-party tool.

ReadyAPI supports Git repositories located in repository-hosting systems like GitHub, GitLab or Bitbucket, as well as Git repositories that reside on servers in your local network.

To work with most Git providers, you need an account. ReadyAPI provides an account manager for Git accounts: you can add your Git account in ReadyAPI and then use it in any of your projects.

To open the Git account manager, click Preferences and select the Git tab. This will open the Git preferences page where you can add and edit Git accounts:

Click the image to enlarge it.

Add account

To add an account, select Connect (or Add Account, if you already have an account of that type):

Click the image to enlarge it.

GitHub

GitHubGitHub

If you use GitHub, click the Connect or Add Account button next to GitHub.

You will be guided through the OAuth process of GitHub. You will have to enter your credentials, pass two-factor authentication if it is enabled for your account, and give the ReadyAPI OAuth app access to your account.

Click the image to enlarge it.

GitHub Enterprise

GitHub EnterpriseGitHub Enterprise

If you use GitHub Enterprise, click the Connect or Add Account button next to GitHub Enterprise. The dialog will appear:

Option	Description
Enterprise server address	The address of your GitHub Enterprise server.
Token	A generated token that will be used to connect your account with ReadyAPI. Tip: If you don't have a token, click Generate Token, and you will be guided through the token generation process in GitHub Enterprise.

Git

GitGit

If you use another Git provider or a local Git server, select Git.

In the dialog that ensues, select the protocol (HTTP or SSH) you use to connect to the repository and specify the connection settings:

• HTTP
• SSH

Option	Description
Username	Your username on the Git server.
Password	Your password on the Git server. Note: Some servers, for example GitHub or Azure DevOps Git, require a personal access token to authenticate. In this case, specify the token instead of the password in this field.

Option	Description
Profile name	The profile name that will be used in ReadyAPI.
SSH key path	A fully-qualified path to the SSH key on your computer.
Passphrase	The passphrase you used when generating the SSH key.

Note:

Git SSH integration does not accept OpenSSH private key format that starts with BEGIN OPENSSH PRIVATE KEY header. This issue can be solved by using ssh-keygen command with -m PEM flag

Bitbucket Cloud

Bitbucket CloudBitbucket Cloud

If you use Bitbucket Cloud, click the Connect or Add Account button next to Bitbucket Cloud.

You will be guided through the OAuth process of Bitbucket Cloud. You will have to enter your credentials, pass two-factor authentication if it is enabled for your account, and give the ReadyAPI OAuth app access to your account.

Click the image to enlarge it.

Bitbucket Data Center / Server

Bitbucket Data Center / ServerBitbucket Data Center / Server

If you use Bitbucket Data Center or Bitbucket Server, click the Connect or Add Account button next to Bitbucket Data Center / Server. The dialog will appear:

Option	Description
Enterprise server address	The address of your Bitbucket Data Center or Bitbucket Server.
Token	A generated token that will be used to connect your account with ReadyAPI. Tip: If you don't have a token, click Generate Token, and you will be guided through the token generation process in your Bitbucket Data Center or Bitbucket Server. The repository permissions for the account must be set to the admin level: Click the image to enlarge it.

GitLab

GitLabGitLab

If you use GitLab SaaS, click the Connect or Add Account button next to GitLab.

You will be guided through the OAuth process of GitLab. You will have to enter your credentials, pass two-factor authentication if it is enabled for your account, and give the ReadyAPI OAuth app access to your account.

Click the image to enlarge it.

GitLab Enterprise

GitLab EnterpriseGitLab Enterprise

If you use GitLab Self-Managed, click the Connect or Add Account button next to GitLab Enterprise. The dialog will appear:

Option	Description
Enterprise server address	The address of your GitLab Self-Managed server.
Token	A generated token that will be used to connect your account with ReadyAPI. Tip: If you don't have a token, click Generate Token, and you will be guided through the token generation process in your GitLab Self-Manged server. Make sure you set the following scopes for the generated access token: Click the image to enlarge it.

Edit account

If you already have a Git account added to ReadyAPI, but you want to edit it, click Edit Account:

Click the image to enlarge it.

To test if your account can connect to the server or repository, select Test Connection.

Note:

The connection test will always be successful for public Git repositories because you can always connect to them, even without credentials. However, you will not be able to perform some actions like push if you are not authorized.

To work with your project in Git, you should first connect it to a Git repository. To do that:

1. Double-click the project in the Navigator panel to open the project editor, and click the Configure Git button in the editor toolbar:

   Show image

   Show imageHide image

   

   Click the image to enlarge it.

   — or —

   Click on the main toolbar and select Connect to Remote Repository:

   Show image

   Show imageHide image

   

   Click the image to enlarge it.

2. To work with Git in ReadyAPI, you should convert your project into a composite project. These projects store test cases and other data as separate files instead of a single XML file. Click Continue to do that:

   

3. If your project was not saved, ReadyAPI shows the Save project dialog. Select the location where you want to save the project, enter the project name and click Save.

4. In the Choose Account dialog, select an account you will use to connect to a repository or add a new one if you haven't configured any Git accounts yet.

   Alternatively, if you just want to initialize a local Git repo that doesn't require credentials, select Create in the New Local Repo section. This will initialize a repo in the project folder.

   

   Click the image to enlarge it.

5. For GitHub, Bitbucket and GitLab accounts: select the repository you want to connect to. You can search for it in the list or input the URL and click Select.

   Tip:	To see details about a repo, click .

   

   Click the image to enlarge it.

   For Git accounts: enter the URL of the repository and click Select:

   

Now, your project is connected to the Git repository, and you can commit and push your changes.

Best practices

ReadyAPI provides an easy way to clone a ReadyAPI project stored in a remote Git repository and import it into ReadyAPI. To do that:

1. Select File > Clone Project from Git from the main menu:

   

2. In the Choose Account dialog, select an account you will use to connect to a repository or add a new one if you haven't configured any Git accounts yet.

   Alternatively, if you just want to import a local Git repo that doesn't require credentials, select Import in the Import a local repo section and select the repo folder.

   

   Click the image to enlarge it.

3. For GitHub, Bitbucket and GitLab accounts: select the repository you want to clone. You can search for it in the list or input the URL and click Select.

   Tip:	To see details about a repo, click .

   

   Click the image to enlarge it.

   For Git accounts: enter the URL of the repository and click Select:

   

Now, you can work with the cloned project and commit and push your changes to the remote repository.

ReadyAPI offers a number of commands to perform typical operations on the project files. You can perform them from the Git panel or from the main menu or context menu:

• Git panel
• Main menu
• Context menu

Click the image to enlarge it.

Click the image to enlarge it.

Click the image to enlarge it.

Once your project is in the repository, you use the Git panel or menu commands to work with it. For more information, see the following topics:

See Troubleshooting.