[ceph.git] / ceph / src / test / librbd / managed_lock / test_mock_AcquireRequest.cc

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab

#include "test/librbd/test_mock_fixture.h"
#include "test/librbd/test_support.h"
#include "test/librados_test_stub/MockTestMemIoCtxImpl.h"
#include "test/librados_test_stub/MockTestMemRadosClient.h"
#include "cls/lock/cls_lock_ops.h"
#include "librbd/managed_lock/AcquireRequest.h"
#include "librbd/managed_lock/BreakRequest.h"
#include "librbd/managed_lock/GetLockerRequest.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <arpa/inet.h>
#include <list>

namespace librbd {
namespace watcher {
template <>
struct Traits<MockImageCtx> {
  typedef librbd::MockImageWatcher Watcher;
};
}

namespace managed_lock {

template<>
struct BreakRequest<librbd::MockImageCtx> {
  Context *on_finish = nullptr;
  static BreakRequest *s_instance;
  static BreakRequest* create(librados::IoCtx& ioctx,
                              AsioEngine& asio_engine,
                              const std::string& oid, const Locker &locker,
                              bool exclusive, bool blocklist_locker,
                              uint32_t blocklist_expire_seconds,
                              bool force_break_lock, Context *on_finish) {
    CephContext *cct = reinterpret_cast<CephContext *>(ioctx.cct());
    EXPECT_EQ(cct->_conf.get_val<bool>("rbd_blocklist_on_break_lock"),
              blocklist_locker);
    EXPECT_EQ(cct->_conf.get_val<uint64_t>("rbd_blocklist_expire_seconds"),
              blocklist_expire_seconds);
    EXPECT_FALSE(force_break_lock);
    ceph_assert(s_instance != nullptr);
    s_instance->on_finish = on_finish;
    return s_instance;
  }

  BreakRequest() {
    s_instance = this;
  }
  MOCK_METHOD0(send, void());
};

template <>
struct GetLockerRequest<librbd::MockImageCtx> {
  Locker *locker = nullptr;
  Context *on_finish = nullptr;

  static GetLockerRequest *s_instance;
  static GetLockerRequest* create(librados::IoCtx& ioctx,
                                  const std::string& oid, bool exclusive,
                                  Locker *locker, Context *on_finish) {
    ceph_assert(s_instance != nullptr);
    s_instance->locker = locker;
    s_instance->on_finish = on_finish;
    return s_instance;
  }

  GetLockerRequest() {
    s_instance = this;
  }

  MOCK_METHOD0(send, void());
};

BreakRequest<librbd::MockImageCtx> *BreakRequest<librbd::MockImageCtx>::s_instance = nullptr;
GetLockerRequest<librbd::MockImageCtx> *GetLockerRequest<librbd::MockImageCtx>::s_instance = nullptr;

} // namespace managed_lock
} // namespace librbd

// template definitions
#include "librbd/managed_lock/AcquireRequest.cc"
template class librbd::managed_lock::AcquireRequest<librbd::MockImageCtx>;

namespace {

MATCHER_P(IsLockType, exclusive, "") {
  cls_lock_lock_op op;
  bufferlist bl;
  bl.share(arg);
  auto iter = bl.cbegin();
  decode(op, iter);
  return op.type == (exclusive ? ClsLockType::EXCLUSIVE : ClsLockType::SHARED);
}

} // anonymous namespace

namespace librbd {
namespace managed_lock {

using ::testing::_;
using ::testing::DoAll;
using ::testing::InSequence;
using ::testing::Invoke;
using ::testing::Return;
using ::testing::SetArgPointee;
using ::testing::StrEq;
using ::testing::WithArg;

static const std::string TEST_COOKIE("auto 123");

class TestMockManagedLockAcquireRequest : public TestMockFixture {
public:
  typedef AcquireRequest<MockImageCtx> MockAcquireRequest;
  typedef BreakRequest<MockImageCtx> MockBreakRequest;
  typedef GetLockerRequest<MockImageCtx> MockGetLockerRequest;

  void expect_lock(MockImageCtx &mock_image_ctx, int r,
                             bool exclusive = true) {
    EXPECT_CALL(get_mock_io_ctx(mock_image_ctx.md_ctx),
                exec(mock_image_ctx.header_oid, _, StrEq("lock"),
                     StrEq("lock"), IsLockType(exclusive), _, _, _))
                  .WillOnce(Return(r));
  }

