8000 Use URI of file to be opened in LS enable test (#11) by ghentschke · Pull Request #40 · eclipse-cdt/cdt-lsp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Use URI of file to be opened in LS enable test (#11) #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 5, 2023
Merged

Use URI of file to be opened in LS enable test (#11) #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 82 additions & 28 deletions ...est/src/org/eclipse/cdt/lsp/editor/ui/test/preference/LspEditorPreferencesTesterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import java.io.File;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.nio.file.Files;

import org.eclipse.cdt.lsp.LspPlugin;
import org.eclipse.cdt.lsp.editor.ui.test.TestUtils;
Expand All @@ -17,6 +16,7 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInfo;
import org.junit.jupiter.api.io.TempDir;


public class LspEditorPreferencesTesterTest {
Expand All @@ -25,16 +25,11 @@ public class LspEditorPreferencesTesterTest {
private static final String HEADER_HPP = "header.hpp";
private static final String MAIN_C = "main.c";
private static final String HEADER_H = "header.h";
//private static final String EXTERNAL_HEADER_HPP = "ExternalHeader.hpp";
private static final String EXTERNAL_HEADER_HPP = "ExternalHeader.hpp";
private IProject project;

// @TempDir -> does not work with org.junit.jupiter.api. Needs junit-jupiter-api and junit-jupiter-params.
// These packages are not accessible on the CI build server because we build with Eclipse 2022-06
// Path tempDir = Files.createTempFile("ExternalHeader", ".hpp", null);

private File createTempHppHeaderfile() throws IOException {
return Files.createTempFile("ExternalHeader", ".hpp").toFile();
}
@TempDir
private static File TEMP_DIR;

@BeforeEach
public void setUp(TestInfo testInfo) throws CoreException {
Expand Down Expand Up @@ -225,13 +220,13 @@ public void testEditorUsedToOpenCHeaderFile_WITH_LsEditorPreferred() throws Core
}

/**
* Tests whether LS enable returns false for an external file which is not opened.
* Tests whether LS enable returns false for an external file when no (LSP) editor is opened.
* @throws IOException
*/
@Test
public void testLsEnableByExternalUriTest_NoEditorOpen() throws CoreException, IOException {
public void testLsNotEnabledForExternalFile_NoEditorOpen() throws CoreException, IOException {
//GIVEN is an external file which does not exists in the given project and is not opened:
File externalFile = createTempHppHeaderfile();
File externalFile = new File(TEMP_DIR, EXTERNAL_HEADER_HPP);
//AND a ICLanguageServerProvider which uses LspEditorPreferencesTester as enabledWhen tester:
ICLanguageServerProvider cLanguageServerProvider = LspPlugin.getDefault().getCLanguageServerProvider();
//WHEN the LspEditorPreferencesTester gets called by the property tester in the enabledWhen element of the serverProvider extension point,
Expand All @@ -242,42 +237,101 @@ public void testLsEnableByExternalUriTest_NoEditorOpen() throws CoreException, I
}

/**
* Tests whether LS enable returns true for an external file which is opened in the C/C++ Editor (LSP).
* Tests whether LS enable returns false for an external file which is opened in the C/C++ Editor.
*/
@Test
public void testLsEnableByExternalUriTest_OpenedInLspCEditor() throws CoreException, IOException {
public void testLsNotEnabledForExternalFile_OpenedInCEditor() throws CoreException, IOException {
//GIVEN is an existing external file:
File externalFile = createTempHppHeaderfile();
File externalFile = new File(TEMP_DIR, EXTERNAL_HEADER_HPP);
externalFile.createNewFile();
//AND it's opened in the LSP based C/C++ Editor:
var editor = TestUtils.openInEditor(externalFile.toURI(), LspPlugin.LSP_C_EDITOR_ID);
//AND it's opened in the C/C++ Editor:
var editor = TestUtils.openInEditor(externalFile.toURI(), LspPlugin.C_EDITOR_ID);
//AND a ICLanguageServerProvider which uses LspEditorPreferencesTester as enabledWhen tester:
ICLanguageServerProvider cLanguageServerProvider = LspPlugin.getDefault().getCLanguageServerProvider();
//WHEN the LspEditorPreferencesTester gets called by the property tester in the enabledWhen element of the serverProvider extension point,
//THEN the LspEditorPreferencesTester.test returns TRUE for the given file URI:
assertTrue(cLanguageServerProvider.isEnabledFor(externalFile.toURI()));
TestUtils.closeEditor(editor, false);
//THEN the LspEditorPreferencesTester.test returns FALSE for the given file URI:
assertTrue(!cLanguageServerProvider.isEnabledFor(externalFile.toURI()));

//ensure clean up
TestUtils.closeEditor(editor, false);
externalFile.delete();
}

/**
* Tests whether LS enable returns false for an external file which is opened in the C/C++ Editor.
* Tests whether LS enable returns true for an external file which is opened in the C/C++ Editor (LSP).
*/
@Test
public void testLsEnableByExternalUriTest_OpenedInCEditor() throws CoreException, IOException {
public void testLsEnableForExternalFile_OpenedInLspCEditor() throws CoreException, IOException {
//GIVEN is an existing external file:
File externalFile = createTempHppHeaderfile();
File externalFile = new File(TEMP_DIR, EXTERNAL_HEADER_HPP);
externalFile.createNewFile();
//AND it's opened in the C/C++ Editor:
var editor = TestUtils.openInEditor(externalFile.toURI(), LspPlugin.C_EDITOR_ID);
//AND it's opened in the LSP based C/C++ Editor:
var editor = TestUtils.openInEditor(externalFile.toURI(), LspPlugin.LSP_C_EDITOR_ID);
//AND a ICLanguageServerProvider which uses LspEditorPreferencesTester as enabledWhen tester:
ICLanguageServerProvider cLanguageServerProvider = LspPlugin.getDefault().getCLanguageServerProvider();
//WHEN the LspEditorPreferencesTester gets called by the property tester in the enabledWhen element of the serverProvider extension point,
//THEN the LspEditorPreferencesTester.test returns FALSE for the given file URI:
assertTrue(!cLanguageServerProvider.isEnabledFor(externalFile.toURI()));
TestUtils.closeEditor(editor, false);
//THEN the LspEditorPreferencesTester.test returns TRUE for the given file URI:
assertTrue(cLanguageServerProvider.isEnabledFor(externalFile.toURI()));

//ensure clean up
TestUtils.closeEditor(edit 10000 or, false);
externalFile.delete();
}

/**
* Tests whether the LS is NOT enabled when switching from a tab with a project file with LS enabled
* to a project file without LS enabled.
* @throws UnsupportedEncodingException
*/
@Test
public void testLsNotEnabledByTabSwitchFromLspToNonLspProjectFile() throws CoreException, UnsupportedEncodingException {
//GIVEN is a project with ENABLED "Prefer C/C++ Editor (LSP)" in the preferences:
TestUtils.setLspPreferred(project, true);
//AND a file exists in the given project:
var lspProjectFile = TestUtils.createFile(project, MAIN_C, FILE_CONTENT);
//AND this file will be opened:
var lspEditorPart = TestUtils.openInEditor(lspProjectFile);
//AND a second project with DISABLED "Prefer C/C++ Editor (LSP)" in the preferences:
var nonLspProject = TestUtils.createCProject("NonLspProject");
TestUtils.setLspPreferred(nonLspProject, false);
//WHEN a file exits in the given second project with DISABLED "Prefer C/C++ Editor (LSP)":
var nonLspProjectFile = TestUtils.createFile(nonLspProject, MAIN_C, FILE_CONTENT);
//THEN the LS won't be enabled for the non LSP project file:
assertTrue(!LspPlugin.getDefault().getCLanguageServerProvider().isEnabledFor(nonLspProjectFile.getLocationURI()));
//AND those file has been be opened:
var nonLspEditorPart = TestUtils.openInEditor(nonLspProjectFile);
//THEN the file from the project with enabled "Prefer C/C++ Editor (LSP)" has been opened in the C/C++ Editor (LSP):
assertEquals(LspPlugin.LSP_C_EDITOR_ID, lspEditorPart.getEditorSite().getId());
//THEN the file from the project with disabled "Prefer C/C++ Editor (LSP)" has been opened in the C/C++ Editor:
assertEquals(LspPlugin.C_EDITOR_ID, nonLspEditorPart.getEditorSite().getId());

//clean-up:
TestUtils.closeEditor(lspEditorPart, false);
TestUtils.closeEditor(nonLspEditorPart, false);
TestUtils.deleteProject(nonLspProject);
}

/**
* Tests whether the LS is enabled for an external header file when a LSP based editor is in focus
* and an external header file shall be opened. (hyperlink test)
* @throws UnsupportedEncodingException, IOException
*/
@Test
public void testLsEnableByHyperlinkFromLspFileToExternalFile() throws CoreException, IOException {
//GIVEN is a project with ENABLED "Prefer C/C++ Editor (LSP)" in the preferences:
TestUtils.setLspPreferred(project, true);
//AND a file exists in the given project:
var lspProjectFile = TestUtils.createFile(project, MAIN_C, FILE_CONTENT);
//AND this file has been opened:
var lspEditorPart = TestUtils.openInEditor(lspProjectFile);
//WHEN an external header file shall be opened in the C/C++ Editor:
File externalFile = new File(TEMP_DIR, EXTERNAL_HEADER_HPP);
externalFile.createNewFile();
//THEN the LS will be enabled for the external file, because we assume that is opened via hyperlink from the opened main.c:
assertTrue(LspPlugin.getDefault().getCLanguageServerProvider().isEnabledFor(externalFile.toURI()));

//clean-up:
TestUtils.closeEditor(lspEditorPart, false);
externalFile.delete();
}

Expand Down
13 changes: 5 additions & 8 deletions ...sp.editor.ui/src/org/eclipse/cdt/lsp/editor/ui/preference/LspEditorPreferencesTester.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

import java.net.URI;

import org.eclipse.cdt.internal.ui.editor.CEditor;
import org.eclipse.cdt.lsp.LspPlugin;
import org.eclipse.cdt.lsp.editor.ui.LspEditorUiPlugin;
import org.eclipse.core.expressions.PropertyTester;
Expand All @@ -34,7 +33,6 @@
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.FileEditorInput;

@SuppressWarnings("restriction")
public class LspEditorPreferencesTester extends PropertyTester {
private static final String FILE_SCHEME = "file"; //$NON-NLS-1$

Expand All @@ -60,11 +58,8 @@ public boolean test(Object receiver, String property, Object[] args, Object expe
}
// When resource == null it's an external file: Check if the file is already opened, if not check the active editor:
return isFileOpenedInLspEditor(editorInput);
} else if (receiver instanceof CEditor) {
// TODO: remove this dirty hack when LSPE4 has solved the issue #393
return false;
}
return true; // we assume it's a C/C++ based editor. TODO: change to false when SPE4 has solved the issue #393 and last else-if has been removed
return false;
}

protected boolean preferLspEditor(IProject project) {
Expand Down Expand Up @@ -123,11 +118,13 @@ private boolean isFileOpenedInLspEditor(URI uri) {
}

if (uri.equals(editorUnputURI)) {
return LspPlugin.LSP_C_EDITOR_ID.equals(editor.getEditor(true).getEditorSite().getId());
// should return false when an external header file with same URI is opened in a LSP editor
// and non LSP editor and tab switching from a non LSP editor to the tab with the file in the non LSP editor:
return LspPlugin.LSP_C_EDITOR_ID.equals(editor.getEditor(true).getEditorSite().getId()) && isLspEditorActive();
}
}
}
// the file has not been opened yet:
// the file has not been opened yet -> goto definition/declaration case
return isLspEditorActive();
}

Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.cdt.lsp/plugin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@
<definition
id="org.eclipse.cdt.lsp.server.enable.editorHasLanguageServer">
<with
variable="activeEditor"> <!-- TODO: replace activeEditor with uri when LSPE fix for #393 has been done -->
variable="uri">
<test
forcePluginActivation="true"
property="org.eclipse.cdt.lsp.server.enable.hasLanguageServer"
Expand Down
0