com.github.sbaudoin.sonar.plugins.ansible.settings.AnsibleSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-ansible-api Show documentation
API for the Ansible lint for SonarQube
There is a newer version: 2.5.1
/**
 * Copyright (c) 2018-2019, Sylvain Baudoin
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.sbaudoin.sonar.plugins.ansible.settings;

import org.sonar.api.PropertyType;
import org.sonar.api.config.PropertyDefinition;
import org.sonar.api.resources.Qualifiers;

import java.util.List;

import static java.util.Arrays.asList;

public class AnsibleSettings {
    public static final String ANSIBLE_LINT_PATH_KEY = "sonar.ansible.ansiblelint.path";
    public static final String ANSIBLE_LINT_PATH_DEFAULT_VALUE = "";
    public static final String ANSIBLE_LINT_CONF_PATH_KEY = "sonar.ansible.ansiblelint.conf.path";
    public static final String ANSIBLE_LINT_CONF_PATH_DEFAULT_VALUE = "";
    public static final String ANSIBLE_LINT_DISABLE_WARNINGS_KEY = "sonar.ansible.ansiblelint.disable_warnings";
    public static final String ANSIBLE_LINT_DISABLE_WARNINGS_DEFAULT_VALUE = "false";
    public static final String CATEGORY = "Ansible";


    private AnsibleSettings() {
    }


    public static List getProperties() {
        return asList(
                PropertyDefinition.builder(ANSIBLE_LINT_PATH_KEY)
                        .name("Path to ansible-lint")
                        .description("Path to the ansible-lint executable. Leave it empty if the command is in the system path.")
                        .defaultValue(ANSIBLE_LINT_PATH_DEFAULT_VALUE)
                        .category(CATEGORY)
                        .onQualifiers(Qualifiers.PROJECT)
                        .build(),
                PropertyDefinition.builder(ANSIBLE_LINT_CONF_PATH_KEY)
                        .name("Path the an ansible-lint configuration file")
                        .description("Path (absolute or relative to project root) to an ansible-lint configuration file. Leave it empty to use the default .ansible-lint file.")
                        .defaultValue(ANSIBLE_LINT_CONF_PATH_DEFAULT_VALUE)
                        .category(CATEGORY)
                        .onQualifiers(Qualifiers.PROJECT)
                        .build(),
                PropertyDefinition.builder(ANSIBLE_LINT_DISABLE_WARNINGS_KEY)
                        .name("Disable ansible-lint warnings")
                        .description("By default, the plugin will show warnings in the scanner output when ansible-lint does; check the box if you want to ignore those warnings and have a cleaner scanner output.")
                        .type(PropertyType.BOOLEAN)
                        .defaultValue(ANSIBLE_LINT_DISABLE_WARNINGS_DEFAULT_VALUE)
                        .category(CATEGORY)
                        .onQualifiers(Qualifiers.PROJECT)
                        .build()
        );
    }
}