com.netflix.spinnaker.halyard.config.validate.v1.providers.dockerRegistry.DockerRegistryAccountValidator.java Source code

Introduction

Here is the source code for com.netflix.spinnaker.halyard.config.validate.v1.providers.dockerRegistry.DockerRegistryAccountValidator.java

Source

/*
 * Copyright 2016 Google, 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.netflix.spinnaker.halyard.config.validate.v1.providers.dockerRegistry;

import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.client.DockerRegistryCatalog;
import com.netflix.spinnaker.clouddriver.docker.registry.security.DockerRegistryNamedAccountCredentials;
import com.netflix.spinnaker.halyard.config.model.v1.node.Validator;
import com.netflix.spinnaker.halyard.config.model.v1.providers.dockerRegistry.DockerRegistryAccount;
import com.netflix.spinnaker.halyard.config.problem.v1.ConfigProblemBuilder;
import com.netflix.spinnaker.halyard.config.problem.v1.ConfigProblemSetBuilder;
import com.netflix.spinnaker.halyard.config.validate.v1.util.ValidatingFileReader;
import com.netflix.spinnaker.halyard.core.problem.v1.Problem.Severity;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Component;

@Component
public class DockerRegistryAccountValidator extends Validator<DockerRegistryAccount> {
    @Override
    public void validate(ConfigProblemSetBuilder p, DockerRegistryAccount n) {
        String resolvedPassword = null;
        String password = n.getPassword();
        String passwordFile = n.getPasswordFile();
        String username = n.getUsername();

        boolean passwordProvided = password != null && !password.isEmpty();
        boolean passwordFileProvided = passwordFile != null && !passwordFile.isEmpty();

        if (passwordProvided && passwordFileProvided) {
            p.addProblem(Severity.ERROR,
                    "You have provided both a password and a password file for your docker registry. You can specify at most one.");
            return;
        }

        if (passwordProvided) {
            resolvedPassword = password;
        } else if (passwordFileProvided) {
            resolvedPassword = ValidatingFileReader.contents(p, passwordFile);
            if (resolvedPassword == null) {
                return;
            }

            if (resolvedPassword.isEmpty()) {
                p.addProblem(Severity.WARNING, "The supplied password file is empty.");
            }
        } else {
            resolvedPassword = "";
        }

        if (!resolvedPassword.isEmpty()) {
            if (username == null || username.isEmpty()) {
                p.addProblem(Severity.WARNING, "You have supplied a password but no username.");
            }
        } else {
            if (username != null && !username.isEmpty()) {
                p.addProblem(Severity.WARNING, "You have a supplied a username but no password.");
            }
        }

        DockerRegistryNamedAccountCredentials credentials;
        try {
            credentials = (new DockerRegistryNamedAccountCredentials.Builder()).accountName(n.getName())
                    .address(n.getAddress()).email(n.getEmail()).password(n.getPassword())
                    .passwordFile(n.getPasswordFile()).dockerconfigFile(n.getDockerconfigFile())
                    .username(n.getUsername()).build();
        } catch (Exception e) {
            p.addProblem(Severity.ERROR,
                    "Failed to instantiate docker credentials for account \"" + n.getName() + "\".");
            return;
        }

        ConfigProblemBuilder authFailureProblem = null;
        if (n.getRepositories() == null || n.getRepositories().size() == 0) {
            try {
                DockerRegistryCatalog catalog = credentials.getCredentials().getClient().getCatalog();

                if (catalog.getRepositories() == null || catalog.getRepositories().size() == 0) {
                    p.addProblem(Severity.ERROR,
                            "Your docker registry has no repositories specified, and the registry's catalog is empty.")
                            .setRemediation(
                                    "Manually specify some repositories for this docker registry to index.");
                }
            } catch (Exception e) {
                authFailureProblem = p.addProblem(Severity.ERROR,
                        "Unable to connect the registries catalog endpoint: " + e.getMessage() + ".");
            }
        } else {
            try {
                // effectively final
                int tagCount[] = new int[1];
                tagCount[0] = 0;
                n.getRepositories().forEach(
                        r -> tagCount[0] += credentials.getCredentials().getClient().getTags(r).getTags().size());
                if (tagCount[0] == 0) {
                    p.addProblem(Severity.WARNING,
                            "None of your supplied repositories contain any tags. Spinnaker will not be able to deploy anything.")
                            .setRemediation("Push some images to your registry.");
                }
            } catch (Exception e) {
                authFailureProblem = p.addProblem(Severity.ERROR,
                        "Unable to reach repository: " + e.getMessage() + ".");
            }
        }

        if (authFailureProblem != null && !StringUtils.isEmpty(resolvedPassword)) {
            String message = "Your registry password has %s whitespace; if this is unintentional, this may be the cause of failed authentication.";
            if (Character.isWhitespace(resolvedPassword.charAt(0))) {
                authFailureProblem.setRemediation(String.format(message, "leading"));
            }

            char c = resolvedPassword.charAt(resolvedPassword.length() - 1);
            if (Character.isWhitespace(c)) {
                authFailureProblem.setRemediation(String.format(message, "trailing"));

                if (passwordFileProvided && c == '\n')
                    authFailureProblem.setRemediation(
                            "Your password file has a trailing newline; many text editors append a newline to files they open."
                                    + " If you think this is causing authentication issues, you can strip the newline with the command:\n\n"
                                    + " tr -d '\\n' < PASSWORD_FILE | tee PASSWORD_FILE");
            }
        }
    }
}