Test plan for checking Language servers

Overview

Name	Language Server Feature	Eclipse Che support
C#	autocomplete, hover, code validation, find definition	autocomplete, code validation
PHP	autocomplete, hover, code validation, find definition	autocomplete, code validation, find definition
Python	autocomplete, hover, code validation, find definition, format	autocomplete, code validation, find definition, format
JSON	code validation	code validation
Type script	autocomplete, hover, code validation, find definition	autocomplete, code validation, find definition
Clang	autocomplete, code validation, find definition, format	autocomplete, code validation, find definition, format
Yaml	autocomplete, hover, code validation
Camel	autocomplete, hover, diagnostic	autocomplete, hover
Golang	autocomplete, hover, code validation, find definition, format

C# language server

Create a workspace through Dashboard based on Default Dot Net stack. Enable C# language server by slider on dashboard if it needed.
Go to freshly created workspace and create *dotnet-web-simple project with wizard.
Open Program.cs. Make sure that language server has been initialized. Go to the dev-machine console and check message like: 2018-06-26 09:04:30,162[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 112] - Started language servers initialization, file path '/dotnet/Program.cs' 2018-06-26 09:04:31,240[rverInitializer] [WARN ] [c.l.CSharpLanguageServerConfig 83] - An executable 'dotnet' is not present at '/projects/dotnet' 2018-06-26 09:04:31,240[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 219] - Initialized language server 'org.eclipse.che.plugin.csharp.languageserver' 2018-06-26 09:04:31,241[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 128] - Finished language servers initialization, file path '/dotnet/Program.cs'
Make sure that code is validated by LS. We should have info markers in the 1-5 and 8,9 positions. Hover curso for instance on the first maker. Make sure that hint contains Unnecessary using directive.
Remove ; from the Build(); - the error marker should appear. Undo changes the error marker should disappear. *Remove Build till . symbol. Invoke autocomplete (Ctrl+Space). Make sure that Build is present in the widget. Hover cursor on Build. Make sure that docker window with Builds an Microsoft.AspNetCore.Hosting.IWebHost which hosts a web application. has been opened.
Paste Build and complete Build();
Hover cursor on Build. Make sure that hovering works without duplicated items. In the widget we should get next: IWebHost IWebHostBuilder.Build() Builds an Microsoft.AspNetCore.Hosting.IWebHost which hosts a web application.
Open Startup.cs file add new method in the body of Startup class:

public static String checkMessage(){
            return "Message has been checked";
        }

Add instance of the Startup.cs class into Program.cs in next way:

set cursor into the body of Main method of Program.cs and create invocation like:

Startup.checkMessage();

Set cursor on the checkMessage and invoke go to the definition by F4
Make sure that Startup.cs file is opened and cursor has been placed to checkMessagemethod.
Set cursor to Build(); and invoke the go to the definition again. Make sure that IWebHostBuilder has been opened and cursor was set to the Build position (Clarify this usecase because this feature may be unavailable)

PHP language server

Create a workspace through Dashboard based on Default PHP stack. Enable PHP language server by slider on dashboard if needed.
Go to freshly created workspace and create web-php-simple project with wizard
Open index-php file and make sure that language server has been initialized. Go to the dev-machine console and check message like: 2018-04-23 08:47:03,059[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 216] - Initialized language server 'org.eclipse.che.plugin.php.languageserver'
Add an error in the echo command and check that error marker is appeared. Click on error marker - the proposal tooltip should pop up. Restore content. Error marker should disappear.
Add variable like $color = "blue";. Make sure there are no errors. Go to the end of echo "Hello World!" type $ and launch autocompletion by Ctrl+Space. The color fragment should be offered.
Set cursor to the new line type e and launch autocompletion by Ctrl+Space. Check that proposal is present, see link below: PHP autocoplete proposal
Create a file in the current project with name lib.php. Add next content into the file:

<?php

function sayHello($name) {
    return "Hello, $name";
}
?>

Add into the index.php file next expression: echo sayHello("man");
Set cursor to sayHello and Assistant -> Find Definition. Make sure, that lip.php file is opened and function sayHellois selected.
Close the lib.php file and open index.php. Set cursor to sayHello and press F4, lip.php file should be opened and function sayHello should be selected.

Python language server

Create a workspace through Dashboard based on Default python stack. Enable language server by slider on dashboard if it needed.
Language server initialization:
Go to a freshly created workspace and create console-python3.5-simple. Open the main.pyfile and make sure that language server has been initialized. Go to the dev-machine console and check message like: 2018-04-24 13:24:49,159[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 216] - Initialized language server 'org.eclipse.che.plugin.python.languageserver
Code validation feature:
Add an error in the print command and check that error marker is appeared. Click on error marker - the proposal widget should be show invalid syntax message. Restore content. Error marker should disappear. type. Remove content from the file and paste code like:

