fix LineHeaderCodeMining redraw logic on empty lines

[tobiasmelcher]

LineHeaderCodeMinings on empty lines were not drawn after calling ISourceViewerExtension5#updateCodeMinings.
Reason: InlinedAnnotationDrawingStrategy#draw triggered call StyledText#redrawRange with length = 0 which is ignored by SWT and no redraw event was triggered

CodeMiningPdeTest is documenting the problem scenario. It opens a plain text editor and the registered provider org.eclipse.jface.text.tests.codemining.CodeMiningTestProvider wants to contribute code minings.
The StaticContentLineCodeMining at line 1, column 1 with label 'mining' will be immediately rendered when the text editor is opened. It is used as indication in the unit test to verify that the text editor is opened and the code minings are all loaded and rendered properly.

Afterwards the global variable CodeMiningTestProvider.provideLineHeaderMining= true; is set which lets the provider also return a LineHeaderCodeMining at the second line. The second line has no text and is empty (there is only one \n character).
The unit test is then calling((ISourceViewerExtension5) viewer).updateCodeMinings(); with the goal to make the additional LineHeaderCodeMining visible.

This was not working before and this pull request will fix the scenario.

I hope you can follow the explanation and understand how this pull request wants to fix this scenario.
The redrawRange call in org.eclipse.jface.text.source.inlined.InlinedAnnotationDrawingStrategy did not trigger a repaint event when length has value 0. The pull request sets the length value to the line delimiter length (value 1 in in the unit test)

textWidget.redrawRange(offset, length, true);

One question to the PDE test. Is it ok to add an additional PDE test in org.eclipse.jface.text.tests? I needed to add a dependency to the plugins org.eclipse.core.resources and org.eclipse.ui.ide so that the text editor could be opened in the unit test. Is that ok?

[github-actions]

Test Results

 1 209 files   - 1   1 209 suites   - 1   1h 4m 8s ⏱️ + 9m 23s
 7 686 tests +2   7 455 ✅  -  1  231 💤 + 3  0 ❌ ±0 
16 143 runs  +1  15 630 ✅  - 43  513 💤 +44  0 ❌ ±0 

Results for commit c9a1c2d. ± Comparison against base commit 50061d4.

This pull request skips 3 tests.

UiTestSuite org.eclipse.ui.tests.api.ApiTestSuite org.eclipse.ui.tests.api.WorkbenchPluginTest ‑ testGetImageRegistryFromAdditionalDisplay
org.eclipse.jface.text.tests.contentassist.ContextInformationTest ‑ testContextInfo_hide_focusOut
org.eclipse.urischeme.internal.registration.TestUnitWinRegistry ‑ testWinRegistry

♻️ This comment has been updated with latest results.

[BeckerWdf]

One question to the PDE test. Is it ok to add an additional PDE test in org.eclipse.jface.text.tests? I needed to add a dependency to the plugins org.eclipse.core.resources and org.eclipse.ui.ide so that the text editor could be opened in the unit test. Is that ok?

Can somebody answer this question?

[BeckerWdf]

The jface.text (none-test)-bundle does not have any dependencies to org.eclipse.ide. Only to org.eclipse.swt, org.eclipse.jface and org.eclipse.core.runtime. And org.eclipse.swt also only has basic dependencies (to swt and equinox).
So I thnik that jface.text test-bundles should not get the org.eclipse.ide dependcies.
Maybe we should move the new test to org.eclipse.ui.editors.tests.

@merks, @mickaelistria What do you think?

[merks]

Yes, better to move/have the test somewhere that already has the necessary dependencies.

[tobiasmelcher]

Yes, better to move/have the test somewhere that already has the necessary dependencies.

Thanks a lot for the clarification. I moved the test to org.eclipse.ui.editors.tests.

[BeckerWdf]

build is failing with

No test report files were found. Configuration error?
Error when executing always post condition:
Also:   hudson.remoting.Channel$CallSiteStackTrace: Remote call to JNLP4-connect connection from 10.40.67.54/10.40.67.54:57290
		at hudson.remoting.Channel.attachCallSiteStackTrace(Channel.java:1787)
		at hudson.remoting.UserRequest$ExceptionResponse.retrieve(UserRequest.java:356)
		at hudson.remoting.Channel.call(Channel.java:1003)
		at hudson.FilePath.act(FilePath.java:1226)
		at hudson.FilePath.act(FilePath.java:1215)
		at hudson.tasks.junit.JUnitParser.parseResult(JUnitParser.java:125)
		at hudson.tasks.junit.JUnitResultArchiver.parse(JUnitResultArchiver.java:160)
		at hudson.tasks.junit.JUnitResultArchiver.parseAndSummarize(JUnitResultArchiver.java:254)
		at hudson.tasks.junit.pipeline.JUnitResultsStepExecution.run(JUnitResultsStepExecution.java:63)
		at hudson.tasks.junit.pipeline.JUnitResultsStepExecution.run(JUnitResultsStepExecution.java:29)
		at org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution.lambda$start$0(SynchronousNonBlockingStepExecution.java:47)
		at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:539)
		at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
		at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
		at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
		at java.base/java.lang.Thread.run(Thread.java:857)

I don't understand this. Is this an infrastructure issue?

[BeckerWdf]

One of the build errors is due to eclipse-pde/eclipse.pde#1310.

[BeckerWdf]

@tobiasmelcher: Looks like your changes broke org.eclipse.ui.editors.tests.SegmentedModeTest

[tobiasmelcher]

[1195450](/eclipse-platform/eclipse.platform.ui/pull/2133/commits/1195450a06cf1a8b26f563919ca9f0b960c072ac)

thanks a lot for pointing me to this test error. Should be now fixed with 1195450

[BeckerWdf]

@HeikoKlare: Is this good to go? I am still not able to understand why "pr-head" fails

[HeikoKlare]

The log shows:

Failed to execute goal org.eclipse.tycho.extras:tycho-p2-extras-plugin:4.0.8:compare-version-with-baselines (compare-attached-artifacts-with-release) on project org.eclipse.e4.ui.widgets: Baseline and reactor have the same fully qualified version, but different content

I guess this is because the PR branch is not rebased on current master and org.eclipse.e4.ui.widgets has changed and increased version by a recently merged PR on which this PR has not been rebased. So rebasing this PR branch on master should resolve that build failure.

[BeckerWdf]

I think this is good to be merged.