ppovb5fc7/gazebo/test/integration/contain_plugin.cc

/*
 * Copyright (C) 2018 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 <string>

#include <ignition/math/Pose3.hh>

#include "gazebo/physics/physics.hh"
#include "gazebo/test/helper_physics_generator.hh"
#include "gazebo/test/ServerFixture.hh"

using namespace gazebo;
class ContainPluginTest : public ServerFixture
{
};

// Flag turned to true once box contains.
bool g_contain = false;

//////////////////////////////////////////////////
// Callback for /contain topic
void containCb(ConstIntPtr &_msg)
{
  g_contain = _msg->data() == 1;
}

//////////////////////////////////////////////////
TEST_F(ContainPluginTest, Disable)
{
  this->Load("worlds/contain_plugin_demo.world", true);
  auto world = physics::get_world();
  ASSERT_NE(nullptr, world);

  // Get models
  auto drill = world->GetModel("drill");
  ASSERT_NE(nullptr, drill);

  // Subscribe to plugin notifications
  std::string prefix("/gazebo/default/drill/");
  auto containSub = this->node->Subscribe(prefix + "contain", &containCb);
  ASSERT_NE(containSub , nullptr);

  // Check box doesn't contain yet
  EXPECT_FALSE(g_contain);

  // Place drill inside box
  drill->SetWorldPose(ignition::math::Pose3d(10.0, 10.0, 1.0, 0, 0, 0));

  // Give it time to fall
  world->Step(1000);

  // Verify we get a notification
  EXPECT_TRUE(g_contain);

  // Place drill outside box
  drill->SetWorldPose(ignition::math::Pose3d(0.0, 0.0, 1.0, 0, 0, 0));

  // Give it time to fall
  world->Step(1000);

  // Verify we get a notification
  EXPECT_FALSE(g_contain);

  // Disable plugin
  auto enablePub = this->node->Advertise<msgs::Int>(prefix + "enable");

  msgs::Int msg;
  msg.set_data(0);
  enablePub->Publish(msg);

  // Place drill inside box
  drill->SetWorldPose(ignition::math::Pose3d(10.0, 10.0, 1.0, 0, 0, 0));

  // Give it time to fall
  world->Step(1000);

  // Wait and see it doesn't notify now
  EXPECT_FALSE(g_contain);
}

//////////////////////////////////////////////////
TEST_F(ContainPluginTest, MovingGeometry)
{
  this->Load("worlds/contain_plugin_moving_demo.world", true);
  auto world = physics::get_world();
  ASSERT_NE(nullptr, world);

  // Subscribe to plugin notifications
  std::string prefix("/gazebo/default/drill/");
  auto containSub = this->node->Subscribe(prefix + "contain", &containCb);
  ASSERT_NE(containSub , nullptr);

  // Box initially does not contain drill
  world->Step(10);
  EXPECT_FALSE(g_contain);

  // Box contains drill after box falls for a bit
  world->Step(400);
  EXPECT_TRUE(g_contain);

  // Box doesn't contain drill after falling a bit more
  world->Step(400);
  EXPECT_FALSE(g_contain);
}

//////////////////////////////////////////////////
TEST_F(ContainPluginTest, RemoveEntity)
{
  this->Load("worlds/contain_plugin_demo.world", true);
  auto world = physics::get_world();
  ASSERT_NE(nullptr, world);

  // Get models
  auto drill = world->GetModel("drill");
  ASSERT_NE(nullptr, drill);

  // Subscribe to plugin notifications
  std::string prefix("/gazebo/default/drill/");
  auto containSub = this->node->Subscribe(prefix + "contain", &containCb);
  ASSERT_NE(containSub , nullptr);

  // Place drill inside box
  drill->SetWorldPose(ignition::math::Pose3d(10.0, 10.0, 1.0, 0, 0, 0));
  world->Step(10);
  EXPECT_TRUE(g_contain);

  // Delete drill
  world->RemoveModel(drill);
  drill = nullptr;

  // Box doesn't contain drill since drill does not exist
  world->Step(10);
  EXPECT_FALSE(g_contain);
}

//////////////////////////////////////////////////
TEST_F(ContainPluginTest, RemoveReferenceEntity)
{
  this->Load("worlds/contain_plugin_moving_demo.world", true);
  auto world = physics::get_world();
  ASSERT_NE(nullptr, world);

  // Subscribe to plugin notifications
  std::string prefix("/gazebo/default/drill/");
  auto containSub = this->node->Subscribe(prefix + "contain", &containCb);
  ASSERT_NE(containSub , nullptr);

  // Box contains drill after box falls for a bit
  world->Step(400);
  EXPECT_TRUE(g_contain);

  // Delete box
  auto box = world->GetModel("box");
  ASSERT_NE(nullptr, box);
  world->RemoveModel(box);
  box = nullptr;

  // No box, so nothing contains the drill
  world->Step(10);
  EXPECT_FALSE(g_contain);
}

//////////////////////////////////////////////////
int main(int argc, char **argv)
{
  ::testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}