roslib: doc update
This commit is contained in:
Ken Conley
parent
6d7022a9e4
commit
dfd07e8291
|
|
@ -29,15 +29,13 @@
|
|||
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
# POSSIBILITY OF SUCH DAMAGE.
|
||||
#
|
||||
# Revision $Id$
|
||||
|
||||
"""
|
||||
roslib is largely deprecated starting in the ROS Fuerte release.
|
||||
|
||||
roslib has a very important role in all Python code written for ROS:
|
||||
it contains the L{load_manifest()} method, which updates the
|
||||
PYTHONPATH based on a set of ROS Package manifest.xml files. Because
|
||||
of this role, roslib is required to be on the PYTHONPATH of every ROS
|
||||
installation.
|
||||
PYTHONPATH based on a set of ROS Package manifest.xml files.
|
||||
|
||||
Beyond the important load_manifest() call, most of the rest of roslib
|
||||
consists of low-level libraries that 99% of ROS users need not
|
||||
|
|
|
|||
|
|
@ -1,38 +0,0 @@
|
|||
if(ROSBUILD)
|
||||
# this is for rosbuild2 integration, you can ignore this
|
||||
include(rosbuild.cmake OPTIONAL)
|
||||
return()
|
||||
endif()
|
||||
cmake_minimum_required(VERSION 2.4.6)
|
||||
include($ENV{ROS_ROOT}/core/rosbuild/rosbuild.cmake)
|
||||
|
||||
# Set the build type. Options are:
|
||||
# Coverage : w/ debug symbols, w/o optimization, w/ code-coverage
|
||||
# Debug : w/ debug symbols, w/o optimization
|
||||
# Release : w/o debug symbols, w/ optimization
|
||||
# RelWithDebInfo : w/ debug symbols, w/ optimization
|
||||
# MinSizeRel : w/o debug symbols, w/ optimization, stripped binaries
|
||||
#set(ROS_BUILD_TYPE RelWithDebInfo)
|
||||
|
||||
rosbuild_init()
|
||||
|
||||
#set the default path for built executables to the "bin" directory
|
||||
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
|
||||
#set the default path for built libraries to the "lib" directory
|
||||
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
|
||||
|
||||
#uncomment if you have defined messages
|
||||
#rosbuild_genmsg()
|
||||
#uncomment if you have defined services
|
||||
#rosbuild_gensrv()
|
||||
|
||||
#common commands for building c++ executables and libraries
|
||||
#rosbuild_add_library(${PROJECT_NAME} src/example.cpp)
|
||||
#target_link_libraries(${PROJECT_NAME} another_library)
|
||||
#rosbuild_add_boost_directories()
|
||||
#rosbuild_link_boost(${PROJECT_NAME} thread)
|
||||
#rosbuild_add_executable(example examples/example.cpp)
|
||||
#target_link_libraries(example ${PROJECT_NAME})
|
||||
|
||||
rosbuild_add_pyunit(test/test_parallel_build.py)
|
||||
rosbuild_add_pyunit(test/test_rosmake_commandline.py)
|
||||
|
|
@ -1 +0,0 @@
|
|||
include $(shell rospack find mk)/cmake.mk
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
/**
|
||||
\mainpage
|
||||
\htmlinclude manifest.html
|
||||
|
||||
\b test_rosmake is ...
|
||||
|
||||
<!--
|
||||
In addition to providing an overview of your package,
|
||||
this is the section where the specification and design/architecture
|
||||
should be detailed. While the original specification may be done on the
|
||||
wiki, it should be transferred here once your package starts to take shape.
|
||||
You can then link to this documentation page from the Wiki.
|
||||
-->
|
||||
|
||||
|
||||
\section codeapi Code API
|
||||
|
||||
<!--
|
||||
Provide links to specific auto-generated API documentation within your
|
||||
package that is of particular interest to a reader. Doxygen will
|
||||
document pretty much every part of your code, so do your best here to
|
||||
point the reader to the actual API.
|
||||
|
||||
If your codebase is fairly large or has different sets of APIs, you
|
||||
should use the doxygen 'group' tag to keep these APIs together. For
|
||||
example, the roscpp documentation has 'libros' group.
|
||||
-->
|
||||
|
||||
|
||||
*/
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<package>
|
||||
<description brief="test_rosmake">
|
||||
|
||||
test_rosmake
|
||||
|
||||
</description>
|
||||
<author>Tully Foote</author>
|
||||
<license>BSD</license>
|
||||
<review status="test" notes=""/>
|
||||
<url>http://ros.org/wiki/test_rosmake</url>
|
||||
<depend package="rosmake"/>
|
||||
<depend package="rosunit"/>
|
||||
|
||||
<platform os="ubuntu" version="9.04"/>
|
||||
<platform os="ubuntu" version="9.10"/>
|
||||
<platform os="ubuntu" version="10.04"/>
|
||||
<platform os="macports" version="macports"/>
|
||||
</package>
|
||||
|
||||
|
||||
|
|
@ -1,251 +0,0 @@
|
|||
#!/usr/bin/env python
|
||||
# Copyright (c) 2009, Willow Garage, Inc.
|
||||
# All rights reserved.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without
|
||||
# modification, are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright
|
||||
# notice, this list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright
|
||||
# notice, this list of conditions and the following disclaimer in the
|
||||
# documentation and/or other materials provided with the distribution.
|
||||
# * Neither the name of the Willow Garage, Inc. nor the names of its
|
||||
# contributors may be used to endorse or promote products derived from
|
||||
# this software without specific prior written permission.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
||||
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
# POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
import roslib; roslib.load_manifest("test_rosmake")
|
||||
|
||||
import sys
|
||||
import unittest
|
||||
import rosunit
|
||||
|
||||
from rosmake import parallel_build
|
||||
NAME = "test_rosmake_parallel_build"
|
||||
|
||||
class TestDependencyTracker(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.deps = {}
|
||||
self.deps1 = {}
|
||||
self.deps["a"] = [ "b", "c", "d","e"]
|
||||
self.deps1["a"] = ["b"]
|
||||
self.deps["b"] = ["c"]
|
||||
self.deps1["b"] = ["c"]
|
||||
self.deps["d"] = ["c", "e"]
|
||||
self.deps1["d"] = ["c", "e"]
|
||||
self.dt = parallel_build.DependencyTracker()
|
||||
self.dt.load_fake_deps(self.deps, self.deps1)
|
||||
|
||||
|
||||
def test_deps_1(self):
|
||||
self.assertEquals(self.deps1["a"], self.dt.get_deps_1("a"))
|
||||
self.assertEquals(self.deps1["b"], self.dt.get_deps_1("b"))
|
||||
self.assertEquals(self.deps1["d"], self.dt.get_deps_1("d"))
|
||||
|
||||
def test_deps(self):
|
||||
self.assertEquals(self.deps["a"], self.dt.get_deps("a"))
|
||||
self.assertEquals(self.deps["b"], self.dt.get_deps("b"))
|
||||
self.assertEquals(self.deps["d"], self.dt.get_deps("d"))
|
||||
|
||||
def test_not_package(self):
|
||||
self.assertEquals([], self.dt.get_deps("This is not a valid package name"))
|
||||
self.assertEquals([], self.dt.get_deps_1("This is not a valid package name"))
|
||||
|
||||
|
||||
class TestBuildQueue(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
deps = {}
|
||||
deps1 = {}
|
||||
deps1["a"] = ["b"]
|
||||
deps["a"] = ["b", "c", "d", "e", "f"]
|
||||
deps1["b"] = ["c"]
|
||||
deps["b"] = ["c", "d", "e", "f"]
|
||||
deps1["c"] = ["d"]
|
||||
deps["c"] = ["d", "e", "f"]
|
||||
deps1["d"] = ["e"]
|
||||
deps["d"] = ["e", "f"]
|
||||
deps["e"] = ["f"]
|
||||
deps1["e"] = ["f"]
|
||||
deps["f"] = []
|
||||
deps1["f"] = []
|
||||
|
||||
self.serial_tracker = parallel_build.DependencyTracker()
|
||||
self.serial_tracker.load_fake_deps(deps, deps1)
|
||||
|
||||
deps = {}
|
||||
deps1 = {}
|
||||
deps["a"] = ["b", "c", "d", "e", "f"]
|
||||
deps1["a"] = ["b", "c", "d", "e", "f"]
|
||||
deps["b"] = []
|
||||
deps1["b"] = []
|
||||
deps["c"] = []
|
||||
deps1["c"] = []
|
||||
deps["d"] = []
|
||||
deps1["d"] = []
|
||||
deps["e"] = []
|
||||
deps1["e"] = []
|
||||
deps["f"] = []
|
||||
deps1["f"] = []
|
||||
|
||||
self.parallel_tracker = parallel_build.DependencyTracker()
|
||||
self.parallel_tracker.load_fake_deps(deps, deps1)
|
||||
|
||||
# full queue
|
||||
def test_full_build(self):
|
||||
bq = parallel_build.BuildQueue(["a", "b", "c", "d", "e", "f"], self.serial_tracker)
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("f", bq.get_valid_package())
|
||||
self.assertEqual(0, len(bq.built))
|
||||
bq.return_built("f")
|
||||
self.assertEqual(1, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("e", bq.get_valid_package())
|
||||
bq.return_built("e")
|
||||
self.assertEqual(2, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("d", bq.get_valid_package())
|
||||
bq.return_built("d")
|
||||
self.assertEqual(3, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("c", bq.get_valid_package())
|
||||
bq.return_built("c")
|
||||
self.assertEqual(4, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("b", bq.get_valid_package())
|
||||
bq.return_built("b")
|
||||
self.assertEqual(5, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("a", bq.get_valid_package())
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
bq.return_built("a")
|
||||
self.assertEqual(6, len(bq.built))
|
||||
self.assertTrue (bq.is_done())
|
||||
self.assertTrue (bq.succeeded())
|
||||
|
||||
|
||||
# partial build
|
||||
def test_partial_build(self):
|
||||
bq = parallel_build.BuildQueue(["d", "e", "f"], self.serial_tracker)
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("f", bq.get_valid_package())
|
||||
self.assertEqual(0, len(bq.built))
|
||||
bq.return_built("f")
|
||||
self.assertEqual(1, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("e", bq.get_valid_package())
|
||||
bq.return_built("e")
|
||||
self.assertEqual(2, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("d", bq.get_valid_package())
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
bq.return_built("d")
|
||||
self.assertEqual(3, len(bq.built))
|
||||
self.assertTrue(bq.is_done())
|
||||
self.assertTrue(bq.succeeded())
|
||||
|
||||
|
||||
# abort early
|
||||
def test_abort_early(self):
|
||||
bq = parallel_build.BuildQueue(["a", "b", "c", "d", "e", "f"], self.serial_tracker)
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
self.assertEqual(0, len(bq.built))
|
||||
|
||||
self.assertEqual("f", bq.get_valid_package())
|
||||
bq.return_built("f")
|
||||
self.assertEqual(1, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("e", bq.get_valid_package())
|
||||
bq.return_built("e")
|
||||
self.assertEqual(2, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual("d", bq.get_valid_package())
|
||||
bq.return_built("d")
|
||||
self.assertEqual(3, len(bq.built))
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
bq.stop()
|
||||
self.assertTrue(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
self.assertEqual(None, bq.get_valid_package())
|
||||
|
||||
# many parallel
|
||||
def test_parallel_build(self):
|
||||
bq = parallel_build.BuildQueue(["a", "b", "c", "d", "e", "f"], self.parallel_tracker)
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
dependents = ["b", "c", "d", "e", "f"]
|
||||
count = 0
|
||||
total = 6
|
||||
while len(dependents) > 0:
|
||||
result= bq.get_valid_package()
|
||||
done = len(bq.built)
|
||||
pkgs = bq._total_pkgs
|
||||
self.assertTrue(result in dependents)
|
||||
#print result, done, pkgs
|
||||
dependents.remove(result)
|
||||
self.assertEqual(count, done)
|
||||
self.assertEqual(total, pkgs)
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
bq.return_built(result)
|
||||
count = count + 1
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
|
||||
|
||||
self.assertEqual("a", bq.get_valid_package())
|
||||
self.assertFalse(bq.is_done())
|
||||
self.assertFalse(bq.succeeded())
|
||||
bq.return_built("a")
|
||||
self.assertTrue (bq.is_done())
|
||||
self.assertTrue (bq.succeeded())
|
||||
|
||||
|
||||
# stalled(future)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
rosunit.unitrun('test_rosmake', "dependency_tracker", TestDependencyTracker, sys.argv, coverage_packages=['rosmake'])
|
||||
rosunit.unitrun('test_rosmake', "build_queue", TestBuildQueue, sys.argv, coverage_packages=['rosmake'])
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
# Software License Agreement (BSD License)
|
||||
#
|
||||
# Copyright (c) 2009, Willow Garage, Inc.
|
||||
# All rights reserved.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without
|
||||
# modification, are permitted provided that the following conditions
|
||||
# are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright
|
||||
# notice, this list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above
|
||||
# copyright notice, this list of conditions and the following
|
||||
# disclaimer in the documentation and/or other materials provided
|
||||
# with the distribution.
|
||||
# * Neither the name of Willow Garage, Inc. nor the names of its
|
||||
# contributors may be used to endorse or promote products derived
|
||||
# from this software without specific prior written permission.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
# POSSIBILITY OF SUCH DAMAGE.
|
||||
import roslib; roslib.load_manifest('test_rosdep')
|
||||
|
||||
import os
|
||||
import struct
|
||||
import sys
|
||||
import unittest
|
||||
import subprocess
|
||||
|
||||
import rosunit
|
||||
import rosdep.core
|
||||
|
||||
|
||||
class RosmakeCommandlineTest(unittest.TestCase):
|
||||
|
||||
def test_Rosmake_commandline_usage(self):
|
||||
self.assertEqual(0,subprocess.call(["rosmake", "-h"]))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
rosunit.unitrun('test_rosmake', 'test_commandline', RosmakeCommandlineTest, coverage_packages=['rosmake.commandline'])
|
||||
|
||||
Loading…
Reference in New Issue