Run an optimizer REST API depending of many contraints for a Vehicle Routing Problem (VRP).
For ruby, bundler and gems, rbenv or rvm are recommanded.
- Ruby 2.3+ (if not using rbenv/rvm)
sudo apt install ruby-full
- redis-server
sudo apt install redis-server
- libgeos-dev
sudo apt install libgeos-dev
brew install redis
brew install geos
bundle install
This project requires some solver and interface projects in order to be fully functionnal!
- Vroom actual master
- Optimizer-ortools & OR-tools v6.5
- (optional / not anymore supported) Optimizer-jsprit & Jsprit
Adjust config/environments files.
bundle exec rake server
And in production mode:
APP_ENV=production bundle exec rake server
Start Redis and then start the worker
APP_ENV=production COUNT=5 QUEUE=* bundle exec rake resque:workers
The API is defined in Swagger format at http://localhost:1791/swagger_doc and can be tested with Swagger-UI http://swagger.mapotempo.com/?url=http://optimizer.mapotempo.com/swagger_doc
curl -X POST --header "Content-Type:application/json" --data '{"vrp":{vehicles":[]}}' http://localhost:1791/0.1/vrp/submit.json?api_key=key
Run tests:
APP_ENV=test ROUTER_URL=http://localhost:4899 bundle exec rake test
You can add your own tests on specific Vehicle Routing Problem (for instance data from real cases). Let's see how to create a new test called "new_test".
You will find template for test in test/real_cases_test.rb
Before creating test, you need to capture scenario, in order to have a static image of your problem, insensitive to the routers edits.
Add your test JSON file into test/fixtures/. Now to create your test, just copy test template in test/wrappers/real_cases_test.rb, or any equivalent file.
Once launched, the dump file of the problem will be created and put aswell in test/fixtures as following:
new_test.dumpfile corresponding to complete vrp with calculated matrices if not provided
If you create a test by using .dump, your test will fail as soon as vrp model is changed. Just run following task to update fixtures:
TEST_DUMP_VRP=true APP_ENV=test bundle exec rake test TEST=test/real_cases_test.rb
Note: you can update a test and run the modified scenario with new vrp .json:
bundle exec rake server
COUNT=5 QUEUE=* bundle exec rake resque:workers
curl -X POST --header "Content-Type:application/json" --data @test/fixtures/my_test.json http://localhost:1791/0.1/vrp/submit.json?api_key=key
If you don't want to run some long real cases tests you can deactive them:
SKIP_REAL_CASES=true APP_ENV=test bundle exec rake test
To test on travis with a optimizer-ortools different than the latest version, specify in your travis configuration the following environment variable : OPTIMIZER_ORTOOLS_VERSION with you travis owner nick.