com.thoughtworks.go.plugin.configrepo.contract.material.CRGitMaterial Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of go-plugin-config-repo-experimental Show documentation

The APIs described here are needed for developing pipeline as code plugins for GoCD - A continuous delivery server

The newest version!

/*
 * Copyright 2019 ThoughtWorks, Inc.
 *
 * 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.thoughtworks.go.plugin.configrepo.contract.material;

import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;
import com.thoughtworks.go.plugin.configrepo.contract.ErrorCollection;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;

import java.util.List;

@Getter
@Setter
@EqualsAndHashCode(callSuper = true)
public class CRGitMaterial extends CRScmMaterial {
    public static final String TYPE_NAME = "git";

    @SerializedName("url")
    @Expose
    private String url;
    @SerializedName("branch")
    @Expose
    private String branch;
    @SerializedName("shallow_clone")
    @Expose
    private boolean shallowClone;

    public CRGitMaterial() {
        this(null, null, true, false, null, null, null, null, false);
    }

    public CRGitMaterial(String materialName, String folder, boolean autoUpdate, boolean whitelist, String username, List filters, String url, String branch, boolean shallowClone) {
        super(TYPE_NAME, materialName, folder, autoUpdate, whitelist, username, filters);
        this.url = url;
        this.branch = branch;
        this.shallowClone = shallowClone;
    }

    @Override
    public String typeName() {
        return TYPE_NAME;
    }

    @Override
    public void getErrors(ErrorCollection errors, String parentLocation) {
        String location = getLocation(parentLocation);
        super.getErrors(errors, location);
        getCommonErrors(errors, location);
        errors.checkMissing(location, "url", url);
    }

    @Override
    public String getLocation(String parent) {
        String myLocation = getLocation() == null ? parent : getLocation();
        String name = getName() == null ? "" : getName();
        String url = getUrl() != null ? getUrl() : "unknown";
        return String.format("%s; Git material %s URL: %s", myLocation, name, url);
    }

}