Skip to content

Add Delegate interface for OlpClient and implement mock for testing #1709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VladyslavTsymbal wants to merge 1 commit into
base: master
Choose a base branch
from
+253 −42
Open

Add Delegate interface for OlpClient and implement mock for testing #1709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 64 additions & 3 deletions olp-cpp-sdk-core/include/olp/core/client/OlpClient.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,56 @@ class CORE_API OlpClient {
using RequestBodyType = std::shared_ptr<std::vector<std::uint8_t>>;

OlpClient();
/**
* @brief Abstract delegate interface for the `OlpClient` implementation.
*
* Implement this interface to inject a custom (e.g. test/mock)
* implementation into `OlpClient` via the
* `OlpClient(std::shared_ptr<Delegate>)` constructor. The production
* implementation is created automatically by the other constructors.
*/
class CORE_API Delegate {
public:
virtual ~Delegate() = default;

/// @copydoc OlpClient::SetBaseUrl
virtual void SetBaseUrl(const std::string& base_url) = 0;
/// @copydoc OlpClient::GetBaseUrl
virtual std::string GetBaseUrl() const = 0;
/// @copydoc OlpClient::GetMutableDefaultHeaders
virtual ParametersType& GetMutableDefaultHeaders() = 0;
/// @copydoc OlpClient::GetSettings
virtual const OlpClientSettings& GetSettings() const = 0;

/// @copydoc OlpClient::CallApi(const std::string&, const std::string&,
/// const ParametersType&, const ParametersType&,
/// const ParametersType&, const RequestBodyType&,
/// const std::string&, const NetworkAsyncCallback&)
virtual CancellationToken CallApi(
const std::string& path, const std::string& method,
const ParametersType& query_params, const ParametersType& header_params,
const ParametersType& form_params, const RequestBodyType& post_body,
const std::string& content_type,
const NetworkAsyncCallback& callback) const = 0;

/// @copydoc OlpClient::CallApi(std::string, std::string, ParametersType,
/// ParametersType, ParametersType, RequestBodyType, std::string,
/// CancellationContext)
virtual HttpResponse CallApi(std::string path, std::string method,
ParametersType query_params,
ParametersType header_params,
ParametersType form_params,
RequestBodyType post_body,
std::string content_type,
CancellationContext context) const = 0;

/// @copydoc OlpClient::CallApiStream
virtual HttpResponse CallApiStream(
std::string path, std::string method, ParametersType query_params,
ParametersType header_params, http::Network::DataCallback data_callback,
RequestBodyType post_body, std::string content_type,
CancellationContext context) const = 0;
};

/**
* @brief Creates the `OlpClient` instance.
Expand All @@ -53,7 +103,19 @@ class CORE_API OlpClient {
* @param base_url The base URL to be used for all outgoing requests.
*/
OlpClient(const OlpClientSettings& settings, std::string base_url);
virtual ~OlpClient();

/**
* @brief Creates the `OlpClient` instance with a custom delegate.
*
* Use this constructor to inject a test or mock implementation.
* The supplied @p delegate must not be null.
*
* @param delegate A non-null shared pointer to a custom `Delegate`
* implementation.
*/
explicit OlpClient(std::shared_ptr<Delegate> delegate);

~OlpClient();

/// A copy constructor.
OlpClient(const OlpClient&);
Expand Down Expand Up @@ -180,8 +242,7 @@ class CORE_API OlpClient {
CancellationContext context) const;

private:
class OlpClientImpl;
std::shared_ptr<OlpClientImpl> impl_;
std::shared_ptr<Delegate> impl_;
};

} // namespace client
Expand Down
119 changes: 80 additions & 39 deletions olp-cpp-sdk-core/src/client/OlpClient.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,41 +456,57 @@ bool IsPending(const PendingUrlRequestPtr& request) {

} // namespace

