Skip to content

Commit 30fa2c4

Browse files
committed
Fix some code issues to pass Sonar quality gate
1 parent e0dc03f commit 30fa2c4

30 files changed

+117
-150
lines changed

cli/src/main/java/org/openapitools/openapidiff/cli/Main.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import java.io.File;
44
import java.io.IOException;
5+
import java.nio.charset.StandardCharsets;
56
import org.apache.commons.cli.CommandLine;
67
import org.apache.commons.cli.CommandLineParser;
78
import org.apache.commons.cli.DefaultParser;
@@ -100,7 +101,6 @@ public static void main(String... args) {
100101
.desc("export diff as text in given file")
101102
.build());
102103

103-
final String message = "Hello logging!";
104104
// create the parser
105105
CommandLineParser parser = new DefaultParser();
106106
try {
@@ -202,7 +202,7 @@ private static void writeOutput(String output, String outputFile) {
202202
File file = new File(outputFile);
203203
logger.debug("Output file: {}", file.getAbsolutePath());
204204
try {
205-
FileUtils.writeStringToFile(file, output);
205+
FileUtils.writeStringToFile(file, output, StandardCharsets.UTF_8);
206206
} catch (IOException e) {
207207
logger.error("Impossible to write output to file {}", outputFile, e);
208208
System.exit(2);

core/src/main/java/org/openapitools/openapidiff/core/OpenApiCompare.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111

1212
public class OpenApiCompare {
1313

14-
private static OpenAPIParser openApiParser = new OpenAPIParser();
15-
private static ParseOptions options = new ParseOptions();
14+
private static final OpenAPIParser openApiParser = new OpenAPIParser();
15+
private static final ParseOptions options = new ParseOptions();
1616

1717
static {
1818
options.setResolve(true);

core/src/main/java/org/openapitools/openapidiff/core/compare/ApiResponseDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
/** Created by adarsh.sharma on 04/01/18. */
1616
public class ApiResponseDiff {
17-
private OpenApiDiff openApiDiff;
17+
private final OpenApiDiff openApiDiff;
1818

1919
public ApiResponseDiff(OpenApiDiff openApiDiff) {
2020
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/Comparable.java

-6
This file was deleted.

core/src/main/java/org/openapitools/openapidiff/core/compare/ContentDiff.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,14 @@
1010
import org.openapitools.openapidiff.core.model.ChangedMediaType;
1111
import org.openapitools.openapidiff.core.model.DiffContext;
1212

13-
public class ContentDiff implements Comparable<Content> {
13+
public class ContentDiff {
1414

15-
private OpenApiDiff openApiDiff;
15+
private final OpenApiDiff openApiDiff;
1616

1717
public ContentDiff(OpenApiDiff openApiDiff) {
1818
this.openApiDiff = openApiDiff;
1919
}
2020

21-
@Override
22-
public boolean compare(Content left, Content right) {
23-
return false;
24-
}
25-
2621
public Optional<ChangedContent> diff(Content left, Content right, DiffContext context) {
2722

2823
MapKeyDiff<String, MediaType> mediaTypeDiff = MapKeyDiff.diff(left, right);

core/src/main/java/org/openapitools/openapidiff/core/compare/ExtensionsDiff.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@
1313
public class ExtensionsDiff {
1414
private final OpenApiDiff openApiDiff;
1515

16-
private ServiceLoader<ExtensionDiff> extensionsLoader = ServiceLoader.load(ExtensionDiff.class);
17-
private List<ExtensionDiff> extensionsDiff = new ArrayList<>();
16+
private final List<ExtensionDiff> extensionsDiff = new ArrayList<>();
1817

1918
public ExtensionsDiff(OpenApiDiff openApiDiff) {
2019
this.openApiDiff = openApiDiff;
21-
this.extensionsLoader.reload();
22-
for (ExtensionDiff anExtensionsLoader : this.extensionsLoader) {
20+
ServiceLoader<ExtensionDiff> extensionsLoader = ServiceLoader.load(ExtensionDiff.class);
21+
extensionsLoader.reload();
22+
for (ExtensionDiff anExtensionsLoader : extensionsLoader) {
2323
extensionsDiff.add(anExtensionsLoader);
2424
}
2525
}

core/src/main/java/org/openapitools/openapidiff/core/compare/HeaderDiff.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414

1515
/** Created by adarsh.sharma on 28/12/17. */
1616
public class HeaderDiff extends ReferenceDiffCache<Header, ChangedHeader> {
17-
private static RefPointer<Header> refPointer = new RefPointer<>(RefType.HEADERS);
18-
private OpenApiDiff openApiDiff;
19-
private Components leftComponents;
20-
private Components rightComponents;
17+
private static final RefPointer<Header> refPointer = new RefPointer<>(RefType.HEADERS);
18+
private final OpenApiDiff openApiDiff;
19+
private final Components leftComponents;
20+
private final Components rightComponents;
2121

2222
public HeaderDiff(OpenApiDiff openApiDiff) {
2323
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/HeadersDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
/** Created by adarsh.sharma on 28/12/17. */
1515
public class HeadersDiff {
16-
private OpenApiDiff openApiDiff;
16+
private final OpenApiDiff openApiDiff;
1717

1818
public HeadersDiff(OpenApiDiff openApiDiff) {
1919
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/MapKeyDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public class MapKeyDiff<K, V> {
1515

1616
private Map<K, V> increased;
1717
private Map<K, V> missing;
18-
private List<K> sharedKey;
18+
private final List<K> sharedKey;
1919

2020
private MapKeyDiff() {
2121
this.sharedKey = new ArrayList<>();

core/src/main/java/org/openapitools/openapidiff/core/compare/MetadataDiff.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99

1010
public class MetadataDiff {
1111

12-
private Components leftComponents;
13-
private Components rightComponents;
14-
private OpenApiDiff openApiDiff;
12+
private final Components leftComponents;
13+
private final Components rightComponents;
14+
private final OpenApiDiff openApiDiff;
1515

1616
public MetadataDiff(OpenApiDiff openApiDiff) {
1717
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/OAuthFlowDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
/** Created by adarsh.sharma on 12/01/18. */
1313
public class OAuthFlowDiff {
14-
private OpenApiDiff openApiDiff;
14+
private final OpenApiDiff openApiDiff;
1515

1616
public OAuthFlowDiff(OpenApiDiff openApiDiff) {
1717
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/OAuthFlowsDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
/** Created by adarsh.sharma on 12/01/18. */
1212
public class OAuthFlowsDiff {
13-
private OpenApiDiff openApiDiff;
13+
private final OpenApiDiff openApiDiff;
1414

1515
public OAuthFlowsDiff(OpenApiDiff openApiDiff) {
1616
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/OperationDiff.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
/** Created by adarsh.sharma on 04/01/18. */
1515
public class OperationDiff {
16-
private OpenApiDiff openApiDiff;
16+
private final OpenApiDiff openApiDiff;
1717

1818
public OperationDiff(OpenApiDiff openApiDiff) {
1919
this.openApiDiff = openApiDiff;
@@ -70,7 +70,7 @@ public Optional<ChangedOperation> diff(
7070
openApiDiff
7171
.getExtensionsDiff()
7272
.diff(oldOperation.getExtensions(), newOperation.getExtensions(), context)
73-
.ifPresent(extensions -> changedOperation.setExtensions(extensions));
73+
.ifPresent(changedOperation::setExtensions);
7474

7575
return isChanged(changedOperation);
7676
}

core/src/main/java/org/openapitools/openapidiff/core/compare/ParameterDiff.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414

1515
public class ParameterDiff extends ReferenceDiffCache<Parameter, ChangedParameter> {
1616

17-
private static RefPointer<Parameter> refPointer = new RefPointer<>(RefType.PARAMETERS);
18-
private Components leftComponents;
19-
private Components rightComponents;
20-
private OpenApiDiff openApiDiff;
17+
private static final RefPointer<Parameter> refPointer = new RefPointer<>(RefType.PARAMETERS);
18+
private final Components leftComponents;
19+
private final Components rightComponents;
20+
private final OpenApiDiff openApiDiff;
2121

2222
public ParameterDiff(OpenApiDiff openApiDiff) {
2323
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/ParametersDiff.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
* @author QDesrame
2020
*/
2121
public class ParametersDiff {
22+
private static final RefPointer<Parameter> refPointer = new RefPointer<>(RefType.PARAMETERS);
2223

23-
private Components leftComponents;
24-
private Components rightComponents;
25-
private OpenApiDiff openApiDiff;
26-
private static RefPointer<Parameter> refPointer = new RefPointer<>(RefType.PARAMETERS);
24+
private final Components leftComponents;
25+
private final Components rightComponents;
26+
private final OpenApiDiff openApiDiff;
2727

2828
public ParametersDiff(OpenApiDiff openApiDiff) {
2929
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/PathDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import org.openapitools.openapidiff.core.model.DiffContext;
1212

1313
public class PathDiff {
14-
private OpenApiDiff openApiDiff;
14+
private final OpenApiDiff openApiDiff;
1515

1616
public PathDiff(OpenApiDiff openApiDiff) {
1717
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/PathsDiff.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
public class PathsDiff {
1414
private static final String REGEX_PATH = "\\{([^/]+)\\}";
15-
private OpenApiDiff openApiDiff;
15+
private final OpenApiDiff openApiDiff;
1616

1717
public PathsDiff(OpenApiDiff openApiDiff) {
1818
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/ReferenceDiffCache.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
/** Created by adarsh.sharma on 07/01/18. */
1010
public abstract class ReferenceDiffCache<C, D> {
11-
private Map<CacheKey, D> refDiffMap;
11+
private final Map<CacheKey, D> refDiffMap;
1212

1313
public ReferenceDiffCache() {
1414
this.refDiffMap = new HashMap<>();

core/src/main/java/org/openapitools/openapidiff/core/compare/RequestBodyDiff.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515

1616
/** Created by adarsh.sharma on 28/12/17. */
1717
public class RequestBodyDiff extends ReferenceDiffCache<RequestBody, ChangedRequestBody> {
18-
private static RefPointer<RequestBody> refPointer = new RefPointer<>(RefType.REQUEST_BODIES);
19-
private OpenApiDiff openApiDiff;
18+
private static final RefPointer<RequestBody> refPointer =
19+
new RefPointer<>(RefType.REQUEST_BODIES);
20+
private final OpenApiDiff openApiDiff;
2021

2122
public RequestBodyDiff(OpenApiDiff openApiDiff) {
2223
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/ResponseDiff.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313

1414
/** Created by adarsh.sharma on 28/12/17. */
1515
public class ResponseDiff extends ReferenceDiffCache<ApiResponse, ChangedResponse> {
16-
private static RefPointer<ApiResponse> refPointer = new RefPointer<>(RefType.RESPONSES);
17-
private OpenApiDiff openApiDiff;
18-
private Components leftComponents;
19-
private Components rightComponents;
16+
private static final RefPointer<ApiResponse> refPointer = new RefPointer<>(RefType.RESPONSES);
17+
private final OpenApiDiff openApiDiff;
18+
private final Components leftComponents;
19+
private final Components rightComponents;
2020

2121
public ResponseDiff(OpenApiDiff openApiDiff) {
2222
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/SchemaDiff.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626

2727
public class SchemaDiff extends ReferenceDiffCache<Schema, ChangedSchema> {
2828

29-
private static RefPointer<Schema> refPointer = new RefPointer<>(RefType.SCHEMAS);
30-
private static Map<Class<? extends Schema>, Class<? extends SchemaDiffResult>>
29+
private static final RefPointer<Schema> refPointer = new RefPointer<>(RefType.SCHEMAS);
30+
private static final Map<Class<? extends Schema>, Class<? extends SchemaDiffResult>>
3131
schemaDiffResultClassMap = new LinkedHashMap<>();
3232

3333
static {
@@ -36,9 +36,9 @@ public class SchemaDiff extends ReferenceDiffCache<Schema, ChangedSchema> {
3636
schemaDiffResultClassMap.put(ComposedSchema.class, ComposedSchemaDiffResult.class);
3737
}
3838

39-
private Components leftComponents;
40-
private Components rightComponents;
41-
private OpenApiDiff openApiDiff;
39+
private final Components leftComponents;
40+
private final Components rightComponents;
41+
private final OpenApiDiff openApiDiff;
4242

4343
public SchemaDiff(OpenApiDiff openApiDiff) {
4444
this.openApiDiff = openApiDiff;

core/src/main/java/org/openapitools/openapidiff/core/compare/SecurityRequirementDiff.java

+24-24
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@
77
import io.swagger.v3.oas.models.security.SecurityScheme;
88
import java.util.*;
99
import org.openapitools.openapidiff.core.model.ChangedSecurityRequirement;
10-
import org.openapitools.openapidiff.core.model.ChangedSecurityScheme;
1110
import org.openapitools.openapidiff.core.model.DiffContext;
1211

1312
/** Created by adarsh.sharma on 07/01/18. */
1413
public class SecurityRequirementDiff {
15-
private OpenApiDiff openApiDiff;
16-
private Components leftComponents;
17-
private Components rightComponents;
14+
private final OpenApiDiff openApiDiff;
15+
private final Components leftComponents;
16+
private final Components rightComponents;
1817

1918
public SecurityRequirementDiff(OpenApiDiff openApiDiff) {
2019
this.openApiDiff = openApiDiff;
@@ -30,8 +29,7 @@ public SecurityRequirementDiff(OpenApiDiff openApiDiff) {
3029

3130
public static SecurityRequirement getCopy(LinkedHashMap<String, List<String>> right) {
3231
SecurityRequirement newSecurityRequirement = new SecurityRequirement();
33-
right.entrySet().stream()
34-
.forEach(e -> newSecurityRequirement.put(e.getKey(), new ArrayList<>(e.getValue())));
32+
right.forEach((key, value) -> newSecurityRequirement.put(key, new ArrayList<>(value)));
3533
return newSecurityRequirement;
3634
}
3735

@@ -68,29 +66,31 @@ public Optional<ChangedSecurityRequirement> diff(
6866
ChangedSecurityRequirement changedSecurityRequirement =
6967
new ChangedSecurityRequirement(left, right != null ? getCopy(right) : null);
7068

71-
left = left == null ? new SecurityRequirement() : left;
72-
right = right == null ? new SecurityRequirement() : right;
69+
SecurityRequirement leftRequirement = left == null ? new SecurityRequirement() : left;
70+
SecurityRequirement rightRequirement = right == null ? new SecurityRequirement() : right;
7371

74-
for (String leftSchemeRef : left.keySet()) {
75-
LinkedHashMap<String, List<String>> rightSec = contains(right, leftSchemeRef);
72+
for (String leftSchemeRef : leftRequirement.keySet()) {
73+
LinkedHashMap<String, List<String>> rightSec = contains(rightRequirement, leftSchemeRef);
7674
if (rightSec.isEmpty()) {
77-
changedSecurityRequirement.addMissing(leftSchemeRef, left.get(leftSchemeRef));
75+
changedSecurityRequirement.addMissing(leftSchemeRef, leftRequirement.get(leftSchemeRef));
7876
} else {
79-
String rightSchemeRef = rightSec.keySet().stream().findFirst().get();
80-
right.remove(rightSchemeRef);
81-
Optional<ChangedSecurityScheme> diff =
82-
openApiDiff
83-
.getSecuritySchemeDiff()
84-
.diff(
85-
leftSchemeRef,
86-
left.get(leftSchemeRef),
87-
rightSchemeRef,
88-
rightSec.get(rightSchemeRef),
89-
context);
90-
diff.ifPresent(changedSecurityRequirement::addChanged);
77+
Optional<String> rightSchemeRef = rightSec.keySet().stream().findFirst();
78+
rightSchemeRef.ifPresent(rightRequirement::remove);
79+
rightSchemeRef
80+
.flatMap(
81+
rightScheme ->
82+
openApiDiff
83+
.getSecuritySchemeDiff()
84+
.diff(
85+
leftSchemeRef,
86+
leftRequirement.get(leftSchemeRef),
87+
rightScheme,
88+
rightSec.get(rightScheme),
89+
context))
90+
.ifPresent(changedSecurityRequirement::addChanged);
9191
}
9292
}
93-
right.forEach(changedSecurityRequirement::addIncreased);
93+
rightRequirement.forEach(changedSecurityRequirement::addIncreased);
9494

9595
return isChanged(changedSecurityRequirement);
9696
}

core/src/main/java/org/openapitools/openapidiff/core/compare/SecurityRequirementsDiff.java

+6-11
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@
2020

2121
/** Created by adarsh.sharma on 07/01/18. */
2222
public class SecurityRequirementsDiff {
23-
private OpenApiDiff openApiDiff;
24-
private Components leftComponents;
25-
private Components rightComponents;
26-
private static RefPointer<SecurityScheme> refPointer = new RefPointer<>(RefType.SECURITY_SCHEMES);
23+
private static final RefPointer<SecurityScheme> refPointer =
24+
new RefPointer<>(RefType.SECURITY_SCHEMES);
25+
26+
private final OpenApiDiff openApiDiff;
27+
private final Components leftComponents;
28+
private final Components rightComponents;
2729

2830
public SecurityRequirementsDiff(OpenApiDiff openApiDiff) {
2931
this.openApiDiff = openApiDiff;
@@ -45,13 +47,6 @@ public Optional<SecurityRequirement> contains(
4547
}
4648

4749
public boolean same(SecurityRequirement left, SecurityRequirement right) {
48-
// List<SecurityScheme.Type> leftTypes = left.keySet().stream()
49-
// .map(x -> leftComponents.getSecuritySchemes().get(x).getType())
50-
// .collect(Collectors.toList());
51-
// List<SecurityScheme.Type> rightTypes = right.keySet().stream()
52-
// .map(x -> rightComponents.getSecuritySchemes().get(x).getType())
53-
// .collect(Collectors.toList());
54-
//
5550
List<Pair<SecurityScheme.Type, SecurityScheme.In>> leftTypes =
5651
getListOfSecuritySchemes(leftComponents, left);
5752
List<Pair<SecurityScheme.Type, SecurityScheme.In>> rightTypes =

0 commit comments

Comments
 (0)