Skip to content

fix: rule 098 is parametrized #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 27, 2025
Merged

fix: rule 098 is parametrized #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70378d6
fix: rule 098 is parametrized
Jun 24, 2025
2f93a08
fix: change variable names and delete prints
Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions src/main/java/apiaddicts/sonar/openapi/checks/format/OAR098LongBasePathCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
package apiaddicts.sonar.openapi.checks.format;

import apiaddicts.sonar.openapi.checks.BaseCheck;
import com.google.common.collect.ImmutableSet;
import com.sonar.sslr.api.AstNodeType;
import org.sonar.check.Rule;
import org.apiaddicts.apitools.dosonarapi.api.v2.OpenApi2Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v3.OpenApi3Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v31.OpenApi31Grammar;
import apiaddicts.sonar.openapi.checks.BaseCheck;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apiaddicts.apitools.dosonarapi.api.v2.OpenApi2Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v3.OpenApi3Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v31.OpenApi31Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;

@Rule(key = OAR098LongBasePathCheck.KEY)
public class OAR098LongBasePathCheck extends BaseCheck {

public static final String KEY = "OAR098";

private static final int LONG_BASE_PATH = 2;

@RuleProperty(key = "long-base-path", description = "long of the path in the basepath keywork value", defaultValue = "" + LONG_BASE_PATH )
private static int basePahtLength = LONG_BASE_PATH;

@Override
public Set<AstNodeType> subscribedKinds() {
return ImmutableSet.of(OpenApi2Grammar.ROOT, OpenApi3Grammar.SERVER, OpenApi31Grammar.SERVER);
Expand Down Expand Up @@ -55,7 +60,7 @@ private void visitV3ServerNode(JsonNode node) {
private void validatePath(String path, JsonNode node) {
List<String> pathParts = Stream.of(path.split("/")).map(String::trim).filter(s -> !s.isEmpty()).collect(Collectors.toList());

if (pathParts.size() > 2) {
if (pathParts.size() > basePahtLength) {
addIssue(KEY, translate("OAR098.error-path-long"), node.value());
}
}
Expand Down
7 changes: 4 additions & 3 deletions src/test/java/org/sonar/samples/openapi/checks/format/OAR098LongBasePathCheckTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
package org.sonar.samples.openapi.checks.format;

import apiaddicts.sonar.openapi.checks.format.OAR098LongBasePathCheck;
import org.junit.Before;
import org.junit.Test;
import org.sonar.api.rule.Severity;
import org.sonar.api.rules.RuleType;
import org.sonar.api.server.rule.RuleParamType;
import org.sonar.samples.openapi.BaseCheckTest;

import apiaddicts.sonar.openapi.checks.format.OAR098LongBasePathCheck;

public class OAR098LongBasePathCheckTest extends BaseCheckTest {

@Before
Expand Down Expand Up @@ -45,6 +45,7 @@ public void verifyRule() {

@Override
public void verifyParameters() {
assertNumberOfParameters(0);
assertNumberOfParameters(1);
assertParameterProperties("long-base-path", "2", RuleParamType.INTEGER);
}
}
Loading