org.jreleaser.engine.distribution.DistributionProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jreleaser-engine Show documentation
JReleaser Engine
There is a newer version: 1.15.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020-2023 The JReleaser 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
 *
 *     https://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 org.jreleaser.engine.distribution;

import org.jreleaser.bundle.RB;
import org.jreleaser.model.Constants;
import org.jreleaser.model.internal.JReleaserContext;
import org.jreleaser.model.internal.distributions.Distribution;
import org.jreleaser.model.internal.packagers.Packager;
import org.jreleaser.model.spi.packagers.PackagerProcessingException;
import org.jreleaser.model.spi.packagers.PackagerProcessor;
import org.jreleaser.mustache.TemplateContext;

import static java.util.Objects.requireNonNull;
import static org.jreleaser.util.StringUtils.requireNonBlank;

/**
 * @author Andres Almiray
 * @since 0.1.0
 */
public class DistributionProcessor {
    private final JReleaserContext context;
    private final String distributionName;
    private final String packagerName;

    private DistributionProcessor(JReleaserContext context,
                                  String distributionName,
                                  String packagerName) {
        this.context = context;
        this.distributionName = distributionName;
        this.packagerName = packagerName;
    }

    public String getDistributionName() {
        return distributionName;
    }

    public String getPackagerName() {
        return packagerName;
    }

    public void prepareDistribution() throws PackagerProcessingException {
        Distribution distribution = context.getModel().findDistribution(distributionName);
        Packager packager = distribution.findPackager(packagerName);
        executeProcessor(distribution, packager, false, RB.$("distributions.action.preparing"),
            packagerProcessor -> packagerProcessor.prepareDistribution(distribution, initProps()));
    }

    public void packageDistribution() throws PackagerProcessingException {
        Distribution distribution = context.getModel().findDistribution(distributionName);
        Packager packager = distribution.findPackager(packagerName);
        executeProcessor(distribution, packager, true, RB.$("distributions.action.packaging"),
            packagerProcessor -> packagerProcessor.packageDistribution(distribution, initProps()));
    }

    public void publishDistribution() throws PackagerProcessingException {
        Distribution distribution = context.getModel().findDistribution(distributionName);
        Packager packager = distribution.findPackager(packagerName);
        executeProcessor(distribution, packager, true, RB.$("distributions.action.publishing"),
            packagerProcessor -> packagerProcessor.publishDistribution(distribution, initProps()));
    }

    private void executeProcessor(Distribution distribution, Packager packager, boolean checkFailed, String action, ProcessorFunction function) throws PackagerProcessingException {
        if (!packager.isEnabled()) {
            context.getLogger().debug(RB.$("distributions.skip.distribution"), distributionName);
            return;
        }

        if (checkFailed && packager.isFailed()) {
            context.getLogger().warn(RB.$("distributions.previous.failure"));
            return;
        }

        PackagerProcessor> packagerProcessor = PackagerProcessors.findProcessor(context, packager);
        if (!packagerProcessor.supportsDistribution(distribution)) {
            context.getLogger().info(RB.$("distributions.not.supported.distribution"), distributionName, distribution.getType());
            return;
        }

        context.getLogger().info(RB.$("distributions.apply.action.distribution"), action, distributionName);

        try {
            function.process(packagerProcessor);
        } catch (PackagerProcessingException ppe) {
            if (packager.isContinueOnError()) {
                packager.fail();
                context.getLogger().warn(RB.$("distributions.failure"), ppe.getMessage());
                context.getLogger().trace(ppe);
            } else {
                throw ppe;
            }
        }
    }

    private TemplateContext initProps() {
        TemplateContext props = context.props();
        props.set(Constants.KEY_PREPARE_DIRECTORY, context.getPrepareDirectory());
        props.set(Constants.KEY_PACKAGE_DIRECTORY, context.getPackageDirectory());
        props.set(Constants.KEY_DISTRIBUTION_PREPARE_DIRECTORY, context.getPrepareDirectory()
            .resolve(distributionName)
            .resolve(packagerName));
        props.set(Constants.KEY_DISTRIBUTION_PACKAGE_DIRECTORY, context.getPackageDirectory()
            .resolve(distributionName)
            .resolve(packagerName));
        return props;
    }

    public static DistributionProcessorBuilder builder() {
        return new DistributionProcessorBuilder();
    }

    interface ProcessorFunction {
        void process(PackagerProcessor> packagerProcessor) throws PackagerProcessingException;
    }

    public static class PackagingAction {
        private final String text;
        private final Type type;
        private final PackagerProcessingFunction function;

        private PackagingAction(String text, Type type, PackagerProcessingFunction function) {
            this.text = text;
            this.type = type;
            this.function = function;
        }

        public String getText() {
            return text;
        }

        public Type getType() {
            return type;
        }

        public PackagerProcessingFunction getFunction() {
            return function;
        }

        public static PackagingAction of(String text, Type type, PackagerProcessingFunction function) {
            return new PackagingAction(text, type, function);
        }

        public enum Type {
            PREPARE,
            PACKAGE,
            PUBLISH
        }
    }

    public static class DistributionProcessorBuilder {
        private JReleaserContext context;
        private String distributionName;
        private String packagerName;

        public DistributionProcessorBuilder context(JReleaserContext context) {
            this.context = requireNonNull(context, "'context' must not be null");
            return this;
        }

        public DistributionProcessorBuilder distributionName(String distributionName) {
            this.distributionName = requireNonBlank(distributionName, "'distributionName' must not be blank");
            return this;
        }

        public DistributionProcessorBuilder packagerName(String packagerName) {
            this.packagerName = requireNonBlank(packagerName, "'packagerName' must not be blank");
            return this;
        }

        public DistributionProcessor build() {
            requireNonNull(context, "'context' must not be null");
            requireNonBlank(distributionName, "'distributionName' must not be blank");
            requireNonBlank(packagerName, "'packagerName' must not be blank");
            return new DistributionProcessor(context, distributionName, packagerName);
        }
    }
}