Forum Discussion

frankkDLL's avatar
Occasional Contributor
7 years ago

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.




16 Replies

  • sanj's avatar
    Super Contributor

    have you tried to see if these are fixed in the latest version?

    I have had some of these issues especially in regards to merge conflicts with earlier versions.


    • frankkDLL's avatar
      Occasional Contributor

      We are using 1.9.0 but we can upgrade to 2.0 and see if the issues persist. When you mention previous you know if you hit the issues in 1.8.0+?

      • sanj's avatar
        Super Contributor

        Thats what I had before


  • My team is using ReadyAPI 2.0.2 and SVN and are having very similar (and frustrating) problems. Definitely having issues with the environments as well, that seems to be pretty common about every time we sync.


    One of the most bizarre ones appears to be in the service XMLs. I just synced one of my service XML files and there was one difference between my local copy and the repository's copy in the <con:resource> node:


    Local copy

    <con:resource name="app" path="/sentinel/app" id="de861a43-df9b-4cc1-a4ad-0c95614c2ded" xmlns:xsi="" xmlns:con="">


    <con:resource name="app" path="/sentinel/app" id="de861a43-df9b-4cc1-a4ad-0c95614c2ded" xmlns:con="" xmlns:xsi="">

    The only difference is the order of the xlmns:xsi and xlmns:con properties. I have 6 files that have this difference and every time I sync they show as new commits. Why/how does the order of these change?

  • slollar's avatar
    Regular Visitor

    We are having this same issue. Did you ever resolve it?