org.openqa.selenium.docker.ContainerInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of selenium-grid 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.26.0

// 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.selenium.docker;

import com.google.common.collect.HashMultimap;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Multimap;
import org.openqa.selenium.Beta;
import org.openqa.selenium.internal.Require;

import java.util.Map;

@Beta
public class ContainerInfo {

  private final Image image;
  // Port bindings, keyed on the container port, with values being host ports
  private final Multimap> portBindings;

  private ContainerInfo(Image image, Multimap> portBindings) {
    this.image = Require.nonNull("Container image", image);
    this.portBindings = Require.nonNull("Port bindings", portBindings);
  }

  public static ContainerInfo image(Image image) {
    return new ContainerInfo(image, HashMultimap.create());
  }

  public ContainerInfo map(Port containerPort, Port hostPort) {
    Require.nonNull("Container port", containerPort);
    Require.nonNull("Host port", hostPort);

    if (!hostPort.getProtocol().equals(containerPort.getProtocol())) {
      throw new DockerException(
          String.format("Port protocols must match: %s -> %s", hostPort, containerPort));
    }

    Multimap> updatedBindings = HashMultimap.create(portBindings);
    updatedBindings.put(
        containerPort.getPort() + "/" + containerPort.getProtocol(),
        ImmutableMap.of("HostPort", String.valueOf(hostPort.getPort()), "HostIp", ""));

    return new ContainerInfo(image, updatedBindings);
  }

  @Override
  public String toString() {
    return "ContainerInfo{" +
      "image=" + image +
      ", portBindings=" + portBindings +
      '}';
  }

  private Map toJson() {
    Map hostConfig = ImmutableMap.of(
        "PortBindings", portBindings.asMap());

    return ImmutableMap.of(
        "Image", image.getId(),
        "HostConfig", hostConfig);
  }
}