class OlpClient::OlpClientImpl {
class OlpClientImpl : public OlpClient::Delegate {
public:
OlpClientImpl();
using ParametersType = OlpClient::ParametersType;
using RequestBodyType = OlpClient::RequestBodyType;

OlpClientImpl(const OlpClientSettings& settings, std::string base_url);
~OlpClientImpl() = default;
~OlpClientImpl() override = default;

void SetBaseUrl(const std::string& base_url);
std::string GetBaseUrl() const;
void SetBaseUrl(const std::string& base_url) override;
std::string GetBaseUrl() const override;

ParametersType& GetMutableDefaultHeaders();
const OlpClientSettings& GetSettings() const { return settings_; }
ParametersType& GetMutableDefaultHeaders() override;
const OlpClientSettings& GetSettings() const override { return settings_; }

CancellationToken CallApi(const std::string& path, const std::string& method,
const ParametersType& query_params,
const ParametersType& header_params,
const ParametersType& form_params,
const RequestBodyType& post_body,
const std::string& content_type,
const NetworkAsyncCallback& callback) const;
CancellationToken CallApi(
const std::string& path, const std::string& method,
const ParametersType& query_params, const ParametersType& header_params,
const ParametersType& form_params, const RequestBodyType& post_body,
const std::string& content_type,
const NetworkAsyncCallback& callback) const override;

HttpResponse CallApi(std::string path, std::string method,
ParametersType query_params,
ParametersType header_params,
http::Network::DataCallback data_callback,
ParametersType header_params, ParametersType form_params,
RequestBodyType post_body, std::string content_type,
CancellationContext context) const;
CancellationContext context) const override;

HttpResponse CallApiStream(std::string path, std::string method,
ParametersType query_params,
ParametersType header_params,
http::Network::DataCallback data_callback,
RequestBodyType post_body,
std::string content_type,
CancellationContext context) const override;

std::shared_ptr<http::NetworkRequest> CreateRequest(
const std::string& path, const std::string& method,
const ParametersType& query_params, const ParametersType& header_params,
const RequestBodyType& post_body, const std::string& content_type) const;

porting::optional<ApiError> AddBearer(bool query_empty,
http::NetworkRequest& request,
CancellationContext& context) const;
http::NetworkRequest& request,
CancellationContext& context) const;

HttpResponse CallApiImpl(std::string path, std::string method,
ParametersType query_params,
ParametersType header_params,
http::Network::DataCallback data_callback,
RequestBodyType post_body, std::string content_type,
CancellationContext context) const;

private:
using MutexType = std::shared_mutex;
Expand All @@ -504,29 +520,26 @@ class OlpClient::OlpClientImpl {
bool ValidateBaseUrl() const;
};

OlpClient::OlpClientImpl::OlpClientImpl()
OlpClientImpl::OlpClientImpl()
: pending_requests_{std::make_shared<PendingUrlRequests>()} {}

OlpClient::OlpClientImpl::OlpClientImpl(const OlpClientSettings& settings,
std::string base_url)
OlpClientImpl::OlpClientImpl(const OlpClientSettings& settings,
std::string base_url)
: base_url_{std::move(base_url)},
settings_{settings},
pending_requests_{std::make_shared<PendingUrlRequests>()} {}

