com.metaeffekt.artifact.analysis.mojo.ExecuteWorkbenchMojo 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.maven.AbstractTermsMetaDataBasedMojo;
import com.metaeffekt.artifact.analysis.workbench.WorkbenchExecution;
import com.metaeffekt.artifact.terms.model.LicenseTextProvider;
import com.metaeffekt.artifact.terms.model.NormalizationMetaData;
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;

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

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

    @Parameter(defaultValue = "src/analysis/workbench.properties")
    private File workbenchControlPropertiesFile;

    /**
     * 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();

        final WorkbenchExecution workbenchExecution =
                new WorkbenchExecution(normalizationMetaData, licenseTextProvider,
                    workbenchBaseDir, workbenchControlPropertiesFile);
        workbenchExecution.configureReferenceInventory(referenceInventoryDir, referenceInventoryIncludes);

        workbenchExecution.executeWorkbench();
    }

}