class MyClass:
    var = 1
    variable = "bla"

    def function(self):
        print("This is a message inside the class.")

Add empty line. Make sure that warning marker with message: W293 blank line contains whitespace is present

Autocomplete feature:
Add empty line again and type code fragment like myobjectx = MyClass()
Press enter and type myobjectx. than ctrl+space. Make sure that function, var and variable fields are available from the class in the proposal menu.
Find definition feature:
Create new python file for instance with name myModule.py and add simple content like:

def add(a, b):
    return a + b

Close the just created file. Open myClass and add next expression:

var2 = myModule.add(100, 200)

Set cursor to add and invoke Assistant -> Find Definition. The myModule.py file should be opened and function add should be selected
Close the myModule.py file. And repeat previous step using F4 key instead of Assistant -> Find Definition invocation
Format code feature:
Create new python file for instance with name format.py and add simple content like:

def towers(i, start, finish, middle):
    if i > 0:
        towers(i-1, start, middle, finish)
        print('move disk from ', start, ' to ', finish)
        towers  ( i-1, middle, finish, start   )

towers  ( 5, 'X', 'Z', 'Y'      )

Select Format option from context menu;
Check that the file content is:

def towers(i, start, finish, middle):
    if i > 0:
        towers(i-1, start, middle, finish)
        print('move disk from ', start, ' to ', finish)
        towers(i-1, middle, finish, start)


towers(5, 'X', 'Z', 'Y')

JSON language server

Create a workspace through Dashboard based on Default Node Stack. Enable JSON language server by slider on dashboard if it need.
Go to the just created workspace and create nodejs-hello-world. Open package.jsonfile and make sure that language server has been initialized. Go to the dev-machine console and check message like: 2018-04-23 13:00:27,948[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 109] - Started language servers initialization, file path '/nodeJs/package.json'
Remove , symbol after last brace

{
  "name": "nodejs-sample",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },

Make sure that error marker appears. Click on the marker and check message like Expected '(end)' and instead saw ':'.in the proposal window.

Hover mouse on "author" text and wait for hover popup with "Expected comma or closing brace" text. Return the just deleted coma and wait disappearance the marker.
Go to the line 9 and add fragment like: "newObj":[1,2,3],. Make sure that JSON does not have any errors.
Add this object again and check error marker with Duplicate object key message.
Go to the line 6 and press ENTER. Add "newObj":[1,2,3], object and check there is not any errors.

Type script language server

Create a workspace through Dashboard based on Default Node Stack. Enable TypeScript language server by slider on dashboard if it need.
Go to the just created workspace and create nodejs-hello-world. Create for example greeter.ts file and add next content:

class Greeter {
    constructor(public greeting: string) { }
    greet() {
        return "<h1>" + this.greeting + "</h1>";
    }
};

var greeter = new Greeter("Hello, world!");
    
document.body.innerHTML = greeter.greet();

make sure that language server has been initialized. Go to the dev-machine console and check message like: [INFO ] [.a.l.LanguageServerInitializer 216] - Initialized language server 'org.eclipse.che.plugin.web.typescript. Add new file like: Greeter.ts wit next content:

class Greeter {
    greeting: string;
    constructor(message: string) {
        this.greeting = message;
    }
    greet() {
        return "Hello, " + this.greeting;
    }
}

let greeter = new Greeter("world");

Add space into keyword class like: c lass. Make sure that error markets have appear. Click on first marker and check the message like: cannot find lass
Remove the space - error makers should disappear. Add empty line after the code and type greeter.. Sent ctrl+space. Make sure that greet() function and greeting field are present in the proposal panel.
Create new file with name printTest.ts and add next content:

let name: string;
export class Print {

print (setVAlue: string): void 

{
    name = setVAlue;
    console.log('<<:'+ name);
}     
    
}

Close the just created file
Open greeter.ts and add to first line: import {Print} from './printTest'
Set cursor after greet() function. Add new function:

 testPrint(): void {
        const printVar = new Print();
        printVar.print("test print");
    }

Set cursor to printVar.print. And invoke Assistant -> Find Definition. Check opening the printTest.ts file. The print function should be selected.
Repeat previous step using F4 key instead of Assistant -> Find Definition invocation

Clang language server

