-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e36dfd0
commit 39bd586
Showing
8 changed files
with
171 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
src/main/java/at/porscheinformatik/sonarqube/licensecheck/swift/SwiftDependencyScanner.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| package at.porscheinformatik.sonarqube.licensecheck.swift; | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.io.InputStream; | ||
| import java.util.Collections; | ||
| import java.util.HashSet; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.regex.Pattern; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import javax.json.Json; | ||
| import javax.json.JsonArray; | ||
| import javax.json.JsonObject; | ||
| import javax.json.JsonReader; | ||
|
|
||
| import org.codehaus.plexus.util.StringUtils; | ||
| import org.sonar.api.batch.sensor.SensorContext; | ||
| import org.sonar.api.utils.log.Logger; | ||
| import org.sonar.api.utils.log.Loggers; | ||
|
|
||
| import at.porscheinformatik.sonarqube.licensecheck.Dependency; | ||
| import at.porscheinformatik.sonarqube.licensecheck.LicenseCheckRulesDefinition; | ||
| import at.porscheinformatik.sonarqube.licensecheck.Scanner; | ||
| import at.porscheinformatik.sonarqube.licensecheck.licensemapping.LicenseMappingService; | ||
| import at.porscheinformatik.sonarqube.licensecheck.utils.LicenseUtils; | ||
|
|
||
| /* | ||
| * This Swift dependency scanner is based on reports produced by LicenseFinder opensource tool | ||
| */ | ||
| public class SwiftDependencyScanner implements Scanner { | ||
| private static final Logger LOGGER = Loggers.get(SwiftDependencyScanner.class); | ||
| private final LicenseMappingService licenseMappingService; | ||
|
|
||
| public SwiftDependencyScanner(LicenseMappingService licenseMappingService) { | ||
| this.licenseMappingService = licenseMappingService; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<Dependency> scan(SensorContext context) { | ||
| File moduleDir = context.fileSystem().baseDir(); | ||
|
|
||
| Map<Pattern, String> defaultLicenseMap = licenseMappingService.getLicenseMap(); | ||
|
|
||
| File licenseDetailsJsonFile = new File(moduleDir, "build" + File.separator + "reports" + File.separator | ||
| + "license_finder" + File.separator + "swift-license-details.json"); | ||
|
|
||
| if (!licenseDetailsJsonFile.exists()) { | ||
| LOGGER.info("No license-details.json file found in {} - skipping Swift dependency scan", | ||
| licenseDetailsJsonFile.getPath()); | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| return readLicenseDetailsJson(licenseDetailsJsonFile) | ||
| .stream() | ||
| .map(d -> LicenseUtils.matchLicense(defaultLicenseMap, d)) | ||
| .peek(d -> d.setInputComponent(context.module())) | ||
| .collect(Collectors.toSet()); | ||
| } | ||
|
|
||
| private Set<Dependency> readLicenseDetailsJson(File licenseDetailsJsonFile) { | ||
| final Set<Dependency> dependencySet = new HashSet<>(); | ||
|
|
||
| try (InputStream fis = new FileInputStream(licenseDetailsJsonFile); | ||
| JsonReader jsonReader = Json.createReader(fis)) { | ||
| JsonObject jo = jsonReader.readObject(); | ||
| JsonArray arr = jo.getJsonArray("dependencies"); | ||
| prepareDependencySet(dependencySet, arr); | ||
| return dependencySet; | ||
| } catch (Exception e) { | ||
| LOGGER.error("Problems reading Swift license file {}: {}", | ||
| licenseDetailsJsonFile.getPath(), e.getMessage()); | ||
| } | ||
| return dependencySet; | ||
| } | ||
|
|
||
| private void prepareDependencySet(Set<Dependency> dependencySet, JsonArray arr) { | ||
| for (javax.json.JsonValue entry : arr) { | ||
| JsonObject jsonDepObj = entry.asJsonObject(); | ||
| String moduleLicense = getModuleLicenseFromJsonObject(jsonDepObj); | ||
| String moduleLicenseUrl = null; | ||
|
|
||
| Dependency dep = new Dependency(jsonDepObj.getString("name", null), | ||
| jsonDepObj.getString("version", null), moduleLicense, LicenseCheckRulesDefinition.LANG_SWIFT); | ||
| dep.setPomPath(moduleLicenseUrl); | ||
| dependencySet.add(dep); | ||
| } | ||
| } | ||
|
|
||
| private String getModuleLicenseFromJsonObject(JsonObject jsonDepObj) { | ||
| String moduleLicense = null; | ||
| JsonArray arrModuleLicenses = jsonDepObj.getJsonArray("licenses"); | ||
| if (arrModuleLicenses != null) { | ||
| moduleLicense = getModuleLicense(arrModuleLicenses); | ||
| } | ||
| return moduleLicense; | ||
| } | ||
|
|
||
| private String getModuleLicense(JsonArray arrModuleLicenses) { | ||
| if (arrModuleLicenses != null && !arrModuleLicenses.isEmpty()) { | ||
| if (arrModuleLicenses.getString(0).equals("unknown")) | ||
| return null; | ||
| return arrModuleLicenses.getString(0); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| } |
33 changes: 33 additions & 0 deletions
33
src/main/java/at/porscheinformatik/sonarqube/licensecheck/utils/LicenseUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| package at.porscheinformatik.sonarqube.licensecheck.utils; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.sonar.api.internal.apachecommons.lang.StringUtils; | ||
| import org.sonar.api.utils.log.Logger; | ||
| import org.sonar.api.utils.log.Loggers; | ||
|
|
||
| import at.porscheinformatik.sonarqube.licensecheck.Dependency; | ||
|
|
||
| public class LicenseUtils { | ||
|
|
||
| private LicenseUtils() {} | ||
|
|
||
| private static final Logger LOGGER = Loggers.get(LicenseUtils.class); | ||
|
|
||
| static public Dependency matchLicense(Map<Pattern, String> licenseMap, Dependency dependency) { | ||
| if (StringUtils.isBlank(dependency.getLicense())) { | ||
| LOGGER.info("Dependency '{}' has no license set.", dependency.getName()); | ||
| return dependency; | ||
| } | ||
|
|
||
| for (Map.Entry<Pattern, String> entry : licenseMap.entrySet()) { | ||
| if (entry.getKey().matcher(dependency.getLicense()).matches()) { | ||
| dependency.setLicense(entry.getValue()); | ||
| break; | ||
| } | ||
| } | ||
| return dependency; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters