Skip to content

Commit e0cbc54

Browse files
FlorianKroissFlorianKroiss
committed
build: Support a wider range of Eclipse versions
1 parent e6399b1 commit e0cbc54

15 files changed

Lines changed: 156 additions & 84 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ jobs:
7171
- windows-latest
7272
# https://github.com/actions/partner-runner-images
7373
- ubuntu-24.04-arm
74+
target-platform:
75+
- oldest
76+
- latest
77+
include:
78+
- os: ubuntu-latest
79+
target-platform: staging
7480
runs-on: ${{ matrix.os }}
7581
timeout-minutes: 20
7682

@@ -160,10 +166,11 @@ jobs:
160166
~/.m2/repository/.cache/tycho
161167
~/.m2/repository/.meta/p2-artifacts.properties
162168
~/.m2/repository/p2
163-
key: ${{ runner.os }}-${{ runner.arch }}-repo-tycho-${{ hashFiles('target-platforms/target-platform-latest/target-platform-latest.target') }}
169+
key: ${{ runner.os }}-${{ runner.arch }}-repo-tycho-${{ hashFiles(format('target-platforms/{0}.target', matrix.target-platform)) }}
164170

165171

166172
- name: "Build with Maven 🔨"
173+
continue-on-error: ${{ matrix.target-platform == 'staging' }}
167174
uses: nick-fields/retry@v4
168175
with:
169176
max_attempts: 3
@@ -195,6 +202,7 @@ jobs:
195202
--errors \
196203
--update-snapshots \
197204
--batch-mode \
205+
-Dlsp4e.targetPlatform=${{ matrix.target-platform }} \
198206
--show-version \
199207
-Declipse.p2.mirrors=false \
200208
-Dsurefire.rerunFailingTestsCount=3 \
@@ -215,7 +223,7 @@ jobs:
215223

216224
- name: "Upload: Repository Zip"
217225
uses: actions/upload-artifact@v7
218-
if: runner.os == 'Linux'
226+
if: runner.os == 'Linux' && matrix.target-platform == 'oldest'
219227
with:
220228
name: org.eclipse.lsp4e.repository-${{matrix.target-platform}}-${{matrix.os}}
221229
path: repository/target/org.eclipse.lsp4e.repository-*.zip

‎.github/workflows/codeql.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ jobs:
122122
~/.m2/repository/.cache/tycho
123123
~/.m2/repository/.meta/p2-artifacts.properties
124124
~/.m2/repository/p2
125-
key: ${{ runner.os }}-${{ runner.arch }}-repo-tycho-${{ hashFiles('target-platforms/target-platform-latest/target-platform-latest.target') }}
125+
key: ${{ runner.os }}-${{ runner.arch }}-repo-tycho-${{ hashFiles('target-platforms/oldest.target') }}
126126

127127

128128
# https://docs.github.com/en/code-security/code-scanning

‎.github/workflows/licensecheck.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ jobs:
9191
~/.m2/repository/.cache/tycho
9292
~/.m2/repository/.meta/p2-artifacts.properties
9393
~/.m2/repository/p2
94-
key: ${{ runner.os }}-${{ runner.arch }}-repo-tycho-${{ hashFiles('target-platforms/target-platform-latest/target-platform-latest.target') }}
94+
key: ${{ runner.os }}-${{ runner.arch }}-repo-tycho-${{ hashFiles('target-platforms/oldest.target') }}
9595

9696

