java/server/test/org/openqa/grid/common/RegistrationRequestTest.java

/*
Copyright 2011 Selenium committers
Copyright 2011 Software Freedom Conservancy

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 org.openqa.grid.common;

import static org.openqa.grid.common.RegistrationRequest.CLEAN_UP_CYCLE;
import static org.openqa.grid.common.RegistrationRequest.REMOTE_HOST;

import java.util.HashMap;
import java.util.Map;

import org.junit.Assert;
import org.junit.Test;
import org.openqa.selenium.Platform;
import org.openqa.selenium.remote.CapabilityType;
import org.openqa.selenium.remote.DesiredCapabilities;

public class RegistrationRequestTest {

  @Test
  public void getConfigAsTests() {
    RegistrationRequest req = new RegistrationRequest();
    String url = "http://a.c:2";

    Map<String, Object> config = new HashMap<String, Object>();
    config.put(CLEAN_UP_CYCLE, 1);
    config.put(REMOTE_HOST, url);

    req.setConfiguration(config);

    int c = req.getConfigAsInt(CLEAN_UP_CYCLE, -1);
    Assert.assertTrue(c == 1);

    int e = req.getConfigAsInt("doesn't exist", 20);
    Assert.assertTrue(e == 20);

    String url2 = req.getConfigAsString(REMOTE_HOST);
    Assert.assertEquals(url2, url);
  }

  @Test
  public void json() {
    RegistrationRequest req = new RegistrationRequest();
    req.setId("id");
    req.setName("Franзois");
    req.setDescription("a\nb\nc");

    String name = "%super !";
    String value = "%з // \\";

    Map<String, Object> config = new HashMap<String, Object>();
    config.put(name, value);

    req.setConfiguration(config);

    for (int i = 0; i < 5; i++) {
      DesiredCapabilities cap = new DesiredCapabilities("firefox", "" + i, Platform.LINUX);
      req.addDesiredCapability(cap);
    }

    String json = req.toJSON();

    RegistrationRequest req2 = RegistrationRequest.getNewInstance(json);

    Assert.assertEquals(req2.getId(), req.getId());
    Assert.assertEquals(req2.getName(), req.getName());
    Assert.assertEquals(req2.getDescription(), req.getDescription());

    Assert.assertEquals(req2.getConfigAsString(name), req.getConfigAsString(name));
    Assert.assertEquals(req2.getCapabilities().size(), req.getCapabilities().size());

  }

  @Test
  public void seleniumGrid1Request() {
    RegistrationRequest request =
        RegistrationRequest
            .getNewInstance("host=localhost&port=5000&environment=Firefox%3A+4%3B+MacOS+X%3A+10.6.7");

    Assert.assertEquals(null, request.getId());
    Assert.assertEquals(null, request.getName());
    Assert.assertEquals(null, request.getDescription());

    // Verify the capabilities were set up properly.
    Assert.assertEquals(1, request.getCapabilities().size());
    DesiredCapabilities caps = request.getCapabilities().get(0);

    // Assert.assertEquals(Platform.LINUX.toString(), caps.get(CapabilityType.PLATFORM));
    Assert.assertEquals("Firefox: 4; MacOS X: 10.6.7",
        caps.getCapability(CapabilityType.BROWSER_NAME));

    // Verify the configuration was set up properly.
   Assert.assertEquals("http://localhost:5000", request.getConfiguration()
        .get(RegistrationRequest.REMOTE_HOST));
    Assert.assertEquals(SeleniumProtocol.Selenium.toString(), request.getConfiguration()
      .get(RegistrationRequest.SELENIUM_PROTOCOL));
   
  }


  @Test
  public void basicCommandLineParam() {
    String hubHost = "-" + RegistrationRequest.HUB_HOST;
    String hubPort = "-" + RegistrationRequest.HUB_PORT;
    RegistrationRequest req =
        RegistrationRequest.build("-role", "rc", hubHost, "ABC", hubPort, "1234","-host","localhost");

    Assert.assertEquals(GridRole.NODE, req.getRole());
    Assert.assertEquals("ABC", req.getConfiguration().get(RegistrationRequest.HUB_HOST));
    Assert.assertEquals(1234, req.getConfiguration().get(RegistrationRequest.HUB_PORT));

  }

  @Test
  public void commandLineParamDefault() {
    RegistrationRequest req = RegistrationRequest.build("-role", "rc");
    // the hub defaults to current IP.
    Assert.assertNotNull(req.getConfiguration().get(RegistrationRequest.HUB_HOST));
    Assert.assertEquals(4444, req.getConfiguration().get(RegistrationRequest.HUB_PORT));
    // the node defaults to current IP.
    Assert.assertNotNull(req.getConfiguration().get(RegistrationRequest.HOST));
    Assert.assertEquals(5555, req.getConfiguration().get(RegistrationRequest.PORT));
  }

  @Test
  public void commandLineParamDefaultCapabilities() {
    String hubHost = "-" + RegistrationRequest.HUB_HOST;
    RegistrationRequest req = RegistrationRequest.build("-role", "rc", hubHost, "ABC","-host","localhost");
    Assert.assertEquals("ABC", req.getConfiguration().get(RegistrationRequest.HUB_HOST));
    Assert.assertNotSame(0, req.getCapabilities().size());

  }

  @Test
  public void registerParam() {
    String hubHost = "-" + RegistrationRequest.HUB_HOST;
    RegistrationRequest req = RegistrationRequest.build("-role", "rc", hubHost, "ABC","-host","localhost");
    Assert.assertEquals(true, req.getConfiguration().get(RegistrationRequest.AUTO_REGISTER));

    RegistrationRequest req2 =
        RegistrationRequest.build("-role", "rc", hubHost, "ABC", "-" +
            RegistrationRequest.AUTO_REGISTER, "false","-host","localhost");
    Assert.assertEquals(false, req2.getConfiguration().get(RegistrationRequest.AUTO_REGISTER));

  }

  @Test
  public void ensurePre2_9HubCompatibility() {
    RegistrationRequest req = RegistrationRequest.build("-role", "rc", "-host", "example.com", "-port", "5555");

    // This is the configuration value for >= v2.9 hubs.
    Assert.assertEquals("http://example.com:5555", req.getConfigAsString(RegistrationRequest.REMOTE_HOST));

    // This is the configuration value for < v2.9 hubs.
    Assert.assertEquals("http://example.com:5555", req.getConfigAsString("url"));
  }
}