org.openqa.grid.web.servlet.console.DefaultProxyHtmlRenderer.java Source code

Java tutorial

Introduction

Here is the source code for org.openqa.grid.web.servlet.console.DefaultProxyHtmlRenderer.java

Source

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC 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.openqa.grid.web.servlet.console;

import org.openqa.grid.common.SeleniumProtocol;
import org.openqa.grid.common.exception.GridException;
import org.openqa.grid.internal.RemoteProxy;
import org.openqa.grid.internal.TestSession;
import org.openqa.grid.internal.TestSlot;
import org.openqa.grid.internal.utils.HtmlRenderer;
import org.openqa.selenium.Platform;
import org.openqa.selenium.remote.CapabilityType;

import java.util.Map;

public class DefaultProxyHtmlRenderer implements HtmlRenderer {

    private RemoteProxy proxy;

    @SuppressWarnings("unused")
    private DefaultProxyHtmlRenderer() {
    }

    public DefaultProxyHtmlRenderer(RemoteProxy proxy) {
        this.proxy = proxy;
    }

    @Override
    public String renderSummary() {
        StringBuilder builder = new StringBuilder();
        builder.append("<div class='proxy'>");
        builder.append("<p class='proxyname'>");
        builder.append(proxy.getClass().getSimpleName());

        // TODO freynaud

        builder.append(getHtmlNodeVersion());

        String platform = getPlatform(proxy);

        builder.append("<p class='proxyid'>id : ");
        builder.append(proxy.getId());
        builder.append(", OS : ").append(platform).append("</p>");

        builder.append(nodeTabs());

        builder.append("<div class='content'>");

        builder.append(tabBrowsers());
        builder.append(tabConfig());

        builder.append("</div>");
        builder.append("</div>");

        return builder.toString();

    }

    private String getHtmlNodeVersion() {
        try {
            Map<String, Object> object = proxy.getProxyStatus();
            Map<?, ?> value = (Map<?, ?>) object.get("value");
            Map<?, ?> build = (Map<?, ?>) value.get("build");
            String version = (String) build.get("version");
            return " (version : " + version + ")";
        } catch (Exception e) {
            return " unknown version," + e.getMessage();
        }
    }

    // content of the config tab.
    private String tabConfig() {
        StringBuilder builder = new StringBuilder();
        builder.append("<div type='config' class='content_detail'>");
        builder.append(proxy.getConfig().toString("<p>%1$s: %2$s</p>"));
        builder.append("</div>");
        return builder.toString();
    }

    // content of the browsers tab
    private String tabBrowsers() {
        StringBuilder builder = new StringBuilder();
        builder.append("<div type='browsers' class='content_detail'>");

        SlotsLines rcLines = new SlotsLines();
        SlotsLines wdLines = new SlotsLines();

        for (TestSlot slot : proxy.getTestSlots()) {
            if (slot.getProtocol() == SeleniumProtocol.Selenium) {
                rcLines.add(slot);
            } else {
                wdLines.add(slot);
            }
        }

        if (rcLines.getLinesType().size() != 0) {
            builder.append("<p class='protocol' >Remote Control (legacy)</p>");
            builder.append(getLines(rcLines));
        }
        if (wdLines.getLinesType().size() != 0) {
            builder.append("<p class='protocol' >WebDriver</p>");
            builder.append(getLines(wdLines));
        }
        builder.append("</div>");
        return builder.toString();
    }

    // the lines of icon representing the possible slots
    private String getLines(SlotsLines lines) {
        StringBuilder builder = new StringBuilder();
        for (MiniCapability cap : lines.getLinesType()) {
            String icon = cap.getIcon();
            String version = cap.getVersion();
            builder.append("<p>");
            if (version != null) {
                builder.append("v:").append(version);
            }
            for (TestSlot s : lines.getLine(cap)) {
                builder.append(getSingleSlotHtml(s, icon));
            }
            builder.append("</p>");
        }
        return builder.toString();
    }

    // icon ( or generic html if icon not available )
    private String getSingleSlotHtml(TestSlot s, String icon) {
        StringBuilder builder = new StringBuilder();
        TestSession session = s.getSession();
        if (icon != null) {
            builder.append("<img ");
            builder.append("src='").append(icon).append("' width='16' height='16'");
        } else {
            builder.append("<a href='#' ");
        }

        if (session != null) {
            builder.append(" class='busy' ");
            builder.append(" title='").append(session.get("lastCommand")).append("' ");
        } else {
            builder.append(" title='").append(s.getCapabilities()).append("'");
        }

        if (icon != null) {
            builder.append(" />\n");
        } else {
            builder.append(">");
            builder.append(s.getCapabilities().get(CapabilityType.BROWSER_NAME));
            builder.append("</a>");
        }
        return builder.toString();
    }

    // the tabs header.
    private String nodeTabs() {
        StringBuilder builder = new StringBuilder();
        builder.append("<div class='tabs'>");
        builder.append("<ul>");
        builder.append("<li class='tab' type='browsers'><a title='test slots' href='#'>Browsers</a></li>");
        builder.append(
                "<li class='tab' type='config'><a title='node configuration' href='#'>Configuration</a></li>");
        builder.append("</ul>");
        builder.append("</div>");
        return builder.toString();
    }

    /**
     * return the platform for the proxy. It should be the same for all slots of the proxy, so checking that.
     * @param proxy remote proxy
     * @return Either the platform name, "Unknown", "mixed OS", or "not specified".
     */
    public static String getPlatform(RemoteProxy proxy) {
        if (proxy.getTestSlots().size() == 0) {
            return "Unknown";
        }
        Platform res = getPlatform(proxy.getTestSlots().get(0));

        for (TestSlot slot : proxy.getTestSlots()) {
            Platform tmp = getPlatform(slot);
            if (tmp != res) {
                return "mixed OS";
            }
            res = tmp;
        }
        if (res == null) {
            return "not specified";
        }
        return res.toString();
    }

    private static Platform getPlatform(TestSlot slot) {
        Object o = slot.getCapabilities().get(CapabilityType.PLATFORM);
        if (o == null) {
            return Platform.ANY;
        }
        if (o instanceof String) {
            return Platform.valueOf((String) o);
        } else if (o instanceof Platform) {
            return (Platform) o;
        } else {
            throw new GridException("Cannot cast " + o + " to org.openqa.selenium.Platform");
        }
    }
}