From 805148125ce9199e1c8e97e533b8ef7b9e06d35b Mon Sep 17 00:00:00 2001 From: Techatrix <19954306+Techatrix@users.noreply.github.com> Date: Sun, 31 Jul 2022 23:39:33 +0200 Subject: [PATCH] revive session tests --- build.zig | 1 + src/Server.zig | 7 +- tests/sessions.zig | 175 ++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 180 insertions(+), 3 deletions(-) diff --git a/build.zig b/build.zig index b0acefd..a08b16a 100644 --- a/build.zig +++ b/build.zig @@ -82,6 +82,7 @@ pub fn build(b: *std.build.Builder) !void { var session_tests = b.addTest("tests/sessions.zig"); session_tests.addPackage(.{ .name = "header", .source = .{ .path = "src/header.zig" } }); + session_tests.addPackage(.{ .name = "server", .source = .{ .path = "src/Server.zig" }, .dependencies = exe.packages.items }); session_tests.setBuildMode(.Debug); session_tests.setTarget(target); test_step.dependOn(&session_tests.step); diff --git a/src/Server.zig b/src/Server.zig index 0c41d8c..ade03a9 100644 --- a/src/Server.zig +++ b/src/Server.zig @@ -2482,8 +2482,11 @@ pub fn processJsonRpc(server: *Server, writer: anytype, arena: *std.heap.ArenaAl const start_time = std.time.milliTimestamp(); defer { - const end_time = std.time.milliTimestamp(); - logger.debug("Took {}ms to process method {s}", .{ end_time - start_time, method }); + // makes `zig build test` look nice + if (!zig_builtin.is_test and !std.mem.eql(u8, method, "shutdown")) { + const end_time = std.time.milliTimestamp(); + Logger.debug(server, writer, "Took {}ms to process method {s}", .{ end_time - start_time, method }); + } } const method_map = .{ diff --git a/tests/sessions.zig b/tests/sessions.zig index 3d61b3f..498865a 100644 --- a/tests/sessions.zig +++ b/tests/sessions.zig @@ -1 +1,174 @@ -// TODO Rewrite tests; the old session tests were extremely broken and unhelpful +const std = @import("std"); +const headerPkg = @import("header"); +const Server = @import("server"); + +const allocator = std.testing.allocator; + +const initialize_msg = + \\{"processId":6896,"clientInfo":{"name":"vscode","version":"1.46.1"},"rootPath":null,"rootUri":null,"capabilities":{"workspace":{"applyEdit":true,"workspaceEdit":{"documentChanges":true,"resourceOperations":["create","rename","delete"],"failureHandling":"textOnlyTransactional"},"didChangeConfiguration":{"dynamicRegistration":true},"didChangeWatchedFiles":{"dynamicRegistration":true},"symbol":{"dynamicRegistration":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]},"tagSupport":{"valueSet":[1]}},"executeCommand":{"dynamicRegistration":true},"configuration":true,"workspaceFolders":true},"textDocument":{"publishDiagnostics":{"relatedInformation":true,"versionSupport":false,"tagSupport":{"valueSet":[1,2]},"complexDiagnosticCodeSupport":true},"synchronization":{"dynamicRegistration":true,"willSave":true,"willSaveWaitUntil":true,"didSave":true},"completion":{"dynamicRegistration":true,"contextSupport":true,"completionItem":{"snippetSupport":true,"commitCharactersSupport":true,"documentationFormat":["markdown","plaintext"],"deprecatedSupport":true,"preselectSupport":true,"tagSupport":{"valueSet":[1]},"insertReplaceSupport":true},"completionItemKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]}},"hover":{"dynamicRegistration":true,"contentFormat":["markdown","plaintext"]},"signatureHelp":{"dynamicRegistration":true,"signatureInformation":{"documentationFormat":["markdown","plaintext"],"parameterInformation":{"labelOffsetSupport":true}},"contextSupport":true},"definition":{"dynamicRegistration":true,"linkSupport":true},"references":{"dynamicRegistration":true},"documentHighlight":{"dynamicRegistration":true},"documentSymbol":{"dynamicRegistration":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]},"hierarchicalDocumentSymbolSupport":true,"tagSupport":{"valueSet":[1]}},"codeAction":{"dynamicRegistration":true,"isPreferredSupport":true,"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["","quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]}}},"codeLens":{"dynamicRegistration":true},"formatting":{"dynamicRegistration":true},"rangeFormatting":{"dynamicRegistration":true},"onTypeFormatting":{"dynamicRegistration":true},"rename":{"dynamicRegistration":true,"prepareSupport":true},"documentLink":{"dynamicRegistration":true,"tooltipSupport":true},"typeDefinition":{"dynamicRegistration":true,"linkSupport":true},"implementation":{"dynamicRegistration":true,"linkSupport":true},"colorProvider":{"dynamicRegistration":true},"foldingRange":{"dynamicRegistration":true,"rangeLimit":5000,"lineFoldingOnly":true},"declaration":{"dynamicRegistration":true,"linkSupport":true},"selectionRange":{"dynamicRegistration":true},"semanticTokens":{"dynamicRegistration":true,"tokenTypes":["comment","keyword","number","regexp","operator","namespace","type","struct","class","interface","enum","typeParameter","function","member","macro","variable","parameter","property","label"],"tokenModifiers":["declaration","documentation","static","abstract","deprecated","readonly"]}},"window":{"workDoneProgress":true}},"trace":"off","workspaceFolders":[{"uri":"file://./tests", "name":"root"}]} +; + +const Context = struct { + server: Server, + request_id: u32 = 1, + + pub fn init() !Context { + var context = Context{ + .server = try Server.init( + allocator, + .{}, + null, + .debug, + ), + }; + + try context.request("initialize", initialize_msg, null); + try context.request("initialized", "{}", null); + return context; + } + + pub fn deinit(self: *Context) void { + self.request("shutdown", "{}", null) catch {}; + self.server.deinit(); + } + + fn request( + self: *Context, + method: []const u8, + params: []const u8, + expect: ?[]const u8, + ) !void { + var arena = std.heap.ArenaAllocator.init(allocator); + defer arena.deinit(); + + var output = std.ArrayList(u8).init(allocator); + defer output.deinit(); + + // create the request + self.request_id += 1; + const req = try std.fmt.allocPrint(allocator, + \\{{"jsonrpc":"2.0","id":{},"method":"{s}","params":{s}}} + , .{ self.request_id, method, params }); + defer allocator.free(req); + + // send the request to the server + try self.server.processJsonRpc(output.writer(), &arena, req); + + // if we don't expect a response ignore it + const expected = expect orelse return; + + // get the output from the server + var buffer_stream = std.io.fixedBufferStream(output.items); + const header = try headerPkg.readRequestHeader(allocator, buffer_stream.reader()); + defer header.deinit(allocator); + + var response_bytes = try allocator.alloc(u8, header.content_length); + defer allocator.free(response_bytes); + + const content_length = try buffer_stream.reader().readAll(response_bytes); + try std.testing.expectEqual(content_length, header.content_length); + + // parse the response + var parser = std.json.Parser.init(allocator, false); + defer parser.deinit(); + + var tree = try parser.parse(response_bytes); + defer tree.deinit(); + + const response = tree.root.Object; + + // assertions + try std.testing.expectEqualStrings("2.0", response.get("jsonrpc").?.String); + try std.testing.expectEqual(self.request_id, @intCast(u32, response.get("id").?.Integer)); + try std.testing.expect(!response.contains("error")); + + const result_json = try std.json.stringifyAlloc(allocator, response.get("result").?, .{}); + defer allocator.free(result_json); + + try std.testing.expectEqualStrings(expected, result_json); + } +}; + +test "Open file, ask for semantic tokens" { + var ctx = try Context.init(); + defer ctx.deinit(); + + try ctx.request("textDocument/didOpen", + \\{"textDocument":{"uri":"file:///test.zig","languageId":"zig","version":420,"text":"const std = @import(\"std\");"}} + , null); + + try ctx.request("textDocument/semanticTokens/full", + \\{"textDocument":{"uri":"file:///test.zig"}} + , + \\{"data":[0,0,5,7,0,0,6,3,2,32,0,4,1,11,0,0,2,7,12,0,0,8,5,9,0]} + ); +} + +test "Request completion in an empty file" { + var ctx = try Context.init(); + defer ctx.deinit(); + + try ctx.request("textDocument/didOpen", + \\{"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"uri":"file:///test.zig","languageId":"zig","version":420,"text":""}}} + , null); + try ctx.request("textDocument/completion", + \\{"textDocument":{"uri":"file:///test.zig"}, "position":{"line":0,"character":0}} + , null); +} + +test "Request completion with no trailing whitespace" { + var ctx = try Context.init(); + defer ctx.deinit(); + + try ctx.request("textDocument/didOpen", + \\{"textDocument":{"uri":"file:///test.zig","languageId":"zig","version":420,"text":"const std = @import(\"std\");\nc"}} + , null); + + try ctx.request("textDocument/completion", + \\{"textDocument":{"uri":"file:///test.zig"}, "position":{"line":1,"character":1}} + , + \\{"isIncomplete":false,"items":[{"label":"std","labelDetails":{"detail":"","description":"@import(\"std\")","sortText":null},"kind":21,"detail":"std","sortText":"1_std","filterText":null,"insertText":"std","insertTextFormat":1,"documentation":null}]} + ); +} + +test "Encoded space in file name and usingnamespace on non-existing symbol" { + var ctx = try Context.init(); + defer ctx.deinit(); + + try ctx.request("textDocument/didOpen", + \\{"textDocument":{"uri":"file:///%20test.zig","languageId":"zig","version":420,"text":"usingnamespace a.b;\nb."}} + , null); + try ctx.request("textDocument/completion", + \\{"textDocument":{"uri":"file:///%20test.zig"}, "position":{"line":1,"character":2}} + , + \\{"isIncomplete":false,"items":[]} + ); +} + +test "Self-referential definition" { + var ctx = try Context.init(); + defer ctx.deinit(); + + try ctx.request("textDocument/didOpen", + \\{"textDocument":{"uri":"file:///test.zig","languageId":"zig","version":420,"text":"const h = h(0);\nc"}} + , null); + try ctx.request("textDocument/completion", + \\{"textDocument":{"uri":"file:///test.zig"}, "position":{"line":1,"character":1}} + , + \\{"isIncomplete":false,"items":[{"label":"h","labelDetails":{"detail":"","description":"h(0)","sortText":null},"kind":21,"detail":"h","sortText":"1_h","filterText":null,"insertText":"h","insertTextFormat":1,"documentation":null}]} + ); +} + +test "Pointer and optional deref" { + var ctx = try Context.init(); + defer ctx.deinit(); + + try ctx.request("textDocument/didOpen", + \\{"textDocument":{"uri":"file:///test.zig","languageId":"zig","version":420,"text":"var value: ?struct { data: i32 = 5 } = null;const ptr = &value;\nconst a = ptr.*.?."}} + , null); + try ctx.request("textDocument/completion", + \\{"textDocument":{"uri":"file:///test.zig"}, "position":{"line":1,"character":18}} + , + \\{"isIncomplete":false,"items":[{"label":"data","labelDetails":{"detail":"","description":"i32 ","sortText":null},"kind":5,"detail":"data","sortText":"3_data","filterText":null,"insertText":"data","insertTextFormat":1,"documentation":null}]} + ); +}