org.sonar.plugins.javascript.bridge.RulesBundles Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-javascript-plugin Show documentation
Code Analyzer for JavaScript/TypeScript/CSS
There is a newer version: 10.17.0.28100
Show newest version
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-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.javascript.bridge;

import java.io.IOException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.scanner.ScannerSide;
import org.sonar.plugins.javascript.api.RulesBundle;
import org.sonarsource.api.sonarlint.SonarLintSide;

@ScannerSide
@SonarLintSide(lifespan = SonarLintSide.INSTANCE)
public class RulesBundles {

  private static final Logger LOG = LoggerFactory.getLogger(RulesBundles.class);

  private final List bundleUrls;
  private final List bundles;

  /**
   * This constructor is used by pico container when no RulesBundle is provided on classpath
   */
  public RulesBundles() {
    this.bundles = Collections.emptyList();
    this.bundleUrls = Collections.emptyList();
  }

  public RulesBundles(RulesBundle[] rulesBundles) {
    bundles = List.of(rulesBundles);
    bundleUrls =
      Arrays
        .stream(rulesBundles)
        .map(bundle -> {
          URL resource = bundle.getClass().getResource(bundle.bundlePath());
          if (resource == null) {
            throw new IllegalStateException(
              String.format(
                "Resource for bundle %s from %s not found.",
                bundle.bundlePath(),
                bundle
              )
            );
          }
          return resource;
        })
        .toList();
  }

  /**
   * Deploy bundles in temporary directory and return list of paths for deployed modules
   *
   */
  public List deploy(Path target) {
    List unpackedBundles = new ArrayList<>();
    bundleUrls.forEach(bundle -> {
      try {
        Path location = Files.createTempDirectory(target, "custom-rules");
        LOG.debug("Deploying custom rules bundle {} to {}", bundle, location);
        BundleUtils.extractFromClasspath(bundle.openStream(), location);
        Path deployedBundle = location.resolve("package").toAbsolutePath();
        if (!Files.exists(deployedBundle)) {
          // Inside tgz we expect "package" directory, this is npm contract.
          // see https://stackoverflow.com/questions/29717774/npm-pack-rename-package-directory
          throw new IllegalStateException(
            "Failed to deploy bundle " + bundle + ". Didn't find 'package' dir."
          );
        }
        unpackedBundles.add(deployedBundle);
      } catch (IOException e) {
        LOG.error("Failed to extract bundle " + bundle, e);
      }
    });
    return unpackedBundles;
  }

  public Optional getUcfgRulesBundle() {
    return bundles.stream().filter(bundle -> "ucfg".equals(bundle.bundleKey())).findAny();
  }
}