io.hyscale.controller.validator.impl.PortsValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-service Show documentation
The newest version!
/**
 * Copyright 2019 Pramati Prism, 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 io.hyscale.controller.validator.impl;

import com.fasterxml.jackson.core.type.TypeReference;
import io.hyscale.commons.exception.HyscaleException;
import io.hyscale.commons.logger.LoggerTags;
import io.hyscale.commons.logger.WorkflowLogger;
import io.hyscale.commons.validator.Validator;
import io.hyscale.controller.activity.ValidatorActivity;
import io.hyscale.controller.model.WorkflowContext;
import io.hyscale.generator.services.builder.DefaultPortsBuilder;
import io.hyscale.servicespec.commons.fields.HyscaleSpecFields;
import io.hyscale.servicespec.commons.model.service.Agent;
import io.hyscale.servicespec.commons.model.service.Port;
import io.hyscale.servicespec.commons.model.service.ServiceSpec;
import org.apache.commons.collections4.CollectionUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

/**
 * Validates the both Service and
 * Agent Ports present in Hspec on
 * Duplication of Ports etc.
 */

@Component
public class PortsValidator implements Validator {

    private static final Logger logger = LoggerFactory.getLogger(PortsValidator.class);

    @Autowired
    DefaultPortsBuilder defaultPortsBuilder;

    @Override
    public boolean validate(WorkflowContext workflowContext) throws HyscaleException {
        ServiceSpec serviceSpec = workflowContext.getServiceSpec();
        List servicePorts = serviceSpec.get(HyscaleSpecFields.ports, new TypeReference<>() {
        });
        List agents = serviceSpec.get(HyscaleSpecFields.agents, new TypeReference<>() {
        });
        return checkDuplicatePorts(servicePorts, agents);
    }

    public boolean checkDuplicatePorts(List servicePorts, List agents) {
        if (CollectionUtils.isEmpty(servicePorts) || CollectionUtils.isEmpty(agents)) {
            return true;
        }
        List exposedPorts = new ArrayList<>();
        servicePorts.stream().forEach(port -> exposedPorts.add(defaultPortsBuilder.updatePortProtocol(port).getPort()));
        StringBuilder duplicatePortsList = new StringBuilder();
        boolean portsValid = true;
        // Check for duplicate ports being exposed in service or agents
        for (Agent agent : agents) {
            if (CollectionUtils.isNotEmpty(agent.getPorts())) {
                for (Port port : agent.getPorts()) {
                    port = defaultPortsBuilder.updatePortProtocol(port);
                    if (exposedPorts.contains(port.getPort())) {
                        duplicatePortsList.append(port.getPort()).append(" ");
                        portsValid = false;
                    }
                    exposedPorts.add(port.getPort());
                }
            }
        }
        if (!portsValid) {
            logger.info("Duplicate Port Exposed in Spec {} ", duplicatePortsList);
            WorkflowLogger.persist(ValidatorActivity.DUPLICATE_PORTS, LoggerTags.ERROR, duplicatePortsList.toString());
        }
        return portsValid;
    }
}