Examples with LicenseChecker org.eclipse.dash.licenses.LicenseChecker used on opensource projects

Example 1 with LicenseChecker

use of org.eclipse.dash.licenses.LicenseChecker in project dash-licenses by eclipse.

the class Main method main.

public static void main(String[] args) {
    CommandLineSettings settings = CommandLineSettings.getSettings(args);
    if (!settings.isValid()) {
        CommandLineSettings.printUsage(System.out);
        System.exit(1);
    }
    if (settings.isShowHelp()) {
        CommandLineSettings.printHelp(System.out);
        System.exit(0);
    }
    Injector injector = Guice.createInjector(new LicenseToolModule(settings));
    LicenseChecker checker = injector.getInstance(LicenseChecker.class);
    List<IResultsCollector> collectors = new ArrayList<>();
    // TODO Set up collectors based on command line parameters
    IResultsCollector primaryCollector = new NeedsReviewCollector();
    collectors.add(primaryCollector);
    String summaryPath = settings.getSummaryFilePath();
    if (summaryPath != null) {
        try {
            collectors.add(new CSVCollector(getWriter(summaryPath)));
        } catch (FileNotFoundException e1) {
            System.out.println("Can't write to " + summaryPath);
            System.exit(1);
        }
    }
    if (settings.isReview()) {
        collectors.add(new CreateReviewRequestCollector(injector.getInstance(GitLabSupport.class), (id, url) -> {
        }));
    }
    Arrays.stream(settings.getFileNames()).forEach(name -> {
        IDependencyListReader reader = null;
        try {
            reader = getReader(name);
        } catch (FileNotFoundException e) {
            System.out.println(String.format("The file \"%s\" does not exist.", name));
            CommandLineSettings.printUsage(System.out);
            System.exit(1);
        }
        if (reader != null) {
            Collection<IContentId> dependencies = reader.getContentIds();
            checker.getLicenseData(dependencies).forEach((id, licenseData) -> {
                collectors.forEach(collector -> collector.accept(licenseData));
            });
        }
    });
    collectors.forEach(IResultsCollector::close);
    System.exit(primaryCollector.getStatus());
}

Example 2 with LicenseChecker

use of org.eclipse.dash.licenses.LicenseChecker in project dash-licenses by eclipse.

the class LicenseToolModule method configure.

@Override
protected void configure() {
    bind(ISettings.class).toInstance(settings);
    bind(LicenseChecker.class).toInstance(new LicenseChecker());
    bind(EclipseFoundationSupport.class).toInstance(new EclipseFoundationSupport());
    bind(ClearlyDefinedSupport.class).toInstance(new ClearlyDefinedSupport());
    bind(LicenseSupport.class).toInstance(new LicenseSupport());
    bind(GitLabSupport.class).toInstance(new GitLabSupport());
    bind(IHttpClientService.class).toInstance(new HttpClientService());
    bind(ExtendedContentDataService.class).toInstance(new ExtendedContentDataService());
    bind(IProxySettings.class).toProvider(Providers.of(proxySettings));
    Multibinder<IExtendedContentDataProvider> extendedContentDataProviders = Multibinder.newSetBinder(binder(), IExtendedContentDataProvider.class);
    extendedContentDataProviders.addBinding().to(NpmjsExtendedContentDataProvider.class);
    extendedContentDataProviders.addBinding().to(MavenCentralExtendedContentDataProvider.class);
    extendedContentDataProviders.addBinding().to(PypiExtendedContentDataProvider.class);
    extendedContentDataProviders.addBinding().to(GitHubExtendedContentDataProvider.class);
// classifierBinder.addBinding().to(GithubDataProvider.class);
}

Example 3 with LicenseChecker

use of org.eclipse.dash.licenses.LicenseChecker in project dash-licenses by eclipse.

the class TestLicenseToolModule method configure.

@Override
protected void configure() {
    bind(ISettings.class).toInstance(settings);
    bind(IHttpClientService.class).toInstance(getHttpClientService());
    bind(LicenseChecker.class).toInstance(new LicenseChecker());
    bind(EclipseFoundationSupport.class).toInstance(new EclipseFoundationSupport());
    bind(ClearlyDefinedSupport.class).toInstance(new ClearlyDefinedSupport());
    bind(LicenseSupport.class).toInstance(new LicenseSupport());
    bind(ExtendedContentDataService.class).toInstance(new ExtendedContentDataService());
    Multibinder<IExtendedContentDataProvider> classifierBinder = Multibinder.newSetBinder(binder(), IExtendedContentDataProvider.class);
    classifierBinder.addBinding().to(NpmjsExtendedContentDataProvider.class);
    classifierBinder.addBinding().to(MavenCentralExtendedContentDataProvider.class);
    classifierBinder.addBinding().to(PypiExtendedContentDataProvider.class);
// classifierBinder.addBinding().to(GithubDataProvider.class);
}

