Examples with EventSystem com.blackducksoftware.integration.hub.detect.workflow.event.EventSystem used on opensource projects

Example 1 with EventSystem

use of com.blackducksoftware.integration.hub.detect.workflow.event.EventSystem in project hub-detect by blackducksoftware.

the class DetectorTool method performDetectors.

public DetectorToolResult performDetectors(SearchOptions searchOptions, String projectBomTool) throws DetectUserFriendlyException {
    logger.info("Preparing to initialize detectors.");
    DetectorFactory detectorFactory = detectContext.getBean(DetectorFactory.class);
    EventSystem eventSystem = detectContext.getBean(EventSystem.class);
    logger.info("Building detector system.");
    DetectorSearchProvider detectorSearchProvider = new DetectorSearchProvider(detectorFactory);
    DetectorSearchEvaluator detectorSearchEvaluator = new DetectorSearchEvaluator();
    SearchManager searchManager = new SearchManager(searchOptions, detectorSearchProvider, detectorSearchEvaluator, eventSystem);
    PreparationManager preparationManager = new PreparationManager(eventSystem);
    ExtractionManager extractionManager = new ExtractionManager();
    DetectorManager detectorManager = new DetectorManager(searchManager, extractionManager, preparationManager, eventSystem);
    logger.info("Running detectors.");
    DetectorToolResult detectorToolResult = detectorManager.runDetectors();
    logger.info("Finished running detectors.");
    eventSystem.publishEvent(Event.DetectorsComplete, detectorToolResult);
    logger.info("Evaluating detectors for project info.");
    DetectorEvaluationNameVersionDecider detectorEvaluationNameVersionDecider = new DetectorEvaluationNameVersionDecider(new DetectorNameVersionDecider());
    Optional<NameVersion> bomToolNameVersion = detectorEvaluationNameVersionDecider.decideSuggestion(detectorToolResult.evaluatedDetectors, projectBomTool);
    detectorToolResult.bomToolProjectNameVersion = bomToolNameVersion;
    logger.info("Finished evaluating detectors for project info.");
    return detectorToolResult;
}

Example 2 with EventSystem

use of com.blackducksoftware.integration.hub.detect.workflow.event.EventSystem in project hub-detect by blackducksoftware.

the class Application method run.

