dev.galasa.docker.internal.properties.DockerRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.docker.manager Show documentation

A Galasa project

The newest version!

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.docker.internal.properties;

import java.util.ArrayList;

import dev.galasa.docker.DockerManagerException;
import dev.galasa.framework.spi.ConfigurationPropertyStoreException;
import dev.galasa.framework.spi.cps.CpsProperties;

/**
 * Default Docker Registries CPS Property
 * 
 * @galasa.cps.property
 * 
 * @galasa.name docker.default.registries
 * 
 * @galasa.description An ordered list of Docker Registries IDs to search for Images requested by Galasa Tests
 * 
 * @galasa.required No
 * 
 * @galasa.default If not provided, DOCKERHUB id will be added
 * 
 * @galasa.valid_values A comma separated list of ID.  See CPS property docker.registry.ID
 * 
 * @galasa.examples 
 * docker.default.registries=LOCAL,DOCKERHUB
 * 
 * @galasa.extra
 * To decouple Docker Registries from the Galasa test, this property allows the Docker Manager
 * to search for images. The main reason being if the customer Docker Registry moves, only this property needs 
 * to change, instead of having to change the source code of lots of tests.
 * 

 * 

 * The registries are searched in order when looking for an image. When the image is located, the search stops. 
 * 

 * 

 * If this property is provided in the CPS, the Docker Hub registry is not automatically appended. If it is required, then the DOCKERHUB id must be included.
 * 
 */
public class DockerRegistry extends CpsProperties {

    public static String[] get() throws DockerManagerException {
        ArrayList ids = new ArrayList();
        try {
            String registryIds = getStringNulled(DockerPropertiesSingleton.cps(), "default", "registries");
            if (registryIds != null) {
				String[] list = registryIds.split(",");

				for (String i: list) {
					ids.add(i);
				}
			}
			String central = "DOCKERHUB";
			
			if (ids.isEmpty()) {
				ids.add(central);
			}

            return ids.toArray(new String[ids.size()]);
        } catch (ConfigurationPropertyStoreException e) {
            throw new DockerManagerException("Problem asking the CPS for available registries: " , e);
        }
    }
}