add get sessions (#208)

* add get sessions

* add changelog

Author: KazuCocoa

CHANGELOG.md

@@ -5,6 +5,7 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
+- Add `sessions` command to get all available sessions on the Appium server
 - [internal] Tweak error messages in emulator module
 
 ### Bug fixes

lib/appium_lib_core/common/base/bridge/mjsonwp.rb

@@ -36,6 +36,11 @@ def commands(command)
             ::Appium::Core::Commands::MJSONWP::COMMANDS[command]
           end
 
+          # Returns all available sessions on the Appium server instance
+          def sessions
+            execute :get_all_sessions
+          end
+
           def take_element_screenshot(element)
             execute :take_element_screenshot, id: element.ref
           end

lib/appium_lib_core/common/base/bridge/w3c.rb

@@ -36,6 +36,11 @@ def commands(command)
             ::Appium::Core::Commands::W3C::COMMANDS[command]
           end
 
+          # Returns all available sessions on the Appium server instance
+          def sessions
+            execute :get_all_sessions
+          end
+
           # Perform touch actions for W3C module.
           # Generate `touch` pointer action here and users can use this via `driver.action`
           # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html

lib/appium_lib_core/common/base/driver.rb

@@ -952,6 +952,18 @@ def session_capabilities
           @bridge.session_capabilities
         end
 
+        # Returns available sessions on the Appium server
+        #
+        # @return [[Hash]]
+        #
+        # @example
+        #
+        #   @driver.sessions #=> [{'id' => 'c363add8-a7ca-4455-b9e3-9ac4d69e95b3', 'capabilities' => { capabilities as Hash }}]
+        #
+        def sessions
+          @bridge.sessions
+        end
+
         # Image Comparison
         def match_images_features(first_image:,
                                   second_image:,

lib/appium_lib_core/common/command/common.rb

@@ -20,6 +20,7 @@ module Commands
       # Some commands differ for each driver.
       COMMAND = {
         # common
+        get_all_sessions:           [:get,  'sessions'],
         available_contexts:         [:get,  'session/:session_id/contexts'],
         set_context:                [:post, 'session/:session_id/context'],
         current_context:            [:get,  'session/:session_id/context'],

test/unit/common_test.rb

@@ -148,11 +148,19 @@ def test_create_session_w3c
           .with(body: { implicit: 0 }.to_json)
           .to_return(headers: Mock::HEADER, status: 200, body: { value: nil }.to_json)
 
+        stub_request(:get, 'http://127.0.0.1:4723/wd/hub/sessions')
+          .to_return(headers: Mock::HEADER, status: 200, body: { value: [{ id: 'c363add8-a7ca-4455-b9e3-9ac4d69e95b3',
+                                                                           capabilities: CAPS }] }.to_json)
+
         driver = ::Appium::Core.for({ caps: CAPS, appium_lib: {} }).start_driver
 
         assert_requested(:post, 'http://127.0.0.1:4723/wd/hub/session', times: 1)
         assert_requested(:post, "#{Mock::SESSION}/timeouts", body: { implicit: 0 }.to_json, times: 1)
-        driver
+
+        sessions = driver.sessions
+        assert_requested(:get, 'http://127.0.0.1:4723/wd/hub/sessions', times: 1)
+        assert_equal 1, sessions.length
+        assert_equal 'c363add8-a7ca-4455-b9e3-9ac4d69e95b3', sessions.first['id']
       end
 
       def test_create_session_w3c_with_http_package

test/unit/script/commands_test.rb

@@ -36,31 +36,28 @@ def test_get_all_command_path
 
     # depends on webdriver-version... (number of commands)
     def test_implemented_mjsonwp_commands
-      assert_equal 146, @c.implemented_mjsonwp_commands.length
-      assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_mjsonwp_commands.first
+      assert_equal ['sessions', [:get]], @c.implemented_mjsonwp_commands.first
 
       # pick up an arbitrary command
       assert_equal %i(get post), @c.implemented_mjsonwp_commands['session/:session_id/alert_text']
     end
 
     def test_implemented_w3c_commands
       # assert_equal 119, @c.implemented_w3c_commands.length
-      assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_w3c_commands.first
+      assert_equal ['sessions', [:get]], @c.implemented_w3c_commands.first
 
       # pick up an arbitrary command
       assert_equal %i(get post), @c.implemented_w3c_commands['session/:session_id/alert/text']
     end
 
     def test_implemented_core_commands
-      assert_equal 60, @c.implemented_core_commands.length
-      assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_core_commands.first
+      assert_equal ['sessions', [:get]], @c.implemented_core_commands.first
 
       # pick up an arbitrary command
       assert_equal [:post], @c.implemented_core_commands['session/:session_id/appium/device/pull_folder']
     end
 
     def test_webdriver_oss_commands
-      assert_equal 86, @c.webdriver_oss_commands.length
       assert_equal ['session/:session_id', %i(get delete)], @c.webdriver_oss_commands.first
 
       # pick up an arbitrary command