Manager_TEST.cc

/*
 * Copyright (C) 2019 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/

#include <gtest/gtest.h>
#include <gz/common/Console.hh>
#include <gz/common/Filesystem.hh>

#include <gz/utils/ExtraTestMacros.hh>

#include <sys/stat.h>

#include "Manager.hh"

class ManagerTest : public ::testing::Test
{
 public:
   ManagerTest(){}
#ifndef _WIN32
   std::string testScriptPath = "/tmp/gz-launch.sh";
#else
   std::string testScriptPath =
     std::string(getenv("localappdata")) + "\\Temp\\gz-launch.bat";
#endif
};

/////////////////////////////////////////////////
bool RemoveTestScript(std::string _testScriptPath)
{
  // Remove the file if it already exists
  if (gz::common::isFile(_testScriptPath))
  {
    if (!gz::common::removeFile(_testScriptPath))
    {
      return false;
    }
  }
  return true;
}

/////////////////////////////////////////////////
bool WriteTestScript(std::string _testScriptPath)
{
  if (!RemoveTestScript(_testScriptPath))
    return false;

  // Write a simple script and mark it executable
  std::ofstream ofs(_testScriptPath);
#ifndef WIN32
  ofs << R"(#!/usr/bin/env bash
echo $TEST_VAR
touch $TEST_VAR
)";
  chmod(_testScriptPath.c_str(), S_IRWXU);
#else
  ofs << R"(echo %TEST_VAR%
type nul > %TEST_VAR%
)";
  _chmod(_testScriptPath.c_str(), _S_IREAD | _S_IWRITE);
#endif
  return true;
}

/////////////////////////////////////////////////
TEST_F(ManagerTest, RunEmptyConfig)
{
  gz::launch::Manager mgr;

  // Expect false because no config file was set.
  EXPECT_FALSE(mgr.RunConfig(""));
}

/////////////////////////////////////////////////
TEST_F(ManagerTest, MissingGz)
{
  std::string config =
    "<executable name='sim'>"
    "  <command>gz-sim-server</command>"
    "</executable>";

  gz::launch::Manager mgr;

  // Stop the manager after a short pause.
  EXPECT_FALSE(mgr.RunConfig(config));
}

/////////////////////////////////////////////////
TEST_F(ManagerTest, RunBadXml)
{
  std::string config =
    "<gz version='1.0'>"
    " executable></executable"
    "</gz>";

  gz::launch::Manager mgr;

  // Stop the manager after a short pause.
  EXPECT_FALSE(mgr.RunConfig(config));
}

/////////////////////////////////////////////////
TEST_F(ManagerTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(RunLs))
{
  std::string cmd;

#ifdef _WIN32
  cmd = "dir";
#else
  cmd = "ls";
#endif

  std::string config =
    R"(<gz version='1.0'>"
    "  <executable name='listDirectory'>"
    "    <command>)" + cmd + R"(</command>"
    "  </executable>"
    "</gz>)";

  gz::launch::Manager mgr;

  // We should be able to run the ls command. This does not check the
  // output.
  EXPECT_TRUE(mgr.RunConfig(config));
}

/////////////////////////////////////////////////
TEST_F(ManagerTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(RunEnvPre))
{
  // Test that environment is applied regardless of order
  #ifndef _WIN32
  std::string testPath = "/tmp/gz-launch-env-test-pre";
  #else
  std::string testPath =
    std::string(getenv("localappdata")) + "\\Temp\\gz-launch-env-test-pre";
  #endif

  if (gz::common::isFile(testPath))
  {
    ASSERT_TRUE(gz::common::removeFile(testPath));
  }

  ASSERT_TRUE(WriteTestScript(testScriptPath));

  std::string config = R"(
<gz version='1.0'>
  <env>
    <name>TEST_VAR</name>
    <value>)" + testPath + R"(</value>
  </env>
  <executable name='touch'>
    <command>)" + std::string(testScriptPath) + R"(</command>
  </executable>
</gz>
)";

  gz::launch::Manager mgr;

  EXPECT_TRUE(mgr.RunConfig(config));
  EXPECT_TRUE(gz::common::isFile(testPath));
  EXPECT_TRUE(gz::common::removeFile(testPath));
  EXPECT_TRUE(RemoveTestScript(testScriptPath));
}

/////////////////////////////////////////////////
TEST_F(ManagerTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(RunEnvPost))
{
  // Test that environment is applied regardless of order
  #ifndef _WIN32
  std::string testPath = "/tmp/gz-launch-env-test-post";
  #else
  std::string testPath =
    std::string(getenv("localappdata")) + "\\Temp\\gz-launch-env-test-post";
  #endif

  if (gz::common::isFile(testPath))
  {
    ASSERT_TRUE(gz::common::removeFile(testPath));
  }

  ASSERT_TRUE(WriteTestScript(testScriptPath));

  std::string config = R"(
<gz version='1.0'>
  <executable name='touch'>
    <command>)" + std::string(testScriptPath) + R"(</command>
  </executable>
  <env>
    <name>TEST_VAR</name>
    <value>)" + testPath + R"(</value>
  </env>
</gz>
)";

  gz::launch::Manager mgr;

  EXPECT_TRUE(mgr.RunConfig(config));
  EXPECT_TRUE(gz::common::isFile(testPath));
  EXPECT_TRUE(gz::common::removeFile(testPath));
  EXPECT_TRUE(RemoveTestScript(testScriptPath));
}

/////////////////////////////////////////////////
int main(int argc, char **argv)
{
  gz::common::Console::SetVerbosity(4);
  ::testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}