Class: Scoutui::Commands::ClickObject

Inherits:
Command
  • Object
show all
Defined in:
lib/scoutui/commands/click_object.rb

Instance Attribute Summary

Attributes inherited from Command

#bm, #cmd, #description, #drv, #enableAssert, #executed, #executed_result, #locator, #rc, #stanza

Instance Method Summary collapse

Methods inherited from Command

#assert?, #disableAssert, #disableAsserts, #enableAsserts, #executedResult, #getLocator, #initialize, #passed?, #result, #run, #setBenchmark, #setLocator, #setResult, #wasExecuted?

Constructor Details

This class inherits a constructor from Scoutui::Commands::Command

Instance Method Details

#_whenClicked(page_elt) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/scoutui/commands/click_object.rb', line 7

def _whenClicked(page_elt)

  return if page_elt.nil?

  if page_elt.is_a?(Hash) && page_elt.has_key?('when_clicked')
    Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Verify #{page_elt['when_clicked']}"

    page_elt['when_clicked'].each do |_elt|

      _r = _elt.keys[0].to_s

      _pg = _elt[_r]

      #    _c = Scoutui::Commands::VerifyElement.new("verifyelement(" + _elt + ")")
      #    _c.execute(@drv)

      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " _whenClicked -> assertions (#{_pg}, #{_r.to_s})"


      if _pg.is_a?(Array)
        _pg.each do |_pg2|
          isVisible=Scoutui::Base::Assertions.instance.isVisible(@drv, _pg2, _r)
        end
      elsif _pg.is_a?(String)
        isVisible=Scoutui::Base::Assertions.instance.isVisible(@drv, _pg, _r)
      else
        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " => #{_pg}"
      end

    end

  end

end

#execute(drv, e = nil) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/scoutui/commands/click_object.rb', line 44

def execute(drv, e=nil)

  retries  = Scoutui::Utils::TestUtils.instance.retries()
  retries = 1 if retries < 1

  waitTime = Scoutui::Utils::TestUtils.instance.getDefaultWait

  Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " click_object.execute: #{@cmd} with #{retries} retries"
  obj=nil

  @drv=drv if !drv.nil?

  bm=nil
  all_windows = @drv.window_handles.size

  _req = Scoutui::Utils::TestUtils.instance.getReq()

  _locator = @cmd.match(/^\s*click\s*\((.*)\)\s*$/i)[1].to_s.strip
  Scoutui::Logger::LogMgr.instance.command.info __FILE__ + (__LINE__).to_s + " clickObject => #{_locator}"

  # _locator = Scoutui::Base::UserVars.instance.get(_locator)
  _locator = Scoutui::Base::UserVars.instance.normalize(_locator)

  Scoutui::Logger::LogMgr.instance.command.debug __FILE__ + (__LINE__).to_s + " | translate : #{_locator}"

  _clicked=false

  _startTime=Time.now
  _endTime=nil
  _clickTime=0
  isEnabled=nil

  begin

      if _locator

        (0..retries).each do |_i|

          _retry = true
          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Retry #{_i} ======> click(#{_locator})"

          begin

            _startTime=Time.now

            wait = Selenium::WebDriver::Wait.new(:timeout =>  waitTime)
            isEnabled = wait.until {
              obj=Scoutui::Base::QBrowser.getElement(@drv, _locator, Scoutui::Commands::Utils.instance.getFrameSearch(),  Scoutui::Commands::Utils.instance.getTimeout)
              obj.is_a?(Selenium::WebDriver::Element) && obj.enabled? && obj.displayed?
            }

            Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " isEnabled : #{isEnabled}"

            if isEnabled # && obj.is_a?(Selenium::WebDriver::Element)

              begin
                @drv.action.move_to(obj).perform
              rescue => ex
                Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " #{ex.class.to_s}"
                Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s +  ex.backtrace.join("\n\t")
              end

              bm=Benchmark.measure {
                obj.click
              }

              _endTime=Time.now
              _clickTime = (_endTime - _startTime)

              setBenchmark(bm)
              _retry = false
              _clicked=true

              if e.is_a?(Hash) && e.has_key?('page') && e['page'].has_key?('highlight') && e['page']['highlight']
                #
                # page:
                #  highlight: true
                #
                obj=Scoutui::Base::QBrowser.highlight(@drv, obj)
                Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " highlight then click : #{obj}"
              end

              if e.is_a?(Hash) && e['page'].has_key?('then')
                thenClause = Scoutui::Commands::ThenClause.new(@drv)
                thenClause.execute(e);
              end

              doUntil = Scoutui::Commands::DoUntil.new(@drv)

              _tm= {:start => Time.now, :end => 0 }
              _bUntil = doUntil.do_until(e)
              _tm[:end]=Time.now
              Testmgr::TestReport.instance.getReq(_req).testcase('until').add(_bUntil, Scoutui::Base::UserVars.instance.normalize("Verify after click, do-until met #{_bUntil}"), (_tm[:end] - _tm[:start]))


            elsif obj.is_a?(Selenium::WebDriver::Element) && obj.displayed?
              Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + "  object is displayed, but not enabled"
            end

          rescue Selenium::WebDriver::Error::StaleElementReferenceError => ex
            Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Retry #{_i} - Selenium::WebDriver::Error::UnknownError"
            Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s +  ex.backtrace.join("\n\t")
            _retry=true


          rescue Selenium::WebDriver::Error::TimeOutError => ex
            _retry=true

          rescue Selenium::WebDriver::Error::UnknownError => ex
            Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Retry #{_i} - Selenium::WebDriver::Error::UnknownError"
            Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s +  ex.backtrace.join("\n\t")
            _retry=true
          end

          break if !_retry

          sleep(0.25)
        end

        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " clicked(#{_locator}): #{_clicked}"
        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " o isWebDriverElement : #{obj.is_a?(Selenium::WebDriver::Element)}"

      #  isEnabled = obj.enabled? if obj.is_a?(Selenium::WebDriver::Element)

        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " o enabled : #{isEnabled}"

      #  if obj.is_a?(Selenium::WebDriver::Element) && !obj.enabled?
        if !isEnabled.nil? && !isEnabled
          Scoutui::Logger::LogMgr.instance.info __FILE__ + (__LINE__).to_s + "o Attemping to click a disabled element : #{_locator}"
        end

      #  puts __FILE__ + (__LINE__).to_s + " Pause for debug"; STDIN.gets

        page_elt = Scoutui::Utils::TestUtils.instance.getPageElement(_locator)

        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " PageElement(#{_locator}) => #{page_elt}"

        if all_windows > @drv.window_handles.size
          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " WINDOW was CLOSED.  Activate first window as our default";
          @drv.switch_to.window @drv.window_handles.first
          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Switched to first window"
        end

        _whenClicked(page_elt)

        if e.is_a?(Hash) && e.has_key?('page') && e['page'].has_key?('then')
          thenClause = Scoutui::Commands::ThenClause.new(@drv)
          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " thenClause => #{thenClause.class}"
          thenClause.execute(e)
        end

      #  _then(e)

      else
        Scoutui::Logger::LogMgr.instance.warn __FILE__ + (__LINE__).to_s + " Unable to click object that is not displayed."
      end


  rescue => ex
    Scoutui::Logger::LogMgr.instance.warn __FILE__ + (__LINE__).to_s + " #{ex.class.to_s} : Error during processing: #{ex.message}"
    Scoutui::Logger::LogMgr.instance.warn " Backtrace:\n\t#{ex.backtrace.join("\n\t")}"
  end


  Scoutui::Logger::LogMgr.instance.asserts.info "Verify object to click exists #{_locator} : #{obj.class.to_s} - #{!obj.nil?.to_s}"
  Scoutui::Logger::LogMgr.instance.asserts.info __FILE__ + (__LINE__).to_s + " Verify clicked #{_locator} - #{_clicked.to_s}"

  Testmgr::TestReport.instance.getReq(_req).testcase('click').add(!obj.nil?, "Verify object to click exists #{_locator} : #{obj.class.to_s}")
  Testmgr::TestReport.instance.getReq(_req).testcase('click').add(_clicked, "Verify clicked #{_locator}", _clickTime)


  if !_clicked
    Scoutui::Logger::LogMgr.instance.asserts.info __FILE__ + (__LINE__).to_s + "   FAILED CLICK: #{_locator}"
    # @drv.save_screenshot("/tmp/clickobject.failed.png")
  end

  setResult(_clicked)
end