chaschev.util.RevisionInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of chutils Show documentation
There is a newer version: 1.4
package chaschev.util;

import org.slf4j.LoggerFactory;

import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Properties;

/**
 * To use you will need to:
 *
 * 1. Copy build.properties found into filtered resources root to your modules.
 * 2. Add maven buildNumber plugin.
 * 3. Define property ${maven.build.timestamp}
 *
 * @author Andrey Chaschev [email protected]
 */
public class RevisionInfo {
    public static enum Env {
        development, production, test;
        public String concise(){
            switch (this) {
                case development:
                    return "dev";
                case production:
                    return "prod";
                case test:
                    return "test";
            }

            throw new IllegalStateException();
        }
    }

    private static org.slf4j.Logger logger = LoggerFactory.getLogger(RevisionInfo.class);

    private String artifactId;
    private String revision;
    private String version;

    private String buildTimestamp;

    private volatile static RevisionInfo instance;

    private final Class aClass;
    private final Properties props = new Properties();

    private Env env;

    public RevisionInfo() {
        aClass = null;
    }

    private RevisionInfo(Class aClass)

    {
        this.aClass = aClass;
    }

    public RevisionInfo init() {
        final String moduleName = "build";

        InputStream is = null;
        try {

            is = aClass.getResourceAsStream("/" + moduleName + ".properties");
            props.load(is);

            revision = props.getProperty("project.revision");
            version = props.getProperty("project.version");
            buildTimestamp = props.getProperty("project.buildTimestamp");
            artifactId = props.getProperty("project.artifactId");
            env = Env.valueOf(props.getProperty("project.env",  "production"));
        } catch (Exception e) {
            logger.warn("Failed to read " + moduleName + ".properties", e);
            revision = "";
            throw Exceptions.runtime(e);
        }

        return this;
    }

    public String getRevision() {
        return revision;
    }

    public String getVersion() {
        return version;
    }

    public String getBuildTimestamp() {
        return buildTimestamp;
    }

    public String getArtifactId() {
        return artifactId;
    }

    @Override
    public String toString() {
        return String.format("%s v%s-%s r%s %s", artifactId, getEnvironment().concise(), version, revision, getBuildDate());
    }

    public String toShortString() {
        return String.format("%s v%s", artifactId, version);
    }

    public String getBuildDate() {
        if (buildTimestamp.matches("\\d+")) {
            return new SimpleDateFormat().format(new Date(Long.parseLong(buildTimestamp)));
        } else {
            return buildTimestamp;
        }
    }

    public static RevisionInfo get(Class aClass) {
        if (instance == null) {
            synchronized (RevisionInfo.class){
                if(instance == null){
                    instance = new RevisionInfo(aClass).init();
                }
            }
        }

        return instance;
    }

    public boolean isDevelopment(){
        return env == Env.development;
    }

    public boolean isProduction(){
        return env == Env.production;
    }

    public boolean isTest(){
        return env == Env.test;
    }

    public Env getEnvironment() {
        return env;
    }

    public static void main(String[] args) {
        System.out.println(RevisionInfo.get(RevisionInfo.class).toString());
    }
}