Example 4 with LicenseChecker

use of org.eclipse.dash.licenses.LicenseChecker in project dash-licenses by eclipse.

the class LicenseCheckMojo method execute.

@Override
public void execute() throws MojoExecutionException, MojoFailureException {
    // top-level reactor project and avoids duplicate invokations
    if (!mavenSession.getCurrentProject().equals(mavenSession.getTopLevelProject())) {
        return;
    }
    if (skip) {
        getLog().info("Skipping dependency license check");
        return;
    }
    // Validate the user-given dash license tool settings
    ISettings settings;
    try {
        settings = new MavenSettings(batch, foundationApi, clearlyDefinedApi, licenses, confidence, projectId, iplabToken);
    } catch (IllegalArgumentException e) {
        throw new MojoExecutionException("Invalid setting: " + e.getMessage());
    }
    // Get filtered list of project dependencies for all modules in the reactor
    Set<Artifact> filteredArtifacts = new HashSet<>();
    for (MavenProject project : reactorProjects) {
        filteredArtifacts.addAll(filterArtifacts(project.getArtifacts()));
    }
    if (getLog().isDebugEnabled()) {
        getLog().debug("Filtered dependency artifact list:");
        filteredArtifacts.stream().sorted().map(a -> "  " + a).forEach(getLog()::debug);
    }
    // Adapt dependency artifacts to dash content IDs
    List<IContentId> deps = new ArrayList<>();
    filteredArtifacts.stream().sorted().forEach(a -> {
        String type = a.getGroupId().startsWith(TychoConstants.P2_GROUPID_PREFIX) ? "p2" : "maven";
        // TODO deps are not necessarily from orbit or maven central
        String source = a.getGroupId().startsWith(TychoConstants.P2_GROUPID_PREFIX) ? "orbit" : "mavencentral";
        // TODO could get duplicates here if two artifact coords differ only by
        // classifier
        deps.add(ContentId.getContentId(type, source, a.getGroupId(), a.getArtifactId(), a.getVersion()));
    });
    List<IResultsCollector> collectors = new ArrayList<>();
    // This collector generates feedback for the user that the command line tool
    // would always print to stdout, so we collect the output in memory for printing
    // to the maven log later
    ByteArrayOutputStream primaryOut = new ByteArrayOutputStream();
    NeedsReviewCollector needsReviewCollector = new NeedsReviewCollector();
    collectors.add(needsReviewCollector);
    Injector injector = Guice.createInjector(new LicenseToolModule(settings, createProxySettings()));
    LicenseChecker checker = injector.getInstance(LicenseChecker.class);
    summary.getParentFile().mkdirs();
    reviewSummary.getParentFile().mkdirs();
    try (OutputStream summaryOut = new FileOutputStream(summary);
        PrintWriter reviewSummaryOut = new PrintWriter(new FileWriter(reviewSummary))) {
        collectors.add(new CSVCollector(summaryOut));
        if (iplabToken != null && projectId != null) {
            collectors.add(new CreateReviewRequestCollector(injector.getInstance(GitLabSupport.class), (id, url) -> reviewSummaryOut.println("[" + id + "](" + url + ")")));
        } else if (iplabToken != null) {
            getLog().info("Provide both an authentication token and a project id to automatically create review tickets.");
        }
        for (LicenseData licenseData : checker.getLicenseData(deps).values()) {
            collectors.forEach(c -> c.accept(licenseData));
        }
        collectors.forEach(IResultsCollector::close);
    } catch (IOException e) {
        throw new MojoExecutionException("Can't write dependency summary file", e);
    }
    // Pass the output from the collectors to the maven log
    primaryOut.toString(StandardCharsets.UTF_8).lines().forEach(getLog()::info);
    getLog().info("Summary file was written to: " + summary);
    if (failWhenReviewNeeded && needsReviewCollector.getStatus() > 0) {
        getLog().error("Dependency license check failed. Some dependencies need to be vetted.");
        throw new MojoFailureException("Some dependencies must be vetted.");
    }
}

Example 5 with LicenseChecker

use of org.eclipse.dash.licenses.LicenseChecker in project dash-licenses by eclipse.

the class LicenseCheckerTests method setup.

@BeforeEach
void setup() {
    Injector injector = Guice.createInjector(new TestLicenseToolModule());
    licenseChecker = injector.getInstance(LicenseChecker.class);
}