com.exasol.projectkeeper.shared.config.BuildOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of project-keeper-shared-model-classes Show documentation
Classes that need to be shared between different modules of project-keeper.
The newest version!
package com.exasol.projectkeeper.shared.config;

import static java.util.Collections.emptyList;
import static java.util.Collections.unmodifiableList;

import java.util.*;

import com.exasol.projectkeeper.shared.config.workflow.CustomWorkflow;

/**
 * CI build configuration.
 */
public final class BuildOptions {
    private static final String DEFAULT_RUNNER_OS = "ubuntu-latest";

    private final String runnerOs;
    private final boolean freeDiskSpace;
    private final List exasolDbVersions;
    private final List workflows;

    private BuildOptions(final Builder builder) {
        this.runnerOs = Objects.requireNonNull(builder.runnerOs, "runnerOs");
        this.freeDiskSpace = builder.freeDiskSpace;
        this.exasolDbVersions = unmodifiableList(Objects.requireNonNull(builder.exasolDbVersions, "exasolDbVersions"));
        this.workflows = builder.workflows;
    }

    /**
     * Get runner OS.
     * 
     * @return CI build runner operating system
     */
    public String getRunnerOs() {
        return this.runnerOs;
    }

    /**
     * Check if the build should free disk space.
     * 
     * @return {@code true} if disk space should be freed before running the build
     */
    public boolean shouldFreeDiskSpace() {
        return freeDiskSpace;
    }

    /**
     * Exasol DB versions for which to run the CI build. If the list is empty, no Matrix build will be used.
     *
     * @return Exasol DB versions for which to run the build
     */
    public List getExasolDbVersions() {
        return exasolDbVersions;
    }

    /**
     * Configuration options for the generated GitHub workflows.
     *
     * @return options for workflows
     */
    public List getWorkflows() {
        return workflows;
    }

    /**
     * Get workflow options by name.
     * 
     * @param workflowName name of the workflow
     * @return workflow options
     */
    public Optional getWorkflow(final String workflowName) {
        return workflows.stream() //
                .filter(workflow -> workflow.getWorkflowName().equals(workflowName)) //
                .findFirst();
    }

    /**
     * Creates builder to build {@link BuildOptions}.
     *
     * @return created builder
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Builder to build {@link BuildOptions}.
     */
    public static final class Builder {
        private List exasolDbVersions = emptyList();
        private boolean freeDiskSpace = false;
        private String runnerOs = DEFAULT_RUNNER_OS;
        private List workflows = emptyList();

        private Builder() {
        }

        /**
         * CI build runner operating system, e.g. {@code ubuntu-latest}.
         *
         * @param runnerOs runner operating system
         * @return {@code this} for fluent programming
         */
        public Builder runnerOs(final String runnerOs) {
            if (runnerOs != null) {
                this.runnerOs = runnerOs;
            }
            return this;
        }

        /**
         * Some builds need more disk space, e.g. for Docker images. If this is {@code true}, the CI build will free up
         * disk space before running the actual build. This will slow down the build about one minute.
         *
         * @param freeDiskSpace {@code true} if the CI build should free up disk space
         * @return {@code this} for fluent programming
         */
        public Builder freeDiskSpace(final boolean freeDiskSpace) {
            this.freeDiskSpace = freeDiskSpace;
            return this;
        }

        /**
         * Run the CI build as a matrix build using the given Exasol DB versions. Sonar will only be run using the first
         * version in the list. If the list is empty, no Matrix build will be used.
         *
         * @param exasolDbVersions Exasol DB versions for which to run the build
         * @return {@code this} for fluent programming
         */
        public Builder exasolDbVersions(final List exasolDbVersions) {
            if (exasolDbVersions != null) {
                this.exasolDbVersions = exasolDbVersions;
            }
            return this;
        }

        /**
         * Set configuration options for generated GitHub workflows.
         *
         * @param workflows options for workflows
         * @return {@code this} for fluent programming
         */
        public Builder workflows(final List workflows) {
            if (workflows != null) {
                this.workflows = workflows;
            }
            return this;
        }

        /**
         * Build a new {@link BuildOptions}.
         *
         * @return built class
         */
        public BuildOptions build() {
            return new BuildOptions(this);
        }
    }

    @Override
    public String toString() {
        return "BuildOptions [runnerOs=" + runnerOs + ", freeDiskSpace=" + freeDiskSpace + ", exasolDbVersions="
                + exasolDbVersions + ", workflows=" + workflows + "]";
    }

    @Override
    public int hashCode() {
        return Objects.hash(runnerOs, freeDiskSpace, exasolDbVersions, workflows);
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final BuildOptions other = (BuildOptions) obj;
        return Objects.equals(runnerOs, other.runnerOs) && freeDiskSpace == other.freeDiskSpace
                && Objects.equals(exasolDbVersions, other.exasolDbVersions)
                && Objects.equals(workflows, other.workflows);
    }
}