@Override
public void run(final ApplicationArguments applicationArguments) throws Exception {
    final long startTime = System.currentTimeMillis();
    // Events, Status and Exit Codes are required even if boot fails.
    EventSystem eventSystem = new EventSystem();
    DetectStatusManager statusManager = new DetectStatusManager(eventSystem);
    ExitCodeUtility exitCodeUtility = new ExitCodeUtility();
    ExitCodeManager exitCodeManager = new ExitCodeManager(eventSystem, exitCodeUtility);
    ReportManager reportManager = ReportManager.createDefault(eventSystem);
    // Before boot even begins, we create a new Spring context for Detect to work within.
    logger.info("Preparing detect.");
    DetectRun detectRun = DetectRun.createDefault();
    DetectContext detectContext = new DetectContext(detectRun);
    BootResult bootResult = null;
    Optional<RunResult> runResult = Optional.empty();
    try {
        logger.info("Detect boot begin.");
        BootManager bootManager = new BootManager(new BootFactory());
        bootResult = bootManager.boot(detectRun, applicationArguments.getSourceArgs(), environment, eventSystem, detectContext);
        logger.info("Detect boot completed.");
    } catch (final Exception e) {
        logger.error("Detect boot failed.");
        exitCodeManager.requestExitCode(e);
    }
    if (bootResult != null && bootResult.bootType == BootResult.BootType.CONTINUE) {
        logger.info("Detect will attempt to run.");
        RunManager runManager = new RunManager(detectContext);
        try {
            logger.info("Detect run begin: " + detectRun.getRunId());
            runResult = Optional.ofNullable(runManager.run());
            logger.info("Detect run completed.");
        } catch (final Exception e) {
            if (e.getMessage() != null) {
                logger.error("Detect run failed: " + e.getMessage());
            } else {
                logger.error("Detect run failed: " + e.getClass().getSimpleName());
            }
            logger.debug("An exception was thrown during the detect run.", e);
            exitCodeManager.requestExitCode(e);
        }
        try {
            logger.info("Detect will attempt to shutdown.");
            DiagnosticManager diagnosticManager = detectContext.getBean(DiagnosticManager.class);
            DirectoryManager directoryManager = detectContext.getBean(DirectoryManager.class);
            DetectConfiguration detectConfiguration = detectContext.getBean(DetectConfiguration.class);
            ConnectivityManager connectivityManager = detectContext.getBean(ConnectivityManager.class);
            ShutdownManager shutdownManager = new ShutdownManager(connectivityManager, statusManager, exitCodeManager, directoryManager, detectConfiguration, reportManager, diagnosticManager);
            logger.info("Detect shutdown begin.");
            shutdownManager.shutdown(runResult);
            logger.info("Detect shutdown completed.");
        } catch (final Exception e) {
            logger.error("Detect shutdown failed.");
            exitCodeManager.requestExitCode(e);
        }
    } else {
        logger.debug("Detect will NOT attempt to run.");
    }
    logger.info("All detect actions completed.");
    // Determine how detect should actually exit
    boolean printOutput = true;
    boolean shouldForceSuccess = false;
    if (bootResult != null && bootResult.detectConfiguration != null) {
        printOutput = !bootResult.detectConfiguration.getBooleanProperty(DetectProperty.DETECT_SUPPRESS_RESULTS_OUTPUT, PropertyAuthority.None);
        shouldForceSuccess = bootResult.detectConfiguration.getBooleanProperty(DetectProperty.DETECT_FORCE_SUCCESS, PropertyAuthority.None);
    }
    // Generally, when requesting a failure status, an exit code is also requested, but if it is not, we default to an unknown error.
    if (statusManager.hasAnyFailure()) {
        eventSystem.publishEvent(Event.ExitCode, new ExitCodeRequest(ExitCodeType.FAILURE_UNKNOWN_ERROR, "A failure status was requested by one or more of Detect's tools."));
    }
    // Find the final (as requested) exit code
    ExitCodeType finalExitCode = exitCodeManager.getWinningExitCode();
    // Print detect's status
    if (printOutput) {
        reportManager.printDetectorIssues();
        statusManager.logDetectResults(new Slf4jIntLogger(logger), finalExitCode);
    }
    // Print duration of run
    final long endTime = System.currentTimeMillis();
    logger.info(String.format("Detect duration: %s", DurationFormatUtils.formatPeriod(startTime, endTime, "HH'h' mm'm' ss's' SSS'ms'")));
    // Exit with formal exit code
    if (finalExitCode != ExitCodeType.SUCCESS && shouldForceSuccess) {
        logger.warn(String.format("Forcing success: Exiting with exit code 0. Ignored exit code was %s.", finalExitCode.getExitCode()));
        System.exit(0);
    } else if (finalExitCode != ExitCodeType.SUCCESS) {
        logger.error(String.format("Exiting with code %s - %s", finalExitCode.getExitCode(), finalExitCode.toString()));
    }
    System.exit(finalExitCode.getExitCode());
}

Example 3 with EventSystem

use of com.blackducksoftware.integration.hub.detect.workflow.event.EventSystem in project hub-detect by blackducksoftware.

the class RunManager method run.

