Merge pull request #1520 from advancedtelematic/fix/OTA-4308/check-di…

…sk-space

Check disk space before downloading files.

src/libaktualizr/package_manager/fetcher_test.cc

@@ -1,5 +1,6 @@
 #include <gtest/gtest.h>
 
+#include <sys/statvfs.h>
 #include <chrono>
 #include <future>
 #include <iostream>
@@ -272,6 +273,43 @@ TEST(Fetcher, DownloadLengthZero) {
   EXPECT_EQ(http->counter, 1);
 }
 
+/* Don't bother downloading a target that is larger than the available disk
+ * space. */
+TEST(Fetcher, NotEnoughDiskSpace) {
+  TemporaryDirectory temp_dir;
+  config.storage.path = temp_dir.Path();
+  config.uptane.repo_server = server;
+
+  std::shared_ptr<INvStorage> storage(new SQLStorage(config.storage, false));
+  auto http = std::make_shared<HttpZeroLength>(temp_dir.Path());
+  auto pacman = std::make_shared<PackageManagerFake>(config.pacman, config.bootloader, storage, http);
+  KeyManager keys(storage, config.keymanagerConfig());
+  Uptane::Fetcher fetcher(config, http);
+
+  // Find how much space is available on disk.
+  struct statvfs stvfsbuf {};
+  EXPECT_EQ(statvfs(temp_dir.Path().c_str(), &stvfsbuf), 0);
+  const uint64_t available_bytes = (stvfsbuf.f_bsize * stvfsbuf.f_bavail);
+
+  // Try to fetch a target larger than the available disk space: an exception is
+  // thrown and the http module is never called.
+  Json::Value empty_target_json;
+  empty_target_json["hashes"]["sha256"] = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";
+  empty_target_json["length"] = available_bytes * 2;
+  Uptane::Target empty_target("empty_file", empty_target_json);
+  EXPECT_THROW(pacman->fetchTarget(empty_target, fetcher, keys, progress_cb, nullptr), std::runtime_error);
+  EXPECT_EQ(http->counter, 0);
+
+  // Try to fetch a 1-byte target: download succeeds, and http module is called.
+  // This is done purely to make sure the test is designed correctly.
+  Json::Value nonempty_target_json;
+  nonempty_target_json["hashes"]["sha256"] = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";
+  nonempty_target_json["length"] = 1;
+  Uptane::Target nonempty_target("fake_file", nonempty_target_json);
+  EXPECT_TRUE(pacman->fetchTarget(nonempty_target, fetcher, keys, progress_cb, nullptr));
+  EXPECT_EQ(http->counter, 1);
+}
+
 #ifndef __NO_MAIN__
 int main(int argc, char** argv) {
   ::testing::InitGoogleTest(&argc, argv);

src/libaktualizr/package_manager/packagemanagerinterface.cc

@@ -110,6 +110,11 @@ bool PackageManagerInterface::fetchTarget(const Uptane::Target& target, Uptane::
       ds->fhandle = storage_->allocateTargetFile(false, target);
     }
 
+    const uint64_t required_bytes = target.length() - ds->downloaded_length;
+    if (!storage_->checkAvailableDiskSpace(required_bytes)) {
+      throw std::runtime_error("Insufficient disk space available to download target");
+    }
+
     std::string target_url = target.uri();
     if (target_url.empty()) {
       target_url = fetcher.getRepoServer() + "/targets/" + Utils::urlEncode(target.filename());

src/libaktualizr/storage/invstorage.h

@@ -184,6 +184,7 @@ class INvStorage {
   virtual void saveEcuReportCounter(const Uptane::EcuSerial& ecu_serial, int64_t counter) = 0;
   virtual bool loadEcuReportCounter(std::vector<std::pair<Uptane::EcuSerial, int64_t>>* results) = 0;
 
+  virtual bool checkAvailableDiskSpace(uint64_t required_bytes) const = 0;
   virtual boost::optional<std::pair<size_t, std::string>> checkTargetFile(const Uptane::Target& target) const = 0;
 
   // Incremental file API

src/libaktualizr/storage/sqlstorage.cc

@@ -1,6 +1,7 @@
 #include "sqlstorage.h"
 
 #include <sys/stat.h>
+#include <sys/statvfs.h>
 #include <iostream>
 #include <map>
 #include <memory>
@@ -1396,6 +1397,25 @@ void SQLStorage::clearInstallationResults() {
   db.commitTransaction();
 }
 
+bool SQLStorage::checkAvailableDiskSpace(const uint64_t required_bytes) const {
+  struct statvfs stvfsbuf {};
+  const int stat_res = statvfs(dbPath().c_str(), &stvfsbuf);
+  if (stat_res < 0) {
+    LOG_WARNING << "Unable to read filesystem statistics: error code " << stat_res;
+    return true;
+  }
+  const uint64_t available_bytes = (stvfsbuf.f_bsize * stvfsbuf.f_bavail);
+  const uint64_t reserved_bytes = 1 << 20;
+
+  if (required_bytes + reserved_bytes < available_bytes) {
+    return true;
+  } else {
+    LOG_ERROR << "Insufficient disk space available to download target! Required: " << required_bytes
+              << ", available: " << available_bytes << ", reserved: " << reserved_bytes;
+    return false;
+  }
+}
+
 boost::optional<std::pair<size_t, std::string>> SQLStorage::checkTargetFile(const Uptane::Target& target) const {
   SQLite3Guard db = dbConnection();
 

src/libaktualizr/storage/sqlstorage.h

@@ -84,6 +84,8 @@ class SQLStorage : public SQLStorageBase, public INvStorage {
   bool loadEcuReportCounter(std::vector<std::pair<Uptane::EcuSerial, int64_t>>* results) override;
   void clearInstallationResults() override;
 
+  bool checkAvailableDiskSpace(uint64_t required_bytes) const override;
+
   std::unique_ptr<StorageTargetWHandle> allocateTargetFile(bool from_director, const Uptane::Target& target) override;
   std::unique_ptr<StorageTargetRHandle> openTargetFile(const Uptane::Target& target) override;
   boost::optional<std::pair<size_t, std::string>> checkTargetFile(const Uptane::Target& target) const override;