Skip to content

refactor: make export session path manageable #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions android_tests/lib/android/specs/driver.rb
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ def sauce?
expected = { automation_name: nil,
custom_url: false,
export_session: false,
export_session_path: '/tmp/appium_lib_session',
default_wait: 1,
sauce_username: nil,
sauce_access_key: nil,
Expand Down
13 changes: 10 additions & 3 deletions ios_tests/lib/ios/specs/driver.rb
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,15 @@ def initialize(opts)
caps[:some_capability].must_equal 'some_capability'
end

t 'verify export session' do
# @driver.session_id
File.read('/tmp/appium_lib_session').strip.must_equal session_id
describe 'export session' do
t 'verify session id in the `export_session_path` variable' do
File.read(export_session_path).strip.must_equal session_id
end

t 'verify export session from default value' do
# @driver.session_id
File.read('/tmp/appium_lib_session').strip.must_equal session_id
end
end

describe 'Appium::Driver attributes' do
Expand All @@ -98,6 +104,7 @@ def initialize(opts)
expected = { automation_name: :xcuitest,
custom_url: false,
export_session: true,
export_session_path: '/tmp/appium_lib_session',
default_wait: 30,
sauce_username: nil,
sauce_access_key: nil,
Expand Down
17 changes: 11 additions & 6 deletions lib/appium_lib/core/driver.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ class Driver
# Export session id to textfile in /tmp for 3rd party tools
# @return [Boolean]
attr_reader :export_session
# @return [String] By default, session id is exported in '/tmp/appium_lib_session'
attr_reader :export_session_path

# Default wait time for elements to appear
# Returns the default client side wait.
Expand Down Expand Up @@ -141,7 +143,7 @@ def start_driver(server_url: nil,
listener: @listener)

# export session
write_session_id(@driver.session_id) if @export_session
write_session_id(@driver.session_id, @export_session_path) if @export_session
rescue Errno::ECONNREFUSED
raise "ERROR: Unable to connect to Appium. Is the server running on #{server_url}?"
end
Expand Down Expand Up @@ -291,9 +293,12 @@ def set_app_path

# @private
def set_appium_lib_specific_values(appium_lib_opts)
@custom_url = appium_lib_opts.fetch :server_url, false
@export_session = appium_lib_opts.fetch :export_session, false
@default_wait = appium_lib_opts.fetch :wait, 0
@custom_url = appium_lib_opts.fetch :server_url, false
@default_wait = appium_lib_opts.fetch :wait, 0

# bump current session id into a particular file
@export_session = appium_lib_opts.fetch :export_session, false
@export_session_path = appium_lib_opts.fetch :export_session_path, '/tmp/appium_lib_session'

@port = appium_lib_opts.fetch :port, 4723

Expand Down Expand Up @@ -330,8 +335,8 @@ def set_automation_name_if_nil
end

# @private
def write_session_id(session_id)
File.open('/tmp/appium_lib_session', 'w') { |f| f.puts session_id }
def write_session_id(session_id, export_path = '/tmp/appium_lib_session')
File.open(export_path, 'w') { |f| f.puts session_id }
rescue IOError => e
::Appium::Logger.warn e
nil
Expand Down
31 changes: 17 additions & 14 deletions lib/appium_lib/driver.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class Driver
attr_reader :caps
attr_reader :custom_url
attr_reader :export_session
attr_reader :export_session_path
attr_reader :default_wait
attr_reader :appium_port
attr_reader :appium_device
Expand Down Expand Up @@ -129,6 +130,7 @@ def initialize(opts = {}, global_driver = nil)
@caps = @core.caps
@custom_url = @core.custom_url
@export_session = @core.export_session
@export_session_path = @core.export_session_path
@default_wait = @core.default_wait
@appium_port = @core.port
@appium_wait_timeout = @core.wait_timeout
Expand Down Expand Up @@ -214,20 +216,21 @@ def set_sauce_related_values(appium_lib_opts)
# Returns a hash of the driver attributes
def driver_attributes
{
caps: @core.caps,
automation_name: @core.automation_name,
custom_url: @core.custom_url,
export_session: @core.export_session,
default_wait: @core.default_wait,
sauce_username: @sauce.username,
sauce_access_key: @sauce.access_key,
sauce_endpoint: @sauce.endpoint,
port: @core.port,
device: @core.device,
debug: @appium_debug,
listener: @listener,
wait_timeout: @core.wait_timeout,
wait_interval: @core.wait_interval
caps: @core.caps,
automation_name: @core.automation_name,
custom_url: @core.custom_url,
export_session: @core.export_session,
export_session_path: @core.export_session_path,
default_wait: @core.default_wait,
sauce_username: @sauce.username,
sauce_access_key: @sauce.access_key,
sauce_endpoint: @sauce.endpoint,
port: @core.port,
device: @core.device,
debug: @appium_debug,
listener: @listener,
wait_timeout: @core.wait_timeout,
wait_interval: @core.wait_interval
}
end

Expand Down