zircon/system/ulib/zxio/tests/dir_v2-test.cc

// 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.

#include <fuchsia/io2/llcpp/fidl.h>
#include <lib/async-loop/cpp/loop.h>
#include <lib/async-loop/default.h>
#include <lib/async/default.h>
#include <lib/fidl-async/cpp/bind.h>
#include <lib/sync/completion.h>
#include <lib/zxio/inception.h>
#include <lib/zxio/ops.h>

#include <atomic>
#include <memory>

#include <zxtest/zxtest.h>

namespace {

namespace fio2 = ::llcpp::fuchsia::io2;

class TestServerBase : public fio2::Directory::Interface {
 public:
  TestServerBase() = default;
  virtual ~TestServerBase() = default;

  // Exercised by |zxio_close|.
  void Close(CloseCompleter::Sync& completer) override {
    num_close_.fetch_add(1);
    completer.Close(ZX_OK);
  }

  void Reopen(fio2::ConnectionOptions options, ::zx::channel object_request,
              ReopenCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Describe(fio2::ConnectionInfoQuery query, DescribeCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void GetToken(GetTokenCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void GetAttributes(fio2::NodeAttributesQuery query,
                     GetAttributesCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void UpdateAttributes(fio2::NodeAttributes attributes,
                        UpdateAttributesCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Sync(SyncCompleter::Sync& completer) override { completer.Close(ZX_ERR_NOT_SUPPORTED); }

  void Open(fidl::StringView path, fio2::OpenMode mode, fio2::ConnectionOptions options,
            zx::channel object_request, OpenCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Unlink(fidl::StringView path, UnlinkCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Enumerate(fio2::DirectoryEnumerateOptions options, zx::channel iterator,
                 EnumerateCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Rename(fidl::StringView src, zx::event dst_parent_token, fidl::StringView dst,
              RenameCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Link(fidl::StringView src, zx::event dst_parent_token, fidl::StringView dst,
            LinkCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  void Watch(fio2::DirectoryWatchMask mask, fio2::DirectoryWatchOptions options,
             zx::channel watcher, WatchCompleter::Sync& completer) override {
    completer.Close(ZX_ERR_NOT_SUPPORTED);
  }

  uint32_t num_close() const { return num_close_.load(); }

 private:
  std::atomic<uint32_t> num_close_ = 0;
};

class DirV2 : public zxtest::Test {
 public:
  void SetUp() final {
    ASSERT_OK(zx::channel::create(0, &control_client_end_, &control_server_end_));
    ASSERT_OK(zxio_dir_v2_init(&dir_, control_client_end_.release()));
  }

  template <typename ServerImpl>
  ServerImpl* StartServer() {
    server_ = std::make_unique<ServerImpl>();
    loop_ = std::make_unique<async::Loop>(&kAsyncLoopConfigNoAttachToCurrentThread);
    zx_status_t status = ZX_OK;
    EXPECT_OK(status = loop_->StartThread("fake-filesystem"));
    if (status != ZX_OK) {
      return nullptr;
    }
    EXPECT_OK(fidl::BindSingleInFlightOnly(loop_->dispatcher(), std::move(control_server_end_),
                                           server_.get()));
    if (status != ZX_OK) {
      return nullptr;
    }
    return static_cast<ServerImpl*>(server_.get());
  }

  void TearDown() final {
    ASSERT_EQ(0, server_->num_close());
    ASSERT_OK(zxio_close(&dir_.io));
    ASSERT_EQ(1, server_->num_close());
  }

 protected:
  zxio_storage_t dir_;
  zx::channel control_client_end_;
  zx::channel control_server_end_;
  std::unique_ptr<TestServerBase> server_;
  std::unique_ptr<async::Loop> loop_;
};

TEST_F(DirV2, Enumerate) {
  class TestServer : public TestServerBase {
   public:
    void Enumerate(fio2::DirectoryEnumerateOptions options, zx::channel iterator,
                   EnumerateCompleter::Sync& completer) override {
      class IteratorServer : public fio2::DirectoryIterator::Interface {
       public:
        explicit IteratorServer(sync_completion_t* completion) : completion_(completion) {}

        // Sends a different entry every time.
        void GetNext(GetNextCompleter::Sync& completer) override {
          auto builder = fio2::DirectoryEntry::UnownedBuilder();
          fidl::StringView name;
          fio2::NodeProtocols protocols;
          fio2::Operations abilities;
          uint64_t id;
          switch (count_) {
            case 0:
              name = fidl::StringView("zero");
              builder.set_name(fidl::unowned_ptr(&name));
              protocols = fio2::NodeProtocols::DIRECTORY;
              builder.set_protocols(fidl::unowned_ptr(&protocols));
              abilities = fio2::Operations::ENUMERATE;
              builder.set_abilities(fidl::unowned_ptr(&abilities));
              id = 0;
              builder.set_id(fidl::unowned_ptr(&id));
              break;
            case 1:
              name = fidl::StringView("one");
              builder.set_name(fidl::unowned_ptr(&name));
              protocols = fio2::NodeProtocols::FILE;
              builder.set_protocols(fidl::unowned_ptr(&protocols));
              abilities = fio2::Operations::READ_BYTES;
              builder.set_abilities(fidl::unowned_ptr(&abilities));
              id = 1;
              builder.set_id(fidl::unowned_ptr(&id));
              break;
            default:
              completer.ReplySuccess(fidl::VectorView<fio2::DirectoryEntry>());
              return;
          }
          count_++;
          fio2::DirectoryEntry entry[1] = {builder.build()};
          completer.ReplySuccess(fidl::unowned_vec(entry));
        }

        ~IteratorServer() { sync_completion_signal(completion_); }

       private:
        uint64_t count_ = 0;
        sync_completion_t* completion_;
      };
      EXPECT_OK(fidl::BindSingleInFlightOnly(
          async_get_default_dispatcher(), std::move(iterator),
          std::make_unique<IteratorServer>(&iterator_teardown_completion_)));
    }

    sync_completion_t iterator_teardown_completion_;
  };

  TestServer* server;
  ASSERT_NO_FAILURES(server = StartServer<TestServer>());
  zxio_dirent_iterator_t iterator;
  ASSERT_OK(zxio_dirent_iterator_init(&iterator, &dir_.io));

  zxio_dirent_t* entry;
  ASSERT_OK(zxio_dirent_iterator_next(&iterator, &entry));
  EXPECT_TRUE(entry->has.protocols);
  EXPECT_EQ(ZXIO_NODE_PROTOCOL_DIRECTORY, entry->protocols);
  EXPECT_TRUE(entry->has.abilities);
  EXPECT_EQ(ZXIO_OPERATION_ENUMERATE, entry->abilities);
  EXPECT_TRUE(entry->has.id);
  EXPECT_EQ(0, entry->id);
  EXPECT_STR_EQ("zero", entry->name);
  EXPECT_EQ(strlen(entry->name), entry->name_length);

  ASSERT_OK(zxio_dirent_iterator_next(&iterator, &entry));
  EXPECT_TRUE(entry->has.protocols);
  EXPECT_EQ(ZXIO_NODE_PROTOCOL_FILE, entry->protocols);
  EXPECT_TRUE(entry->has.abilities);
  EXPECT_EQ(ZXIO_OPERATION_READ_BYTES, entry->abilities);
  EXPECT_TRUE(entry->has.id);
  EXPECT_EQ(1, entry->id);
  EXPECT_STR_EQ("one", entry->name);
  EXPECT_EQ(strlen(entry->name), entry->name_length);

  ASSERT_EQ(ZX_ERR_NOT_FOUND, zxio_dirent_iterator_next(&iterator, &entry));
  ASSERT_EQ(ZX_ERR_NOT_FOUND, zxio_dirent_iterator_next(&iterator, &entry));

  // Destroying the iterator should trigger the teardown of server-side iterator connection.
  zxio_dirent_iterator_destroy(&iterator);
  ASSERT_OK(
      sync_completion_wait_deadline(&server->iterator_teardown_completion_, ZX_TIME_INFINITE));
}

}  // namespace