public RunResult run() throws DetectUserFriendlyException, InterruptedException, IntegrationException {
    // TODO: Better way for run manager to get dependencies so he can be tested. (And better ways of creating his objects)
    final DetectConfiguration detectConfiguration = detectContext.getBean(DetectConfiguration.class);
    final DetectConfigurationFactory detectConfigurationFactory = detectContext.getBean(DetectConfigurationFactory.class);
    final DirectoryManager directoryManager = detectContext.getBean(DirectoryManager.class);
    final EventSystem eventSystem = detectContext.getBean(EventSystem.class);
    final CodeLocationNameManager codeLocationNameManager = detectContext.getBean(CodeLocationNameManager.class);
    final BdioCodeLocationCreator bdioCodeLocationCreator = detectContext.getBean(BdioCodeLocationCreator.class);
    final ConnectionManager connectionManager = detectContext.getBean(ConnectionManager.class);
    final DetectInfo detectInfo = detectContext.getBean(DetectInfo.class);
    final ConnectivityManager connectivityManager = detectContext.getBean(ConnectivityManager.class);
    if (connectivityManager.getPhoneHomeManager().isPresent()) {
        connectivityManager.getPhoneHomeManager().get().startPhoneHome();
    }
    final RunResult runResult = new RunResult();
    final RunOptions runOptions = detectConfigurationFactory.createRunOptions();
    final DetectToolFilter detectToolFilter = runOptions.getDetectToolFilter();
    DetectorEnvironment detectorEnvironment = new DetectorEnvironment(directoryManager.getSourceDirectory(), Collections.emptySet(), 0, null, false);
    DetectorFactory detectorFactory = detectContext.getBean(DetectorFactory.class);
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (detectToolFilter.shouldInclude(DetectTool.DOCKER)) {
        logger.info("Will include the docker tool.");
        ToolRunner toolRunner = new ToolRunner(eventSystem, detectorFactory.createDockerDetector(detectorEnvironment));
        toolRunner.run(runResult);
        logger.info("Docker actions finished.");
    } else {
        logger.info("Docker tool will not be run.");
    }
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (detectToolFilter.shouldInclude(DetectTool.BAZEL)) {
        logger.info("Will include the bazel tool.");
        ToolRunner toolRunner = new ToolRunner(eventSystem, detectorFactory.createBazelDetector(detectorEnvironment));
        toolRunner.run(runResult);
        logger.info("Bazel actions finished.");
    } else {
        logger.info("Bazel tool will not be run.");
    }
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (detectToolFilter.shouldInclude(DetectTool.DETECTOR)) {
        logger.info("Will include the detector tool.");
        final String projectBomTool = detectConfiguration.getProperty(DetectProperty.DETECT_PROJECT_DETECTOR, PropertyAuthority.None);
        final SearchOptions searchOptions = detectConfigurationFactory.createSearchOptions(directoryManager.getSourceDirectory());
        final DetectorTool detectorTool = new DetectorTool(detectContext);
        final DetectorToolResult detectorToolResult = detectorTool.performDetectors(searchOptions, projectBomTool);
        runResult.addToolNameVersionIfPresent(DetectTool.DETECTOR, detectorToolResult.bomToolProjectNameVersion);
        runResult.addDetectCodeLocations(detectorToolResult.bomToolCodeLocations);
        runResult.addApplicableDetectors(detectorToolResult.applicableDetectorTypes);
        if (detectorToolResult.failedDetectorTypes.size() > 0) {
            eventSystem.publishEvent(Event.ExitCode, new ExitCodeRequest(ExitCodeType.FAILURE_DETECTOR, "A detector failed."));
        }
        logger.info("Detector actions finished.");
    } else {
        logger.info("Detector tool will not be run.");
    }
    logger.info(ReportConstants.RUN_SEPARATOR);
    logger.info("Completed code location tools.");
    logger.info("Determining project info.");
    final ProjectNameVersionOptions projectNameVersionOptions = detectConfigurationFactory.createProjectNameVersionOptions(directoryManager.getSourceDirectory().getName());
    final ProjectNameVersionDecider projectNameVersionDecider = new ProjectNameVersionDecider(projectNameVersionOptions);
    final NameVersion projectNameVersion = projectNameVersionDecider.decideProjectNameVersion(runOptions.getPreferredTools(), runResult.getDetectToolProjectInfo());
    logger.info("Project name: " + projectNameVersion.getName());
    logger.info("Project version: " + projectNameVersion.getVersion());
    Optional<ProjectVersionWrapper> projectVersionWrapper = Optional.empty();
    if (connectivityManager.isDetectOnline() && connectivityManager.getBlackDuckServicesFactory().isPresent()) {
        final BlackDuckServicesFactory blackDuckServicesFactory = connectivityManager.getBlackDuckServicesFactory().get();
        logger.info("Getting or creating project.");
        final DetectProjectServiceOptions options = detectConfigurationFactory.createDetectProjectServiceOptions();
        final DetectProjectMappingService detectProjectMappingService = new DetectProjectMappingService(blackDuckServicesFactory.createBlackDuckService());
        final DetectProjectService detectProjectService = new DetectProjectService(blackDuckServicesFactory, options, detectProjectMappingService);
        projectVersionWrapper = Optional.of(detectProjectService.createOrUpdateHubProject(projectNameVersion, options.getApplicationId()));
        if (projectVersionWrapper.isPresent() && runOptions.shouldUnmapCodeLocations()) {
            logger.info("Unmapping code locations.");
            final DetectCodeLocationUnmapService detectCodeLocationUnmapService = new DetectCodeLocationUnmapService(blackDuckServicesFactory.createBlackDuckService(), blackDuckServicesFactory.createCodeLocationService());
            detectCodeLocationUnmapService.unmapCodeLocations(projectVersionWrapper.get().getProjectVersionView());
        } else {
            logger.debug("Will not unmap code locations: Project view was not present, or should not unmap code locations.");
        }
    } else {
        logger.debug("Detect is not online, and will not create the project.");
    }
    logger.info("Completed project and version actions.");
    logger.info("Processing Detect Code Locations.");
    final CodeLocationWaitData codeLocationWaitData = new CodeLocationWaitData();
    final BdioManager bdioManager = new BdioManager(detectInfo, new SimpleBdioFactory(), new IntegrationEscapeUtil(), codeLocationNameManager, detectConfiguration, bdioCodeLocationCreator, directoryManager, eventSystem);
    final BdioResult bdioResult = bdioManager.createBdioFiles(runOptions.getAggregateName(), projectNameVersion, runResult.getDetectCodeLocations());
    if (bdioResult.getUploadTargets().size() > 0) {
        logger.info("Created " + bdioResult.getUploadTargets().size() + " BDIO files.");
        bdioResult.getUploadTargets().forEach(it -> eventSystem.publishEvent(Event.OutputFileOfInterest, it.getUploadFile()));
        if (connectivityManager.isDetectOnline() && connectivityManager.getBlackDuckServicesFactory().isPresent()) {
            logger.info("Uploading BDIO files.");
            final BlackDuckServicesFactory blackDuckServicesFactory = connectivityManager.getBlackDuckServicesFactory().get();
            final DetectBdioUploadService detectBdioUploadService = new DetectBdioUploadService(detectConfiguration, blackDuckServicesFactory.createBdioUploadService(), eventSystem);
            final CodeLocationCreationData<UploadBatchOutput> uploadBatchOutputCodeLocationCreationData = detectBdioUploadService.uploadBdioFiles(bdioResult.getUploadTargets());
            codeLocationWaitData.setFromBdioCodeLocationCreationData(uploadBatchOutputCodeLocationCreationData);
        }
    } else {
        logger.debug("Did not create any BDIO files.");
    }
    logger.info("Completed Detect Code Location processing.");
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (detectToolFilter.shouldInclude(DetectTool.SIGNATURE_SCAN)) {
        logger.info("Will include the signature scanner tool.");
        final BlackDuckSignatureScannerOptions blackDuckSignatureScannerOptions = detectConfigurationFactory.createBlackDuckSignatureScannerOptions();
        final BlackDuckSignatureScannerTool blackDuckSignatureScannerTool = new BlackDuckSignatureScannerTool(blackDuckSignatureScannerOptions, detectContext);
        final SignatureScannerToolResult signatureScannerToolResult = blackDuckSignatureScannerTool.runScanTool(projectNameVersion, runResult.getDockerTar());
        if (signatureScannerToolResult.getResult() == Result.SUCCESS && signatureScannerToolResult.getCreationData().isPresent()) {
            codeLocationWaitData.setFromSignatureScannerCodeLocationCreationData(signatureScannerToolResult.getCreationData().get());
        }
        logger.info("Signature scanner actions finished.");
    } else {
        logger.info("Signature scan tool will not be run.");
    }
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (detectToolFilter.shouldInclude(DetectTool.BINARY_SCAN)) {
        logger.info("Will include the binary scanner tool.");
        if (connectivityManager.isDetectOnline() && connectivityManager.getBlackDuckServicesFactory().isPresent()) {
            final BlackDuckServicesFactory blackDuckServicesFactory = connectivityManager.getBlackDuckServicesFactory().get();
            final BlackDuckBinaryScannerTool blackDuckBinaryScanner = new BlackDuckBinaryScannerTool(eventSystem, codeLocationNameManager, detectConfiguration, blackDuckServicesFactory);
            BinaryScanToolResult result = blackDuckBinaryScanner.performBinaryScanActions(projectNameVersion);
            if (result.isSuccessful()) {
                codeLocationWaitData.setFromBinaryScan(result.getNotificationTaskRange(), result.getCodeLocationNames());
            }
        }
        logger.info("Binary scanner actions finished.");
    } else {
        logger.info("Binary scan tool will not be run.");
    }
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (detectToolFilter.shouldInclude(DetectTool.POLARIS)) {
        logger.info("Will include the Polaris tool.");
        final PolarisTool polarisTool = new PolarisTool(eventSystem, directoryManager, new ExecutableRunner(), connectionManager);
        polarisTool.runPolaris(new Slf4jIntLogger(logger), directoryManager.getSourceDirectory());
        logger.info("Polaris actions finished.");
    } else {
        logger.info("Polaris CLI tool will not be run.");
    }
    logger.info(ReportConstants.RUN_SEPARATOR);
    if (projectVersionWrapper.isPresent() && connectivityManager.isDetectOnline() && connectivityManager.getBlackDuckServicesFactory().isPresent()) {
        final BlackDuckServicesFactory blackDuckServicesFactory = connectivityManager.getBlackDuckServicesFactory().get();
        logger.info("Will perform Black Duck post actions.");
        final BlackduckReportOptions blackduckReportOptions = detectConfigurationFactory.createReportOptions();
        final PolicyCheckOptions policyCheckOptions = detectConfigurationFactory.createPolicyCheckOptions();
        final long timeoutInSeconds = detectConfigurationFactory.getTimeoutInSeconds();
        final BlackduckPostActions blackduckPostActions = new BlackduckPostActions(blackDuckServicesFactory, eventSystem);
        blackduckPostActions.perform(blackduckReportOptions, policyCheckOptions, codeLocationWaitData, projectVersionWrapper.get(), timeoutInSeconds);
        final boolean hasAtLeastOneBdio = !bdioResult.getUploadTargets().isEmpty();
        final boolean shouldHaveScanned = detectToolFilter.shouldInclude(DetectTool.SIGNATURE_SCAN);
        if (hasAtLeastOneBdio || shouldHaveScanned) {
            final Optional<String> componentsLink = projectVersionWrapper.get().getProjectVersionView().getFirstLink(ProjectVersionView.COMPONENTS_LINK);
            if (componentsLink.isPresent()) {
                logger.info(String.format("To see your results, follow the URL: %s", componentsLink.get()));
            }
        }
        logger.info("Black Duck actions have finished.");
    } else {
        logger.debug("Will not perform post actions: Detect is not online.");
    }
    logger.info("All tools have finished.");
    logger.info(ReportConstants.RUN_SEPARATOR);
    return runResult;
}