test/plugin/runner/src/main/java/org/apache/skywalking/plugin/test/helper/DockerComposeRunningGenerator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.skywalking.plugin.test.helper;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

import org.apache.skywalking.plugin.test.helper.exception.GenerateFailedException;
import org.apache.skywalking.plugin.test.helper.vo.DockerCompose;
import org.apache.skywalking.plugin.test.helper.vo.DockerService;
import org.apache.skywalking.plugin.test.helper.vo.DockerServiceReader;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.introspector.Property;
import org.yaml.snakeyaml.nodes.NodeTuple;
import org.yaml.snakeyaml.nodes.Tag;
import org.yaml.snakeyaml.representer.Representer;

public class DockerComposeRunningGenerator extends AbstractRunningGenerator {

    @Override
    public void generateAdditionFiles(IConfiguration configuration) throws GenerateFailedException {
        DockerCompose dockerCompose = convertDockerCompose(configuration);

        try {
            getFileWriter().dump(dockerCompose, new FileWriter(new File(configuration.outputDir(), "docker-compose" +
                ".yml")));
        } catch (IOException e) {
            throw new GenerateFailedException();
        }
    }

    private DockerCompose convertDockerCompose(IConfiguration configuration) {
        DockerCompose dockerCompose = new DockerCompose();
        dockerCompose.setVersion("2.1");

        HashMap<String, DockerService> dockerServices = new HashMap<>();
        DockerService container = new DockerService();
        container.setImage(String.format("%s:latest", configuration.dockerImageName()));

        configuration.caseConfiguration().getDependencies().forEach((name, dependencyComponent) -> {
            DockerService dockerService = new DockerService();
            DockerServiceReader serviceReader = dependencyComponent;
            dockerService.setEnvironments(serviceReader.environment());
            dockerService.setImage(serviceReader.image());
            dockerServices.put(name, dockerService);
        });

        container.setLinks(new ArrayList<>(configuration.caseConfiguration().getDependencies().keySet()));

        List<String> environment = new ArrayList<String>();
        environment.add(String.format("SCENARIO_VERSION=%s", configuration.scenarioVersion()));
        environment.add(String.format("SCENARIO_SUPPORT_FRAMEWORK=%s", configuration.testFramework()));
        environment.add(String.format("SCENARIO_ENTRY_SERVICE=%s", configuration.entryService()));
        environment.add(String.format("SCENARIO_HEALTH_CHECK_URL=%s", configuration.healthCheck()));

        List<String> volumes = new ArrayList<>();
        volumes.add(String.format("%s:/usr/local/skywalking-agent-scenario/agent", configuration.agentHome()));

        container.setVolumes(volumes);
        container.setEnvironments(environment);

        dockerServices.put(String.format("skywalking-agent-test-%s-%s", configuration.testFramework(),
            configuration.scenarioVersion())
            , container);
        dockerCompose.setServices(dockerServices);

        return dockerCompose;
    }

    private Yaml getFileWriter() {
        DumperOptions dumperOptions = new DumperOptions();
        dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
        Representer representer = new Representer() {
            @Override
            protected NodeTuple representJavaBeanProperty(Object javaBean, Property property, Object propertyValue,
                Tag customTag) {
                if (propertyValue == null) {
                    return null;
                } else {
                    return super.representJavaBeanProperty(javaBean, property, propertyValue, customTag);
                }
            }
        };

        representer.addClassTag(DockerCompose.class, Tag.MAP);
        return new Yaml(representer, dumperOptions);
    }

    @Override
    public String runningScript(IConfiguration configuration) {
        return String.format("docker-compose -f %s up", configuration.outputDir() + File.separator + "docker-compose" +
            ".yml");
    }
}