9797
- name: Dash License check # see https://github.com/eclipse/dash-licenses

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Latest snapshot builds, for testing, can usually be found at `https://download.e
5252
1. _File > Open Projects from Filesystem..._ , select the path to the LSP4E Git repo and the relevant children projects you want to import
5353
1. Depending on the task you're planning to work on, multiple workflows are available to configure the [target-platform](https://help.eclipse.org/latest/topic/org.eclipse.pde.doc.user/concepts/target.htm?cp=4_1_5)
5454
* In many cases, this simplest workflow will be sufficient: Install latest LSP4E snapshot in your target-platform (can be your current IDE), or
55-
* If you don't want to mix versions of LSP4E, open [target-platforms/target-platform-latest/target-platform-latest.target](target-platforms/target-platform-latest/target-platform-latest.target) from within Eclipse and click **Set as Active Target-Platform** in the top right corner.
55+
* If you don't want to mix versions of LSP4E, open [target-platforms/latest.target](target-platforms/latest.target) from within Eclipse and click **Set as Active Target-Platform** in the top right corner.
5656
1. Open the project modules you want to work on (right-click > Open project) and their dependencies
5757
1. Happy coding! 🤗
5858

‎org.eclipse.lsp4e.test/META-INF/MANIFEST.MF‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
22
Bundle-ManifestVersion: 2
33
Bundle-Name: Tests for language server bundle (Incubation)
44
Bundle-SymbolicName: org.eclipse.lsp4e.test;singleton:=true
5-
Bundle-Version: 0.16.9.qualifier
5+
Bundle-Version: 0.16.10.qualifier
66
Fragment-Host: org.eclipse.lsp4e
77
Bundle-Vendor: Eclipse LSP4E
88
Bundle-RequiredExecutionEnvironment: JavaSE-21
@@ -30,8 +30,8 @@ Require-Bundle: org.eclipse.core.runtime,
3030
org.eclipse.e4.ui.workbench,
3131
org.eclipse.tm4e.ui,
3232
org.eclipse.core.filesystem,
33-
junit-jupiter-api;bundle-version="[6.0.1,7.0.0)",
34-
junit-jupiter-params;bundle-version="[6.0.1,7.0.0)",
33+
junit-jupiter-api;bundle-version="[5.12.2,6.0.0)",
34+
junit-jupiter-params;bundle-version="[5.12.2,6.0.0)",
3535
org.hamcrest,
3636
org.opentest4j
3737
Automatic-Module-Name: org.eclipse.lsp4e.test

‎org.eclipse.lsp4e.test/pom.xml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</parent>
99
<artifactId>org.eclipse.lsp4e.test</artifactId>
1010
<packaging>eclipse-test-plugin</packaging>
11-
<version>0.16.9-SNAPSHOT</version>
11+
<version>0.16.10-SNAPSHOT</version>
1212

1313
<properties>
1414
<os-jvm-flags /> <!-- for the default case -->
@@ -38,12 +38,15 @@
3838
<version>${tycho-version}</version>
3939
<!-- https://tycho.eclipseprojects.io/doc/latest/tycho-surefire-plugin/test-mojo.html -->
4040
<configuration>
41+
<systemProperties>
42+
<!-- Set a system property, so we can disable some JUnit tests based on the current target platform -->
43+
<lsp4e.targetPlatform>${lsp4e.targetPlatform}</lsp4e.targetPlatform>
44+
</systemProperties>
4145
<trimStackTrace>false</trimStackTrace>
4246
<useUIHarness>true</useUIHarness>
4347
<useUIThread>true</useUIThread>
4448
<forkedProcessTimeoutInSeconds>1200</forkedProcessTimeoutInSeconds>
4549
<argLine>-Dfile.encoding=${project.build.sourceEncoding} -Xms1g -Xmx1g -Djava.util.logging.config.file=${project.basedir}/src/jul.properties ${ui.test.vmargs} ${os-jvm-flags}</argLine>
46-
<providerHint>junit6</providerHint>
4750
</configuration>
4851
</plugin>
4952
</plugins>

‎org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/codeactions/CodeActionTests.java‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,12 +188,9 @@ public void testCodeActionLiteralWorkspaceEdit() throws CoreException {
188188
@Test
189189
public void testNoCodeActionOnReadOnlySource() throws CoreException {
190190
IFile f = TestUtils.createUniqueTestFile(project, "error");
191-
f.setResourceAttributes(new ResourceAttributes() {
192-
@Override
193-
public boolean isReadOnly() {
194-
return true;
195-
}
196-
});
191+
ResourceAttributes attrs = f.getResourceAttributes();
192+
attrs.setReadOnly(true);
193+
f.setResourceAttributes(attrs);
197194

198195
final var tEdit = new TextEdit(new Range(new Position(0, 0), new Position(0, 5)), "fixed");
199196
final var wEdit = new WorkspaceEdit(Collections.singletonMap(f.getLocationURI().toString(), List.of(tEdit)));

‎org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/documentLink/DocumentLinkReconcilingTest.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import org.eclipse.swt.custom.StyleRange;
3838
import org.eclipse.swt.graphics.Color;
3939
import org.junit.jupiter.api.Test;
40+
import org.junit.jupiter.api.condition.DisabledIfSystemProperty;
4041

4142
public class DocumentLinkReconcilingTest extends AbstractTestWithProject {
4243

@@ -188,6 +189,9 @@ public void testMidLineClippedDocumentLinkReconciling() throws Exception {
188189
}
189190

190191
@Test
192+
@DisabledIfSystemProperty(named = "lsp4e.targetPlatform", matches = "oldest", disabledReason = """
193+
Fails on oldest target platform.
194+
Note: this will only work when called from Maven or when setting the propery explicitly.""")
191195
public void testClippedDocumentLinkReconciling() throws Exception {
192196
MockLanguageServer.INSTANCE.setDocumentLinks(CONTENT_LINKS);
193197

‎org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/utils/AbstractTestWithProject.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
import org.eclipse.core.resources.IProject;
1717
import org.eclipse.core.resources.IResource;
18+
import org.eclipse.core.resources.ResourceAttributes;
1819
import org.eclipse.core.runtime.CoreException;
1920
import org.junit.jupiter.api.AfterEach;
2021
import org.junit.jupiter.api.BeforeEach;
@@ -53,6 +54,17 @@ private static void deleteProjectWithRetries(IProject project, int maxAttempts,
5354
if (!project.exists()) {
5455
break;
5556
}
57+
project.open(null);
58+
project.accept(r -> {
59+
ResourceAttributes attrs = r.getResourceAttributes();
60+
// At least one test creates a read-only resource.
61+
// This leads to errors when trying to delete the project, so we make all files writable again.
62+
if (attrs != null && attrs.isReadOnly()) {
63+
attrs.setReadOnly(false);
64+
r.setResourceAttributes(attrs);
65+
}
66+
return true;
67+
});
5668
project.close(null);
5769
project.delete(IResource.FORCE | IResource.ALWAYS_DELETE_PROJECT_CONTENT, null);
5870
break;

‎org.eclipse.lsp4e/src/org/eclipse/lsp4e/outline/CNFOutlinePage.java‎

Lines changed: 28 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import static org.eclipse.lsp4e.internal.NullSafetyHelper.castNullable;
1717
import static org.eclipse.lsp4e.internal.NullSafetyHelper.lateNonNull;
1818

19+
import java.lang.reflect.InvocationTargetException;
1920
import java.util.ArrayList;
2021

2122
import org.eclipse.core.runtime.Adapters;
@@ -54,7 +55,6 @@
5455
import org.eclipse.swt.widgets.Control;
5556
import org.eclipse.ui.IActionBars;
5657
import org.eclipse.ui.navigator.CommonViewer;
57-
import org.eclipse.ui.navigator.CommonViewerComparator;
5858
import org.eclipse.ui.navigator.CommonViewerSorter;
5959
import org.eclipse.ui.texteditor.ITextEditor;
6060
import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
@@ -77,8 +77,8 @@ public class CNFOutlinePage implements IContentOutlinePage, ILabelProviderListen
7777

7878
private final LanguageServerWrapper wrapper;
7979

80-
@Nullable
81-
private static Boolean canUseCommonViewerComparator;
80+
private static @Nullable Class<?> comparatorClass = null;
81+
private static boolean checkedForComparatorClass = false;
8282

8383
public CNFOutlinePage(LanguageServerWrapper wrapper, @Nullable ITextEditor textEditor) {
8484
preferences = InstanceScope.INSTANCE.getNode(LanguageServerPlugin.PLUGIN_ID);
@@ -95,7 +95,7 @@ public void createControl(final Composite parent) {
9595
if (document != null) {
9696
outlineViewer.setInput(new OutlineViewerInput(document, wrapper, textEditor));
9797
}
98-
outlineViewer.setComparator(createComparator());
98+
configureSorterOrComparator(outlineViewer);
9999
outlineViewer.getLabelProvider().addListener(this);
100100
final var textEditor = this.textEditor;
101101
if (textEditor != null) {
@@ -130,60 +130,34 @@ public void createControl(final Composite parent) {
130130
}
131131

132132
/**
133-
* Try to be compatible with older Eclipse versions (before 4.39) where
134-
* CommonViewerComparator is not available.
135-
*
136-
* @return comparator for the outline
137-
*/
138-
private static ViewerComparator createComparator() {
139-
if (checkIfCommonViewerComparatorAvailable()) {
140-
return Eclipse439PlusComparator.create();
141-
}
142-
return EclipseBefore439Comparator.create();
143-
}
144-
145-
private static boolean checkIfCommonViewerComparatorAvailable() {
146-
if(canUseCommonViewerComparator != null) {
147-
return canUseCommonViewerComparator.booleanValue();
148-
}
149-
try {
150-
Class.forName("org.eclipse.ui.navigator.CommonViewerComparator"); //$NON-NLS-1$
151-
canUseCommonViewerComparator = Boolean.TRUE;
152-
return true;
153-
} catch (ClassNotFoundException e) {
154-
canUseCommonViewerComparator = Boolean.FALSE;
155-
return false;
156-
}
157-
}
158-
159-
/**
160-
* Compatible with modern Eclipse versions (4.39 and later) where
161-
* CommonViewerComparator is available.
162-
* <p>
163-
* This is extracted to an extra class to avoid classloading issues on older Eclipse versions where
164-
* the CommonViewerComparator class is not available. If we try to load a class referencing
165-
* CommonViewerComparator on an older Eclipse version, it will result in a ClassNotFoundException.
166-
*
167-
* @return comparator for the outline
133+
* Workaround for a Bug in Eclipse 4.39:
134+
* Before 4.39, the CommonViewerSorter can be used.
135+
* Starting with 4.39, using the CommonViewerSorter breaks sorting,
136+
* so the newer CommonViewerComparator must be used.
137+
* Once our oldest Target Platform contains CommonViewerComparator, we can drop this workaround.
138+
* @param viewer The viewer to configure
168139
*/
169-
private static final class Eclipse439PlusComparator {
170-
static ViewerComparator create() {
171-
return new CommonViewerComparator();
140+
private void configureSorterOrComparator(CommonViewer viewer) {
141+
if (!checkedForComparatorClass) {
142+
checkedForComparatorClass = true;
143+
try {
144+
comparatorClass = Class.forName("org.eclipse.ui.navigator.CommonViewerComparator"); //$NON-NLS-1$
145+
} catch (ClassNotFoundException e) {
146+
// Will trigger on < 4.39.
147+
}
172148
}
173-
}
174149

175-
/**
176-
* Compatible with older Eclipse versions (before 4.39) where
177-
* CommonViewerComparator is not available.
178-
* <p>
179-
* This is extracted to an extra class to avoid classloading issues
180-
*
181-
* @return comparator for the outline
182-
*/
183-
private static final class EclipseBefore439Comparator {
184-
static ViewerComparator create() {
185-
return new CommonViewerSorter();
150+
if (comparatorClass != null) {
151+
try {
152+
ViewerComparator comparator = (ViewerComparator) comparatorClass.getDeclaredConstructor().newInstance();
153+
viewer.setComparator(comparator);
154+
return;
155+
} catch (InstantiationException | IllegalAccessException | IllegalArgumentException
156+
| InvocationTargetException | NoSuchMethodException | SecurityException e) {
157+
// Fall-through
158+
}
186159
}
160+
viewer.setSorter(new CommonViewerSorter());
187161
}
188162

189163
/**

0 commit comments

Comments
 (0)