* Fixed failing CI issues.

lawmaestro · lawmaestro · commit aef524791e8e · 2018-07-24T21:53:05.000+01:00
* Added unit test for progress callback.
* Updated `README.md` with documentation for the new progress callback additions.
diff --git a/README.md b/README.md
@@ -207,6 +207,20 @@ conn->SetProxy("37.187.100.23:3128");
 RestClient::Response res = conn->get("/get");
 ```
 
+## Progress callback
+
+Two simple wrapper functions are provided to setup progress callback for uploads/downloads;
+Calling `conn->SetFileProgressCallback(callback)` with a callback parameter matching the prototype `int progress_callback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)` will setup the progress callback.
+Calling `conn->SetFileProgressCallbackData(data)` is optional. This will set the data pointer which is the first parameter fed back to the progress callback - `clientp`. If this isn't set then `clientp` will default to the connection object `conn`.
+
+```cpp
+// set CURLOPT_NOPROGRESS
+// set CURLOPT_PROGRESSFUNCTION
+conn->SetFileProgressCallback(progressFunc);
+// set CURLOPT_PROGRESSDATA
+conn->SetFileProgressCallbackData(data);
+```
+
 ## Dependencies
 - [libcurl][]
 
diff --git a/include/restclient-cpp/connection.h b/include/restclient-cpp/connection.h
@@ -79,6 +79,10 @@ class Connection {
       *  Member 'timeout' contains the configured timeout
       *  @var Info::followRedirects
       *  Member 'followRedirects' contains whether or not to follow redirects
+      *  @var Info::progressFn
+      *  Member 'progressFn' file progress callback function
+      *  @var Info::progressFnData
+      *  Member 'progressFnData' file progress callback data
       *  @var Info::basicAuth
       *  Member 'basicAuth' contains information about basic auth
       *  @var basicAuth::username
diff --git a/source/connection.cc b/source/connection.cc
@@ -194,8 +194,9 @@ RestClient::Connection::SetNoSignal(bool no) {
  *
  */
 void
-RestClient::Connection::SetFileProgressCallback(curl_progress_callback progressFn) {
-	this->progressFn = progressFn;
+RestClient::Connection::SetFileProgressCallback(curl_progress_callback
+                                                progressFn) {
+  this->progressFn = progressFn;
 }
 
 /**
@@ -206,7 +207,7 @@ RestClient::Connection::SetFileProgressCallback(curl_progress_callback progressF
  */
 void
 RestClient::Connection::SetFileProgressCallbackData(void* data) {
-	this->progressFnData = data;
+  this->progressFnData = data;
 }
 
 /**
@@ -365,15 +366,19 @@ RestClient::Connection::performCurlRequest(const std::string& uri) {
   }
 
   // set file progress callback
-  if (this->progressFn)
-  {
+  if (this->progressFn) {
     curl_easy_setopt(this->curlHandle, CURLOPT_NOPROGRESS, 0);
-    curl_easy_setopt(this->curlHandle, CURLOPT_PROGRESSFUNCTION, this->progressFn);
+    curl_easy_setopt(this->curlHandle,
+                     CURLOPT_PROGRESSFUNCTION,
+                    this->progressFn);
     if (this->progressFnData) {
-      curl_easy_setopt(this->curlHandle, CURLOPT_PROGRESSDATA, this->progressFnData);
-    }
-    else {
-      curl_easy_setopt(this->curlHandle, CURLOPT_PROGRESSDATA, this);
+      curl_easy_setopt(this->curlHandle,
+                       CURLOPT_PROGRESSDATA,
+                       this->progressFnData);
+    } else {
+      curl_easy_setopt(this->curlHandle,
+                       CURLOPT_PROGRESSDATA,
+                       this);
     }
   }
 
diff --git a/test/test_connection.cc b/test/test_connection.cc
@@ -217,6 +217,26 @@ TEST_F(ConnectionTest, TestNoSignal)
   EXPECT_EQ(200, res.code);
 }
 
+TEST_F(ConnectionTest, TestSetProgress)
+{
+	static double totalToDownload = 0;
+	static double totalDownloaded = 0;
+
+	auto progressCallback = [](void* pData, double downloadTotal, double downloaded, double uploadTotal, double uploaded) -> int {
+    totalToDownload = downloadTotal;
+    totalDownloaded = downloaded;
+    return 0;
+	};
+
+	conn->SetFileProgressCallback(progressCallback);
+	conn->SetFileProgressCallbackData(nullptr);
+
+  RestClient::Response res = conn->get("/anything/{test_data}");
+	EXPECT_EQ(200, res.code);
+  EXPECT_EQ(totalToDownload, 267);
+  EXPECT_EQ(totalDownloaded, 267);
+}
+
 TEST_F(ConnectionTest, TestProxy)
 {
   conn->SetProxy("127.0.0.1:3128");