  void expect_get_locker(MockImageCtx &mock_image_ctx,
                         MockGetLockerRequest &mock_get_locker_request,
                         const Locker &locker, int r) {
    EXPECT_CALL(mock_get_locker_request, send())
      .WillOnce(Invoke([&mock_image_ctx, &mock_get_locker_request, locker, r]() {
          *mock_get_locker_request.locker = locker;
          mock_image_ctx.image_ctx->op_work_queue->queue(
            mock_get_locker_request.on_finish, r);
        }));
  }

  void expect_break_lock(MockImageCtx &mock_image_ctx,
                         MockBreakRequest &mock_break_request, int r) {
    EXPECT_CALL(mock_break_request, send())
      .WillOnce(FinishRequest(&mock_break_request, r, &mock_image_ctx));
  }
};

TEST_F(TestMockManagedLockAcquireRequest, SuccessExclusive) {

  librbd::ImageCtx *ictx;
  ASSERT_EQ(0, open_image(m_image_name, &ictx));

  MockImageCtx mock_image_ctx(*ictx);
  MockGetLockerRequest mock_get_locker_request;

  InSequence seq;
  expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, 0);
  expect_lock(mock_image_ctx, 0);

  C_SaferCond ctx;
  MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
    mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
    TEST_COOKIE, true, true, 0, &ctx);
  req->send();
  ASSERT_EQ(0, ctx.wait());
}

TEST_F(TestMockManagedLockAcquireRequest, SuccessShared) {

  librbd::ImageCtx *ictx;
  ASSERT_EQ(0, open_image(m_image_name, &ictx));

  MockImageCtx mock_image_ctx(*ictx);
  MockGetLockerRequest mock_get_locker_request;

  InSequence seq;
  expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, 0);
  expect_lock(mock_image_ctx, 0, false);

  C_SaferCond ctx;
  MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
    mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
    TEST_COOKIE, false, true, 0, &ctx);
  req->send();
  ASSERT_EQ(0, ctx.wait());
}

TEST_F(TestMockManagedLockAcquireRequest, LockBusy) {
  librbd::ImageCtx *ictx;
  ASSERT_EQ(0, open_image(m_image_name, &ictx));

  MockImageCtx mock_image_ctx(*ictx);
  MockGetLockerRequest mock_get_locker_request;
  MockBreakRequest mock_break_request;
  expect_op_work_queue(mock_image_ctx);

  InSequence seq;
  expect_get_locker(mock_image_ctx, mock_get_locker_request,
                    {entity_name_t::CLIENT(1), "auto 123", "1.2.3.4:0/0", 123},
                    0);
  expect_lock(mock_image_ctx, -EBUSY);
  expect_break_lock(mock_image_ctx, mock_break_request, 0);
  expect_lock(mock_image_ctx, -ENOENT);

  C_SaferCond ctx;
  MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
    mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
    TEST_COOKIE, true, true, 0, &ctx);
  req->send();
  ASSERT_EQ(-ENOENT, ctx.wait());
}

TEST_F(TestMockManagedLockAcquireRequest, GetLockInfoError) {
  librbd::ImageCtx *ictx;
  ASSERT_EQ(0, open_image(m_image_name, &ictx));

  MockImageCtx mock_image_ctx(*ictx);
  MockGetLockerRequest mock_get_locker_request;

  InSequence seq;
  expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, -EINVAL);

  C_SaferCond ctx;
  MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
    mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
    TEST_COOKIE, true, true, 0, &ctx);
  req->send();
  ASSERT_EQ(-EINVAL, ctx.wait());
}

TEST_F(TestMockManagedLockAcquireRequest, GetLockInfoEmpty) {
  librbd::ImageCtx *ictx;
  ASSERT_EQ(0, open_image(m_image_name, &ictx));

  MockImageCtx mock_image_ctx(*ictx);
  MockGetLockerRequest mock_get_locker_request;

  InSequence seq;
  expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, -ENOENT);
  expect_lock(mock_image_ctx, -EINVAL);

  C_SaferCond ctx;
  MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
    mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
    TEST_COOKIE, true, true, 0, &ctx);
  req->send();
  ASSERT_EQ(-EINVAL, ctx.wait());
}

