All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.exasol.projectkeeper.config.ProjectKeeperRawConfig Maven / Gradle / Ivy

    There is a newer version: 5.0.0
    Show newest version
    package com.exasol.projectkeeper.config;

import static java.util.Collections.emptyList;

import java.util.List;
import java.util.Map;

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

/**
 * Intermediate class for reading the config. This is used by {@link ProjectKeeperConfigReader}.
 * 
    
 * SnakeYML requires this to be public.
 * 
    
 */
public class ProjectKeeperRawConfig {
    private List sources;
    private List linkReplacements;
    private List excludes;
    private Object version;
    private Build build;

    /**
     * Create a new instance.
     */
    public ProjectKeeperRawConfig() {
        // Required for adding Javadoc.
    }

    /**
     * Get the sources.
     * 
     * @return sources
     */
    public List getSources() {
        return sources;
    }

    /**
     * Get link replacements.
     * 
     * @return link replacements
     */
    public List getLinkReplacements() {
        return linkReplacements;
    }

    /**
     * Get the excludes.
     * 
    
     * This is either
     * 
      
     * 
    • a {@link String}, e.g.
     * {@code E-PK-CORE-17: Missing required file: '.github/workflows/project-keeper-verify.yml'}
     * 
    • or a {@link Map} with key {@code regex} and a {@link String} value, e.g.
     * {@code W-PK-CORE-151: Pom file .* contains no reference to project-keeper-maven-plugin.}
     * 
    
     * 
     * @return excludes
     */
    public List getExcludes() {
        return excludes;
    }

    /**
     * Get version.
     * 
    
     * This is either
     * 
      
     * 
    • a {@link String}, e.g. {@code 1.2.3}
     * 
    • or a {@link Map} with key {@code fromSource} and a {@link String} value, e.g. {@code project-keeper/pom.xml}
     * 
    
     * 
     * @return version
     */
    public Object getVersion() {
        return version;
    }

    /**
     * Set sources.
     * 
     * @param sources sources
     */
    public void setSources(final List sources) {
        this.sources = sources;
    }

    /**
     * Set link replacements.
     * 
     * @param linkReplacements link replacements
     */
    public void setLinkReplacements(final List linkReplacements) {
        this.linkReplacements = linkReplacements;
    }

    /**
     * Set excludes.
     * 
     * @param excludes excludes
     */
    public void setExcludes(final List excludes) {
        this.excludes = excludes;
    }

    /**
     * Set version.
     * 
     * @param version version
     */
    public void setVersion(final Object version) {
        this.version = version;
    }

    /**
     * Get the CI build configuration.
     * 
     * @return build options
     */
    public Build getBuild() {
        return build;
    }

    /**
     * Set the CI build options.
     * 
     * @param build build configuration
     */
    public void setBuild(final Build build) {
        this.build = build;
    }

    /**
     * Intermediate class for reading the config sources, i.e. modules or sub-projects.
     * 
    
     * SnakeYML requires this class to be public.
     */
    public static class Source {
        private String path;
        private String type;
        private List modules;
        private boolean advertise = true;
        private ProjectKeeperRawConfig.ParentPomRef parentPom;
        private List artifacts;

        /** Create a new instance. */
        public Source() {
            // Required for specifying Javadoc
        }

        /**
         * Get the source path, e.g. {@code project-keeper/pom.xml}.
         * 
         * @return path
         */
        public String getPath() {
            return path;
        }

        /**
         * Get the source type, e.g. {@code maven}.
         * 
         * @return type
         */
        public String getType() {
            return type;
        }

        /**
         * Get the list of modules enabled for the source, e.g. {@code maven_central}, {@code integration_tests} etc.
         * 
         * @return enabled modules
         */
        public List getModules() {
            return modules;
        }

        /**
         * Check if this source is customer visible and should be advertised.
         * 
         * @return {@code true} if the source should be advertised
         */
        public boolean isAdvertised() {
            return advertise;
        }

        /**
         * Get the referenced parent POM for Maven sources or {@code null} if none is used.
         * 
         * @return parent POM
         */
        public ProjectKeeperRawConfig.ParentPomRef getParentPom() {
            return parentPom;
        }

        /**
         * Set the list of release artifact paths, relative to to {@link #getPath()}, example:
         * {@code target/my-artifact.jar}
         * 
         * @return release artifact paths
         */
        public List getArtifacts() {
            return artifacts;
        }

        /**
         * Set the path.
         * 
         * @param path path
         */
        public void setPath(final String path) {
            this.path = path;
        }

        /**
         * Set the type.
         * 
         * @param type type
         */
        public void setType(final String type) {
            this.type = type;
        }

        /**
         * Set the modules.
         * 
         * @param modules modules
         */
        public void setModules(final List modules) {
            this.modules = modules;
        }

        /**
         * Set the parent POM.
         * 
         * @param parentPom parent POM
         */
        public void setParentPom(final ProjectKeeperRawConfig.ParentPomRef parentPom) {
            this.parentPom = parentPom;
        }

        /**
         * Set the advertise flag.
         * 
         * @param advertise advertise
         */
        public void setAdvertise(final boolean advertise) {
            this.advertise = advertise;
        }

