com.metaeffekt.artifact.analysis.mojo.ScanFolderMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ae-artifact-analysis-plugin Show documentation
The newest version!
/*
 * Copyright 2021-2024 the original author or authors.
 *
 * Licensed 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.metaeffekt.artifact.analysis.mojo;

import com.metaeffekt.artifact.analysis.flow.ObserveFolderFlow;
import com.metaeffekt.artifact.analysis.flow.ObserveFolderFlowParam;
import com.metaeffekt.artifact.analysis.flow.ScanConsumer;
import com.metaeffekt.artifact.analysis.flow.ScanFlowParam;
import com.metaeffekt.artifact.analysis.maven.AbstractTermsMetaDataBasedMojo;
import com.metaeffekt.artifact.analysis.model.DefaultPropertyProvider;
import com.metaeffekt.artifact.analysis.utils.FileUtils;
import com.metaeffekt.artifact.analysis.utils.PropertyUtils;
import com.metaeffekt.artifact.terms.model.LicenseTextProvider;
import com.metaeffekt.artifact.terms.model.NormalizationMetaData;
import com.metaeffekt.resource.InventoryDirResource;
import com.metaeffekt.resource.InventoryResource;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import java.io.File;
import java.util.Properties;
import java.util.function.Consumer;

/**
 * Scans the folder for scan inputs.
 */
@Mojo(name = "scan-folder", defaultPhase = LifecyclePhase.PROCESS_RESOURCES)
public class ScanFolderMojo extends AbstractTermsMetaDataBasedMojo {

    @Parameter(defaultValue = "${project.basedir}/.input")
    private File inputDir;

    @Parameter(defaultValue = "${project.basedir}/.analysis")
    private File analysisDir;

    @Parameter(defaultValue = "${project.basedir}/.analysis/tmp")
    private File tmpBaseDir;

    @Parameter(defaultValue = "${project.basedir}/.analysis/status")
    private File statusBaseDir;

    @Parameter(defaultValue = "${project.basedir}/.output")
    private File outputDir;

    @Parameter(defaultValue = "src/analysis/scan-control.properties")
    private File scanControlPropertiesFile;

    @Parameter(defaultValue = "10")
    private int delayInSeconds;

    /**
     * The reference inventory directory.
     */
    @Parameter(required = true)
    private File referenceInventoryDir;

    /**
     * The includes pattern to match the inventory files against.

     * By default, this is all .xls files in the inventory directory.
     */
    @Parameter(defaultValue = "inventory/*.xls*")
    private String referenceInventoryIncludes;

    @Override
    protected void doRun() throws Exception {
        final NormalizationMetaData normalizationMetaData = getNormalizationMetaData();
        final LicenseTextProvider licenseTextProvider = getLicenseTextProvider();

        // create property provider
        final DefaultPropertyProvider propertyProvider = new DefaultPropertyProvider();
        final Properties properties = PropertyUtils.loadProperties(scanControlPropertiesFile);
        propertyProvider.putAll(properties);

        // initialize template for ScanFlowParams
        final ScanFlowParam scanFlowParamTemplate = ScanFlowParam.build()
                .using(normalizationMetaData)
                .using(licenseTextProvider)
                .using(analysisDir)
                .configuredBy(propertyProvider);

        final File tmpBaseDir = new File(analysisDir, "tmp");
        final File statusBaseDir = new File(analysisDir, "status");

        final InventoryResource referenceInventoryResource =
                InventoryDirResource.attach(referenceInventoryDir, referenceInventoryIncludes);

        final Consumer consumer = new ScanConsumer(
                analysisDir, tmpBaseDir, outputDir,
                referenceInventoryResource, scanFlowParamTemplate);

        final ObserveFolderFlowParam param = new ObserveFolderFlowParam(inputDir, statusBaseDir, tmpBaseDir, consumer);

        FileUtils.forceMkdir(param.getObservationDir());

        FileUtils.deleteDirectory(param.getTmpBaseDir());
        FileUtils.forceMkdir(param.getTmpBaseDir());

        new ObserveFolderFlow().process(param);
    }

}