src/modular/lib/modular_test_harness/cpp/fake_story_shell.h

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_MODULAR_LIB_MODULAR_TEST_HARNESS_CPP_FAKE_STORY_SHELL_H_
#define SRC_MODULAR_LIB_MODULAR_TEST_HARNESS_CPP_FAKE_STORY_SHELL_H_

#include <lib/modular/testing/cpp/fake_component.h>

#include <sdk/lib/sys/cpp/component_context.h>

namespace modular_testing {

// Story shell fake that provides access to the StoryShellContext.
//
// EXAMPLE USAGE (see test_harness_fixture.h for more details on how to use the
// test harness):
//
// modular_testing::FakeStoryShell fake_story_shell(
//    {.url = modular_testing::TestHarnessBuilder::GenerateFakeUrl(),
//     .sandbox_services = {"fuchsia.modular.StoryShellContext"}});
//
// modular_testing::TestHarnessBuilder builder;
// builder.InterceptSessionShell(fake_story_shell.BuildInterceptOptions());
// builder.BuildAndRun(test_harness()));
//
// // Wait for the session shell to be intercepted.
// RunLoopUntil([&] { return fake_story_shell.is_running(); });
class FakeStoryShell : public modular_testing::FakeComponent, fuchsia::modular::StoryShell {
 public:
  explicit FakeStoryShell(FakeComponent::Args args);
  ~FakeStoryShell() override;

  // Instantiates a FakeStoryShell with a randomly generated URL and default sandbox services
  // (see GetDefaultSandboxServices()).
  static std::unique_ptr<FakeStoryShell> CreateWithDefaultOptions();

  // Returns the default list of services (capabilities) a story shell expects in its namespace.
  // This method is useful when setting up a story shell for interception.
  //
  // Default services:
  //  * none
  static std::vector<std::string> GetDefaultSandboxServices();

  bool is_initialized() const { return !!story_shell_context_; }

  void set_on_destroy(fit::function<void()> on_destroy) { on_destroy_ = std::move(on_destroy); }

  void set_on_add_surface(
      fit::function<void(fuchsia::modular::ViewConnection, fuchsia::modular::SurfaceInfo2)>
          on_add_surface) {
    on_add_surface_ = std::move(on_add_surface);
  }

  fuchsia::modular::StoryShellContext* story_shell_context() { return story_shell_context_.get(); }

  // Produces a handler function that can be used in the outgoing service
  // provider.
  fidl::InterfaceRequestHandler<fuchsia::modular::StoryShell> GetHandler();

 private:
  // |modular_testing::FakeComponent|
  void OnCreate(fuchsia::sys::StartupInfo startup_info) override;

  // |modular_testing::FakeComponent|
  void OnDestroy() override;

  // |fuchsia::modular::StoryShell|
  void Initialize(
      fidl::InterfaceHandle<fuchsia::modular::StoryShellContext> story_shell_context) override;

  // |fuchsia::modular::StoryShell|
  void AddSurface(fuchsia::modular::ViewConnection view_connection,
                  fuchsia::modular::SurfaceInfo surface_info) override;

  // |fuchsia::modular::StoryShell|
  void AddSurface2(fuchsia::modular::ViewConnection2 view_connection,
                   fuchsia::modular::SurfaceInfo surface_info) override;

  // |fuchsia::modular::StoryShell|
  // Checks if the surface relationships match expectations
  void AddSurface3(fuchsia::modular::ViewConnection view_connection,
                   fuchsia::modular::SurfaceInfo2 surface_info) override;

  // |fuchsia::modular::StoryShell|
  void FocusSurface(std::string /* surface_id */) override {}

  // |fuchsia::modular::StoryShell|
  void DefocusSurface(std::string /* surface_id */, DefocusSurfaceCallback callback) override {
    callback();
  }

  // |fuchsia::modular::StoryShell|
  void RemoveSurface(std::string /* surface_id */) override {}

  // |fuchsia::modular::StoryShell|
  void UpdateSurface(fuchsia::modular::ViewConnection view_connection,
                     fuchsia::modular::SurfaceInfo /* surface_info */) override {}

  fuchsia::modular::StoryShellContextPtr story_shell_context_;
  fidl::BindingSet<fuchsia::modular::StoryShell> bindings_;
  fit::function<void(fuchsia::modular::ViewConnection, fuchsia::modular::SurfaceInfo2)>
      on_add_surface_;
  fit::function<void()> on_destroy_;
};

}  // namespace modular_testing

#endif  // SRC_MODULAR_LIB_MODULAR_TEST_HARNESS_CPP_FAKE_STORY_SHELL_H_