|
| 1 | +""" |
| 2 | +The goal of these tests is to check that ALS remembers a base configuration to which it |
| 3 | +can revert settings when receiving null values in didChangeConfiguration notifiactions. |
| 4 | +
|
| 5 | +It's important to check that the base configuration can be obtained both when there are |
| 6 | +config files (.als.json or User config file), and when there aren't - i.e. when settings |
| 7 | +are sent with the initialize request, or with the first didChangeConfiguration |
| 8 | +notification. |
| 9 | +
|
| 10 | +To observe the active configuration, we use a project file where the object directory is |
| 11 | +defined via an external scenario variable and we use the als-object-dir command to query |
| 12 | +that. |
| 13 | +
|
| 14 | +We also need a way to wait until the project has finished loading in order to query its |
| 15 | +object dir. To do that we add at least one source file and await the end of indexing. |
| 16 | +
|
| 17 | +The scenarios we want to test: |
| 18 | +
|
| 19 | +1. There is a config file. Then the initialize request also provides settings, but the |
| 20 | +base config should be the config file. |
| 21 | +
|
| 22 | +2. There are no config files, and the initialize request contains settings with non-null |
| 23 | +values that should be the base config. |
| 24 | +
|
| 25 | +3. There are no config files, and the initialize request contains settings with all null |
| 26 | +values. This is the case when no ada.* settings are set in VS Code. The config at |
| 27 | +initialize should be considered the base config. |
| 28 | +
|
| 29 | +4. There are no config files. The initialize request doesn't contain any settings. The |
| 30 | +first didChangeConfig notification should be considered as the base config. |
| 31 | +""" |
| 32 | + |
| 33 | +import os |
| 34 | +from lsprotocol.types import ClientCapabilities, InitializeParams |
| 35 | +from drivers.pylsp import ( |
| 36 | + URI, |
| 37 | + ALSClientServerConfig, |
| 38 | + ALSLanguageClient, |
| 39 | + ALSSettings, |
| 40 | + assertEqual, |
| 41 | + test, |
| 42 | +) |
| 43 | + |
| 44 | + |
| 45 | +@test( |
| 46 | + config=ALSClientServerConfig( |
| 47 | + server_command=[ |
| 48 | + os.environ.get("ALS", "ada_language_server"), |
| 49 | + "--config", |
| 50 | + "my_config.json", |
| 51 | + ], |
| 52 | + ), |
| 53 | + initialize=False, |
| 54 | +) |
| 55 | +async def test1(lsp: ALSLanguageClient) -> None: |
| 56 | + # Even if we send settings in the initialize request, the config file should |
| 57 | + # constitue the base config. |
| 58 | + settings: ALSSettings = { |
| 59 | + "scenarioVariables": {"Var": "value-from-init"}, |
| 60 | + } |
| 61 | + await lsp.initialize_session( |
| 62 | + InitializeParams( |
| 63 | + ClientCapabilities(), |
| 64 | + root_uri=URI(os.getcwd()), |
| 65 | + initialization_options={"ada": settings}, |
| 66 | + ) |
| 67 | + ) |
| 68 | + # Because no project file was set, we need a didOpen to load the project |
| 69 | + lsp.didOpenVirtual() |
| 70 | + await lsp.awaitIndexingEnd() |
| 71 | + assertEqual(await lsp.getObjDirBasename(), "value-from-init") |
| 72 | + |
| 73 | + # Now let's change the settings |
| 74 | + lsp.didChangeConfig({"scenarioVariables": {"Var": "new-value"}}) |
| 75 | + await lsp.awaitIndexingEnd() |
| 76 | + assertEqual(await lsp.getObjDirBasename(), "new-value") |
| 77 | + |
| 78 | + # Now we send a null value to revert to the base config which should be the config |
| 79 | + # file, not the initialize request. |
| 80 | + lsp.didChangeConfig({"scenarioVariables": None}) |
| 81 | + await lsp.awaitIndexingEnd() |
| 82 | + assertEqual(await lsp.getObjDirBasename(), "value-from-config-file") |
| 83 | + |
| 84 | + |
| 85 | +@test(initialize=False) |
| 86 | +async def test2(lsp: ALSLanguageClient) -> None: |
| 87 | + # In this scenario there are no config files. The settings in the initialize request |
| 88 | + # should constitute the base config. |
| 89 | + settings: ALSSettings = { |
| 90 | + "scenarioVariables": {"Var": "value-from-init"}, |
| 91 | + } |
| 92 | + await lsp.initialize_session( |
| 93 | + InitializeParams( |
| 94 | + ClientCapabilities(), |
| 95 | + root_uri=URI(os.getcwd()), |
| 96 | + initialization_options={"ada": settings}, |
| 97 | + ) |
| 98 | + ) |
| 99 | + # Because no project file was set, we need a didOpen to load the project |
| 100 | + lsp.didOpenVirtual() |
| 101 | + await lsp.awaitIndexingEnd() |
| 102 | + assertEqual(await lsp.getObjDirBasename(), "value-from-init") |
| 103 | + |
| 104 | + # Now let's change the settings and revert back to see if we revert to the right |
| 105 | + # value. |
| 106 | + lsp.didChangeConfig({"scenarioVariables": {"Var": "new-value"}}) |
| 107 | + await lsp.awaitIndexingEnd() |
| 108 | + assertEqual(await lsp.getObjDirBasename(), "new-value") |
| 109 | + |
| 110 | + lsp.didChangeConfig({"scenarioVariables": None}) |
| 111 | + await lsp.awaitIndexingEnd() |
| 112 | + assertEqual(await lsp.getObjDirBasename(), "value-from-init") |
| 113 | + |
| 114 | + |
| 115 | +@test(initialize=False) |
| 116 | +async def test3(lsp: ALSLanguageClient) -> None: |
| 117 | + # This scenario reproduces what happens in VS Code when there are no ada.* settings |
| 118 | + # |
| 119 | + # The settings in the initialize request are null |
| 120 | + settings: ALSSettings = { |
| 121 | + "scenarioVariables": None, |
| 122 | + } |
| 123 | + await lsp.initialize_session( |
| 124 | + InitializeParams( |
| 125 | + ClientCapabilities(), |
| 126 | + root_uri=URI(os.getcwd()), |
| 127 | + initialization_options={"ada": settings}, |
| 128 | + ) |
| 129 | + ) |
| 130 | + # Because no project file was set, we need a didOpen to load the project |
| 131 | + lsp.didOpenVirtual() |
| 132 | + await lsp.awaitIndexingEnd() |
| 133 | + # No value was provided for the scenario variable, so we should get the default |
| 134 | + # value defined in the project. |
| 135 | + assertEqual(await lsp.getObjDirBasename(), "value-from-prj") |
| 136 | + |
| 137 | + # Now let's change the settings and revert back to see if we revert to the right |
| 138 | + # value. |
| 139 | + lsp.didChangeConfig({"scenarioVariables": {"Var": "new-value"}}) |
| 140 | + await lsp.awaitIndexingEnd() |
| 141 | + assertEqual(await lsp.getObjDirBasename(), "new-value") |
| 142 | + |
| 143 | + lsp.didChangeConfig({"scenarioVariables": None}) |
| 144 | + await lsp.awaitIndexingEnd() |
| 145 | + assertEqual(await lsp.getObjDirBasename(), "value-from-prj") |
| 146 | + |
| 147 | + |
| 148 | +@test(initialize=False) |
| 149 | +async def test4(lsp: ALSLanguageClient) -> None: |
| 150 | + # There is no config file |
| 151 | + await lsp.initialize_session( |
| 152 | + InitializeParams( |
| 153 | + ClientCapabilities(), |
| 154 | + root_uri=URI(os.getcwd()), |
| 155 | + # initialize has no settings |
| 156 | + ) |
| 157 | + ) |
| 158 | + # Because no project file was set, we need a didOpen to load the project |
| 159 | + lsp.didOpenVirtual() |
| 160 | + await lsp.awaitIndexingEnd() |
| 161 | + # No value was provided for the scenario variable, so we should get the default |
| 162 | + # value defined in the project. |
| 163 | + assertEqual(await lsp.getObjDirBasename(), "value-from-prj") |
| 164 | + |
| 165 | + # Now let's send the first didChangeConfiguration. This should constitute the base |
| 166 | + # config. |
| 167 | + lsp.didChangeConfig( |
| 168 | + {"scenarioVariables": {"Var": "value-from-first-config-change"}} |
| 169 | + ) |
| 170 | + await lsp.awaitIndexingEnd() |
| 171 | + assertEqual(await lsp.getObjDirBasename(), "value-from-first-config-change") |
| 172 | + |
| 173 | + # Now we change to another value, and revert with a null value. |
| 174 | + lsp.didChangeConfig({"scenarioVariables": {"Var": "new-value"}}) |
| 175 | + await lsp.awaitIndexingEnd() |
| 176 | + assertEqual(await lsp.getObjDirBasename(), "new-value") |
| 177 | + |
| 178 | + lsp.didChangeConfig({"scenarioVariables": None}) |
| 179 | + await lsp.awaitIndexingEnd() |
| 180 | + assertEqual(await lsp.getObjDirBasename(), "value-from-first-config-change") |
0 commit comments