TEST_F(TestMockManagedLockAcquireRequest, BreakLockError) {
  librbd::ImageCtx *ictx;
  ASSERT_EQ(0, open_image(m_image_name, &ictx));

  MockImageCtx mock_image_ctx(*ictx);
  MockGetLockerRequest mock_get_locker_request;
  MockBreakRequest mock_break_request;

  InSequence seq;
  expect_get_locker(mock_image_ctx, mock_get_locker_request,
                    {entity_name_t::CLIENT(1), "auto 123", "1.2.3.4:0/0", 123},
                    0);
  expect_lock(mock_image_ctx, -EBUSY);
  expect_break_lock(mock_image_ctx, mock_break_request, -EINVAL);

  C_SaferCond ctx;
  MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
    mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
    TEST_COOKIE, true, true, 0, &ctx);
  req->send();
  ASSERT_EQ(-EINVAL, ctx.wait());
}

} // namespace managed_lock
} // namespace librbd
Commit	Line	Data
7c673cae FG	1	// -- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t --
	2	// vim: ts=8 sw=2 smarttab
	3
	4	#include "test/librbd/test_mock_fixture.h"
	5	#include "test/librbd/test_support.h"
	6	#include "test/librados_test_stub/MockTestMemIoCtxImpl.h"
	7	#include "test/librados_test_stub/MockTestMemRadosClient.h"
	8	#include "cls/lock/cls_lock_ops.h"
	9	#include "librbd/managed_lock/AcquireRequest.h"
	10	#include "librbd/managed_lock/BreakRequest.h"
	11	#include "librbd/managed_lock/GetLockerRequest.h"
	12	#include "gmock/gmock.h"
	13	#include "gtest/gtest.h"
	14	#include <arpa/inet.h>
	15	#include <list>
	16
	17	namespace librbd {
	18	namespace watcher {
	19	template <>
	20	struct Traits<MockImageCtx> {
	21	typedef librbd::MockImageWatcher Watcher;
	22	};
	23	}
	24
	25	namespace managed_lock {
	26
	27	template<>
	28	struct BreakRequest<librbd::MockImageCtx> {
	29	Context *on_finish = nullptr;
	30	static BreakRequest *s_instance;
f67539c2 TL	31	static BreakRequest* create(librados::IoCtx& ioctx,
f67539c2 TL	32	AsioEngine& asio_engine,
7c673cae	33	const std::string& oid, const Locker &locker,
f67539c2 TL	34	bool exclusive, bool blocklist_locker,
f67539c2 TL	35	uint32_t blocklist_expire_seconds,
7c673cae FG	36	bool force_break_lock, Context *on_finish) {
7c673cae FG	37	CephContext cct = reinterpret_cast<CephContext >(ioctx.cct());
f67539c2 TL	38	EXPECT_EQ(cct->_conf.get_val<bool>("rbd_blocklist_on_break_lock"),
	39	blocklist_locker);
	40	EXPECT_EQ(cct->_conf.get_val<uint64_t>("rbd_blocklist_expire_seconds"),
	41	blocklist_expire_seconds);
7c673cae	42	EXPECT_FALSE(force_break_lock);
11fdf7f2	43	ceph_assert(s_instance != nullptr);
7c673cae FG	44	s_instance->on_finish = on_finish;
	45	return s_instance;
	46	}
	47
	48	BreakRequest() {
	49	s_instance = this;
	50	}
	51	MOCK_METHOD0(send, void());
	52	};
	53
	54	template <>
	55	struct GetLockerRequest<librbd::MockImageCtx> {
11fdf7f2 TL	56	Locker *locker = nullptr;
11fdf7f2 TL	57	Context *on_finish = nullptr;
7c673cae FG	58
	59	static GetLockerRequest *s_instance;
	60	static GetLockerRequest* create(librados::IoCtx& ioctx,
	61	const std::string& oid, bool exclusive,
	62	Locker locker, Context on_finish) {
11fdf7f2	63	ceph_assert(s_instance != nullptr);
7c673cae FG	64	s_instance->locker = locker;
	65	s_instance->on_finish = on_finish;
	66	return s_instance;
	67	}
	68
	69	GetLockerRequest() {
	70	s_instance = this;
	71	}
	72
	73	MOCK_METHOD0(send, void());
	74	};
	75
	76	BreakRequest<librbd::MockImageCtx> *BreakRequest<librbd::MockImageCtx>::s_instance = nullptr;
	77	GetLockerRequest<librbd::MockImageCtx> *GetLockerRequest<librbd::MockImageCtx>::s_instance = nullptr;
	78
	79	} // namespace managed_lock
	80	} // namespace librbd
	81
	82	// template definitions
	83	#include "librbd/managed_lock/AcquireRequest.cc"
	84	template class librbd::managed_lock::AcquireRequest<librbd::MockImageCtx>;
	85
	86	namespace {
	87
	88	MATCHER_P(IsLockType, exclusive, "") {
	89	cls_lock_lock_op op;
	90	bufferlist bl;
	91	bl.share(arg);
11fdf7f2 TL	92	auto iter = bl.cbegin();
11fdf7f2 TL	93	decode(op, iter);
f67539c2	94	return op.type == (exclusive ? ClsLockType::EXCLUSIVE : ClsLockType::SHARED);
7c673cae FG	95	}
	96
	97	} // anonymous namespace
	98
	99	namespace librbd {
	100	namespace managed_lock {
	101
	102	using ::testing::_;
	103	using ::testing::DoAll;
	104	using ::testing::InSequence;
	105	using ::testing::Invoke;
	106	using ::testing::Return;
	107	using ::testing::SetArgPointee;
	108	using ::testing::StrEq;
	109	using ::testing::WithArg;
	110
	111	static const std::string TEST_COOKIE("auto 123");
	112
	113	class TestMockManagedLockAcquireRequest : public TestMockFixture {
	114	public:
	115	typedef AcquireRequest<MockImageCtx> MockAcquireRequest;
	116	typedef BreakRequest<MockImageCtx> MockBreakRequest;
	117	typedef GetLockerRequest<MockImageCtx> MockGetLockerRequest;
	118
	119	void expect_lock(MockImageCtx &mock_image_ctx, int r,
	120	bool exclusive = true) {
	121	EXPECT_CALL(get_mock_io_ctx(mock_image_ctx.md_ctx),
	122	exec(mock_image_ctx.header_oid, _, StrEq("lock"),
f67539c2	123	StrEq("lock"), IsLockType(exclusive), _, _, _))
7c673cae FG	124	.WillOnce(Return(r));
	125	}
	126
	127	void expect_get_locker(MockImageCtx &mock_image_ctx,
	128	MockGetLockerRequest &mock_get_locker_request,
	129	const Locker &locker, int r) {
	130	EXPECT_CALL(mock_get_locker_request, send())
	131	.WillOnce(Invoke([&mock_image_ctx, &mock_get_locker_request, locker, r]() {
	132	*mock_get_locker_request.locker = locker;
	133	mock_image_ctx.image_ctx->op_work_queue->queue(
	134	mock_get_locker_request.on_finish, r);
	135	}));
	136	}
	137
	138	void expect_break_lock(MockImageCtx &mock_image_ctx,
	139	MockBreakRequest &mock_break_request, int r) {
	140	EXPECT_CALL(mock_break_request, send())
	141	.WillOnce(FinishRequest(&mock_break_request, r, &mock_image_ctx));
	142	}
	143	};
	144
	145	TEST_F(TestMockManagedLockAcquireRequest, SuccessExclusive) {
	146
	147	librbd::ImageCtx *ictx;
	148	ASSERT_EQ(0, open_image(m_image_name, &ictx));
	149
	150	MockImageCtx mock_image_ctx(*ictx);
	151	MockGetLockerRequest mock_get_locker_request;
	152
	153	InSequence seq;
	154	expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, 0);
	155	expect_lock(mock_image_ctx, 0);
	156
	157	C_SaferCond ctx;
	158	MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
f67539c2 TL	159	mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
f67539c2 TL	160	TEST_COOKIE, true, true, 0, &ctx);
7c673cae FG	161	req->send();
	162	ASSERT_EQ(0, ctx.wait());
	163	}
	164
	165	TEST_F(TestMockManagedLockAcquireRequest, SuccessShared) {
	166
	167	librbd::ImageCtx *ictx;
	168	ASSERT_EQ(0, open_image(m_image_name, &ictx));
	169
	170	MockImageCtx mock_image_ctx(*ictx);
	171	MockGetLockerRequest mock_get_locker_request;
	172
	173	InSequence seq;
	174	expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, 0);
	175	expect_lock(mock_image_ctx, 0, false);
	176
	177	C_SaferCond ctx;
	178	MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
