Class: RunLoop::Environment

Inherits:
Object
  • Object
show all
Defined in:
lib/run_loop/environment.rb

Class Method Summary collapse

Class Method Details

.bundle_id ⇒ Object

Returns the value of BUNDLE_ID



100
101
102
103
104
105
106
107
 
# File 'lib/run_loop/environment.rb', line 100

def self.bundle_id
  value = ENV['BUNDLE_ID']
  if !value || value == ''
    nil
  else
    value
  end
end

.ci? ⇒ Boolean

Returns true if running in a CI environment



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/run_loop/environment.rb', line 177

def self.ci?
  [
    self.ci_var_defined?,
    self.travis?,
    self.jenkins?,
    self.circle_ci?,
    self.teamcity?,
    self.gitlab?
  ].any?
end

.circle_ci? ⇒ Boolean

Returns true if running in Circle CI

Checks the value of CIRCLECI



155
156
157
158
 
# File 'lib/run_loop/environment.rb', line 155

def self.circle_ci?
  value = ENV["CIRCLECI"]
  !!value && value != ''
end

.debug? ⇒ Boolean

Returns true if debugging is enabled.



17
18
19
 
# File 'lib/run_loop/environment.rb', line 17

def self.debug?
  ENV['DEBUG'] == '1'
end

.debug_read? ⇒ Boolean

Returns true if read debugging is enabled.



22
23
24
 
# File 'lib/run_loop/environment.rb', line 22

def self.debug_read?
  ENV['DEBUG_READ'] == '1'
end

.derived_data ⇒ Object

Returns the value of DERIVED_DATA which can be used to specify an alternative DerivedData directory.

The default is ~/Library/Xcode/DerivedData, but Xcode allows you to change this value.



61
62
63
64
65
66
67
68
 
# File 'lib/run_loop/environment.rb', line 61

def self.derived_data
  value = ENV["DERIVED_DATA"]
  if value.nil? || value == ""
    nil
  else
    File.expand_path(value)
  end
end

.developer_dir ⇒ Object

Note:

Never call this directly. Always create an Xcode instance and allow it to derive the path to the Xcode toolchain.

Returns the value of DEVELOPER_DIR



127
128
129
130
131
132
133
134
 
# File 'lib/run_loop/environment.rb', line 127

def self.developer_dir
  value = ENV['DEVELOPER_DIR']
  if !value || value == ''
    nil
  else
    value
  end
end

.device_endpoint ⇒ Object

Returns the value of DEVICE_ENDPOINT



37
38
39
 
# File 'lib/run_loop/environment.rb', line 37

def self.device_endpoint
  ENV["DEVICE_ENDPOINT"]
end

.device_target ⇒ Object

Returns the value of DEVICE_TARGET



32
33
34
 
# File 'lib/run_loop/environment.rb', line 32

def self.device_target
  ENV["DEVICE_TARGET"]
end

.gitlab? ⇒ Boolean

Returns true if running in Teamcity

Checks the value of GITLAB_CI



171
172
173
174
 
# File 'lib/run_loop/environment.rb', line 171

def self.gitlab?
  value = ENV["GITLAB_CI"]
  !!value && value != ''
end

.jenkins? ⇒ Boolean

Returns true if running in Jenkins CI

Checks the value of JENKINS_HOME



139
140
141
142
 
# File 'lib/run_loop/environment.rb', line 139

def self.jenkins?
  value = ENV["JENKINS_HOME"]
  !!value && value != ''
end

.path_to_app_bundle ⇒ Object

Returns to the path to the app bundle (simulator builds).

Both APP_BUNDLE_PATH and APP are checked and in that order.

Use of APP_BUNDLE_PATH is deprecated and will be removed.



114
115
116
117
118
119
120
121
 
# File 'lib/run_loop/environment.rb', line 114

def self.path_to_app_bundle
  value = ENV['APP_BUNDLE_PATH'] || ENV['APP']
  if !value || value == ''
    nil
  else
    File.expand_path(value)
  end
end

.solution ⇒ Object

Returns the value of SOLUTION which can be used to specify a Xamarin Studio .sln

This is useful if your project has multiple solutions (.sln) and Calabash cannot detect the correct one.



75
76
77
78
79
80
81
82
 
# File 'lib/run_loop/environment.rb', line 75

def self.solution
  value = ENV["SOLUTION"]
  if value.nil? || value == ""
    nil
  else
    File.expand_path(value)
  end
end

.teamcity? ⇒ Boolean

Returns true if running in Teamcity

Checks the value of TEAMCITY_PROJECT_NAME



163
164
165
166
 
# File 'lib/run_loop/environment.rb', line 163

def self.teamcity?
  value = ENV["TEAMCITY_PROJECT_NAME"]
  !!value && value != ''
end

.trace_template ⇒ Object

Returns the value of TRACE_TEMPLATE; the Instruments template to use during testing.



86
87
88
 
# File 'lib/run_loop/environment.rb', line 86

def self.trace_template
  ENV['TRACE_TEMPLATE']
end

.travis? ⇒ Boolean

Returns true if running in Travis CI

Checks the value of TRAVIS



147
148
149
150
 
# File 'lib/run_loop/environment.rb', line 147

def self.travis?
  value = ENV["TRAVIS"]
  !!value && value != ''
end

.uia_timeout ⇒ Object

Returns the value of UIA_TIMEOUT. Use this control how long to wait for instruments to launch and attach to your application.

Non-empty values are converted to a float.



94
95
96
97
 
# File 'lib/run_loop/environment.rb', line 94

def self.uia_timeout
  timeout = ENV['UIA_TIMEOUT']
  timeout ? timeout.to_f : nil
end

.user_home_directory ⇒ Object

Returns the user home directory



5
6
7
8
9
10
11
12
13
14
 
# File 'lib/run_loop/environment.rb', line 5

def self.user_home_directory
  if self.xtc?
     home = File.join("./", "tmp", "home")
     FileUtils.mkdir_p(home)
     home
  else
    require 'etc'
    Etc.getpwuid.dir
  end
end

.with_debugging(debug, &block) ⇒ Object

!@visibility private



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/run_loop/environment.rb', line 189

def self.with_debugging(debug, &block)
  if debug
    original_value = ENV['DEBUG']

    begin
      ENV['DEBUG'] = '1'
      block.call
    ensure
      ENV['DEBUG'] = original_value
    end

  else
    block.call
  end
end

.xcodeproj ⇒ Object

Returns the value of XCODEPROJ which can be used to specify an Xcode project directory (my.xcodeproj).

This is useful if your project has multiple xcodeproj directories.

Most users should not set this variable.



47
48
49
50
51
52
53
54
 
# File 'lib/run_loop/environment.rb', line 47

def self.xcodeproj
  value = ENV["XCODEPROJ"]
  if value.nil? || value == ""
    return nil
  else
    File.expand_path(value)
  end
end

.xtc? ⇒ Boolean

Returns true if we are running on the XTC



27
28
29
 
# File 'lib/run_loop/environment.rb', line 27

def self.xtc?
  ENV['XAMARIN_TEST_CLOUD'] == '1'
end