org.technologybrewery.habushu.RetrieveWheelsMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of habushu-maven-plugin Show documentation
Leverages Poetry and Pyenv to provide an automated, predictable order of execution of build commands that apply DevOps and configuration management best practices
The newest version!
package org.technologybrewery.habushu;

import java.io.File;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.technologybrewery.habushu.util.HabushuUtil;

/**
 * Helper mojo that handles the retrieving of wheel artifacts from poetry
 * cache by artifactId and into a given targetDirectory during the 
 * {@link LifecyclePhase#VALIDATE} build phase. 
 *
 * @param wheelDependencies A List of Wheel Dependencies which will identify wheel 
 *                          files by {@WheelDependency.artifactId} in poetry cache and place them into 
 *                          a given {@WheelDependency.targetDirectory}. This logic specifically targets
 *                          wheel artifacts cached by the {@param cacheWheels} parameter and REQUIRES 
 *                          the requested wheel to have first been cached prior to setting this config
 * @throws HabushuException
 * @deprecated This mojo is deprecated, use the containerize-dependencies goal instead
 */
@Deprecated
@Mojo(name = "retrieve-wheels", defaultPhase = LifecyclePhase.VALIDATE)
public class RetrieveWheelsMojo extends AbstractHabushuMojo {
    /**
    * A List of Wheel Dependencies to retrieve from poetry cache. 
    */    
    @Parameter(property = "habushu.wheelDependencies", required = false)
    protected List wheelDependencies;

    /**
    * Overriding to allow execution in non-habushu projects
    */      
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        doExecute();
    }    

    @Override
    public void doExecute() throws MojoExecutionException, MojoFailureException {
        getLog().warn("The cache-wheels goal has been deperecated," +
                "please see the containerize-dependencies goal instead." );
        if (!wheelDependencies.isEmpty()) {
            processWheelDependencies();
        }
    }

    protected void processWheelDependencies() {
        getLog().info(String.format("Processing %s Wheel Dependencies..", wheelDependencies.size()));
        try {
            for (WheelDependency wd : wheelDependencies) {
                File poetryCacheWheelDirectory = getCachedWheelDirectory(wd.getArtifactId());
                String targetDirectory = wd.getTargetDirectory();

                if (poetryCacheWheelDirectory.exists()) {
                    List wheelFiles = Stream.of(poetryCacheWheelDirectory.listFiles())
                            .filter(file -> file.getAbsolutePath().endsWith(".whl"))
                            .map(File::getAbsoluteFile)
                            .collect(Collectors.toList());

                    if (wheelFiles.size()==0) {
                        getLog().warn(String.format("Did not find any %s wheels in poetry cache.", wd.getArtifactId()));
                        getLog().warn("Consider using the `cacheWheel` configuration to cache the wheel artifact before depending on it.");
                    } else {
                        for (File file : wheelFiles) {
                            HabushuUtil.copyFile(file.getPath(), String.format("%s/%s", targetDirectory, file.getName()));
                            getLog().info(String.format("Retrieved the cached %s file", file.getName()));
                        }
                    }         
                } else{
                    getLog().warn(String.format("Could not locate %s in poetry cache.", wd.getArtifactId()));
                    getLog().warn("Consider using the `cacheWheel` configuration to cache the wheel artifact before depending on it.");
                }
            }
        } catch (Exception e) {
            throw new HabushuException("Could not process Wheel Dependencies!", e);
        }
    }

    protected File getProjectBuildDirectory() {
        return new File(project.getBuild().getDirectory());
    }
}