Add check to make sure that program name and save path is specified w… (#447)

…hen downloading program.

Also renamed the input parameter for clarity

Author: URJala

include/ur_client_library/ur/dashboard_client.h

@@ -758,12 +758,13 @@ class DashboardClient
   /*!
    * \brief Download a program from the robot
    *
-   * \param filename The name of the program file on the robot. This is the name as returned by
-   * commandGetProgramListWithResponse. \param save_path The path where the program file should be saved on the machine
-   * where the dashboard client is running.
+   * \param program_name The name of the program file on the robot. This is the name as returned by
+   * commandGetProgramListWithResponse.
+   * \param save_path The path where the program file should be saved on the machine where the
+   *  dashboard client is running.
    *
    */
-  DashboardResponse commandDownloadProgramWithResponse(const std::string& filename, const std::string& save_path);
+  DashboardResponse commandDownloadProgramWithResponse(const std::string& program_name, const std::string& save_path);
 
   /*!
    * \brief Makes sure that the dashboard_server's version is above the required version

include/ur_client_library/ur/dashboard_client_implementation_g5.h

@@ -163,7 +163,7 @@ class DashboardClientImplG5 : public DashboardClientImpl, comm::TCPSocket
   DashboardResponse commandGetProgramList() override;
   DashboardResponse commandUploadProgram(const std::string& file_path) override;
   DashboardResponse commandUpdateProgram(const std::string& file_path) override;
-  DashboardResponse commandDownloadProgram(const std::string& filename, const std::string& save_path) override;
+  DashboardResponse commandDownloadProgram(const std::string& program_name, const std::string& save_path) override;
 
   void setReceiveTimeout(const timeval& timeout) override
   {

include/ur_client_library/ur/dashboard_client_implementation_x.h

@@ -160,7 +160,7 @@ class DashboardClientImplX : public DashboardClientImpl
   DashboardResponse commandGetProgramList() override;
   DashboardResponse commandUploadProgram(const std::string& file_path) override;
   DashboardResponse commandUpdateProgram(const std::string& file_path) override;
-  DashboardResponse commandDownloadProgram(const std::string& filename, const std::string& save_path) override;
+  DashboardResponse commandDownloadProgram(const std::string& program_name, const std::string& save_path) override;
 
   void setReceiveTimeout([[maybe_unused]] const timeval& timeout) override
   {

src/ur/dashboard_client.cpp

@@ -562,10 +562,10 @@ DashboardResponse DashboardClient::commandUpdateProgramWithResponse(const std::s
   return impl_->commandUpdateProgram(file_path);
 }
 
-DashboardResponse DashboardClient::commandDownloadProgramWithResponse(const std::string& filename,
+DashboardResponse DashboardClient::commandDownloadProgramWithResponse(const std::string& program_name,
                                                                       const std::string& save_path)
 {
-  return impl_->commandDownloadProgram(filename, save_path);
+  return impl_->commandDownloadProgram(program_name, save_path);
 }
 
 void DashboardClient::assertVersion(const std::string& e_series_min_ver, const std::string& cb3_min_ver,

src/ur/dashboard_client_implementation_g5.cpp

@@ -1204,7 +1204,7 @@ DashboardResponse DashboardClientImplG5::commandUpdateProgram([[maybe_unused]] c
                                 ". It is supported from PolyScope 10.12.0 onwards.");
 }
 
-DashboardResponse DashboardClientImplG5::commandDownloadProgram([[maybe_unused]] const std::string& program_file_name,
+DashboardResponse DashboardClientImplG5::commandDownloadProgram([[maybe_unused]] const std::string& program_name,
                                                                 [[maybe_unused]] const std::string& destination_path)
 {
   throw NotImplementedException("commandDownloadProgram is not available for PolyScope " +

src/ur/dashboard_client_implementation_x.cpp

@@ -486,15 +486,26 @@ DashboardResponse DashboardClientImplX::commandUpdateProgram(const std::string&
       file_path, [this](const std::string& e, const httplib::UploadFormDataItems& f) { return put(e, f); });
 }
 
-DashboardResponse DashboardClientImplX::commandDownloadProgram(const std::string& filename,
+DashboardResponse DashboardClientImplX::commandDownloadProgram(const std::string& program_name,
                                                                const std::string& save_path)
 {
   if (robot_api_version_ < VersionInformation::fromString("3.1.4"))
   {
     throw NotImplementedException("commandDownloadProgram is not implemented for Robot API version < 3.1.4. Please "
                                   "upgrade the robot to PolyScope 10.12.0 or higher to use this command.");
   }
-  auto response = get("/programs/v1/" + filename, false);  // The json response is pretty long. Don't print it.
+  if (program_name.size() == 0 || save_path.size() == 0)
+  {
+    std::string error = "Both program_name and save_path parameters should be populated.";
+    error += program_name.size() == 0 ? " Program name is empty." : "";
+    error += save_path.size() == 0 ? " Save path is empty." : "";
+    URCL_LOG_ERROR(error.c_str());
+    DashboardResponse response;
+    response.ok = false;
+    response.message = error;
+    return response;
+  }
+  auto response = get("/programs/v1/" + program_name, false);  // The json response is pretty long. Don't print it.
   if (response.ok)
   {
     std::ofstream save_file(save_path, std::ios_base::out);

tests/test_dashboard_client_x.cpp

@@ -442,6 +442,12 @@ TEST_F(DashboardClientTestX, download_program)
 
     response = dashboard_client_->commandDownloadProgram("test upload", "/non_existent_dir/downloaded.urpx");
     ASSERT_FALSE(response.ok);
+
+    response = dashboard_client_->commandDownloadProgram("", "/tmp/downloaded.urpx");
+    ASSERT_FALSE(response.ok);
+
+    response = dashboard_client_->commandDownloadProgram("test upload", "");
+    ASSERT_FALSE(response.ok);
   }
 }