f67539c2 TL	179	mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
f67539c2 TL	180	TEST_COOKIE, false, true, 0, &ctx);
7c673cae FG	181	req->send();
	182	ASSERT_EQ(0, ctx.wait());
	183	}
	184
	185	TEST_F(TestMockManagedLockAcquireRequest, LockBusy) {
	186	librbd::ImageCtx *ictx;
	187	ASSERT_EQ(0, open_image(m_image_name, &ictx));
	188
	189	MockImageCtx mock_image_ctx(*ictx);
	190	MockGetLockerRequest mock_get_locker_request;
	191	MockBreakRequest mock_break_request;
	192	expect_op_work_queue(mock_image_ctx);
	193
	194	InSequence seq;
	195	expect_get_locker(mock_image_ctx, mock_get_locker_request,
	196	{entity_name_t::CLIENT(1), "auto 123", "1.2.3.4:0/0", 123},
	197	0);
	198	expect_lock(mock_image_ctx, -EBUSY);
	199	expect_break_lock(mock_image_ctx, mock_break_request, 0);
7c673cae FG	200	expect_lock(mock_image_ctx, -ENOENT);
	201
	202	C_SaferCond ctx;
	203	MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
f67539c2 TL	204	mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
f67539c2 TL	205	TEST_COOKIE, true, true, 0, &ctx);
7c673cae FG	206	req->send();
	207	ASSERT_EQ(-ENOENT, ctx.wait());
	208	}
	209
	210	TEST_F(TestMockManagedLockAcquireRequest, GetLockInfoError) {
	211	librbd::ImageCtx *ictx;
	212	ASSERT_EQ(0, open_image(m_image_name, &ictx));
	213
	214	MockImageCtx mock_image_ctx(*ictx);
	215	MockGetLockerRequest mock_get_locker_request;
	216
	217	InSequence seq;
	218	expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, -EINVAL);
	219
	220	C_SaferCond ctx;
	221	MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
