InstallerTests.cpp

/*
 * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/*
 * IMPORTANT:
 * These tests are designed to run only in CI environment.
*/

#include "CBuildIntegTestEnv.h"

using namespace std;

class InstallerTests : public ::testing::Test {
  void SetUp();
protected:
  void RunInstallerScript(const string& arg);
  void CheckInstallationDir(const string& path, bool expect);
  void CheckExtractedDir(const string& path, bool expect);
};

void InstallerTests::SetUp() {
  if (CBuildIntegTestEnv::ci_installer_path.empty()) {
    GTEST_SKIP();
  }
}

void InstallerTests::RunInstallerScript(const string& arg) {
  int ret_val;
  error_code ec;

  ASSERT_EQ(true, fs::exists(scripts_folder + "/installer_run.sh", ec))
    << "error: installer_run.sh not found";

  string cmd = "cd " + scripts_folder + " && " + SH + " \"./installer_run.sh " + arg + "\"";
  ret_val = system(cmd.c_str());
  ASSERT_EQ(ret_val, 0);
}

void InstallerTests::CheckInstallationDir(const string& path, bool expect) {
  vector<pair<string, vector<string>>> dirVec = {
#ifdef _WIN32
    { "bin", vector<string>{ "cbuild.sh", "cbuildgen.exe", "cpackget.exe", "csolution.exe"} },
#else
    { "bin", vector<string>{ "cbuild.sh", "cbuildgen", "cpackget", "csolution"} },
#endif
    { "doc", vector<string>{ "index.html", "html"} },
    { "etc", vector<string>{ "AC6.6.16.2.cmake", "CPRJ.xsd",
      "GCC.10.3.1.cmake", "IAR.9.32.1.cmake", "setup"} }
  };

  error_code ec;
  EXPECT_EQ(expect, fs::exists(path, ec)) << "Path " << path << " does "
    << (expect ? "not " : "") << "exist!";

  for (auto dirItr = dirVec.begin(); dirItr != dirVec.end(); ++dirItr) {
    for (auto fileItr = dirItr->second.begin(); fileItr != dirItr->second.end(); ++fileItr) {
      EXPECT_EQ(expect, fs::exists(path + "/" + dirItr->first + "/" + (*fileItr), ec))
        << "File " << (*fileItr) << " does " << (expect ? "not " : "") << "exist!";
    }
  }

  EXPECT_EQ(expect, fs::exists(path + "/LICENSE.txt", ec))
    << "File LICENSE.txt does " << (expect ? "not " : "") << "exist!";
}

void InstallerTests::CheckExtractedDir(const string& path, bool expect) {
  vector<pair<string, vector<string>>> dirVec = {
    { "bin", vector<string>{ "cbuild.sh",
    "cbuild.lin-amd64",    "cbuild.exe-amd64",
    "cpackget.lin-amd64",  "cpackget.exe-amd64",
    "cbuildgen.lin-amd64", "cbuildgen.exe-amd64",
    "csolution.lin-amd64", "csolution.exe-amd64",
    "cbuild.lin-arm64",
    "cpackget.lin-arm64",
    "cbuildgen.lin-arm64",
    "csolution.lin-arm64"} },
    { "doc", vector<string>{ "index.html", "html"} },
    { "etc", vector<string>{ "AC6.6.16.2.cmake", "CPRJ.xsd",
      "GCC.10.3.1.cmake", "IAR.9.32.1.cmake", "setup"} }
  };

  error_code ec;
  EXPECT_EQ(expect, fs::exists(path, ec)) << "Path "<< path << " does " << (expect ? "not " : "") << "exist!";

  for (auto dirItr = dirVec.begin(); dirItr != dirVec.end(); ++dirItr) {
    for (auto fileItr = dirItr->second.begin(); fileItr != dirItr->second.end(); ++fileItr) {
      EXPECT_EQ(expect, fs::exists(path + "/" + dirItr->first + "/" + (*fileItr), ec))
        << "File " << (*fileItr) << " does " << (expect ? "not " : "") << "exist!";
    }
  }

  EXPECT_EQ(expect, fs::exists(path + "/LICENSE.txt", ec))
    << "File LICENSE.txt does " << (expect ? "not " : "") << "exist!";
}

// Test installer with Invalid arguments
TEST_F(InstallerTests, InvalidArgTest) {
  string installDir = testout_folder + "/Installation";
  string arg = "--testoutput=" + testout_folder + " -Invalid";

  RteFsUtils::RemoveDir(installDir);
  RunInstallerScript   (arg);
  CheckInstallationDir (installDir, true);
}

// Run installer with help command
TEST_F(InstallerTests, InstallerHelpTest) {
  string installDir = testout_folder + "/Installation";
  string arg = "--testoutput=" + testout_folder + " -h";

  RteFsUtils::RemoveDir(installDir);
  RunInstallerScript   (arg);
  CheckInstallationDir (installDir, false);
}

// Run installer with version command
TEST_F(InstallerTests, InstallerVersionTest) {
  string installDir = testout_folder + "/Installation";
  string arg = "--testoutput=" + testout_folder + " -v";

  RteFsUtils::RemoveDir(installDir);
  RunInstallerScript   (arg);
  CheckInstallationDir (installDir, false);
}

// Validate installer extract option
TEST_F(InstallerTests, InstallerExtractTest) {
  string arg = "--testoutput=" + testout_folder + " -x " +
    testout_folder + "/Installation/ExtractOut";
  string extractDir = testout_folder + "/Installation/ExtractOut";

  RteFsUtils::RemoveDir(extractDir);
  RunInstallerScript   (arg);
  CheckExtractedDir    (extractDir, true);
}

// Validate installation and post installation content
TEST_F(InstallerTests, ValidInstallationTest) {
  string installDir = testout_folder + "/Installation";
  string arg = "--testoutput=" + testout_folder;

  RteFsUtils::RemoveDir(installDir);
  RunInstallerScript   (arg);
  CheckInstallationDir (installDir, true);
}