org.sonar.zaproxy.rule.ZapRuleDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-zap-plugin Show documentation
Integrates ZAP reports into SonarQube
There is a newer version: 2.3.0
/*
 * ZAP Plugin for SonarQube
 * Copyright (C) 2015-2017 Gene Gotimer
 * [email protected]
 *
 * 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.zaproxy.rule;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import org.apache.commons.io.Charsets;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.config.Settings;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.api.server.rule.RulesDefinitionXmlLoader;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.zaproxy.ZapPlugin;
import org.sonar.zaproxy.base.ZapConstants;

public class ZapRuleDefinition implements RulesDefinition {

  private static final Logger LOGGER = Loggers.get(ZapRuleDefinition.class);

  private final RulesDefinitionXmlLoader xmlLoader;
  private final Settings settings;

  public ZapRuleDefinition(RulesDefinitionXmlLoader xmlLoader, Settings settings) {
    this.xmlLoader = xmlLoader;
    this.settings = settings;
  }

  private String getRulesFilePath() {
    String rulesFilePath = this.settings.getString(ZapConstants.RULES_FILE_PATH_PROPERTY);
    if (StringUtils.isBlank(rulesFilePath)) {
      return null;
    }
    LOGGER.info("Path to rules.xml = [" + rulesFilePath + "]");
    return rulesFilePath;
  }

  private void loadDefaultZAProxyRules(NewRepository repository) {
    xmlLoader
        .load(repository, getClass().getResourceAsStream(ZapPlugin.RULES_FILE), Charsets.UTF_8);
  }

  @Override
  public void define(Context context) {
    NewRepository repository = context
        .createRepository(ZapPlugin.REPOSITORY_KEY, ZapPlugin.LANGUAGE_KEY);
    repository.setName(ZapPlugin.REPOSITORY_KEY);

    String rulesFilePath = getRulesFilePath();

    if (rulesFilePath == null) { // rules.xml by default
      loadDefaultZAProxyRules(repository);
    } else { // custom rules.xml
      File f = null;
      try {
        f = new File(rulesFilePath);
        xmlLoader.load(repository, new FileInputStream(f), "UTF-8");
      } catch (FileNotFoundException e) {
        LOGGER.warn("The file " + f.getAbsolutePath() + " does not exist", e);

        // Load default ZAProxy rules if custom rules.xml does not exist.
        loadDefaultZAProxyRules(repository);
      }
    }
    repository.done();
  }

}