f67539c2 TL	222	mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
f67539c2 TL	223	TEST_COOKIE, true, true, 0, &ctx);
7c673cae FG	224	req->send();
	225	ASSERT_EQ(-EINVAL, ctx.wait());
	226	}
	227
	228	TEST_F(TestMockManagedLockAcquireRequest, GetLockInfoEmpty) {
	229	librbd::ImageCtx *ictx;
	230	ASSERT_EQ(0, open_image(m_image_name, &ictx));
	231
	232	MockImageCtx mock_image_ctx(*ictx);
	233	MockGetLockerRequest mock_get_locker_request;
	234
	235	InSequence seq;
	236	expect_get_locker(mock_image_ctx, mock_get_locker_request, {}, -ENOENT);
	237	expect_lock(mock_image_ctx, -EINVAL);
	238
	239	C_SaferCond ctx;
	240	MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
f67539c2 TL	241	mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
f67539c2 TL	242	TEST_COOKIE, true, true, 0, &ctx);
7c673cae FG	243	req->send();
	244	ASSERT_EQ(-EINVAL, ctx.wait());
	245	}
	246
	247	TEST_F(TestMockManagedLockAcquireRequest, BreakLockError) {
	248	librbd::ImageCtx *ictx;
	249	ASSERT_EQ(0, open_image(m_image_name, &ictx));
	250
	251	MockImageCtx mock_image_ctx(*ictx);
	252	MockGetLockerRequest mock_get_locker_request;
	253	MockBreakRequest mock_break_request;
	254
	255	InSequence seq;
	256	expect_get_locker(mock_image_ctx, mock_get_locker_request,
	257	{entity_name_t::CLIENT(1), "auto 123", "1.2.3.4:0/0", 123},
	258	0);
	259	expect_lock(mock_image_ctx, -EBUSY);
	260	expect_break_lock(mock_image_ctx, mock_break_request, -EINVAL);
	261
	262	C_SaferCond ctx;
	263	MockAcquireRequest *req = MockAcquireRequest::create(mock_image_ctx.md_ctx,
f67539c2 TL	264	mock_image_ctx.image_watcher, *ictx->asio_engine, mock_image_ctx.header_oid,
f67539c2 TL	265	TEST_COOKIE, true, true, 0, &ctx);
7c673cae FG	266	req->send();
	267	ASSERT_EQ(-EINVAL, ctx.wait());
	268	}
	269
	270	} // namespace managed_lock
	271	} // namespace librbd