update integration test docs

Author: davidsemakula

crates/lsp-server/tests/actions.rs

@@ -8,7 +8,7 @@ mod utils;
 // The high-level methodology for code/intent actions test cases is:
 // - Read the source code of an ink! entity file in the `test-fixtures` directory (e.g https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/contracts/erc20.rs).
 // - (Optionally) Make some modifications to the source code at a specific offset/text range to create a specific test case.
-// - Send the the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
+// - Send the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Send an LSP code action request from client to server for the test case.
 // - Retrieve the LSP code action response sent from the server to the client.
 // - Verify that the code action response results match the expected results.

crates/lsp-server/tests/create_project_command.rs renamed to crates/lsp-server/tests/commands.rs

@@ -1,7 +1,15 @@
-//! integration tests for ink! Language Server create project command.
+//! integration tests for ink! Language Server commands.
 
 mod utils;
 
+// Tests the create new project command.
+// The high-level methodology for the "creatProject" command test is:
+// - Send an LSP execute command request for "createProject" from client to server including a project name and uri.
+// - Retrieve the LSP execute command response sent from the server to the client
+//   (which should be an empty result that simply signifies that the server received the request).
+// - Retrieve the LSP workspace/applyEdit request sent from the server to the client which is triggered by the "createProject" command.
+// - Verify that the workspace edit creates the expected files and contents.
+// See inline comments for more details.
 #[test]
 fn create_project_command_works() {
     // Creates an in-memory connection to an initialized LSP server.

crates/lsp-server/tests/completions.rs

@@ -8,7 +8,7 @@ mod utils;
 // The high-level methodology for completions test cases is:
 // - Read the source code of an ink! entity file in the `test-fixtures` directory (e.g https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/contracts/erc20.rs).
 // - (Optionally) Make some modifications to the source code at a specific offset/text range to create a specific test case.
-// - Send the the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
+// - Send the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Send an LSP completion request from client to server for the test case.
 // - Retrieve the LSP completion response sent from the server to the client.
 // - Verify that the completion response results match the expected results.

crates/lsp-server/tests/diagnostics.rs

@@ -7,7 +7,7 @@ mod utils;
 // The high-level methodology for diagnostics test cases is:
 // - Read the source code of an ink! entity file in the `test-fixtures` directory (e.g https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/contracts/erc20.rs).
 // - (Optionally) Make modifications to the source code at specific offsets/text ranges to create a specific test case.
-// - Send the the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
+// - Send the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Retrieve the `PublishDiagnostics` notification that's sent from the server to the client when the server receives a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Verify that the diagnostics in the `PublishDiagnostics` notification match the expected results.
 // See inline comments for more details.

crates/lsp-server/tests/hover.rs

@@ -8,7 +8,7 @@ mod utils;
 // The high-level methodology for hover content test cases is:
 // - Read the source code of an ink! entity file in the `test-fixtures` directory (e.g https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/contracts/erc20.rs).
 // - (Optionally) Make some modifications to the source code at a specific offset/text range to create a specific test case.
-// - Send the the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
+// - Send the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Send an LSP hover request from client to server for the test case.
 // - Retrieve the LSP hover response sent from the server to the client.
 // - Verify that the hover response results match the expected results.

crates/lsp-server/tests/inlay_hints.rs

@@ -8,7 +8,7 @@ mod utils;
 // The high-level methodology for inlay hints test cases is:
 // - Read the source code of an ink! entity file in the `test-fixtures` directory (e.g https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/contracts/erc20.rs).
 // - (Optionally) Make some modifications to the source code at a specific offset/text range to create a specific test case.
-// - Send the the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
+// - Send the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Send an LSP inlay hints request from client to server for the test case.
 // - Retrieve the LSP inlay hints response sent from the server to the client.
 // - Verify that the inlay hints response results match the expected results.

crates/lsp-server/tests/signature_help.rs

@@ -8,7 +8,7 @@ mod utils;
 // The high-level methodology for signature help test cases is:
 // - Read the source code of an ink! entity file in the `test-fixtures` directory (e.g https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/contracts/erc20.rs).
 // - (Optionally) Make some modifications to the source code at a specific offset/text range to create a specific test case.
-// - Send the the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
+// - Send the modified source code from client to server via a `DidOpenTextDocument` or `DidChangeTextDocument` LSP notification.
 // - Send an LSP signature help request from client to server for the test case.
 // - Retrieve the LSP signature help response sent from the server to the client.
 // - Verify that the signature help response results match the expected results.