com.xceptance.xlt.gce.OpListInstancesByNameLabelNonInteractively Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
There is a newer version: 8.1.0
/*
 * Copyright (c) 2005-2022 Xceptance Software Technologies GmbH
 *
 * 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.xceptance.xlt.gce;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import com.google.api.services.compute.model.Instance;
import com.google.api.services.compute.model.Region;

/**
 * Retrieves all machine instances with a certain name label and prints their corresponding agent controller URLs to a
 * file or stdout.
 */
class OpListInstancesByNameLabelNonInteractively
{
    /**
     * The underlying GCE client.
     */
    private final GceClient gceClient;

    /**
     * Constructor.
     * 
     * @param gceClient
     *            the GCE client to use
     */
    OpListInstancesByNameLabelNonInteractively(final GceClient gceClient)
    {
        this.gceClient = gceClient;
    }

    /**
     * Retrieves all machine instances with a certain name label and prints their corresponding agent controller URLs to
     * a file or stdout.
     *
     * @param regionName
     *            the name of the region
     * @param nameLabel
     *            the value of the name label
     * @param outputFile
     *            the file to write the agent controller properties to, or null if the properties are to be
     *            written to stdout
     */
    void execute(final String regionName, final String nameLabel, final File outputFile) throws IOException
    {
        try
        {
            final Region region = gceClient.getRegion(regionName);
            List instances = gceClient.getInstancesInRegion(region);

            // TODO: check for state RUNNING?
            instances = filterInstancesByNameLabel(instances, nameLabel);

            GceAdminUtils.outputAgentControllerConnectionProperties(instances, outputFile);
        }
        catch (final Exception e)
        {
            GceAdminUtils.dieWithMessage(String.format("Failed to list the instances with name label '%s' in region '%s'", nameLabel,
                                                       regionName),
                                         e);
        }
    }

    /**
     * Filters instances by the given name label.
     *
     * @param instances
     *            the list of instances
     * @param nameLabel
     *            the name label
     * @return the instances having such a name label
     */
    private List filterInstancesByNameLabel(final List instances, final String nameLabel)
    {
        final List filteredInstances = new ArrayList<>();

        for (final Instance instance : instances)
        {
            final Map instanceLabels = instance.getLabels();

            if (instanceLabels != null)
            {
                final String instanceNameLabel = instanceLabels.get("name");

                if (nameLabel.equals(instanceNameLabel))
                {
                    filteredInstances.add(instance);
                }
            }
        }

        return filteredInstances;
    }
}