Create a workspace through Dashboard based on Default C++ language server. Create the console-cpp-project from the wizard.
Open hello.cc file and make sure that language server has been initialized. Go to the dev-machine tab and check that message like2018-04-24 14:37:56,579[rverInitializer] [INFO ] [.a.l.LanguageServerInitializer 109] - Started language servers initialization, file path '/cpp/hello.cc' is present. Set cursor to the 7 line. Delete the line. Type std::. Make sure that error marker with expected unqualified-id message appears.
Type std::cou and launch code assistant by Ctrl+Space. Select cout Outstream from the proposal menu. Type << "Hello World!;" Make sure that there is no any errors.
Erase std::``. Make sure that error marker appears in line 7. Add using namespace std;`in the line 4. Make sure that there is no any errors.
Add new file for example: iseven.h and add content:

#ifndef VARIABLE
#define VARIABLE

int isEven(int arg);

#endif

Create the new cpp file: iseven.cpp and add next:

int isEven(int x) {
    return x % 2 == 0;
}

Close all opened files excepthello.cc. Set next content:

#include <iostream>
#include "iseven.h"

void test(int);

int main()
{
  int x = 4;
  std::cout << "Hello World!" << std::endl;
  std::cout << isEven(x) << std::endl;
  return 0;
}

Set cursor to isEven and invoke Assistant -> Find Definition. Check opening the iseven.h file. The int isEven(int arg); function should be selected.

Yaml language server

Language server initialization:

Create a workspace through Dashboard based on Node. Go to the workspace. Profile -> Preferences. Set the YAMPL schema: Select Yaml->Add Schema URl button -> type kubernetes.
Create the blank project from the wizard.
Create for example openshift.yaml project file. Make sure that language server has been initialized. Go to the dev-machine console and check message like: [INFO ] [.a.l.LanguageServerInitializer 109] - Started language servers initialization, file path '/yaml/openshift.yaml'

Autocomplete feature:

In the opened file launch autocomplete (Ctrl+Space). Make sure that kind value is present in the proposal widget, check document window with content: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds. Enter this value.
Launch autocomplete, select PersistentVolume. Make sure that there is no errors.
Go to the new line type api, launch autocomplete,make sure that apiVersion: has been passed. Launch autocomplete, v1 value should be added.
Go to the new line type me. Launch autocomplete and check metadata: should be added.
Go to the beginning string and launch autocomplete. The error marker should appear. Remove the tabs. The YAML should be valid again.

Hover feature:

Move mouse pointer on 'kind:' text, wait hover popup and check "Kind is a string value representing the REST resource this object represents." message in it.
Move mouse pointer on 'apiVersion:' text, wait hover popup and check "APIVersion defines the versioned schema of this representation of an object." message in it.

Comment code feature:

Select any line of code.
Comment this line by Ctrl+'/' buttons and check that the line is commented.
Launch comment feature again and check that the line uncommented.

Code validation feature:

Add 'k' symbol to 1,1 position and checkcheck that error marker is appeared.
Click on error marker and check 'Unexpected property kkind' message.
Restore content. Error marker should disappear.

Camel language server

Create a workspace through Dashboard based on Default Java stack. Enable Apache Camel language server by slider on dashboard if needed. Go to the just created workspace. Make sure that language server has been initialized. Go to the dev-machine console and check message like: Initialized Language Server org.eclipse.che.plugin.camel.server.languageserver on project file:/... Create for example empty project and add the file: camel.xml. Add content into the file like this:

<!-- here we have Spring XML file with all the namespaces here in the top of the XML file -->
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:camel="http://camel.apache.org/schema/spring"
       xmlns:cxf="http://camel.apache.org/schema/cxf"
       xsi:schemaLocation="
         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
         http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd
         http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd">
 
  <!-- this is Spring XML example of the Camel route in the ReportIncidentRoutes class -->
  <!-- this is for demonstration purpose, to show how you can use Camel with XML DSL -->
 
   <!-- here we define the CXF endpoint, where {{port}} refers to a placeholder so we can define the port number
           in an external .properties file -->
  <cxf:cxfEndpoint id="reportIncident"
                   address="http://localhost:{{port}}/camel-example-reportincident/webservices/incident"
                   wsdlURL="etc/report_incident.wsdl"
                   serviceClass="org.apache.camel.example.reportincident.ReportIncidentEndpoint"/>
 
   <!-- We use a bean to make the response bean that CXF expects -->
  <bean id="responseBean" class="org.apache.camel.example.reportincident.MyBean"/>
 
   <!-- this is the bean we use to generate the dynamic file name -->
  <bean id="filenameGenerator" class="org.apache.camel.example.reportincident.FilenameGenerator"/>
 
  <!-- this CamelContext contains the equivalent route from the Java DSL, but in XML
       so end users can see how to implement the route in both Java and XML -->
  <camelContext id="camel" xmlns="http://camel.apache.org/schema/spring">
 
    <!-- property which contains port number -->
    <!-- we have file:target/custom.properties which can be optional and override existing values, we use this for testing purpose -->
    <camel:propertyPlaceholder id="properties" location="classpath:incident.properties,file:target/custom.properties"/>
 
    <!-- this is the first route that uses CXF as web service -->
    <route>
      <from uri="cxf:bean:reportIncident"/>
      <convertBodyTo type="org.apache.camel.example.reportincident.InputReportIncident"/>
      <setHeader headerName="CamelFileName">
        <method bean="filenameGenerator" method="generateFilename"/>
      </setHeader>
      <to uri="velocity:etc/MailBody.vm"/>
      <to uri="file://target/subfolder"/>
      <transform>
        <method bean="responseBean" method="getOK"/>
      </transform>
    </route>
 
    <!-- this is the 2nd route that pickup files and send them as emails -->
    <route>
      <from uri="file://target/subfolder"/>
      <setHeader headerName="subject">
        <constant>new incident reported</constant>
      </setHeader>
      <to uri="smtp://someone@localhost?password=secret&amp;[email protected]"/>
    </route>
 
  </camelContext>
 
</beans>

Go to the <from uri="cxf:bean:reportIncident"/> section of the camel.xml file. Change <from uri="cxf:bean:reportIncident"/>to <from uri="tim"/> and invoke ctrl + Space. Select timer:timerName from the proposal menu. Check document docker window. Make sure that content like:The timer component is used for generating message exchanges when a timer fires. is present. Paste the selected content (timer:timerName) from codeassist.
Type ?. Invoke codeassistant again by ctrl + Space. Make sure that fixedRate=false fragment has been pasted properly.
Type &. Invoke codeassistant, select exchangePatterninto proposal menu. Invoke ctrl + Space again. Paste InOnly param.

Golang language server

Create a workspace through Dashboard based on Go stack with desktop-go-simple project. Enable Golang language server by slider on Dashboard if it need.
Language server initialization:

Open main.go file from desktop-go-simple project.
Go to the dev-machine console and check Finished language servers initialization, file path '/desktop-go-simple/main.go' message.

Autocomplete feature

Create a new line on line 10;
Add fmt.P code and launch autocompletion by Ctrl+Space;
Check that proposal Printfis present.

Code validation feature:

Add an error in code and check that error marker is appeared.
Click on error marker - the proposal widget should be show invalid syntax message.
Restore content. The error marker should disappear.
Add a new variable and check error marker with " declared and not used" message

Format feature:

Create print.go file and add next content:

package
 main

import (


	       "fmt"
)

                const COLOR_RED = "\x1b[31;1m "
            const COLOR_GREEN = "\x1b[32;1m "
        const COLOR_YELLOW = "\x1b[33;1m "
    const COLOR_BLACK = "\x1b[34;1m "

func        Print(color string, s string) {
	fmt.Printf("%s %s\n",                      color,s)
}

Select Format option from context menu;
Check that the file content is:

package main

import (
	"fmt"
)

const COLOR_RED = "\x1b[31;1m "
const COLOR_GREEN = "\x1b[32;1m "
const COLOR_YELLOW = "\x1b[33;1m "
const COLOR_BLACK = "\x1b[34;1m "

func Print(color string, s string) {
	fmt.Printf("%s %s\n", color, s)
}

Find Definition feature:

Create "towers.go" file and add next content to it:

package main

import (
	"fmt"
)

var count int

func hanoi(n int, a, b, c string) {
	if n == 1 {
		count++
		Print(COLOR_GREEN, fmt.Sprintf("Step %d: move disk from %s to %s\n", count, a, c))
		return
	}

	hanoi(n-1, a, c, b)
	count++
	Print(COLOR_YELLOW, fmt.Sprintf("Step %d: move disk from %s to %s\n", count, a, c))
	hanoi(n-1, b, a, c)
}

func main() {
	hanoi(3, "1", "2", "3")
}

Set cursor to Print and invoke Assistant -> Find Definition. The "print.go" file should be opened and function Print should be selected
Close the print.go file. And repeat previous step using F4 key instead of Assistant -> Find Definition invocation

Maven LS in progress ...
Add test cases with Formatting...
Hover features (clarify hover in php,)
Testcases with sidecars - clarify what do we need ?
Add next use cases to LS that can format selected text:
- there is no blank line in selected text
- there is a blank line in selected text
- there are several lines in selected text
- cursor position must be in the same place after formatting

The plan is not complete and should be supplemented

Project Management

Community

Contributing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly