org.sonar.plugins.dotnet.tests.DotCoverReportParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-dotnet-shared-library Show documentation
Share code between C# and VB.NET plugins
The newest version!
/*
 * SonarSource :: .NET :: Shared library
 * Copyright (C) 2014-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.dotnet.tests;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class DotCoverReportParser implements CoverageParser {

  private static final String TITLE_START = "";
  private static final String HIGHLIGHT_RANGES_START = "highlightRanges([";
  // the pattern for the information about a sequence point - [lineStart, columnStart, lineEnd, columnEnd, hits]
  private static final Pattern SEQUENCE_POINT = Pattern.compile("\\[(\\d++),\\d++,\\d++,\\d++,(\\d++)]");
  private static final Logger LOG = LoggerFactory.getLogger(DotCoverReportParser.class);
  private final FileService fileService;

  public DotCoverReportParser(FileService fileService) {
    this.fileService = fileService;
  }

  @Override
  public void accept(File file, Coverage coverage) {
    LOG.info("Parsing the dotCover report {}", file.getAbsolutePath());
    new Parser(file, coverage).parse();
  }

  private class Parser {

    private final File file;
    private final Coverage coverage;

    Parser(File file, Coverage coverage) {
      this.file = file;
      this.coverage = coverage;
    }

    public void parse() {
      String contents;
      try {
        contents = new String(Files.readAllBytes(file.toPath()), StandardCharsets.UTF_8);
      } catch (IOException e) {
        throw new IllegalStateException(e);
      }

      String fileCanonicalPath = extractFileCanonicalPath(contents);
      if (fileCanonicalPath != null && fileService.isSupportedAbsolute(fileCanonicalPath)) {
        collectCoverage(fileCanonicalPath, contents);
      } else {
        LOG.debug("Skipping the import of dotCover code coverage for file '{}' because it is not indexed or"
            + " does not have the supported language. " + VERIFY_SONARPROJECTPROPERTIES_MESSAGE,
          fileCanonicalPath);
      }
    }

    @Nullable
    private String extractFileCanonicalPath(String contents) {
      int indexOfTitleStart = getIndexOf(contents, TITLE_START, 0);
      int indexOfTitleEnd = getIndexOf(contents, "", indexOfTitleStart);
      String lowerCaseAbsolutePath = contents.substring(indexOfTitleStart + TITLE_START.length(), indexOfTitleEnd);
      try {
        return new File(lowerCaseAbsolutePath).getCanonicalPath();
      } catch (IOException e) {
        LOG.debug("Skipping the import of dotCover code coverage for the invalid file path: " + lowerCaseAbsolutePath + ".", e);
        return null;
      }
    }

    private void collectCoverage(String fileCanonicalPath, String contents) {
      int indexOfScript = getIndexOf(contents, "