Tests for Push application (Lyx,SublimeText,Texmaker,TeXstudio,Vim,WinEdt,TexShop)

[lachiri-ilias]

Me and my group (@Blezie, @JohannBiorck @vladdobre @Kr1st1an-F) are currently working on the Issue (#3191 TeXworks). We are currently writing tests for this issue.

We have noticed that all the push method (Lyx, SublimeText, Texmaker, TeXstudio, Vim, WinEdt, TexShop) doesn't contain test and they are very similar. So we wonder if we can contribute to create these tests ?

[Siedlerchr]

I see, but it's not straightforward to have tests as these interact with external programs on the system and require the editors to be installed on the system.

However, the only thing I would try is to check if the generated command is correctly generated, e.g. if the citation string is correctly generated with prefix + key + suffix

1. Test pushing entries to the real application and verify that the cite key is correctly inserted
2. Now you can try to write an automatic test, e.g. verifying the output of getCommandLine to check if it's correctly escaped with all quotes etc

And I just see that PushToLyx for example is missing the prefix and suffix

[koppor]

Adding tests is kind of "integration test". An X server needs to be started. We do that for

jabref/.github/workflows/tests.yml

Line 245 in 62ee331

run: xvfb-run --auto-servernum ./gradlew guiTest

.

The test needs to do following:

1. Install tool X
2. Open "example.tex" in tool X
3. Set JabRef to push to tool X
4. Instruct tool X to save the file
5. Check "example.tex" for differences.

"example.tex" can be an empty file at step 2.

Steps 2 and 4 can be very difficult from a command line. I expect 10 to 20 hours per tool to find out how to automate.

Thus, I agree with the comment at #10941 (comment) so that the generated string is correct.

[AdamWysokinski]

The test needs to do following:

1. Install tool X

2. Open "example.tex" in tool X

3. Set JabRef to push to tool X

4. Instruct tool X to save the file

5. Check "example.tex" for differences.

"example.tex" can be an empty file at step 2.

Steps 2 and 4 can be very difficult from a command line. I expect 10 to 20 hours per tool to find out how to automate.

Thus, I agree with the comment at #10941 (comment) so that the generated string is correct.

If this would be of any use, in SublimeText commands may be run from CLI:

subl -b --command open "example.tex"
subl -b --command save

The -b switch makes it to run in the background.

[koppor]

I close this issue as this is neither a user-facing issue nor something reported by the maintainers of JabRef.

Nevertheless, thank you for choosing JabRef.