org.openqa.grid.internal.utils.configuration.StandaloneConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-server Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 4.0.0-alpha-2
// 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.internal.utils.configuration;

import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;

import com.beust.jcommander.Parameter;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;

public class StandaloneConfiguration {

  @Parameter(
    names = "-browserTimeout",
    description = " in seconds : number of seconds a browser session is allowed to hang (0 means indefinite) while a WebDriver command is running (example: driver.get(url)). If the timeout is reached while a WebDriver command is still processing, the session will quit. Minimum value is 60. Default is 0"
  )
  public Integer browserTimeout;

  @Parameter(
    names = "-debug",
    description = " : enables LogLevel.FINE. Default is false (if omitted)"
  )
  public boolean debug;

  @Parameter(
    names = {"--help", "-help", "-h"},
    help = true,
    hidden = true,
    description = "Displays this help"
  )
  public boolean help;

  @Parameter(
    names = "-jettyThreads",
    hidden = true
  )
  public Integer jettyThreads;

  @Parameter(
    names = "-log",
    description = " filename : the filename to use for logging. If omitted, will log to STDOUT"
  )
  public String log;

  @Parameter(
    names = "-logLongForm",
    description = " : if specified, all log statements (including to log file from \"log\" parameter) will include the Thread ID"
  )
  public boolean logLongForm;

  @Parameter(
    names = {"-port"},
    description = " : the port number the server will use. Defaults to [4444]. When \"role\" is a set to [node], default is [5555]"
  )
  public Integer port;

  @Parameter(
    names = "-role",
    description = " options are [hub], [node], or [standalone] : Default is [standalone]"
  )
  public String role = "standalone";

  @Parameter(
    names = {"-timeout", "-sessionTimeout"},
    description = " in seconds : Specifies the timeout before the hub automatically kills a session that hasn't had any activity in the last X seconds. The test slot will then be released for another test to use. This is typically used to take care of client crashes. For grid hub/node roles, cleanUpCycle must also be set. Default is 1800 (30 minutes)"
  )
  public Integer timeout = 1800;

  @Parameter(
    names = {"-avoidProxy"},
    description = "DO NOT USE. Hack to allow selenium 3.0 server run in SauceLabs",
    hidden = true
  )
  private Boolean avoidProxy;

  /**
   * copy another configuration's values into this one if they are set.
   * @param other
   */
  public void merge(StandaloneConfiguration other) {
    if (other.browserTimeout != null) {
      browserTimeout = other.browserTimeout;
    }
    if (other.jettyThreads != null) {
      jettyThreads = other.jettyThreads;
    }
    if (other.timeout != 1800) {
      timeout = other.timeout;
    }
    // role, port, log, debug and help are not merged, they are only consumed by the immediately running node and can't affect a remote
  }

  public String toString(String format) {
    StringBuilder sb = new StringBuilder();
    sb.append(toString(format, "browserTimeout", browserTimeout));
    sb.append(toString(format, "debug", debug));
    sb.append(toString(format, "help", help));
    sb.append(toString(format, "jettyThreads", jettyThreads));
    sb.append(toString(format, "log", log));
    sb.append(toString(format, "logLongForm", logLongForm));
    sb.append(toString(format, "port", port));
    sb.append(toString(format, "role", role));
    sb.append(toString(format, "timeout", timeout));
    return sb.toString();
  }

  @Override
  public String toString() {
    return toString(" -%1$s %2$s");
  }

  public StringBuilder toString(String format, String name, Object value) {
    StringBuilder sb = new StringBuilder();
    List iterator;
    if (value instanceof List) {
      iterator = (List)value;
    } else {
      iterator = Arrays.asList(value);
    }
    for (Object v : iterator) {
      if (v != null &&
          !(v instanceof Map && ((Map) v).isEmpty()) &&
          !(v instanceof Collection && ((Collection) v).isEmpty())) {
        sb.append(String.format(format, name, v));
      }
    }
    return sb;
  }

  public JsonElement toJson() {
    GsonBuilder builder = new GsonBuilder();
    addJsonTypeAdapter(builder);
    return builder.create().toJsonTree(this);
  }

  protected void addJsonTypeAdapter(GsonBuilder builder) {
  }
}