cerc-io/solidity
11
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

LSP: Implements goto-definition.

Browse Source
This commit is contained in:
Christian Parpart
2022-03-14 11:59:41 +01:00
parent 1035eacb53
commit 2b2f8acc12
16 changed files with 719 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/libsolidity/lsp/goto_definition.sol
+68
View File
@@ -0,0 +1,68 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.8.0;
import "./lib.sol";
interface I
{
function f(uint x) external returns (uint);
}
contract IA is I
{
function f(uint x) public pure override returns (uint) { return x + 1; }
}
contract IB is I
{
function f(uint x) public pure override returns (uint) { return x + 2; }
}
library IntLib
{
function add(int self, int b) public pure returns (int) { return self + b; }
}
contract C
{
I obj;
function virtual_inheritance() public payable
{
obj = new IA();
obj.f(1); // goto-definition should jump to definition of interface.
}
using IntLib for *;
function using_for(int i) pure public
{
i.add(5);
14.add(4);
}
function useLib(uint n) public payable returns (uint)
{
return Lib.add(n, 1);
}
function enums(Color c) public pure returns (Color d)
{
Color e = Color.Red;
if (c == e)
d = Color.Green;
else
d = c;
}
type Price is uint128;
function udlTest() public pure returns (uint128)
{
Price p = Price.wrap(128);
return Price.unwrap(p);
}
function structCtorTest(uint8 v) public pure returns (uint8 result)
{
RGBColor memory c = RGBColor(v, 2 * v, 3 * v);
result = c.red;
}
}
test/libsolidity/lsp/goto_definition_imports.sol
+19
View File
@@ -0,0 +1,19 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.8.0;
import {Weather as Wetter} from "./lib.sol";
import "./lib.sol" as That;
contract C
{
function test_symbol_alias() public pure returns (Wetter result)
{
result = Wetter.Sunny;
}
function test_library_alias() public pure returns (That.Color result)
{
That.Color color = That.Color.Red;
result = color;
}
}
test/libsolidity/lsp/lib.sol
+26
View File
@@ -1,6 +1,25 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.8.0;
/// Some Error type E.
error E(uint, uint);
enum Weather {
Sunny,
Cloudy,
Rainy
}
/// Some custom Color enum type holding 3 colors.
enum Color {
/// Red color.
Red,
/// Green color.
Green,
/// Blue color.
Blue
}
library Lib
{
function add(uint a, uint b) public pure returns (uint result)
@@ -13,3 +32,10 @@ library Lib
uint unused;
}
}
struct RGBColor
{
uint8 red;
uint8 green;
uint8 blue;
}
test/lsp.py
+279 -8
View File
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
# pragma pylint: disable=too-many-lines
import argparse
import fnmatch
import json
@@ -361,6 +361,52 @@ class SolidityLSPTestSuite: # {{{
},
"diagnostic: check range"
)
def expect_location(
self,
obj: dict,
uri: str,
lineNo: int,
startEndColumns: Tuple[int, int]
):
"""
obj is an JSON object containing two keys:
- 'uri': a string of the document URI
- 'range': the location range, two child objects 'start' and 'end',
each having a 'line' and 'character' integer value.
"""
[startColumn, endColumn] = startEndColumns
self.expect_equal(obj['uri'], uri)
self.expect_equal(obj['range']['start']['line'], lineNo)
self.expect_equal(obj['range']['start']['character'], startColumn)
self.expect_equal(obj['range']['end']['line'], lineNo)
self.expect_equal(obj['range']['end']['character'], endColumn)
def expect_goto_definition_location(
self,
solc: JsonRpcProcess,
document_uri: str,
document_position: Tuple[int, int],
expected_uri: str,
expected_lineNo: int,
expected_startEndColumns: Tuple[int, int],
description: str
):
response = solc.call_method(
'textDocument/definition',
{
'textDocument': {
'uri': document_uri,
},
'position': {
'line': document_position[0],
'character': document_position[1]
}
}
)
message = "Goto definition (" + description + ")"
self.expect_equal(len(response['result']), 1, message)
self.expect_location(response['result'][0], expected_uri, expected_lineNo, expected_startEndColumns)
# }}}
# {{{ actual tests
@@ -434,7 +480,7 @@ class SolidityLSPTestSuite: # {{{
report = published_diagnostics[1]
self.expect_equal(report['uri'], self.get_test_file_uri('lib'), "Correct file URI")
self.expect_equal(len(report['diagnostics']), 1, "one diagnostic")
self.expect_diagnostic(report['diagnostics'][0], code=2072, lineNo=12, startEndColumns=(8, 19))
self.expect_diagnostic(report['diagnostics'][0], code=2072, lineNo=31, startEndColumns=(8, 19))
def test_didChange_in_A_causing_error_in_B(self, solc: JsonRpcProcess) -> None:
# Reusing another test but now change some file that generates an error in the other.
@@ -451,8 +497,8 @@ class SolidityLSPTestSuite: # {{{
[
{
'range': {
'start': { 'line': 5, 'character': 0 },
'end': { 'line': 10, 'character': 0 }
'start': { 'line': 24, 'character': 0 },
'end': { 'line': 29, 'character': 0 }
},
'text': "" # deleting function `add`
}
@@ -497,7 +543,7 @@ class SolidityLSPTestSuite: # {{{
report = published_diagnostics[1]
self.expect_equal(report['uri'], self.get_test_file_uri('lib'), "Correct file URI")
self.expect_equal(len(report['diagnostics']), 1, "one diagnostic")
self.expect_diagnostic(report['diagnostics'][0], code=2072, lineNo=12, startEndColumns=(8, 19))
self.expect_diagnostic(report['diagnostics'][0], code=2072, lineNo=31, startEndColumns=(8, 19))
def test_textDocument_didChange_updates_diagnostics(self, solc: JsonRpcProcess) -> None:
self.setup_lsp(solc)
@@ -555,8 +601,8 @@ class SolidityLSPTestSuite: # {{{
{
'range':
{
'start': { 'line': 12, 'character': 1 },
'end': { 'line': 13, 'character': 1 }
'start': { 'line': 31, 'character': 1 },
'end': { 'line': 32, 'character': 1 }
},
'text': ""
}
@@ -673,7 +719,7 @@ class SolidityLSPTestSuite: # {{{
reports = self.wait_for_diagnostics(solc, 2)
self.expect_equal(len(reports), 2, '')
self.expect_equal(len(reports[0]['diagnostics']), 0, "should not contain diagnostics")
self.expect_diagnostic(reports[1]['diagnostics'][0], 2072, 12, (8, 19)) # unused variable in lib.sol
self.expect_diagnostic(reports[1]['diagnostics'][0], 2072, 31, (8, 19)) # unused variable in lib.sol
# Now close the file and expect the warning for lib.sol to be removed
solc.send_message(
@@ -744,6 +790,231 @@ class SolidityLSPTestSuite: # {{{
self.expect_equal(len(report3['diagnostics']), 1, "one diagnostic")
self.expect_diagnostic(report3['diagnostics'][0], 4126, 6, (1, 23))
def test_textDocument_definition(self, solc: JsonRpcProcess) -> None:
self.setup_lsp(solc)
FILE_NAME = 'goto_definition'
FILE_URI = self.get_test_file_uri(FILE_NAME)
LIB_URI = self.get_test_file_uri('lib')
solc.send_message('textDocument/didOpen', {
'textDocument': {
'uri': FILE_URI,
'languageId': 'Solidity',
'version': 1,
'text': self.get_test_file_contents(FILE_NAME)
}
})
published_diagnostics = self.wait_for_diagnostics(solc, 2)
self.expect_equal(len(published_diagnostics), 2, "publish diagnostics for 2 files")
self.expect_equal(len(published_diagnostics[0]['diagnostics']), 0)
self.expect_equal(len(published_diagnostics[1]['diagnostics']), 1)
self.expect_diagnostic(published_diagnostics[1]['diagnostics'][0], 2072, 31, (8, 19)) # unused variable in lib.sol
# import directive
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(3, 9), # symbol `"./lib.sol"` in `import "./lib.sol"`
expected_uri=LIB_URI,
expected_lineNo=0,
expected_startEndColumns=(0, 0),
description="import directive"
)
# type symbol to jump to type defs (error, contract, enum, ...)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(30, 19), # symbol `IA` in `new IA()`
expected_uri=FILE_URI,
expected_lineNo=10,
expected_startEndColumns=(9, 11),
description="type symbol to jump to definition"
)
# virtual function lookup?
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(31, 12), # symbol `f`, jumps to interface definition
expected_uri=FILE_URI,
expected_lineNo=7,
expected_startEndColumns=(13, 14),
description="virtual function lookup"
)
# using for
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(37, 10), # symbol `add` in `i.add(5)`
expected_uri=FILE_URI,
expected_lineNo=22,
expected_startEndColumns=(13, 16),
description="using for"
)
# library
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(43, 15), # symbol `Lib` in `Lib.add(n, 1)`
expected_uri=LIB_URI,
expected_lineNo=22,
expected_startEndColumns=(8, 11),
description="Library symbol from different file"
)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(43, 19), # symbol `add` in `Lib.add(n, 1)`
expected_uri=LIB_URI,
expected_lineNo=24,
expected_startEndColumns=(13, 16),
description="Library member symbol from different file"
)
# enum type symbol and enum values
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(46, 19), # symbol `Color` in function signature's parameter
expected_uri=LIB_URI,
expected_lineNo=13,
expected_startEndColumns=(5, 10),
description="Enum type"
)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(48, 24), # symbol `Red` in `Color.Red`
expected_uri=LIB_URI,
expected_lineNo=15,
expected_startEndColumns=(4, 7),
description="Enum value"
)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(48, 24), # symbol `Red` in `Color.Red`
expected_uri=LIB_URI,
expected_lineNo=15,
expected_startEndColumns=(4, 7),
description="Enum value"
)
# local variable declarations
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(49, 17), # symbol `e` in `(c == e)`
expected_uri=FILE_URI,
expected_lineNo=48,
expected_startEndColumns=(14, 15),
description="local variable declaration"
)
# User defined type
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(58, 8), # symbol `Price` in `Price p ...`
expected_uri=FILE_URI,
expected_lineNo=55,
expected_startEndColumns=(9, 14),
description="User defined type on left hand side"
)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(58, 18), # symbol `Price` in `Price.wrap()` expected_uri=FILE_URI,
expected_uri=FILE_URI,
expected_lineNo=55,
expected_startEndColumns=(9, 14),
description="User defined type on right hand side."
)
# struct constructor also properly jumps to the struct's declaration.
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(64, 33), # symbol `RGBColor` right hand side expression.
expected_uri=LIB_URI,
expected_lineNo=35,
expected_startEndColumns=(7, 15),
description="Struct constructor."
)
def test_textDocument_definition_imports(self, solc: JsonRpcProcess) -> None:
self.setup_lsp(solc)
FILE_NAME = 'goto_definition_imports'
FILE_URI = self.get_test_file_uri(FILE_NAME)
LIB_URI = self.get_test_file_uri('lib')
solc.send_message('textDocument/didOpen', {
'textDocument': {
'uri': FILE_URI,
'languageId': 'Solidity',
'version': 1,
'text': self.get_test_file_contents(FILE_NAME)
}
})
published_diagnostics = self.wait_for_diagnostics(solc, 2)
self.expect_equal(len(published_diagnostics), 2, "publish diagnostics for 2 files")
self.expect_equal(len(published_diagnostics[0]['diagnostics']), 0)
self.expect_equal(len(published_diagnostics[1]['diagnostics']), 1)
self.expect_diagnostic(published_diagnostics[1]['diagnostics'][0], 2072, 31, (8, 19)) # unused variable in lib.sol
# import directive: test symbol alias
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(3, 9), # in `Weather` of `import {Weather as Wetter} from "./lib.sol"`
expected_uri=LIB_URI,
expected_lineNo=6,
expected_startEndColumns=(5, 12),
description="goto definition of symbol in symbol alias import directive"
)
# import directive: test symbol alias
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(8, 55), # `Wetter` in return type declaration
expected_uri=LIB_URI,
expected_lineNo=6,
expected_startEndColumns=(5, 12),
description="goto definition of symbol in symbol alias import directive"
)
# That.Color tests with `That` being the aliased library to be imported.
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(13, 55), # `That` in return type declaration
expected_uri=LIB_URI,
expected_lineNo=13,
expected_startEndColumns=(5, 10),
description="goto definition of symbol in symbol alias import directive"
)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(15, 8),
expected_uri=LIB_URI,
expected_lineNo=13,
expected_startEndColumns=(5, 10),
description="`That` in LHS variable assignment"
)
self.expect_goto_definition_location(
solc=solc,
document_uri=FILE_URI,
document_position=(15, 27),
expected_uri=FILE_URI,
expected_lineNo=4,
expected_startEndColumns=(22, 26),
description="`That` in expression"
)
def test_textDocument_didChange_empty_file(self, solc: JsonRpcProcess) -> None:
"""
Starts with an empty file and changes it to look like