com.blackducksoftware.integration.hub.detect.detector.gradle.GradleInspectorExtractor.java Source code

Introduction

Here is the source code for com.blackducksoftware.integration.hub.detect.detector.gradle.GradleInspectorExtractor.java

Source

/**
 * hub-detect
 *
 * Copyright (C) 2019 Black Duck Software, Inc.
 * http://www.blackducksoftware.com/
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.blackducksoftware.integration.hub.detect.detector.gradle;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.blackducksoftware.integration.hub.detect.configuration.DetectConfiguration;
import com.blackducksoftware.integration.hub.detect.configuration.DetectProperty;
import com.blackducksoftware.integration.hub.detect.configuration.PropertyAuthority;
import com.blackducksoftware.integration.hub.detect.util.executable.Executable;
import com.blackducksoftware.integration.hub.detect.util.executable.ExecutableOutput;
import com.blackducksoftware.integration.hub.detect.util.executable.ExecutableRunner;
import com.blackducksoftware.integration.hub.detect.workflow.codelocation.DetectCodeLocation;
import com.blackducksoftware.integration.hub.detect.workflow.extraction.Extraction;
import com.blackducksoftware.integration.hub.detect.workflow.file.DetectFileFinder;
import com.synopsys.integration.util.NameVersion;

public class GradleInspectorExtractor {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    private final ExecutableRunner executableRunner;
    private final DetectFileFinder detectFileFinder;
    private final GradleReportParser gradleReportParser;
    private final DetectConfiguration detectConfiguration;

    public GradleInspectorExtractor(final ExecutableRunner executableRunner,
            final DetectFileFinder detectFileFinder, final GradleReportParser gradleReportParser,
            final DetectConfiguration detectConfiguration) {
        this.executableRunner = executableRunner;
        this.detectFileFinder = detectFileFinder;
        this.gradleReportParser = gradleReportParser;
        this.detectConfiguration = detectConfiguration;
    }

    public Extraction extract(final File directory, final String gradleExe, final String gradleInspector,
            final File outputDirectory) {
        try {
            String gradleCommand = detectConfiguration.getProperty(DetectProperty.DETECT_GRADLE_BUILD_COMMAND,
                    PropertyAuthority.None);

            final List<String> arguments = new ArrayList<>();
            if (StringUtils.isNotBlank(gradleCommand)) {
                gradleCommand = gradleCommand.replaceAll("dependencies", "").trim();
                Arrays.stream(gradleCommand.split(" ")).filter(StringUtils::isNotBlank).forEach(arguments::add);
            }
            arguments.add("dependencies");
            arguments.add(String.format("--init-script=%s", gradleInspector));
            arguments.add(String.format("-DGRADLEEXTRACTIONDIR=%s", outputDirectory.getCanonicalPath()));
            arguments.add("--info");

            final Executable executable = new Executable(directory, gradleExe, arguments);
            final ExecutableOutput output = executableRunner.execute(executable);

            if (output.getReturnCode() == 0) {
                final File rootProjectMetadataFile = detectFileFinder.findFile(outputDirectory,
                        "rootProjectMetadata.txt");
                final List<File> codeLocationFiles = detectFileFinder.findFiles(outputDirectory,
                        "*_dependencyGraph.txt");

                final List<DetectCodeLocation> codeLocations = new ArrayList<>();
                String projectName = null;
                String projectVersion = null;
                if (codeLocationFiles != null) {
                    codeLocationFiles.stream()
                            .map(codeLocationFile -> gradleReportParser.parseDependencies(codeLocationFile))
                            .filter(Optional::isPresent).map(Optional::get).forEach(codeLocations::add);

                    if (rootProjectMetadataFile != null) {
                        final Optional<NameVersion> projectNameVersion = gradleReportParser
                                .parseRootProjectNameVersion(rootProjectMetadataFile);
                        if (projectNameVersion.isPresent()) {
                            projectName = projectNameVersion.get().getName();
                            projectVersion = projectNameVersion.get().getVersion();
                        }
                    } else {
                        logger.warn(
                                "Gradle inspector did not create a meta data report so no project version information was found.");
                    }
                }
                return new Extraction.Builder().success(codeLocations).projectName(projectName)
                        .projectVersion(projectVersion).build();
            } else {
                return new Extraction.Builder()
                        .failure("The gradle inspector returned a non-zero exit code: " + output.getReturnCode())
                        .build();
            }
        } catch (final Exception e) {
            return new Extraction.Builder().exception(e).build();
        }
    }

}