void OlpClient::OlpClientImpl::SetBaseUrl(const std::string& base_url) {
void OlpClientImpl::SetBaseUrl(const std::string& base_url) {
base_url_.lockedAssign(base_url);
}

std::string OlpClient::OlpClientImpl::GetBaseUrl() const {
return base_url_.lockedCopy();
}
std::string OlpClientImpl::GetBaseUrl() const { return base_url_.lockedCopy(); }

OlpClient::ParametersType&
OlpClient::OlpClientImpl::GetMutableDefaultHeaders() {
OlpClient::ParametersType& OlpClientImpl::GetMutableDefaultHeaders() {
return default_headers_;
}

porting::optional<client::ApiError> OlpClient::OlpClientImpl::AddBearer(
porting::optional<client::ApiError> OlpClientImpl::AddBearer(
bool query_empty, http::NetworkRequest& request,
CancellationContext& context) const {
const auto& settings = settings_.authentication_settings;
Expand Down Expand Up @@ -566,14 +579,14 @@ porting::optional<client::ApiError> OlpClient::OlpClientImpl::AddBearer(
return porting::none;
}

bool OlpClient::OlpClientImpl::ValidateBaseUrl() const {
bool OlpClientImpl::ValidateBaseUrl() const {
return base_url_.locked([](const std::string& base_url) {
return base_url == "" || (base_url.find(kHttpPrefix) != std::string::npos ||
base_url.find(kHttpsPrefix) != std::string::npos);
});
}

std::shared_ptr<http::NetworkRequest> OlpClient::OlpClientImpl::CreateRequest(
std::shared_ptr<http::NetworkRequest> OlpClientImpl::CreateRequest(
const std::string& path, const std::string& method,
const OlpClient::ParametersType& query_params,
const OlpClient::ParametersType& header_params,
Expand Down Expand Up @@ -612,7 +625,7 @@ std::shared_ptr<http::NetworkRequest> OlpClient::OlpClientImpl::CreateRequest(
return network_request;
}

CancellationToken OlpClient::OlpClientImpl::CallApi(
CancellationToken OlpClientImpl::CallApi(
const std::string& path, const std::string& method,
const OlpClient::ParametersType& query_params,
const OlpClient::ParametersType& header_params,
Expand Down Expand Up @@ -706,7 +719,33 @@ CancellationToken OlpClient::OlpClientImpl::CallApi(
return cancellation_token;
}

HttpResponse OlpClient::OlpClientImpl::CallApi(
HttpResponse OlpClientImpl::CallApi(std::string path, std::string method,
OlpClient::ParametersType query_params,
OlpClient::ParametersType header_params,
OlpClient::ParametersType /*form_params*/,
OlpClient::RequestBodyType post_body,
std::string content_type,
CancellationContext context) const {
return CallApiImpl(std::move(path), std::move(method),
std::move(query_params), std::move(header_params), nullptr,
std::move(post_body), std::move(content_type),
std::move(context));
}

HttpResponse OlpClientImpl::CallApiStream(
std::string path, std::string method,
OlpClient::ParametersType query_params,
OlpClient::ParametersType header_params,
http::Network::DataCallback data_callback,
OlpClient::RequestBodyType post_body, std::string content_type,
CancellationContext context) const {
return CallApiImpl(std::move(path), std::move(method),
std::move(query_params), std::move(header_params),
std::move(data_callback), std::move(post_body),
std::move(content_type), std::move(context));
}

HttpResponse OlpClientImpl::CallApiImpl(
std::string path, std::string method,
OlpClient::ParametersType query_params,
OlpClient::ParametersType header_params,
Expand Down Expand Up @@ -831,6 +870,8 @@ HttpResponse OlpClient::OlpClientImpl::CallApi(
OlpClient::OlpClient() : impl_(std::make_shared<OlpClientImpl>()) {}
OlpClient::OlpClient(const OlpClientSettings& settings, std::string base_url)
: impl_(std::make_shared<OlpClientImpl>(settings, std::move(base_url))) {}
OlpClient::OlpClient(std::shared_ptr<Delegate> delegate)
: impl_(std::move(delegate)) {}
OlpClient::~OlpClient() = default;
OlpClient::OlpClient(const OlpClient&) = default;
OlpClient& OlpClient::operator=(const OlpClient&) = default;
Expand Down Expand Up @@ -864,14 +905,14 @@ CancellationToken OlpClient::CallApi(
HttpResponse OlpClient::CallApi(std::string path, std::string method,
ParametersType query_params,
ParametersType header_params,
ParametersType /*form_params*/,
ParametersType form_params,
RequestBodyType post_body,
std::string content_type,
CancellationContext context) const {
return impl_->CallApi(std::move(path), std::move(method),
std::move(query_params), std::move(header_params),
nullptr, std::move(post_body), std::move(content_type),
std::move(context));
std::move(form_params), std::move(post_body),
std::move(content_type), std::move(context));
}

HttpResponse OlpClient::CallApiStream(std::string path, std::string method,
Expand All @@ -881,10 +922,10 @@ HttpResponse OlpClient::CallApiStream(std::string path, std::string method,
RequestBodyType post_body,
std::string content_type,
CancellationContext context) const {
return impl_->CallApi(std::move(path), std::move(method),
std::move(query_params), std::move(header_params),
std::move(data_callback), std::move(post_body),
std::move(content_type), std::move(context));
return impl_->CallApiStream(std::move(path), std::move(method),
std::move(query_params), std::move(header_params),
std::move(data_callback), std::move(post_body),
std::move(content_type), std::move(context));
}

} // namespace client
Expand Down
Loading
Loading