Add basic facades for Extractor and Contractor run methods.

Based on idea suggested in comments to #3776, simplifies
use of extractor and contractor as libraries.

CMakeLists.txt

@@ -143,10 +143,10 @@ add_executable(osrm-contract src/tools/contract.cpp)
 add_executable(osrm-routed src/tools/routed.cpp $<TARGET_OBJECTS:SERVER> $<TARGET_OBJECTS:UTIL>)
 add_executable(osrm-datastore src/tools/store.cpp $<TARGET_OBJECTS:UTIL>)
 add_library(osrm src/osrm/osrm.cpp $<TARGET_OBJECTS:ENGINE> $<TARGET_OBJECTS:UTIL> $<TARGET_OBJECTS:STORAGE>)
-add_library(osrm_extract $<TARGET_OBJECTS:EXTRACTOR> $<TARGET_OBJECTS:UTIL>)
+add_library(osrm_contract src/osrm/contractor.cpp $<TARGET_OBJECTS:CONTRACTOR> $<TARGET_OBJECTS:UTIL>)
+add_library(osrm_extract src/osrm/extractor.cpp $<TARGET_OBJECTS:EXTRACTOR> $<TARGET_OBJECTS:UTIL>)
 add_library(osrm_partition $<TARGET_OBJECTS:PARTITIONER> $<TARGET_OBJECTS:UTIL>)
 add_library(osrm_customize $<TARGET_OBJECTS:CUSTOMIZER> $<TARGET_OBJECTS:UTIL>)
-add_library(osrm_contract $<TARGET_OBJECTS:CONTRACTOR> $<TARGET_OBJECTS:UTIL>)
 add_library(osrm_store $<TARGET_OBJECTS:STORAGE> $<TARGET_OBJECTS:UTIL>)
 
 if(ENABLE_GOLD_LINKER)

include/osrm/contractor.hpp

@@ -0,0 +1,50 @@
+/*
+
+Copyright (c) 2017, Project OSRM contributors
+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.
+
+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 HOLDER 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.
+
+*/
+
+#ifndef OSRM_CONTRACTOR_HPP
+#define OSRM_CONTRACTOR_HPP
+
+namespace osrm
+{
+namespace contractor
+{
+struct ContractorConfig;
+
+} // ns contractor
+
+/**
+ * Runs contraction hierarchy computation process.
+ *
+ * \param config The user-provided contraction configuration.
+ * \throws osrm::util::exception
+ * \see Contractor, ContractorConfig
+ */
+void contract(const contractor::ContractorConfig &config);
+
+} // ns osrm
+
+#endif // OSRM_CONTRACTOR_HPP

include/osrm/contractor_config.hpp

@@ -0,0 +1,38 @@
+/*
+
+Copyright (c) 2017, Project OSRM contributors
+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.
+
+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 HOLDER 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.
+
+*/
+
+#ifndef GLOBAL_CONTRACTOR_CONFIG_HPP
+#define GLOBAL_CONTRACTOR_CONFIG_HPP
+
+#include "contractor/contractor_config.hpp"
+
+namespace osrm
+{
+using contractor::ContractorConfig;
+}
+
+#endif

include/osrm/extractor.hpp

@@ -0,0 +1,50 @@
+/*
+
+Copyright (c) 2017, Project OSRM contributors
+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.
+
+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 HOLDER 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.
+
+*/
+
+#ifndef OSRM_EXTRACTOR_HPP
+#define OSRM_EXTRACTOR_HPP
+
+namespace osrm
+{
+namespace extractor
+{
+struct ExtractorConfig;
+
+} // ns contractor
+
+/**
+ * Runs extraction process.
+ *
+ * \param config The user-provided extraction configuration.
+ * \throws osrm::util::exception, osmium::io_error
+ * \see Extractor, ExtractorConfig
+ */
+void extract(const extractor::ExtractorConfig &config);
+
+} // ns osrm
+
+#endif // OSRM_EXTRACTOR_HPP

include/osrm/extractor_config.hpp

@@ -0,0 +1,38 @@
+/*
+
+Copyright (c) 2017, Project OSRM contributors
+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.
+
+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 HOLDER 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.
+
+*/
+
+#ifndef GLOBAL_EXTRACTOR_CONFIG_HPP
+#define GLOBAL_EXTRACTOR_CONFIG_HPP
+
+#include "extractor/extractor_config.hpp"
+
+namespace osrm
+{
+using extractor::ExtractorConfig;
+}
+
+#endif

src/osrm/contractor.cpp

@@ -0,0 +1,12 @@
+#include "osrm/contractor.hpp"
+#include "contractor/contractor.hpp"
+#include "contractor/contractor_config.hpp"
+
+namespace osrm
+{
+
+// Pimpl-like facade
+
+void contract(const contractor::ContractorConfig &config) { contractor::Contractor(config).Run(); }
+
+} // ns osrm

src/osrm/extractor.cpp

@@ -0,0 +1,17 @@
+#include "osrm/extractor.hpp"
+#include "extractor/extractor.hpp"
+#include "extractor/extractor_config.hpp"
+#include "extractor/scripting_environment_lua.hpp"
+
+namespace osrm
+{
+
+// Pimpl-like facade
+
+void extract(const extractor::ExtractorConfig &config)
+{
+    extractor::Sol2ScriptingEnvironment scripting_environment(config.profile_path.string().c_str());
+    extractor::Extractor(config).run(scripting_environment);
+}
+
+} // ns osrm

unit_tests/CMakeLists.txt

@@ -13,6 +13,15 @@ file(GLOB PartitionTestsSources
 file(GLOB LibraryTestsSources
     library_tests.cpp
     library/*.cpp)
+list(REMOVE_ITEM LibraryTestsSources ${CMAKE_CURRENT_SOURCE_DIR}/library/extract.cpp ${CMAKE_CURRENT_SOURCE_DIR}/library/contract.cpp)
+
+file(GLOB LibraryExtractTestsSources
+    library_tests.cpp
+    library/extract.cpp)
+
+file(GLOB LibraryContractTestsSources
+    library_tests.cpp
+    library/contract.cpp)
 
 file(GLOB ServerTestsSources
     server_tests.cpp
@@ -41,6 +50,14 @@ add_executable(library-tests
 	EXCLUDE_FROM_ALL
 	${LibraryTestsSources})
 
+add_executable(library-extract-tests
+	EXCLUDE_FROM_ALL
+	${LibraryExtractTestsSources})
+
+add_executable(library-contract-tests
+	EXCLUDE_FROM_ALL
+	${LibraryContractTestsSources})
+
 add_executable(server-tests
 	EXCLUDE_FROM_ALL
 	${ServerTestsSources}
@@ -65,9 +82,13 @@ endif()
 
 target_compile_definitions(extractor-tests PRIVATE COMPILE_DEFINITIONS OSRM_FIXTURES_DIR="${CMAKE_SOURCE_DIR}/unit_tests/fixtures")
 target_compile_definitions(library-tests PRIVATE COMPILE_DEFINITIONS OSRM_TEST_DATA_DIR="${TEST_DATA_DIR}")
+target_compile_definitions(library-extract-tests PRIVATE COMPILE_DEFINITIONS OSRM_TEST_DATA_DIR="${TEST_DATA_DIR}")
+target_compile_definitions(library-contract-tests PRIVATE COMPILE_DEFINITIONS OSRM_TEST_DATA_DIR="${TEST_DATA_DIR}")
 
 target_include_directories(engine-tests PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
 target_include_directories(library-tests PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_include_directories(library-extract-tests PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_include_directories(library-contract-tests PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
 target_include_directories(util-tests PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
 target_include_directories(partition-tests PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
 
@@ -75,8 +96,10 @@ target_link_libraries(engine-tests ${ENGINE_LIBRARIES} ${Boost_UNIT_TEST_FRAMEWO
 target_link_libraries(extractor-tests ${EXTRACTOR_LIBRARIES} ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
 target_link_libraries(partition-tests ${PARTITIONER_LIBRARIES} ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
 target_link_libraries(library-tests osrm ${ENGINE_LIBRARIES} ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
+target_link_libraries(library-extract-tests osrm_extract ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
+target_link_libraries(library-contract-tests osrm_contract ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
 target_link_libraries(server-tests osrm ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
 target_link_libraries(util-tests ${UTIL_LIBRARIES} ${Boost_UNIT_TEST_FRAMEWORK_LIBRARY})
 
 add_custom_target(tests
-	DEPENDS engine-tests extractor-tests partition-tests library-tests server-tests util-tests)
+	DEPENDS engine-tests extractor-tests partition-tests library-tests library-extract-tests server-tests util-tests)

unit_tests/library/contract.cpp

@@ -0,0 +1,21 @@
+#include <boost/test/test_case_template.hpp>
+#include <boost/test/unit_test.hpp>
+
+#include "osrm/contractor.hpp"
+#include "osrm/contractor_config.hpp"
+
+#include <tbb/task_scheduler_init.h> // default_num_threads
+
+BOOST_AUTO_TEST_SUITE(library_contract)
+
+BOOST_AUTO_TEST_CASE(test_contract_with_invalid_config)
+{
+    using namespace osrm;
+
+    osrm::ContractorConfig config;
+    config.requested_num_threads = tbb::task_scheduler_init::default_num_threads();
+    BOOST_CHECK_THROW(osrm::contract(config),
+                      std::exception); // including osrm::util::exception, etc.
+}
+
+BOOST_AUTO_TEST_SUITE_END()

unit_tests/library/extract.cpp

@@ -0,0 +1,27 @@
+#include <boost/test/test_case_template.hpp>
+#include <boost/test/unit_test.hpp>
+
+#include "osrm/extractor.hpp"
+#include "osrm/extractor_config.hpp"
+
+#include <tbb/task_scheduler_init.h> // default_num_threads
+
+BOOST_AUTO_TEST_SUITE(library_extract)
+
+BOOST_AUTO_TEST_CASE(test_extract_with_invalid_config)
+{
+    osrm::ExtractorConfig config;
+    config.requested_num_threads = tbb::task_scheduler_init::default_num_threads();
+    BOOST_CHECK_THROW(osrm::extract(config),
+                      std::exception); // including osrm::util::exception, osmium::io_error, etc.
+}
+
+BOOST_AUTO_TEST_CASE(test_extract_with_valid_config)
+{
+    osrm::ExtractorConfig config;
+    config.input_path = {OSRM_TEST_DATA_DIR "/monaco.osm.pbf"};
+    config.requested_num_threads = tbb::task_scheduler_init::default_num_threads();
+    BOOST_CHECK_NO_THROW(osrm::extract(config));
+}
+
+BOOST_AUTO_TEST_SUITE_END()