vtk-m2/vtkm/cont/testing/UnitTestInitialize.cxx

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//
//  Copyright 2019 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
//  Copyright 2019 UT-Battelle, LLC.
//  Copyright 2019 Los Alamos National Security.
//
//  Under the terms of Contract DE-NA0003525 with NTESS,
//  the U.S. Government retains certain rights in this software.
//
//  Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
//  Laboratory (LANL), the U.S. Government retains certain rights in
//  this software.
//============================================================================

#include <vtkm/cont/Initialize.h>

#include <vtkm/cont/testing/Testing.h>

namespace
{

constexpr const char* PROGRAM_NAME = "program-name";

template <typename... T>
void MakeArgs(int& argc, char**& argv, T&&... args)
{
  constexpr std::size_t numArgs = sizeof...(args) + 1;

  std::array<std::string, numArgs> stringArgs = { { PROGRAM_NAME, args... } };

  // These static variables are declared as static so that the memory will stick around but won't
  // be reported as a leak.
  static std::array<std::vector<char>, numArgs> vecArgs;
  static std::array<char*, numArgs + 1> finalArgs;
  std::cout << "  starting args:";
  for (std::size_t i = 0; i < numArgs; ++i)
  {
    std::cout << " " << stringArgs[i];
    // Safely copying a C-style string is a PITA
    vecArgs[i].resize(0);
    vecArgs[i].reserve(stringArgs[i].size() + 1);
    for (auto&& c : stringArgs[i])
    {
      vecArgs[i].push_back(c);
    }
    vecArgs[i].push_back('\0');

    finalArgs[i] = vecArgs[i].data();
  }
  finalArgs[numArgs] = nullptr;
  std::cout << std::endl;

  argc = static_cast<int>(numArgs);
  argv = finalArgs.data();
}

template <typename... T>
void CheckArgs(int argc, char* argv[], T&&... args)
{
  constexpr std::size_t numArgs = sizeof...(args) + 1;

  std::array<std::string, numArgs> expectedArgs = { { PROGRAM_NAME, args... } };

  std::cout << "  expected args:";
  for (std::size_t i = 0; i < numArgs; ++i)
  {
    std::cout << " " << expectedArgs[i];
  }
  std::cout << std::endl;

  std::cout << "  received args:";
  for (int i = 0; i < argc; ++i)
  {
    std::cout << " " << argv[i];
  }
  std::cout << std::endl;

  VTKM_TEST_ASSERT(
    numArgs == static_cast<std::size_t>(argc), "Got wrong number of arguments (", argc, ")");

  for (std::size_t i = 0; i < numArgs; ++i)
  {
    VTKM_TEST_ASSERT(expectedArgs[i] == argv[i], "Arg ", i, " wrong");
  }

  std::cout << std::endl;
}

void InitializeZeroArguments()
{
  std::cout << "Initialize with no arguments" << std::endl;
  vtkm::cont::Initialize();
}

void InitializeNoOptions()
{
  std::cout << "Initialize without any options" << std::endl;

  int argc;
  char** argv;
  MakeArgs(argc, argv);
  vtkm::cont::InitializeResult result = vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv);

  std::cout << "Usage statement returned from Initialize:" << std::endl;
  std::cout << result.Usage << std::endl;
}

void InitializeStandardOptions()
{
  std::cout << "Initialize with some standard options" << std::endl;

  int argc;
  char** argv;
  MakeArgs(argc, argv, "--device", "Any");
  vtkm::cont::Initialize(argc, argv, vtkm::cont::InitializeOptions::Strict);
  CheckArgs(argc, argv);
}

void InitializeCustomOptions()
{
  std::cout << "Initialize with some custom options and arguments" << std::endl;

  int argc;
  char** argv;
  MakeArgs(argc, argv, "--foo", "-bar", "baz", "buz");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo", "-bar", "baz", "buz");

  MakeArgs(argc, argv, "--foo", "-bar", "--", "baz", "buz");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo", "-bar", "--", "baz", "buz");
}

void InitializeMixedOptions()
{
  std::cout << "Initialize with options both for VTK-m and some that are not." << std::endl;

  int argc;
  char** argv;
  MakeArgs(argc, argv, "--foo", "--device", "Any", "--bar", "baz");
  vtkm::cont::Initialize(argc, argv, vtkm::cont::InitializeOptions::AddHelp);
  CheckArgs(argc, argv, "--foo", "--bar", "baz");

  MakeArgs(argc, argv, "--foo", "-v", "OFF", "--", "--device", "Any", "--bar", "baz");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo", "--", "--device", "Any", "--bar", "baz");

  MakeArgs(argc, argv, "--device", "Any", "foo");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "foo");
}

void InitializeCustomOptionsWithArgs()
{
  std::cout << "Calling program has option --foo that takes arg bar." << std::endl;

  int argc;
  char** argv;
  MakeArgs(argc, argv, "--device", "Any", "--foo=bar", "--baz");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo=bar", "--baz");

  MakeArgs(argc, argv, "--foo=bar", "--baz", "--device", "Any");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo=bar", "--baz");

  MakeArgs(argc, argv, "--device", "Any", "--foo", "bar", "--baz");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo", "bar", "--baz");

  MakeArgs(argc, argv, "--foo", "bar", "--baz", "--device", "Any");
  vtkm::cont::Initialize(argc, argv);
  CheckArgs(argc, argv, "--foo", "bar", "--baz");
}

void InitializeWithHelp()
{
  std::cout << "Pass help flag to initialize" << std::endl;

  int argc;
  char** argv;
  MakeArgs(argc, argv, "--help");
  vtkm::cont::Initialize(argc, argv, vtkm::cont::InitializeOptions::AddHelp);

  VTKM_TEST_FAIL("Help argument did not exit as expected.");
}

void DoInitializeTests()
{
  // Technically, by the time we get here, we have already called Initialize once.
  std::cout << "Note: This test calls vtkm::cont::Initialize multiple times to test" << std::endl
            << "it under different circumstances. You may get warnings/errors about" << std::endl
            << "that, particularly from the logging interface." << std::endl;

  InitializeZeroArguments();
  InitializeNoOptions();
  InitializeStandardOptions();
  InitializeCustomOptions();
  InitializeMixedOptions();
  InitializeCustomOptionsWithArgs();

  // This should be the last function called as it should exit with a zero status.
  InitializeWithHelp();
}

} // anonymous namespace

int UnitTestInitialize(int argc, char* argv[])
{
  return vtkm::cont::testing::Testing::Run(DoInitializeTests, argc, argv);
}