Skip to content

Commit 5bfb3b8

Browse files
authored
chore: add deprecation marks in core (#430)
* add deprecation mark in core.quit_driver * chore: tweak comments * deprecate platform_version, not necessary for the core * remove override since 4.2 has the same * add missing endpoints * add missing endpoints more * add missing endpoints more * tweak spaces * use driver.quit in tests
1 parent 30c6cae commit 5bfb3b8

13 files changed

+25
-19
lines changed

lib/appium_lib_core/common/base/bridge.rb

+2-6
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,6 @@ def session_capabilities
211211
::Appium::Core::Base::Capabilities.json_create execute(:get_capabilities)
212212
end
213213

214-
# Override for safe. Newer ruby selenium webdriver already has the same code
215-
def page_source
216-
execute :get_page_source
217-
end
218-
219214
# For Appium
220215
# override
221216
def element_displayed?(element)
@@ -229,7 +224,8 @@ def element_displayed?(element)
229224
# override
230225
def element_attribute(element, name)
231226
# For W3C in Selenium Client
232-
# execute_atom :getAttribute, element, name
227+
# execute_atom :getAttribute, element, name.
228+
# 'dom_attribute' in the WebDriver Selenium.
233229
execute :get_element_attribute, id: element.id, name: name
234230
end
235231

lib/appium_lib_core/common/command.rb

+4
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,15 @@ module Commands
7070
find_elements: [:post, 'session/:session_id/elements'],
7171
find_child_element: [:post, 'session/:session_id/element/:id/element'],
7272
find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
73+
find_shadow_child_element: [:post, 'session/:session_id/shadow/:id/element'],
74+
find_shadow_child_elements: [:post, 'session/:session_id/shadow/:id/elements'],
7375
get_active_element: [:get, 'session/:session_id/element/active'],
7476
is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
7577
get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
7678
get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
7779
get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'],
80+
get_element_aria_role: [:get, 'session/:session_id/element/:id/computedrole'],
81+
get_element_aria_label: [:get, 'session/:session_id/element/:id/computedlabel'],
7882
get_element_text: [:get, 'session/:session_id/element/:id/text'],
7983
get_element_tag_name: [:get, 'session/:session_id/element/:id/name'],
8084
get_element_rect: [:get, 'session/:session_id/element/:id/rect'],

lib/appium_lib_core/driver.rb

+9-3
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ def initialize
328328
public
329329

330330
# @private
331-
# Set up for a neww session
331+
# Set up for a new session
332332
def setup_for_new_session(opts = {})
333333
@custom_url = opts.delete :url # to set the custom url as :url
334334

@@ -443,7 +443,7 @@ def start_driver(server_url: nil,
443443
@driver
444444
end
445445

446-
# @privvate
446+
# @private
447447
# Attach to an existing session
448448
def attach_to(session_id, url: nil, automation_name: nil, platform_name: nil,
449449
http_client_ops: { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 })
@@ -509,14 +509,15 @@ def set_implicit_wait_by_default(wait)
509509
{}
510510
end
511511

512-
# Quits the driver
512+
# [Deprecated] Quits the driver. This method is the same as @driver.quit
513513
# @return [void]
514514
#
515515
# @example
516516
#
517517
# @core.quit_driver
518518
#
519519
def quit_driver
520+
::Appium::Logger.warn('[DEPRECATION] quit_driver will be removed. Please use @driver.quit instead.')
520521
@driver.quit
521522
rescue # rubocop:disable Style/RescueStandardError
522523
nil
@@ -562,6 +563,11 @@ def appium_server_version
562563
# @core.platform_version #=> [10,1,1]
563564
#
564565
def platform_version
566+
::Appium::Logger.warn(
567+
'[DEPRECATION] platform_version method will be. ' \
568+
'Please check the platformVersion via @driver.capabilities["platformVersion"] instead.'
569+
)
570+
565571
p_version = @driver.capabilities['platformVersion'] || @driver.session_capabilities['platformVersion']
566572
p_version.split('.').map(&:to_i)
567573
end

test/functional/android/android/device_data_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def setup
2626

2727
def teardown
2828
save_reports(@driver)
29-
@@core.quit_driver
29+
@driver&.quit
3030
end
3131

3232
def test_push_and_pull_file

test/functional/android/android/device_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def setup
2626

2727
def teardown
2828
save_reports(@driver)
29-
@@core.quit_driver
29+
@driver&.quit
3030
end
3131

3232
def test_window_size

test/functional/android/android/mjpeg_server_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def setup
2626

2727
def teardown
2828
save_reports(@driver)
29-
@@core.quit_driver
29+
@driver&.quit
3030
end
3131

3232
def test_start_recording_screen

test/functional/android/android/mobile_commands_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def setup
2424

2525
def teardown
2626
save_reports(@driver)
27-
@core.quit_driver
27+
@driver&.quit
2828
end
2929

3030
# @since Appium 1.12.0

test/functional/android/android/search_context_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def setup
2626

2727
def teardown
2828
save_reports(@driver)
29-
@@core.quit_driver
29+
@driver&.quit
3030
end
3131

3232
def test_uiautomator

test/functional/android/driver_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def setup
2525

2626
def teardown
2727
save_reports(@driver)
28-
@@core.quit_driver
28+
@driver&.quit
2929
end
3030

3131
def test_appium_server_version

test/functional/android/patch_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def setup
2525

2626
def teardown
2727
save_reports(@driver)
28-
@@core.quit_driver
28+
@driver&.quit
2929
end
3030

3131
def test_method_missing_attributes

test/functional/android/webdriver/create_session_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def test_w3c_default
2727
driver = core.start_driver
2828
assert !driver.capabilities.nil?
2929

30-
core.quit_driver
30+
driver&.quit
3131
end
3232
end
3333
end

test/functional/android/webdriver/device_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def setup
2727

2828
def teardown
2929
save_reports(@driver)
30-
@@core.quit_driver
30+
@driver&.quit
3131
end
3232

3333
def test_capabilities

test/functional/android/webdriver/w3c_actions_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def setup
2727

2828
def teardown
2929
save_reports(@driver)
30-
@@core.quit_driver
30+
@driver&.quit
3131
end
3232

3333
def test_tap_scroll

0 commit comments

Comments
 (0)