        /**
         * Set the list of release artifact paths, relative to to {@link #getPath()}, example:
         * {@code target/my-artifact.jar}
         * 
         * @param artifacts release artifact paths
         */
        public void setArtifacts(final List artifacts) {
            this.artifacts = artifacts;
        }
    }

    /**
     * Reference to a parent pom of a Maven source.
     * 
    
     * SnakeYML requires this class to be public.
     * 
    
     */
    public static class ParentPomRef {
        private String groupId;
        private String artifactId;
        private String version;
        private String relativePath;

        /**
         * Create a new instance.
         */
        public ParentPomRef() {
            // Required for adding Javadoc.
        }

        /**
         * Get the group ID of the parent POM.
         * 
         * @return group ID
         */
        public String getGroupId() {
            return groupId;
        }

        /**
         * Get the artifact ID of the parent POM.
         * 
         * @return artifact ID
         */
        public String getArtifactId() {
            return artifactId;
        }

        /**
         * Get the version of the parent POM.
         * 
         * @return version
         */
        public String getVersion() {
            return version;
        }

        /**
         * Get the relative path to the parent POM, e.g. {@code ../parent-pom/pom.xml}
         * 
         * @return relative path
         */
        public String getRelativePath() {
            return relativePath;
        }

        /**
         * Set the group ID.
         * 
         * @param groupId group ID
         */
        public void setGroupId(final String groupId) {
            this.groupId = groupId;
        }

        /**
         * Set the artifact ID.
         * 
         * @param artifactId artifact ID
         */
        public void setArtifactId(final String artifactId) {
            this.artifactId = artifactId;
        }

        /**
         * Set the version.
         * 
         * @param version version
         */
        public void setVersion(final String version) {
            this.version = version;
        }

        /**
         * Set the relative path.
         * 
         * @param relativePath relative path.
         */
        public void setRelativePath(final String relativePath) {
            this.relativePath = relativePath;
        }
    }

    /**
     * Intermediate class for de-serializing build options from PK's YAML configuration file
     * {@link ProjectKeeperConfigReader#CONFIG_FILE_NAME}.
     * 
    
     * SnakeYML requires this class to be public.
     */
    @SuppressWarnings("java:S1104") // Only used for serialization, getter/setters not needed
    public static class Build {
        private String runnerOs;
        private boolean freeDiskSpace = false;
        private List exasolDbVersions = emptyList();
        /** Build workflow customizations allow adding and replacing steps in the default build workflow */
        public List workflows = emptyList();

        /**
         * Create a new instance.
         */
        public Build() {
            // Required for adding Javadoc.
        }

        /**
         * Get CI build runner operating system, e.g. {@code ubuntu-20.04}.
         * 
         * @return CI build runner operating system
         */
        public String getRunnerOs() {
            return runnerOs;
        }

        /**
         * Set CI build runner operating system, e.g. {@code ubuntu-20.04}. Default: {@code ubuntu-latest}.
         * 
         * @param runnerOs CI build runner operating system
         */
        public void setRunnerOs(final String runnerOs) {
            this.runnerOs = runnerOs;
        }

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

        /**
         * Set free disk space flag.
         * 
         * @param freeDiskSpace {@code true} if the CI build should free disk space before running the build
         */
        public void setFreeDiskSpace(final boolean freeDiskSpace) {
            this.freeDiskSpace = freeDiskSpace;
        }

        /**
         * Get Exasol DB version.
         * 
         * @return Exasol DB versions for which to run the CI build
         */
        public List getExasolDbVersions() {
            return exasolDbVersions;
        }

        /**
         * Set Exasol DB version.
         * 
         * @param exasolDbVersions Exasol DB versions for which to run the CI build
         */
        public void setExasolDbVersions(final List exasolDbVersions) {
            this.exasolDbVersions = exasolDbVersions;
        }
    }

    /**
     * Intermediate class for de-serializing workflow customizations from PK's YAML configuration file.
     * 
    
     * SnakeYML requires this class to be public.
     */
    @SuppressWarnings("java:S1104") // Only used for serialization, getter/setters not needed
    public static class Workflow {
        /** Create a new instance. */
        public Workflow() {
            // Required for specifying Javadoc
        }

        /** Workflow name, e.g. {@code ci-build.yml} or {@code release.yml}. */
        public String name;
        /** GitHub environment, e.g. {@code aws}. */
        public String environment;
        /** List of customizations for the workflow. */
        public List stepCustomizations;
    }

    /**
     * Intermediate class for de-serializing workflow customizations from PK's YAML configuration file.
     * 
    
     * SnakeYML requires this class to be public.
     */
    @SuppressWarnings("java:S1104") // Only used for serialization, getter/setters not needed
    public static class RawStepCustomization {
        /** Create a new instance. */
        public RawStepCustomization() {
            // Required for specifying Javadoc
        }

        /** ID of the job to customize. */
        public String job;
        /** Customization type (insert/replace). */
        public StepCustomization.Type action;
        /** ID of the step to replace or after which to insert. */
        public String stepId;
        /** The step content to insert/replace. */
        public Map content;
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy