Implementing switchToParentFrame command for IE driver

Author: jimevans

cpp/iedriver/CommandHandlers/SwitchToParentFrameCommandHandler.h

@@ -0,0 +1,49 @@
+// Copyright 2014 Software Freedom Conservancy
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef WEBDRIVER_IE_SWITCHTOPARENTFRAMECOMMANDHANDLER_H_
+#define WEBDRIVER_IE_SWITCHTOPARENTFRAMECOMMANDHANDLER_H_
+
+#include "../Browser.h"
+#include "../IECommandHandler.h"
+#include "../IECommandExecutor.h"
+
+namespace webdriver {
+
+class SwitchToParentFrameCommandHandler : public IECommandHandler {
+ public:
+  SwitchToParentFrameCommandHandler(void) {
+  }
+
+  virtual ~SwitchToParentFrameCommandHandler(void) {
+  }
+
+ protected:
+  void ExecuteInternal(const IECommandExecutor& executor,
+                       const LocatorMap& locator_parameters,
+                       const ParametersMap& command_parameters,
+                       Response* response) {
+    BrowserHandle browser_wrapper;
+    int status_code = executor.GetCurrentBrowser(&browser_wrapper);
+    if (status_code != WD_SUCCESS) {
+      response->SetErrorResponse(status_code, "Unable to get browser");
+      return;
+    }
+    browser_wrapper->SetFocusedFrameToParent();
+    response->SetSuccessResponse(Json::Value::null);
+  }
+};
+
+} // namespace webdriver
+
+#endif // WEBDRIVER_IE_SWITCHTOPARENTFRAMECOMMANDHANDLER_H_

cpp/iedriver/DocumentHost.cpp

@@ -156,6 +156,34 @@ int DocumentHost::SetFocusedFrameByIndex(const int frame_index) {
   return this->SetFocusedFrameByIdentifier(frame_identifier);
 }
 
+void DocumentHost::SetFocusedFrameToParent() {
+  LOG(TRACE) << "Entering DocumentHost::SetFocusedFrameToParent";
+  // Three possible outcomes.
+  // Outcome 1: Already at top-level browsing context. No-op.
+  if (this->focused_frame_window_ != NULL) {
+    CComPtr<IHTMLWindow2> parent_window;
+    HRESULT hr = this->focused_frame_window_->get_parent(&parent_window);
+    if (FAILED(hr)) {
+      LOGHR(WARN, hr) << "IHTMLWindow2::get_parent call failed.";
+    }
+    CComPtr<IHTMLWindow2> top_window;
+    hr = this->focused_frame_window_->get_top(&top_window);
+    if (FAILED(hr)) {
+      LOGHR(WARN, hr) << "IHTMLWindow2::get_top call failed.";
+    }
+    if (top_window.IsEqualObject(parent_window)) {
+      // Outcome 2: Focus is on a frame one level deep, making the
+      // parent the top-level browsing context. Set focused frame
+      // pointer to NULL.
+      this->focused_frame_window_ = NULL;
+    } else {
+      // Outcome 3: Focus is on a frame more than one level deep.
+      // Set focused frame pointer to parent frame.
+      this->focused_frame_window_ = parent_window;
+    }
+  }
+}
+
 int DocumentHost::SetFocusedFrameByIdentifier(VARIANT frame_identifier) {
   LOG(TRACE) << "Entering DocumentHost::SetFocusedFrameByIdentifier";
 

cpp/iedriver/DocumentHost.h

@@ -67,6 +67,7 @@ class DocumentHost {
   int SetFocusedFrameByIndex(const int frame_index);
   int SetFocusedFrameByName(const std::string& frame_name);
   int SetFocusedFrameByElement(IHTMLElement* frame_element);
+  void SetFocusedFrameToParent(void);
 
   bool wait_required(void) const { return this->wait_required_; }
   void set_wait_required(const bool value) { this->wait_required_ = value; }

cpp/iedriver/IECommandExecutor.cpp

@@ -72,6 +72,7 @@
 #include "CommandHandlers/SetWindowSizeCommandHandler.h"
 #include "CommandHandlers/SubmitElementCommandHandler.h"
 #include "CommandHandlers/SwitchToFrameCommandHandler.h"
+#include "CommandHandlers/SwitchToParentFrameCommandHandler.h"
 #include "CommandHandlers/SwitchToWindowCommandHandler.h"
 #include "StringUtilities.h"
 
@@ -766,6 +767,7 @@ void IECommandExecutor::PopulateCommandHandlers() {
   this->command_handlers_[webdriver::CommandType::GetWindowHandles] = CommandHandlerHandle(new GetAllWindowHandlesCommandHandler);
   this->command_handlers_[webdriver::CommandType::SwitchToWindow] = CommandHandlerHandle(new SwitchToWindowCommandHandler);
   this->command_handlers_[webdriver::CommandType::SwitchToFrame] = CommandHandlerHandle(new SwitchToFrameCommandHandler);
+  this->command_handlers_[webdriver::CommandType::SwitchToParentFrame] = CommandHandlerHandle(new SwitchToParentFrameCommandHandler);
   this->command_handlers_[webdriver::CommandType::Get] = CommandHandlerHandle(new GoToUrlCommandHandler);
   this->command_handlers_[webdriver::CommandType::GoForward] = CommandHandlerHandle(new GoForwardCommandHandler);
   this->command_handlers_[webdriver::CommandType::GoBack] = CommandHandlerHandle(new GoBackCommandHandler);

cpp/iedriver/IEDriver.vcxproj

@@ -262,6 +262,7 @@
     <ClInclude Include="CommandHandlers\SetTimeoutCommandHandler.h" />
     <ClInclude Include="CommandHandlers\SetWindowPositionCommandHandler.h" />
     <ClInclude Include="CommandHandlers\SetWindowSizeCommandHandler.h" />
+    <ClInclude Include="CommandHandlers\SwitchToParentFrameCommandHandler.h" />
     <ClInclude Include="DocumentHost.h" />
     <ClInclude Include="Element.h" />
     <ClInclude Include="ElementFinder.h" />

cpp/iedriver/IEDriver.vcxproj.filters

@@ -349,6 +349,9 @@
     <ClInclude Include="ProxyManager.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="CommandHandlers\SwitchToParentFrameCommandHandler.h">
+      <Filter>Header Files\CommandHandlers</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <None Include="IEDriver.def">

cpp/iedriverserver/CHANGELOG

@@ -9,6 +9,10 @@ available via the project downloads page. Changes in "revision" field indicate
 private releases checked into the prebuilts directory of the source tree, but
 not made generally available on the downloads page.
 
+v2.42.0.1
+=========
+ * Implemented switchToParentFrame command.
+
 v2.42.0.0
 =========
  * Release to synchronize with release of Selenium project.