Оптимизация механизма запуска тестов.

build.gradle.kts

@@ -74,6 +74,7 @@ dependencies {
     // spring
     api("org.springframework.boot:spring-boot-starter")
     api("org.springframework.boot:spring-boot-starter-websocket")
+    api("org.springframework.boot:spring-boot-starter-cache")
     api("info.picocli:picocli-spring-boot-starter:4.7.6")
 
     // lsp4j core

src/main/java/com/github/_1c_syntax/bsl/languageserver/codelenses/AbstractRunTestsCodeLensSupplier.java

@@ -21,18 +21,36 @@
  */
 package com.github._1c_syntax.bsl.languageserver.codelenses;
 
+import com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration;
+import com.github._1c_syntax.bsl.languageserver.configuration.events.LanguageServerConfigurationChangedEvent;
 import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
 import com.github._1c_syntax.bsl.languageserver.context.FileType;
 import com.github._1c_syntax.bsl.languageserver.events.LanguageServerInitializeRequestReceivedEvent;
+import com.github._1c_syntax.utils.Absolute;
+import jakarta.annotation.Nullable;
+import lombok.RequiredArgsConstructor;
 import org.eclipse.lsp4j.ClientInfo;
 import org.eclipse.lsp4j.InitializeParams;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.cache.annotation.CacheConfig;
+import org.springframework.cache.annotation.CacheEvict;
+import org.springframework.cache.annotation.Cacheable;
 import org.springframework.context.event.EventListener;
 
+import java.net.URI;
+import java.nio.file.Path;
 import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Collectors;
 
+@RequiredArgsConstructor
+@CacheConfig(cacheNames = "testSources")
 public abstract class AbstractRunTestsCodeLensSupplier<T extends CodeLensData>
   implements CodeLensSupplier<T> {
 
+  protected final LanguageServerConfiguration configuration;
+
   private boolean clientIsSupported;
 
   /**
@@ -43,6 +61,7 @@ public abstract class AbstractRunTestsCodeLensSupplier<T extends CodeLensData>
    * @param event Событие
    */
   @EventListener
+  @CacheEvict(allEntries = true)
   public void handleEvent(LanguageServerInitializeRequestReceivedEvent event) {
     var clientName = Optional.of(event)
       .map(LanguageServerInitializeRequestReceivedEvent::getParams)
@@ -52,11 +71,61 @@ public void handleEvent(LanguageServerInitializeRequestReceivedEvent event) {
     clientIsSupported = "Visual Studio Code".equals(clientName);
   }
 
+  /**
+   * Обработчик события {@link LanguageServerConfigurationChangedEvent}.
+   * <p>
+   * Сбрасывает кеш при изменении конфигурации.
+   *
+   * @param event Событие
+   */
+  @EventListener
+  @CacheEvict(allEntries = true)
+  public void handleLanguageServerConfigurationChange(LanguageServerConfigurationChangedEvent event) {
+    // No-op. Служит для сброса кеша при изменении конфигурации
+  }
+
   /**
    * {@inheritDoc}
    */
   @Override
   public boolean isApplicable(DocumentContext documentContext) {
-    return documentContext.getFileType() == FileType.OS && clientIsSupported;
+    var uri = documentContext.getUri();
+    var testSources = getSelf().getTestSources(documentContext.getServerContext().getConfigurationRoot());
+
+    return clientIsSupported
+      && documentContext.getFileType() == FileType.OS
+      && testSources.stream().anyMatch(testSource -> isInside(uri, testSource));
+  }
+
+  /**
+   * Получить self-injected экземпляр себя для работы механизмов кэширования.
+   *
+   * @return Управляемый Spring'ом экземпляр себя
+   */
+  protected abstract AbstractRunTestsCodeLensSupplier<T> getSelf();
+
+  /**
+   * Получить список каталогов с тестами с учетом корня рабочей области.
+   * <p>
+   * public для работы @Cachable.
+   *
+   * @param configurationRoot Корень конфигурации
+   * @return Список исходных файлов тестов
+   */
+  @Cacheable
+  public Set<URI> getTestSources(@Nullable Path configurationRoot) {
+    var configurationRootString = Optional.ofNullable(configurationRoot)
+      .map(Path::toString)
+      .orElse("");
+
+    return configuration.getCodeLensOptions().getTestRunnerAdapterOptions().getTestSources()
+      .stream()
+      .map(testDir -> Path.of(configurationRootString, testDir))
+      .map(path -> Absolute.path(path).toUri())
+      .collect(Collectors.toSet());
+  }
+
+  private static boolean isInside(URI childURI, URI parentURI) {
+    return !parentURI.relativize(childURI).isAbsolute();
   }
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/codelenses/RunAllTestsCodeLensSupplier.java

@@ -26,10 +26,12 @@
 import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
 import com.github._1c_syntax.bsl.languageserver.utils.Resources;
-import lombok.RequiredArgsConstructor;
+import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.lsp4j.CodeLens;
 import org.eclipse.lsp4j.Command;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Lazy;
 import org.springframework.stereotype.Component;
 
 import java.nio.file.Paths;
@@ -41,17 +43,31 @@
  * Поставщик линзы для запуска всех тестов в текущем файле.
  */
 @Component
-@RequiredArgsConstructor
 @Slf4j
 public class RunAllTestsCodeLensSupplier
   extends AbstractRunTestsCodeLensSupplier<DefaultCodeLensData> {
 
   private static final String COMMAND_ID = "language-1c-bsl.languageServer.runAllTests";
 
   private final TestRunnerAdapter testRunnerAdapter;
-  private final LanguageServerConfiguration configuration;
   private final Resources resources;
 
+  // Self-injection для работы кэша в базовом классе.
+  @Autowired
+  @Lazy
+  @Getter
+  private RunAllTestsCodeLensSupplier self;
+
+  public RunAllTestsCodeLensSupplier(
+    LanguageServerConfiguration configuration,
+    TestRunnerAdapter testRunnerAdapter,
+    Resources resources
+  ) {
+    super(configuration);
+    this.testRunnerAdapter = testRunnerAdapter;
+    this.resources = resources;
+  }
+
   /**
    * {@inheritDoc}
    */

src/main/java/com/github/_1c_syntax/bsl/languageserver/codelenses/RunTestCodeLensSupplier.java

@@ -28,12 +28,14 @@
 import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
 import com.github._1c_syntax.bsl.languageserver.utils.Resources;
 import lombok.EqualsAndHashCode;
-import lombok.RequiredArgsConstructor;
+import lombok.Getter;
 import lombok.ToString;
 import lombok.Value;
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.lsp4j.CodeLens;
 import org.eclipse.lsp4j.Command;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Lazy;
 import org.springframework.stereotype.Component;
 
 import java.beans.ConstructorProperties;
@@ -43,23 +45,36 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 /**
  * Поставщик линз для запуска теста по конкретному тестовому методу.
  */
 @Component
-@RequiredArgsConstructor
 @Slf4j
 public class RunTestCodeLensSupplier
   extends AbstractRunTestsCodeLensSupplier<RunTestCodeLensSupplier.RunTestCodeLensData> {
 
   private static final String COMMAND_ID = "language-1c-bsl.languageServer.runTest";
 
   private final TestRunnerAdapter testRunnerAdapter;
-  private final LanguageServerConfiguration configuration;
   private final Resources resources;
 
+  // Self-injection для работы кэша в базовом классе.
+  @Autowired
+  @Lazy
+  @Getter
+  private RunTestCodeLensSupplier self;
+
+  public RunTestCodeLensSupplier(
+    LanguageServerConfiguration configuration,
+    TestRunnerAdapter testRunnerAdapter,
+    Resources resources
+  ) {
+    super(configuration);
+    this.testRunnerAdapter = testRunnerAdapter;
+    this.resources = resources;
+  }
+
   /**
    * {@inheritDoc}
    */
@@ -77,7 +92,7 @@
       .map(symbolTree::getMethodSymbol)
       .flatMap(Optional::stream)
       .map(methodSymbol -> toCodeLens(methodSymbol, documentContext))
-      .collect(Collectors.toList());
+      .toList();
   }
 
   /**

src/main/java/com/github/_1c_syntax/bsl/languageserver/codelenses/testrunner/TestRunnerAdapter.java

@@ -22,7 +22,10 @@
 package com.github._1c_syntax.bsl.languageserver.codelenses.testrunner;
 
 import com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration;
+import com.github._1c_syntax.bsl.languageserver.configuration.events.LanguageServerConfigurationChangedEvent;
 import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.annotations.Annotation;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.exec.CommandLine;
@@ -32,7 +35,10 @@
 import org.apache.commons.exec.PumpStreamHandler;
 import org.apache.commons.io.output.ByteArrayOutputStream;
 import org.apache.commons.lang3.SystemUtils;
-import org.apache.commons.lang3.tuple.Pair;
+import org.springframework.cache.annotation.CacheConfig;
+import org.springframework.cache.annotation.CacheEvict;
+import org.springframework.cache.annotation.Cacheable;
+import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Component;
 
 import java.io.IOException;
@@ -42,11 +48,8 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
-import java.util.Map;
-import java.util.WeakHashMap;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import java.util.stream.Collectors;
 
 /**
  * Расчетчик списка тестов в документе.
@@ -55,26 +58,44 @@
 @Component
 @RequiredArgsConstructor
 @Slf4j
+@CacheConfig(cacheNames = "testIds")
 public class TestRunnerAdapter {
 
   private static final Pattern NEW_LINE_PATTERN = Pattern.compile("\r?\n");
-  private static final Map<Pair<DocumentContext, Integer>, List<String>> CACHE = new WeakHashMap<>();
 
   private final LanguageServerConfiguration configuration;
 
+  /**
+   * Обработчик события {@link LanguageServerConfigurationChangedEvent}.
+   * <p>
+   * Очищает кэш при изменении конфигурации.
+   *
+   * @param event Событие
+   */
+  @EventListener
+  @CacheEvict(allEntries = true)
+  public void handleEvent(LanguageServerConfigurationChangedEvent event) {
+    // No-op. Служит для сброса кеша при изменении конфигурации
+  }
+
   /**
    * Получить идентификаторы тестов, содержащихся в файле.
    *
    * @param documentContext Контекст документа с тестами.
    * @return Список идентификаторов тестов.
    */
+  @Cacheable
   public List<String> getTestIds(DocumentContext documentContext) {
-    var cacheKey = Pair.of(documentContext, documentContext.getVersion());
+    var options = configuration.getCodeLensOptions().getTestRunnerAdapterOptions();
+
+    if (options.isGetTestsByTestRunner()) {
+      return computeTestIdsByTestRunner(documentContext);
+    }
 
-    return CACHE.computeIfAbsent(cacheKey, pair -> computeTestIds(documentContext));
+    return computeTestIdsByLanguageServer(documentContext);
   }
 
-  private List<String> computeTestIds(DocumentContext documentContext) {
+  private List<String> computeTestIdsByTestRunner(DocumentContext documentContext) {
     var options = configuration.getCodeLensOptions().getTestRunnerAdapterOptions();
 
     var executable = SystemUtils.IS_OS_WINDOWS ? options.getExecutableWin() : options.getExecutable();
@@ -123,7 +144,18 @@ private List<String> computeTestIds(DocumentContext documentContext) {
       .map(getTestsRegex::matcher)
       .filter(Matcher::matches)
       .map(matcher -> matcher.group(1))
-      .collect(Collectors.toList());
+      .toList();
   }
 
+  private List<String> computeTestIdsByLanguageServer(DocumentContext documentContext) {
+    var annotations = configuration.getCodeLensOptions().getTestRunnerAdapterOptions().getAnnotations();
+    return documentContext.getSymbolTree()
+      .getMethods()
+      .stream()
+      .filter(methodSymbol -> methodSymbol.getAnnotations().stream()
+        .map(Annotation::getName)
+        .anyMatch(annotations::contains))
+      .map(MethodSymbol::getName)
+      .toList();
+  }
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/configuration/codelens/TestRunnerAdapterOptions.java

@@ -23,11 +23,17 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.github._1c_syntax.bsl.languageserver.configuration.databind.AnnotationsDeserializer;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import org.apache.commons.lang3.SystemUtils;
 
+import java.util.Collections;
+import java.util.Set;
+import java.util.TreeSet;
+
 /**
  * Параметры запускателя тестового фреймворка.
  */
@@ -37,6 +43,21 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class TestRunnerAdapterOptions {
 
+  public static final Set<String> DEFAULT_ANNOTATIONS = getDefaultAnnotations();
+
+  /**
+   * Каталоги с исходными файлами тестов.
+   */
+  private Set<String> testSources = Set.of("tests");
+
+  /**
+   * Имена аннотаций, маркирующих тесты.
+   * <p>
+   * Используется при получении списка тестов средствами сервера.
+   */
+  @JsonDeserialize(using = AnnotationsDeserializer.class)
+  private Set<String> annotations = DEFAULT_ANNOTATIONS;
+
   /**
    * Имя исполняемого файла тестового фреймворка (linux и macOS).
    */
@@ -45,6 +66,10 @@ public class TestRunnerAdapterOptions {
    * Имя исполняемого файла тестового фреймворка (windows).
    */
   private String executableWin = "1testrunner.bat";
+  /**
+   * Флаг, указывающий на необходимость получения списка тестов через исполняемый файл тестового фреймворка.
+   */
+  private boolean getTestsByTestRunner;
   /**
    * Аргументы для получения списка тестов.
    */
@@ -70,4 +95,12 @@ public class TestRunnerAdapterOptions {
   public String getExecutableForCurrentOS() {
     return SystemUtils.IS_OS_WINDOWS ? executableWin : executable;
   }
+
+  private static Set<String> getDefaultAnnotations() {
+    Set<String> annotations = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
+    annotations.add("Test");
+    annotations.add("Тест");
+
+    return Collections.unmodifiableSet(annotations);
+  }
 }