Ask a Question

Ready! API and GIT SCM struggles

Occasional Contributor

Ready! API and GIT SCM struggles

Hi All,


Just wondering if some of you could offer some advice on using Ready! API with teams where multiple team members are working on shared projects. We are using GIT as our source control management tool via the GIT integration plugin but are hitting issues where team members are losing work and in general really struggling to get consistent stability with the integration between Ready! API and GIT.


A summary of how the team is working:


We use Ready!API (1.9) in a team of testers (varying levels of technical ability) who:
• Create and update test suites
• Use each other's test suites to run tests, clone test cases
• Make occasional updates to the shared environment settings

Git SCM is used to share the project among the team members; Ready!API offers Git integration using a Git plugin which is bundled with the tool.

The team experiences many issues with the Git integration, including:
• Changes to environment and other settings being overwritten
  o Ready!API uses one file settings.xml for the settings.
  o Ready!API changes this file settings.xml every time a project is opened (should have been fixed in version 2.0, not tested yet).
  o When multiple team members have changed any (environment) settings, this causes Git merge conflicts.
• Ready!API lacks support to automatically resolve these merge conflicts and lets the users resolve these themselves using external text editors.
• With the complexity of the settings.xml files, this is beyond what can be expected of Ready!API users.

• Considerable loss of work due to disappearing and overwritten test suites
  o When multiple team members re-order or rename test suites or test cases, these changes are not correctly brought over to other team members because of merge conflicts in files named elements.order.
• Ready!API lacks support to automatically resolve these merge conflicts and lets the users resolve these themselves using external text editors.
  o We have also found many cases of the actual test suites (i.e. the actual folders) getting lost when team members synchronize their work via Git, but haven't found the root cause to this yet.
• We see commits with the missing folders successfully pushed to the Git repository, but subsequent commits by other team members don't have those folders anymore.

• In general: Ready!API's Git conflict resolution handling is implemented
  o In case of merge conflicts, Ready!API offers three conflict resolution methods:
    • Mine: this causes issues, as other's work gets overwritten by our changes
    • Theirs: this causes issues, as our work gets overwritten by other's changes
    • Recursive: this requires merges using external merging tools in many cases, which is beyond what can be expected of Ready!API's (many) users due to the complex contents of files that Ready!API uses.

In order to mitigate thes issues, we have tried the following:
1. Using external Git integration tools rather than the Ready!API plugins
  o This still has the same issues as using Ready!API's Git integration plugin, but at least does not easily allow to overwrite each other's work.
  o We experience the following issue, however:
     • Ready!API caches project files. Hence, external changes to the project files do not correctly reflect in the project.
2. Using separate composite projects, having one team member work on a project at a time
  o Besides this undermines the benefits of using Git integration to share projects, this approach also is not ideal as team members want to be able to see other's work but not to change it. This can not be enforced in Ready!API.

Is there a way to provide a smart merge conflict resolution method in Ready!API, which removes the need for team members to either choose whether to overwrite their own or other's changes or merge using external merge tools in case of conflicts. Ready!API understands the complex file structure and should be able to merge automatically in the majority of cases. In case no automated merging is possible, the user should be presented a more convenient overview of which test suites, test cases settings, etcetera should be copied from the local to the remote repository and vice versa. The current mechanisms expect too much of the internal working of Ready!API to its users.


Would be interested to hear how other teams are overcoming these challenges.




Occasional Contributor

@TanyaYatskovska after 2 years the topic still doesn't have a solution, I wanted to get some update on this, as I am having the issues described here.


Anyway, I am going to submit a new case with my details.

Occasional Contributor

@TanyaGorbunova i still see no clear evidence as to a fix for this issue. Surely, instructing someone to ingore this issue and create a new issue is masking how long teams have been struggling with the integration between Ready API and SCMs?


We are still working around the issue via a manual process.

SmartBear Alumni (Retired)

Hi Guys,


There are several reasons why I asked to submit a new topic. Here are only some of them:

  • There are several issues discussed here. So, it's unclear which exact issue @ArthurM faced. 
  • Our Support Team doesn't monitor the discussions on a regular basis. It's a community - we believe that most of the questions can be resolved by talking with peers. If we see that the question is quite complex and require the investigation, we can invite a Support Team to the discussion.
  • It's always to better submit one issue per discussion. In this case, the conversation will go only around one topic and it will be extremely helpful.

@frankkDLL, have you contacted the Support Team regarding any issues posted here? I'm sure the Support team along with the R&D team always do their best to make sure that our customers are satisfied with ReadyAPI.

Tanya Yatskovskaya
SmartBear Community and Education Manager

Occasional Contributor

Hi @TanyaYatskovska - that's fair enough. I admit i was of the impression that the support team would keep an active eye on the community discussions.


We've ported from v2.5.0 to v2.6.0 this week, so I will evaluate if we still have the issues with the latest version of Ready API. I read that there were some improvements made to the GIT integration

If a new topic was created per Tanya's request, please provide a hyperlink to it. I'll try to search for it in the meantime.

Occasional Contributor

I didn't not create a new project, I've implemented a workaround to avoid conflicts on changed property values, and actually haven't used ReadyAPI activlely since, so, not sure if other types of conflicts are still actual.

Occasional Contributor

I tried to come up with some tips to mitigate conflicts, please see here:

Showing results for 
Search instead for 
Did you mean: