REST api on Selenium Hub #3460

krmahadevan · Feb 4, 2017

By placing an X in the preceding checkbox, I verify that I have signed the Contributor License Agreement

@dima-groupon

This PR represents the original work that was started off by @dima-groupon as part of #265 and later rebased and revived by @mach6

krmahadevan · Feb 4, 2017

This PR represents the original work that was started off by @dima-groupon as part of #265 and later rebased and revived by @mach6

@mach6

@mach6

Here's how the apis and their corresponding responses would look like

http://localhost:4444/api/v1

GET endpoints:

/api/v1
- Description: HTML page documenting the API endpoints (this page)
- Class: org.openqa.grid.web.servlet.api.v1.ApiV1
- Usage: /api/v1
/api/v1/hub
- Description: Returns configuration and proxy information of the hub
- Class: org.openqa.grid.web.servlet.api.v1.HubInfo
- Usage: /api/v1/hub
/api/v1/nodes
- Description: List of computers connected to the HUB and the nodes on each computer
- Class: org.openqa.grid.web.servlet.api.v1.Nodes
- Usage: /api/v1/nodes
/api/v1/proxy
- Description: Returns configuration and capability information for the current proxy
- Class: org.openqa.grid.web.servlet.api.v1.Proxy
- Usage: /api/v1/proxy/<ID> - ID retrieved from the /node endpoint
/api/v1/sessions
- Description: List of currently open sessions
- Class: org.openqa.grid.web.servlet.api.v1.Sessions
- Usage: /api/v1/sessions
/api/v1/session
- Description: Returns details for a given session
- Class: org.openqa.grid.web.servlet.api.v1.SessionInfo
- Usage: /api/v1/sessions/ - ID retrieved from the /sessions endpoint
Get Hub information. http://localhost:4444/api/v1/hub

{
  "configuration": {
    "capabilityMatcher": "org.openqa.grid.internal.utils.DefaultCapabilityMatcher",
    "newSessionWaitTimeout": -1,
    "throwOnCapabilityNotPresent": true,
    "cleanUpCycle": 5000,
    "custom": {},
    "host": "192.168.1.5",
    "servlets": [],
    "withoutServlets": [],
    "browserTimeout": 0,
    "debug": false,
    "port": 4444,
    "role": "hub",
    "timeout": 1800
  },
  "nodes": [
    {
      "host": "192.168.1.5",
      "port": 5555,
      "id": "http://192.168.1.5:5555"
    },
    {
      "host": "192.168.1.5",
      "port": 6666,
      "id": "http://192.168.1.5:6666"
    }
  ],
  "registrationUrl": "http://192.168.1.5:4444//grid/register/",
  "consoleUrl": "http://192.168.1.5:4444//grid/console",
  "newSessionRequestCount": 0,
  "usedProxyCount": 2,
  "totalProxyCount": 2,
  "activeSessionCount": 3
}

Get list of nodes attached to the hub http://localhost:4444/api/v1/nodes

[
  {
    "host": "192.168.1.5",
    "port": 5555,
    "id": "http://192.168.1.5:5555",
    "slotUsage": {
      "total": 11,
      "busy": 2,
      "breakup": [
        {
          "browser": "chrome",
          "usage": {
            "total": 5,
            "busy": 2
          }
        },
        {
          "browser": "internet explorer",
          "usage": {
            "total": 1,
            "busy": 0
          }
        },
        {
          "browser": "firefox",
          "usage": {
            "total": 5,
            "busy": 0
          }
        }
      ]
    }
  },
  {
    "host": "192.168.1.5",
    "port": 6666,
    "id": "http://192.168.1.5:6666",
    "slotUsage": {
      "total": 11,
      "busy": 1,
      "breakup": [
        {
          "browser": "chrome",
          "usage": {
            "total": 5,
            "busy": 1
          }
        },
        {
          "browser": "internet explorer",
          "usage": {
            "total": 1,
            "busy": 0
          }
        },
        {
          "browser": "firefox",
          "usage": {
            "total": 5,
            "busy": 0
          }
        }
      ]
    }
  }
]

Given a Proxy Id, get details of the proxy http://localhost:4444/api/v1/proxy/http://192.168.1.5:5555

{
  "isBusy": true,
  "sessions": [
    {
      "browserName": "chrome",
      "sessionId": "157569ab-e0d8-4d04-b78d-7244d9d2d0c4"
    },
    {
      "browserName": "chrome",
      "sessionId": "30c089bd-ff76-4b95-a157-78519c488986"
    }
  ],
  "java": {
    "version": "1.8.0_66"
  },
  "os": {
    "name": "Mac OS X",
    "arch": "x86_64",
    "version": "10.12.3"
  },
  "slotUsage": {
    "total": 11,
    "busy": 2,
    "breakup": [
      {
        "browser": "chrome",
        "usage": {
          "total": 5,
          "busy": 2
        }
      },
      {
        "browser": "internet explorer",
        "usage": {
          "total": 1,
          "busy": 0
        }
      },
      {
        "browser": "firefox",
        "usage": {
          "total": 5,
          "busy": 0
        }
      }
    ]
  },
  "htmlRenderer": "org.openqa.grid.selenium.proxy.WebProxyHtmlRenderer",
  "build": {
    "version": "3.0.1",
    "revision": "unknown",
    "time": "unknown"
  },
  "percentUsed": 40.0,
  "lastSessionStart": 1486196956545,
  "config": {
    "hubHost": "localhost",
    "hubPort": 4444,
    "id": "http://192.168.1.5:5555",
    "capabilities": [
      {
        "browserName": "chrome",
        "seleniumProtocol": "WebDriver",
        "maxInstances": 5,
        "platform": "MAC"
      },
      {
        "browserName": "firefox",
        "seleniumProtocol": "WebDriver",
        "maxInstances": 5,
        "platform": "MAC"
      },
      {
        "browserName": "internet explorer",
        "seleniumProtocol": "WebDriver",
        "maxInstances": 1,
        "platform": "MAC"
      }
    ],
    "downPollingLimit": 2,
    "hub": "http://localhost:4444/grid/register",
    "nodePolling": 5000,
    "nodeStatusCheckTimeout": 5000,
    "proxy": "org.openqa.grid.selenium.proxy.DefaultRemoteProxy",
    "register": true,
    "registerCycle": 5000,
    "unregisterIfStillDownAfter": 60000,
    "cleanUpCycle": 5000,
    "custom": {},
    "host": "192.168.1.5",
    "maxSession": 5,
    "servlets": [],
    "withoutServlets": [],
    "browserTimeout": 0,
    "debug": false,
    "port": 5555,
    "role": "node",
    "timeout": 1800
  }
}

List all active sessions in the Hub http://localhost:4444/api/v1/sessions

{
  "31006720-cddd-408d-8f65-09813b8b5cb7": {
    "slotInfo": {
      "host": "192.168.1.5",
      "port": 6666,
      "id": "http://192.168.1.5:6666"
    },
    "browser": "chrome"
  },
  "eb38d217-3445-4f03-bf58-3428d28fb130": {
    "slotInfo": {
      "host": "192.168.1.5",
      "port": 5555,
      "id": "http://192.168.1.5:5555"
    },
    "browser": "chrome"
  },
  "8e9b194d-72ce-4b69-aecf-a0672f854b57": {
    "slotInfo": {
      "host": "192.168.1.5",
      "port": 5555,
      "id": "http://192.168.1.5:5555"
    },
    "browser": "chrome"
  }
}

Given a Session Id, get details of the session http://localhost:4444/api/v1/session/8e9b194d-72ce-4b69-aecf-a0672f854b57

{
  "isForwardingRequest": false,
  "proxy": {
    "host": "192.168.1.5",
    "port": 5555,
    "nodeId": "http://192.168.1.5:5555"
  },
  "protocol": "WebDriver",
  "lastActivityWasAt": 253698,
  "isOrphaned": false,
  "internalKey": "bb556e03-95c4-4abd-bbae-7fbcfe16c026",
  "requestedCapabilities": {
    "browserName": "chrome"
  },
  "requestPath": "/wd/hub"
}

krmahadevan · Feb 4, 2017

@mach6

Here's how the apis and their corresponding responses would look like

http://localhost:4444/api/v1

GET endpoints:

/api/v1
- Description: HTML page documenting the API endpoints (this page)
- Class: org.openqa.grid.web.servlet.api.v1.ApiV1
- Usage: /api/v1
/api/v1/hub
- Description: Returns configuration and proxy information of the hub
- Class: org.openqa.grid.web.servlet.api.v1.HubInfo
- Usage: /api/v1/hub
/api/v1/nodes
- Description: List of computers connected to the HUB and the nodes on each computer
- Class: org.openqa.grid.web.servlet.api.v1.Nodes
- Usage: /api/v1/nodes
/api/v1/proxy
- Description: Returns configuration and capability information for the current proxy
- Class: org.openqa.grid.web.servlet.api.v1.Proxy
- Usage: /api/v1/proxy/<ID> - ID retrieved from the /node endpoint
/api/v1/sessions
- Description: List of currently open sessions
- Class: org.openqa.grid.web.servlet.api.v1.Sessions
- Usage: /api/v1/sessions
/api/v1/session
- Description: Returns details for a given session
- Class: org.openqa.grid.web.servlet.api.v1.SessionInfo
- Usage: /api/v1/sessions/ - ID retrieved from the /sessions endpoint
Get Hub information. http://localhost:4444/api/v1/hub

{
  "configuration": {
    "capabilityMatcher": "org.openqa.grid.internal.utils.DefaultCapabilityMatcher",
    "newSessionWaitTimeout": -1,
    "throwOnCapabilityNotPresent": true,
    "cleanUpCycle": 5000,
    "custom": {},
    "host": "192.168.1.5",
    "servlets": [],
    "withoutServlets": [],
    "browserTimeout": 0,
    "debug": false,
    "port": 4444,
    "role": "hub",
    "timeout": 1800
  },
  "nodes": [
    {
      "host": "192.168.1.5",
      "port": 5555,
      "id": "http://192.168.1.5:5555"
    },
    {
      "host": "192.168.1.5",
      "port": 6666,
      "id": "http://192.168.1.5:6666"
    }
  ],
  "registrationUrl": "http://192.168.1.5:4444//grid/register/",
  "consoleUrl": "http://192.168.1.5:4444//grid/console",
  "newSessionRequestCount": 0,
  "usedProxyCount": 2,
  "totalProxyCount": 2,
  "activeSessionCount": 3
}

Get list of nodes attached to the hub http://localhost:4444/api/v1/nodes

[
  {
    "host": "192.168.1.5",
    "port": 5555,
    "id": "http://192.168.1.5:5555",
    "slotUsage": {
      "total": 11,
      "busy": 2,
      "breakup": [
        {
          "browser": "chrome",
          "usage": {
            "total": 5,
            "busy": 2
          }
        },
        {
          "browser": "internet explorer",
          "usage": {
            "total": 1,
            "busy": 0
          }
        },
        {
          "browser": "firefox",
          "usage": {
            "total": 5,
            "busy": 0
          }
        }
      ]
    }
  },
  {
    "host": "192.168.1.5",
    "port": 6666,
    "id": "http://192.168.1.5:6666",
    "slotUsage": {
      "total": 11,
      "busy": 1,
      "breakup": [
        {
          "browser": "chrome",
          "usage": {
            "total": 5,
            "busy": 1
          }
        },
        {
          "browser": "internet explorer",
          "usage": {
            "total": 1,
            "busy": 0
          }
        },
        {
          "browser": "firefox",
          "usage": {
            "total": 5,
            "busy": 0
          }
        }
      ]
    }
  }
]

Given a Proxy Id, get details of the proxy http://localhost:4444/api/v1/proxy/http://192.168.1.5:5555

{
  "isBusy": true,
  "sessions": [
    {
      "browserName": "chrome",
      "sessionId": "157569ab-e0d8-4d04-b78d-7244d9d2d0c4"
    },
    {
      "browserName": "chrome",
      "sessionId": "30c089bd-ff76-4b95-a157-78519c488986"
    }
  ],
  "java": {
    "version": "1.8.0_66"
  },
  "os": {
    "name": "Mac OS X",
    "arch": "x86_64",
    "version": "10.12.3"
  },
  "slotUsage": {
    "total": 11,
    "busy": 2,
    "breakup": [
      {
        "browser": "chrome",
        "usage": {
          "total": 5,
          "busy": 2
        }
      },
      {
        "browser": "internet explorer",
        "usage": {
          "total": 1,
          "busy": 0
        }
      },
      {
        "browser": "firefox",
        "usage": {
          "total": 5,
          "busy": 0
        }
      }
    ]
  },
  "htmlRenderer": "org.openqa.grid.selenium.proxy.WebProxyHtmlRenderer",
  "build": {
    "version": "3.0.1",
    "revision": "unknown",
    "time": "unknown"
  },
  "percentUsed": 40.0,
  "lastSessionStart": 1486196956545,
  "config": {
    "hubHost": "localhost",
    "hubPort": 4444,
    "id": "http://192.168.1.5:5555",
    "capabilities": [
      {
        "browserName": "chrome",
        "seleniumProtocol": "WebDriver",
        "maxInstances": 5,
        "platform": "MAC"
      },
      {
        "browserName": "firefox",
        "seleniumProtocol": "WebDriver",
        "maxInstances": 5,
        "platform": "MAC"
      },
      {
        "browserName": "internet explorer",
        "seleniumProtocol": "WebDriver",
        "maxInstances": 1,
        "platform": "MAC"
      }
    ],
    "downPollingLimit": 2,
    "hub": "http://localhost:4444/grid/register",
    "nodePolling": 5000,
    "nodeStatusCheckTimeout": 5000,
    "proxy": "org.openqa.grid.selenium.proxy.DefaultRemoteProxy",
    "register": true,
    "registerCycle": 5000,
    "unregisterIfStillDownAfter": 60000,
    "cleanUpCycle": 5000,
    "custom": {},
    "host": "192.168.1.5",
    "maxSession": 5,
    "servlets": [],
    "withoutServlets": [],
    "browserTimeout": 0,
    "debug": false,
    "port": 5555,
    "role": "node",
    "timeout": 1800
  }
}

List all active sessions in the Hub http://localhost:4444/api/v1/sessions

{
  "31006720-cddd-408d-8f65-09813b8b5cb7": {
    "slotInfo": {
      "host": "192.168.1.5",
      "port": 6666,
      "id": "http://192.168.1.5:6666"
    },
    "browser": "chrome"
  },
  "eb38d217-3445-4f03-bf58-3428d28fb130": {
    "slotInfo": {
      "host": "192.168.1.5",
      "port": 5555,
      "id": "http://192.168.1.5:5555"
    },
    "browser": "chrome"
  },
  "8e9b194d-72ce-4b69-aecf-a0672f854b57": {
    "slotInfo": {
      "host": "192.168.1.5",
      "port": 5555,
      "id": "http://192.168.1.5:5555"
    },
    "browser": "chrome"
  }
}

Given a Session Id, get details of the session http://localhost:4444/api/v1/session/8e9b194d-72ce-4b69-aecf-a0672f854b57

{
  "isForwardingRequest": false,
  "proxy": {
    "host": "192.168.1.5",
    "port": 5555,
    "nodeId": "http://192.168.1.5:5555"
  },
  "protocol": "WebDriver",
  "lastActivityWasAt": 253698,
  "isOrphaned": false,
  "internalKey": "bb556e03-95c4-4abd-bbae-7fbcfe16c026",
  "requestedCapabilities": {
    "browserName": "chrome"
  },
  "requestPath": "/wd/hub"
}

@krmahadevan

@krmahadevan thanks for this! This is going to take a little time to vet with the Se community. I'll look at the existing work in more detail in the days to come but in the meantime, will you please add tests? Cheers!

mach6 · Feb 6, 2017

@krmahadevan thanks for this! This is going to take a little time to vet with the Se community. I'll look at the existing work in more detail in the days to come but in the meantime, will you please add tests? Cheers!

@mach6

@mach6 - Any news on how is the review with the SE community going on ? Thought of quickly checking on this!

krmahadevan · Feb 24, 2017

@mach6 - Any news on how is the review with the SE community going on ? Thought of quickly checking on this!

mach6 · Feb 24, 2017

mach6 reviewed Feb 24, 2017

View changes

mach6 · Feb 24, 2017

java/server/src/org/openqa/grid/web/servlet/api/v1/HubInfo.java

@@ -0,0 +1,48 @@
+package org.openqa.grid.web.servlet.api.v1;


Needs the copyright text

@krmahadevan

@krmahadevan in general, agreement that since all of these api's are GET only, it is okay and will add value -- though there is concern about the long term implications of supporting additional api's and the fact that we'll have a mixed bag of RESTful (GET) operations and RESTish (POST/DELETE/GET) operations (the existing apis).

Once we complete the tests and remaining refinement, I believe I can merge this.

mach6 · Feb 24, 2017

@krmahadevan in general, agreement that since all of these api's are GET only, it is okay and will add value -- though there is concern about the long term implications of supporting additional api's and the fact that we'll have a mixed bag of RESTful (GET) operations and RESTish (POST/DELETE/GET) operations (the existing apis).

Once we complete the tests and remaining refinement, I believe I can merge this.

mach6 · Feb 24, 2017

mach6 reviewed Feb 24, 2017

View changes

mach6 · Feb 24, 2017

java/server/src/org/openqa/grid/web/servlet/api/v1/utils/ProxyUtil.java

+    JsonObject computer = new JsonObject();
+    computer.addProperty("host", proxy.getRemoteHost().getHost());
+    computer.addProperty("port", proxy.getRemoteHost().getPort());
+    computer.addProperty("id", proxy.getId());


I liked it better when we were hashing the Id for the benefit of the HTTP URL. This looks silly to me http://localhost:4444/api/v1/proxy/http://192.168.1.5:5555 due to http:// ... http://

Fixed this by accepting both forms viz., with and without the protocol

@mach6

@mach6 - I have added tests as well. We should now be good to get this merged.

krmahadevan · Feb 27, 2017

@mach6 - I have added tests as well. We should now be good to get this merged.

@mach6

ping @mach6 .. Gentle reminder Doug!

krmahadevan · Feb 28, 2017

ping @mach6 .. Gentle reminder Doug!

mach6 · Feb 28, 2017

mach6 reviewed Feb 28, 2017

View changes

mach6 · Feb 28, 2017

java/server/test/org/openqa/grid/e2e/misc/GridRestfulAPITest.java

@@ -0,0 +1,149 @@
+package org.openqa.grid.e2e.misc;


needs the copyright

mach6 · Feb 28, 2017

mach6 reviewed Feb 28, 2017

View changes

java/server/src/org/openqa/grid/web/servlet/api/v1/Proxy.java

@krmahadevan

@krmahadevan thx for the follow-up here. I left a few more new comments for your consideration

mach6 · Feb 28, 2017

@krmahadevan thx for the follow-up here. I left a few more new comments for your consideration

@mach6

@mach6 - I have consolidated the proxy end-point and the session end-point into the same thing so that it works for querying all proxies/sessions (or) for a particular proxy/session.

I would really like to get this PR wrapped up. Please let me know what else is pending on this.

krmahadevan · Mar 4, 2017

@mach6 - I have consolidated the proxy end-point and the session end-point into the same thing so that it works for querying all proxies/sessions (or) for a particular proxy/session.

I would really like to get this PR wrapped up. Please let me know what else is pending on this.

@mach6

ping @mach6 - Gentle reminder!

krmahadevan · Mar 9, 2017

ping @mach6 - Gentle reminder!

@mach6

ping @mach6 - Any updates on this ?

krmahadevan · Mar 13, 2017

ping @mach6 - Any updates on this ?

@lukeis

@lukeis - Do you think you could help me with this ? I haven't heard from @mach6 Not sure why though! Its been more than a month since this PR was raised.. and I would really love to have this feature within Grid...

krmahadevan · Mar 14, 2017

@lukeis - Do you think you could help me with this ? I haven't heard from @mach6 Not sure why though! Its been more than a month since this PR was raised.. and I would really love to have this feature within Grid...

@mach6

@mach6 - Pls let me know if I should just close off this PR. I haven't heard of anything on this PR and its more than a couple of months...

krmahadevan · May 18, 2017

@mach6 - Pls let me know if I should just close off this PR. I haven't heard of anything on this PR and its more than a couple of months...

Sorry for the continued delay. please do not close

mach6 · May 19, 2017

Sorry for the continued delay. please do not close

@mach6

@mach6 - What is holding this PR ? Can you please let me know. I was hoping that this would be wrapped up a long time back.

krmahadevan · May 26, 2017

@mach6 - What is holding this PR ? Can you please let me know. I was hoping that this would be wrapped up a long time back.

krmahadevan referenced this pull request Feb 4, 2017
Open
Enhance the "grid/api/hub" response to include the list of nodes wired into the Hub as well #3446

mach6 added the C-grid label Feb 6, 2017

krmahadevan closed this Jun 8, 2017

krmahadevan deleted the krmahadevan:krmahadevan_github_265 branch Jun 8, 2017

SeleniumHQ/selenium

Join GitHub today

REST api on Selenium Hub #3460

Conversation

krmahadevan commented Feb 4, 2017

krmahadevan referenced this pull request Feb 4, 2017

This comment has been minimized.

krmahadevan commented Feb 4, 2017

This comment has been minimized.

krmahadevan commented Feb 4, 2017

mach6 added the C-grid label Feb 6, 2017

This comment has been minimized.

mach6 commented Feb 6, 2017

This comment has been minimized.

krmahadevan commented Feb 24, 2017

mach6 reviewed Feb 24, 2017 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

mach6 commented Feb 24, 2017

mach6 reviewed Feb 24, 2017 View changes

This comment has been minimized.

mach6 Feb 24, 2017 • edited

This comment has been minimized.

This comment has been minimized.

krmahadevan commented Feb 27, 2017

This comment has been minimized.

krmahadevan commented Feb 28, 2017

mach6 reviewed Feb 28, 2017 View changes

This comment has been minimized.

mach6 reviewed Feb 28, 2017 View changes

This comment has been minimized.

mach6 commented Feb 28, 2017

dima-groupon and others added some commits Oct 7, 2014

This comment has been minimized.

krmahadevan commented Mar 4, 2017

This comment has been minimized.

krmahadevan commented Mar 9, 2017

This comment has been minimized.

krmahadevan commented Mar 13, 2017

This comment has been minimized.

krmahadevan commented Mar 14, 2017

This comment has been minimized.

krmahadevan commented May 18, 2017 • edited

This comment has been minimized.

mach6 commented May 19, 2017

This comment has been minimized.

krmahadevan commented May 26, 2017

krmahadevan closed this Jun 8, 2017

krmahadevan deleted the krmahadevan:krmahadevan_github_265 branch Jun 8, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Jun 8, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Aug 1, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Sep 7, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Oct 9, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Nov 3, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Nov 6, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Nov 16, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Nov 24, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Dec 4, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Dec 8, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Dec 12, 2017

mach6 added a commit to mach6/selenium that referenced this pull request Apr 23, 2018

mach6 reviewed Feb 24, 2017

View changes

mach6 reviewed Feb 24, 2017

View changes

mach6 Feb 24, 2017 •

edited

mach6 reviewed Feb 28, 2017

View changes

mach6 reviewed Feb 28, 2017

View changes

krmahadevan commented May 18, 2017 •

edited