\" : \"'\" + description + \"'\") + \" \" + coordinates;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/Route.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Objects;\n\n/**\n * Vehicle's itinerary (sequence of visits) and its depot. This entity cannot exist without the vehicle and the depot\n * but it's allowed to have no visits when the vehicle hasn't been assigned any (it's idle).\n * \n * This entity describes part of a {@link RoutingPlan solution} of the vehicle routing problem\n * (assignment of a subset of visits to one of the vehicles).\n * It doesn't carry the data about physical tracks between adjacent visits.\n * Geographical data is held by {@link RouteWithTrack}.\n */\npublic class Route {\n\n private final Vehicle vehicle;\n private final Location depot;\n private final List visits;\n\n /**\n * Create a vehicle route.\n *\n * @param vehicle the vehicle assigned to this route (not {@code null})\n * @param depot vehicle's depot (not {@code null})\n * @param visits list of visits (not {@code null})\n */\n public Route(Vehicle vehicle, Location depot, List visits) {\n this.vehicle = Objects.requireNonNull(vehicle);\n this.depot = Objects.requireNonNull(depot);\n this.visits = new ArrayList<>(Objects.requireNonNull(visits));\n // TODO Probably remove this check when we have more types: new Route(Depot depot, List visits).\n // Then visits obviously cannot contain the depot. But will we still require that no visit has the same\n // location as the depot? (I don't think so).\n if (visits.contains(depot)) {\n throw new IllegalArgumentException(\"Depot (\" + depot + \") must not be one of the visits (\" + visits + \")\");\n }\n long uniqueVisits = visits.stream().distinct().count();\n if (uniqueVisits < visits.size()) {\n long duplicates = visits.size() - uniqueVisits;\n throw new IllegalArgumentException(\"Some visits have been visited multiple times (\" + duplicates + \")\");\n }\n }\n\n /**\n * The vehicle assigned to this route.\n *\n * @return route's vehicle (never {@code null})\n */\n public Vehicle vehicle() {\n return vehicle;\n }\n\n /**\n * Depot in which the route starts and ends.\n *\n * @return route's depot (never {@code null})\n */\n public Location depot() {\n return depot;\n }\n\n /**\n * List of vehicle's visits (not including the depot).\n *\n * @return list of visits\n */\n public List visits() {\n return Collections.unmodifiableList(visits);\n }\n\n @Override\n public String toString() {\n return \"Route{\" +\n \"vehicle=\" + vehicle +\n \", depot=\" + depot.id() +\n \", visits=\" + visits.stream().map(Location::id).collect(toList()) +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/RouteWithTrack.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Objects;\n\n/**\n * Vehicle's {@link Route itinerary} enriched with detailed geographical description of the route.\n * This object contains data needed to visualize vehicle's route on a map.\n */\npublic class RouteWithTrack extends Route {\n\n private final List> track;\n\n /**\n * Create a route with track. When route is empty (no visits), track must be empty too and vice-versa\n * (non-empty route must have a non-empty track).\n *\n * @param route vehicle's route (not {@code null})\n * @param track track going through all visits (not {@code null})\n */\n public RouteWithTrack(Route route, List> track) {\n super(route.vehicle(), route.depot(), route.visits());\n this.track = new ArrayList<>(Objects.requireNonNull(track));\n if (route.visits().isEmpty() && !track.isEmpty() || !route.visits().isEmpty() && track.isEmpty()) {\n throw new IllegalArgumentException(\"Route and track must be either both empty or both non-empty\");\n }\n }\n\n /**\n * Vehicle's track that goes from vehicle's depot through all visits and returns to the depot.\n *\n * @return vehicle's track (not {@code null})\n */\n public List> track() {\n return Collections.unmodifiableList(track);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/RoutingPlan.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static java.util.Collections.emptyList;\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\n\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n/**\n * Route plan for the whole vehicle fleet.\n */\npublic class RoutingPlan {\n\n private static final Logger logger = LoggerFactory.getLogger(RoutingPlan.class);\n\n private final Distance distance;\n private final List vehicles;\n private final Location depot;\n private final List visits;\n private final List routes;\n\n /**\n * Create a routing plan.\n *\n * @param distance the overall travel distance\n * @param vehicles all available vehicles\n * @param depot the depot (may be {@code null})\n * @param visits all visits\n * @param routes routes of all vehicles\n */\n public RoutingPlan(\n Distance distance,\n List vehicles,\n Location depot,\n List visits,\n List routes) {\n this.distance = Objects.requireNonNull(distance);\n this.vehicles = new ArrayList<>(Objects.requireNonNull(vehicles));\n this.depot = depot;\n this.visits = new ArrayList<>(Objects.requireNonNull(visits));\n this.routes = new ArrayList<>(Objects.requireNonNull(routes));\n if (depot == null) {\n if (!routes.isEmpty()) {\n throw new IllegalArgumentException(\"Routes must be empty when depot is null\");\n }\n } else if (routes.size() != vehicles.size()) {\n throw new IllegalArgumentException(describeVehiclesRoutesInconsistency(\n \"There must be exactly one route per vehicle\", vehicles, routes));\n } else if (haveDifferentVehicles(vehicles, routes)) {\n throw new IllegalArgumentException(describeVehiclesRoutesInconsistency(\n \"Some routes are assigned to non-existent vehicles\", vehicles, routes));\n } else if (!routes.isEmpty()) {\n List visited = routes.stream()\n .map(Route::visits)\n .flatMap(Collection::stream)\n .collect(toList());\n ArrayList unvisited = new ArrayList<>(visits);\n unvisited.removeAll(visited);\n if (!unvisited.isEmpty()) {\n // This happens because we're also publishing solutions that are not fully initialized.\n // TODO decide whether this allowed or not\n logger.warn(\"Some visits are unvisited: {}\", unvisited);\n }\n visited.removeAll(visits);\n if (!visited.isEmpty()) {\n throw new IllegalArgumentException(\n \"Some routes are going through visits that haven't been defined: \" + visited);\n }\n }\n }\n\n private static boolean haveDifferentVehicles(List vehicles, List routes) {\n return routes.stream()\n .map(Route::vehicle)\n .anyMatch(vehicle -> !vehicles.contains(vehicle));\n }\n\n private static String describeVehiclesRoutesInconsistency(\n String cause,\n List vehicles,\n List routes) {\n List vehicleIdsFromRoutes = routes.stream()\n .map(route -> route.vehicle().id())\n .collect(toList());\n return cause\n + \":\\n- Vehicles (\" + vehicles.size() + \"): \" + vehicles\n + \"\\n- Routes' vehicleIds (\" + routes.size() + \"): \" + vehicleIdsFromRoutes;\n }\n\n /**\n * Create an empty routing plan.\n *\n * @return empty routing plan\n */\n public static RoutingPlan empty() {\n return new RoutingPlan(Distance.ZERO, emptyList(), null, emptyList(), emptyList());\n }\n\n /**\n * Total distance traveled (sum of distances of all routes).\n *\n * @return travel distance\n */\n public Distance distance() {\n return distance;\n }\n\n /**\n * All available vehicles.\n *\n * @return all vehicles\n */\n public List vehicles() {\n return Collections.unmodifiableList(vehicles);\n }\n\n /**\n * Routes of all vehicles in the depot. Includes empty routes of vehicles that stay in the depot.\n *\n * @return all routes (may be empty when there is no depot or no vehicles)\n */\n public List routes() {\n return Collections.unmodifiableList(routes);\n }\n\n /**\n * All visits that are part of the routing problem.\n *\n * @return all visits\n */\n public List visits() {\n return Collections.unmodifiableList(visits);\n }\n\n /**\n * The depot.\n *\n * @return depot (may be missing)\n */\n public Optional depot() {\n return Optional.ofNullable(depot);\n }\n\n /**\n * Routing plan is empty when there is no depot, no vehicles and no routes.\n *\n * @return {@code true} if the plan is empty\n */\n public boolean isEmpty() {\n // No need to check routes. No depot => no routes.\n return depot == null && vehicles.isEmpty();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/RoutingProblem.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\n\n/**\n * Definition of the vehicle routing problem instance.\n */\npublic class RoutingProblem {\n\n private final String name;\n private final List vehicles;\n private final LocationData depot;\n private final List visits;\n\n /**\n * Create routing problem instance.\n *\n * @param name the instance name\n * @param vehicles list of vehicles (not {@code null})\n * @param depot the depot (may be {@code null} if there is no depot)\n * @param visits list of visits (not {@code null})\n */\n public RoutingProblem(\n String name,\n List vehicles,\n LocationData depot,\n List visits) {\n this.name = Objects.requireNonNull(name);\n this.vehicles = new ArrayList<>(Objects.requireNonNull(vehicles));\n this.depot = depot;\n this.visits = new ArrayList<>(Objects.requireNonNull(visits));\n }\n\n /**\n * Get routing problem instance name.\n *\n * @return routing problem instance name\n */\n public String name() {\n return name;\n }\n\n /**\n * Get the depot.\n *\n * @return depot (never {@code null})\n */\n public Optional depot() {\n return Optional.ofNullable(depot);\n }\n\n /**\n * Get locations that should be visited.\n *\n * @return visits\n */\n public List visits() {\n return visits;\n }\n\n /**\n * Vehicles that are part of the problem definition.\n *\n * @return vehicles\n */\n public List vehicles() {\n return vehicles;\n }\n\n @Override\n public String toString() {\n return name;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/Vehicle.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\n/**\n * Vehicle that can be used to deliver cargo to visits.\n */\npublic class Vehicle extends VehicleData {\n\n private final long id;\n\n Vehicle(long id, String name, int capacity) {\n super(name, capacity);\n this.id = id;\n }\n\n /**\n * Vehicle's ID.\n *\n * @return unique ID\n */\n public long id() {\n return id;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n Vehicle vehicle = (Vehicle) o;\n return id == vehicle.id;\n }\n\n @Override\n public int hashCode() {\n return Long.hashCode(id);\n }\n\n @Override\n public String toString() {\n return name().isEmpty() ? Long.toString(id) : (id + \": '\" + name() + \"'\");\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/VehicleData.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport java.util.Objects;\n\n/**\n * Data about a vehicle.\n */\npublic class VehicleData {\n\n private final String name;\n private final int capacity;\n\n VehicleData(String name, int capacity) {\n this.name = Objects.requireNonNull(name);\n this.capacity = capacity;\n }\n\n /**\n * Vehicle's name (unique description).\n *\n * @return vehicle's name\n */\n public String name() {\n return name;\n }\n\n /**\n * Vehicle's capacity.\n *\n * @return vehicle's capacity\n */\n public int capacity() {\n return capacity;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n VehicleData that = (VehicleData) o;\n return capacity == that.capacity &&\n name.equals(that.name);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(name, capacity);\n }\n\n @Override\n public String toString() {\n return name.isEmpty() ? \"\" : \"'\" + name + \"'\";\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/VehicleFactory.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\n/**\n * Creates {@link Vehicle} instances.\n */\npublic class VehicleFactory {\n\n private VehicleFactory() {\n throw new AssertionError(\"Utility class\");\n }\n\n /**\n * Create vehicle data.\n *\n * @param name vehicle's name\n * @param capacity vehicle's capacity\n * @return vehicle data\n */\n public static VehicleData vehicleData(String name, int capacity) {\n return new VehicleData(name, capacity);\n }\n\n /**\n * Create a new vehicle with the given ID, name and capacity.\n *\n * @param id vehicle's ID\n * @param name vehicle's name\n * @param capacity vehicle's capacity\n * @return new vehicle\n */\n public static Vehicle createVehicle(long id, String name, int capacity) {\n return new Vehicle(id, name, capacity);\n }\n\n /**\n * Create a vehicle with given ID and capacity of zero. The vehicle will have a non-empty name.\n *\n * @param id vehicle's ID\n * @return new testing vehicle instance\n */\n public static Vehicle testVehicle(long id) {\n return new Vehicle(id, \"Vehicle \" + id, 0);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/domain/package-info.java",
"content": "/**\n * Domain model. Contains vehicles, depots, visits and so on.\n * The code in this package only depends on {@link java.lang} and is not affected\n * by any framework used in this project.\n */\npackage org.optaweb.vehiclerouting.domain;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceCrudRepository.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport javax.enterprise.context.ApplicationScoped;\n\nimport io.quarkus.hibernate.orm.panache.PanacheRepositoryBase;\nimport io.quarkus.panache.common.Parameters;\n\n/**\n * Distance repository.\n */\n@ApplicationScoped\npublic class DistanceCrudRepository implements PanacheRepositoryBase {\n\n void deleteByFromIdOrToId(long deletedLocationId) {\n delete(\n \"fromId = :deletedLocationId or toId = :deletedLocationId\",\n Parameters.with(\"deletedLocationId\", deletedLocationId));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceEntity.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport java.util.Objects;\n\nimport javax.persistence.EmbeddedId;\nimport javax.persistence.Entity;\n\n/**\n * Distance between two locations that can be persisted.\n */\n@Entity\nclass DistanceEntity {\n\n @EmbeddedId\n private DistanceKey key;\n\n private Long distance;\n\n protected DistanceEntity() {\n // for JPA\n }\n\n DistanceEntity(DistanceKey key, Long distance) {\n this.key = Objects.requireNonNull(key);\n this.distance = Objects.requireNonNull(distance);\n }\n\n DistanceKey getKey() {\n return key;\n }\n\n Long getDistance() {\n return distance;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n DistanceEntity that = (DistanceEntity) o;\n return key.equals(that.key) &&\n distance.equals(that.distance);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(key, distance);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceKey.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport java.io.Serializable;\nimport java.util.Objects;\n\nimport javax.persistence.Embeddable;\n\n/**\n * Composite key for {@link DistanceEntity}.\n */\n@Embeddable\nclass DistanceKey implements Serializable {\n\n // TODO make it a foreign key to LocationEntity\n private Long fromId;\n private Long toId;\n\n protected DistanceKey() {\n // for JPA\n }\n\n DistanceKey(long fromId, long toId) {\n this.fromId = fromId;\n this.toId = toId;\n }\n\n Long getFromId() {\n return fromId;\n }\n\n void setFromId(Long fromId) {\n this.fromId = fromId;\n }\n\n Long getToId() {\n return toId;\n }\n\n void setToId(Long toId) {\n this.toId = toId;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n DistanceKey that = (DistanceKey) o;\n return fromId.equals(that.fromId) &&\n toId.equals(that.toId);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(fromId, toId);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceRepositoryImpl.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport java.util.Optional;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.service.distance.DistanceRepository;\n\n@ApplicationScoped\nclass DistanceRepositoryImpl implements DistanceRepository {\n\n private final DistanceCrudRepository distanceRepository;\n\n @Inject\n DistanceRepositoryImpl(DistanceCrudRepository distanceRepository) {\n this.distanceRepository = distanceRepository;\n }\n\n @Override\n public void saveDistance(Location from, Location to, Distance distance) {\n DistanceEntity distanceEntity = new DistanceEntity(new DistanceKey(from.id(), to.id()), distance.millis());\n distanceRepository.persist(distanceEntity);\n }\n\n @Override\n public Optional getDistance(Location from, Location to) {\n return distanceRepository.findByIdOptional(new DistanceKey(from.id(), to.id()))\n .map(DistanceEntity::getDistance)\n .map(Distance::ofMillis);\n }\n\n @Override\n public void deleteDistances(Location location) {\n distanceRepository.deleteByFromIdOrToId(location.id());\n }\n\n @Override\n public void deleteAll() {\n distanceRepository.deleteAll();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/LocationCrudRepository.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport javax.enterprise.context.ApplicationScoped;\n\nimport io.quarkus.hibernate.orm.panache.PanacheRepository;\n\n/**\n * Location repository.\n */\n@ApplicationScoped\npublic class LocationCrudRepository implements PanacheRepository {\n\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/LocationEntity.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport java.math.BigDecimal;\nimport java.util.Objects;\n\nimport javax.persistence.Column;\nimport javax.persistence.Entity;\nimport javax.persistence.GeneratedValue;\nimport javax.persistence.GenerationType;\nimport javax.persistence.Id;\n\n/**\n * Persistable location.\n */\n@Entity\nclass LocationEntity {\n\n @Id\n @GeneratedValue(strategy = GenerationType.AUTO)\n private long id;\n\n // https://wiki.openstreetmap.org/wiki/Node#Structure\n @Column(precision = 9, scale = 7)\n private BigDecimal latitude;\n @Column(precision = 10, scale = 7)\n private BigDecimal longitude;\n\n private String description;\n\n protected LocationEntity() {\n // for JPA\n }\n\n LocationEntity(long id, BigDecimal latitude, BigDecimal longitude, String description) {\n this.id = id;\n this.latitude = Objects.requireNonNull(latitude);\n this.longitude = Objects.requireNonNull(longitude);\n this.description = Objects.requireNonNull(description);\n }\n\n long getId() {\n return id;\n }\n\n BigDecimal getLatitude() {\n return latitude;\n }\n\n BigDecimal getLongitude() {\n return longitude;\n }\n\n String getDescription() {\n return description;\n }\n\n @Override\n public String toString() {\n return \"LocationEntity{\" +\n \"id=\" + id +\n \", latitude=\" + latitude +\n \", longitude=\" + longitude +\n \", description='\" + description + '\\'' +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/LocationRepositoryImpl.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.List;\nimport java.util.Optional;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.service.location.LocationRepository;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n@ApplicationScoped\nclass LocationRepositoryImpl implements LocationRepository {\n\n private static final Logger logger = LoggerFactory.getLogger(LocationRepositoryImpl.class);\n private final LocationCrudRepository repository;\n\n @Inject\n LocationRepositoryImpl(LocationCrudRepository repository) {\n this.repository = repository;\n }\n\n @Override\n public Location createLocation(Coordinates coordinates, String description) {\n LocationEntity locationEntity = new LocationEntity(0, coordinates.latitude(), coordinates.longitude(), description);\n repository.persist(locationEntity);\n Location location = toDomain(locationEntity);\n logger.info(\"Created location {}.\", location.fullDescription());\n return location;\n }\n\n @Override\n public List locations() {\n return repository.streamAll()\n .map(LocationRepositoryImpl::toDomain)\n .collect(toList());\n }\n\n @Override\n public Location removeLocation(long id) {\n Optional maybeLocation = repository.findByIdOptional(id);\n maybeLocation.ifPresent(locationEntity -> repository.deleteById(id));\n LocationEntity locationEntity = maybeLocation.orElseThrow(\n () -> new IllegalArgumentException(\"Location{id=\" + id + \"} doesn't exist\"));\n Location location = toDomain(locationEntity);\n logger.info(\"Deleted location {}.\", location.fullDescription());\n return location;\n }\n\n @Override\n public void removeAll() {\n repository.deleteAll();\n }\n\n @Override\n public Optional find(long locationId) {\n return repository.findByIdOptional(locationId).map(LocationRepositoryImpl::toDomain);\n }\n\n private static Location toDomain(LocationEntity locationEntity) {\n return new Location(\n locationEntity.getId(),\n new Coordinates(locationEntity.getLatitude(), locationEntity.getLongitude()),\n locationEntity.getDescription());\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/VehicleCrudRepository.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport javax.enterprise.context.ApplicationScoped;\n\nimport io.quarkus.hibernate.orm.panache.PanacheRepository;\n\n/**\n * Vehicle repository.\n */\n@ApplicationScoped\npublic class VehicleCrudRepository implements PanacheRepository {\n\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/VehicleEntity.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport javax.persistence.Entity;\nimport javax.persistence.GeneratedValue;\nimport javax.persistence.GenerationType;\nimport javax.persistence.Id;\n\n/**\n * Persistable vehicle.\n */\n@Entity\npublic class VehicleEntity {\n\n @Id\n @GeneratedValue(strategy = GenerationType.AUTO)\n private long id;\n private String name;\n private int capacity;\n\n protected VehicleEntity() {\n // for JPA\n }\n\n public VehicleEntity(long id, String name, int capacity) {\n this.id = id;\n this.name = name;\n this.capacity = capacity;\n }\n\n public long getId() {\n return id;\n }\n\n public String getName() {\n return name;\n }\n\n public void setName(String name) {\n this.name = name;\n }\n\n public int getCapacity() {\n return capacity;\n }\n\n public void setCapacity(int capacity) {\n this.capacity = capacity;\n }\n\n @Override\n public String toString() {\n return \"VehicleEntity{\" +\n \"id=\" + id +\n \", name='\" + name + '\\'' +\n \", capacity=\" + capacity +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/VehicleRepositoryImpl.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.List;\nimport java.util.Optional;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.domain.VehicleData;\nimport org.optaweb.vehiclerouting.domain.VehicleFactory;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleRepository;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n@ApplicationScoped\npublic class VehicleRepositoryImpl implements VehicleRepository {\n\n private static final Logger logger = LoggerFactory.getLogger(VehicleRepositoryImpl.class);\n private final VehicleCrudRepository repository;\n\n @Inject\n public VehicleRepositoryImpl(VehicleCrudRepository repository) {\n this.repository = repository;\n }\n\n @Override\n public Vehicle createVehicle(int capacity) {\n VehicleEntity vehicleEntity = new VehicleEntity(0, null, capacity);\n repository.persist(vehicleEntity);\n vehicleEntity.setName(\"Vehicle \" + vehicleEntity.getId());\n Vehicle vehicle = toDomain(vehicleEntity);\n logger.info(\"Created vehicle {}.\", vehicle);\n return vehicle;\n }\n\n @Override\n public Vehicle createVehicle(VehicleData vehicleData) {\n VehicleEntity vehicleEntity = new VehicleEntity(0, vehicleData.name(), vehicleData.capacity());\n repository.persist(vehicleEntity);\n Vehicle vehicle = toDomain(vehicleEntity);\n logger.info(\"Created vehicle {}.\", vehicle);\n return vehicle;\n }\n\n @Override\n public List vehicles() {\n return repository.streamAll()\n .map(VehicleRepositoryImpl::toDomain)\n .collect(toList());\n }\n\n @Override\n public Vehicle removeVehicle(long id) {\n Optional optionalVehicleEntity = repository.findByIdOptional(id);\n VehicleEntity vehicleEntity = optionalVehicleEntity.orElseThrow(\n () -> new IllegalArgumentException(\"Vehicle{id=\" + id + \"} doesn't exist\"));\n repository.deleteById(id);\n Vehicle vehicle = toDomain(vehicleEntity);\n logger.info(\"Deleted vehicle {}.\", vehicle);\n return vehicle;\n }\n\n @Override\n public void removeAll() {\n repository.deleteAll();\n }\n\n @Override\n public Optional find(long vehicleId) {\n return repository.findByIdOptional(vehicleId).map(VehicleRepositoryImpl::toDomain);\n }\n\n @Override\n public Vehicle changeCapacity(long vehicleId, int capacity) {\n VehicleEntity vehicleEntity = repository.findByIdOptional(vehicleId).orElseThrow(() -> new IllegalArgumentException(\n \"Can't change Vehicle{id=\" + vehicleId + \"} because it doesn't exist\"));\n vehicleEntity.setCapacity(capacity);\n repository.flush();\n return VehicleFactory.createVehicle(vehicleEntity.getId(), vehicleEntity.getName(), vehicleEntity.getCapacity());\n }\n\n private static Vehicle toDomain(VehicleEntity vehicleEntity) {\n return VehicleFactory.createVehicle(\n vehicleEntity.getId(),\n vehicleEntity.getName(),\n vehicleEntity.getCapacity());\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/persistence/package-info.java",
"content": "/**\n * Persistence infrastructure.\n */\npackage org.optaweb.vehiclerouting.plugin.persistence;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/Constants.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\npublic class Constants {\n\n public static final String SOLVER_CONFIG = \"solverConfig.xml\";\n\n private Constants() {\n throw new AssertionError(\"Constants class\");\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/DistanceMapImpl.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.plugin.planner.domain.DistanceMap;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocation;\nimport org.optaweb.vehiclerouting.service.location.DistanceMatrixRow;\n\n/**\n * Provides distances to {@link PlanningLocation}s by reading from a {@link DistanceMatrixRow}.\n */\npublic class DistanceMapImpl implements DistanceMap {\n\n private final DistanceMatrixRow distanceMatrixRow;\n\n public DistanceMapImpl(DistanceMatrixRow distanceMatrixRow) {\n this.distanceMatrixRow = Objects.requireNonNull(distanceMatrixRow);\n }\n\n @Override\n public long distanceTo(PlanningLocation location) {\n return distanceMatrixRow.distanceTo(location.getId()).millis();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/RouteChangedEventPublisher.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Event;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.optaweb.vehiclerouting.service.route.RouteChangedEvent;\nimport org.optaweb.vehiclerouting.service.route.ShallowRoute;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n/**\n * Converts planning solution to a {@link RouteChangedEvent} and publishes it so that it can be processed by other\n * components that listen for this type of event.\n */\n@ApplicationScoped\nclass RouteChangedEventPublisher {\n\n private static final Logger logger = LoggerFactory.getLogger(RouteChangedEventPublisher.class);\n\n private final Event eventPublisher;\n\n @Inject\n RouteChangedEventPublisher(Event eventPublisher) {\n this.eventPublisher = eventPublisher;\n }\n\n /**\n * Publish solution as a {@link RouteChangedEvent}.\n *\n * @param solution solution\n */\n void publishSolution(VehicleRoutingSolution solution) {\n RouteChangedEvent event = solutionToEvent(solution, this);\n logger.info(\n \"New solution with {} depots, {} vehicles, {} visits, distance: {}, score: {}\",\n solution.getDepotList().size(),\n solution.getVehicleList().size(),\n solution.getVisitList().size(),\n event.distance(),\n solution.getScore());\n logger.debug(\"Routes: {}\", event.routes());\n eventPublisher.fire(event);\n }\n\n /**\n * Convert a planning domain solution to an event that can be published.\n *\n * @param solution solution\n * @param source source of the event\n * @return new event describing the solution\n */\n static RouteChangedEvent solutionToEvent(VehicleRoutingSolution solution, Object source) {\n List routes = routes(solution);\n return new RouteChangedEvent(\n source,\n // Turn negative soft score into a positive amount of time.\n Distance.ofMillis(-solution.getScore().softScore()),\n vehicleIds(solution),\n depotId(solution),\n visitIds(solution),\n routes);\n }\n\n private static List visitIds(VehicleRoutingSolution solution) {\n return solution.getVisitList().stream()\n .map(visit -> visit.getLocation().getId())\n .collect(toList());\n }\n\n /**\n * Extract routes from the solution. Includes empty routes of vehicles that stay in the depot.\n *\n * @param solution solution\n * @return one route per vehicle\n */\n private static List routes(VehicleRoutingSolution solution) {\n // TODO include unconnected customers in the result\n if (solution.getDepotList().isEmpty()) {\n return Collections.emptyList();\n }\n ArrayList routes = new ArrayList<>();\n for (PlanningVehicle vehicle : solution.getVehicleList()) {\n PlanningDepot depot = vehicle.getDepot();\n if (depot == null) {\n throw new IllegalArgumentException(\n \"Vehicle (id=\" + vehicle.getId() + \") is not in the depot. That's not allowed\");\n }\n List visits = new ArrayList<>();\n for (PlanningVisit visit : vehicle.getFutureVisits()) {\n if (!solution.getVisitList().contains(visit)) {\n throw new IllegalArgumentException(\"Visit (\" + visit + \") doesn't exist\");\n }\n visits.add(visit.getLocation().getId());\n }\n routes.add(new ShallowRoute(vehicle.getId(), depot.getId(), visits));\n }\n return routes;\n }\n\n /**\n * Get IDs of vehicles in the solution.\n *\n * @param solution the solution\n * @return vehicle IDs\n */\n private static List vehicleIds(VehicleRoutingSolution solution) {\n return solution.getVehicleList().stream()\n .map(PlanningVehicle::getId)\n .collect(toList());\n }\n\n /**\n * Get solution's depot ID.\n *\n * @param solution the solution in which to look for the depot\n * @return first depot ID from the solution or {@code null} if there are no depots\n */\n private static Long depotId(VehicleRoutingSolution solution) {\n return solution.getDepotList().isEmpty() ? null : solution.getDepotList().get(0).getId();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/RouteOptimizerConfig.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport java.util.concurrent.ExecutorService;\nimport java.util.concurrent.Executors;\n\nimport javax.enterprise.context.Dependent;\nimport javax.enterprise.inject.Produces;\n\nimport org.optaplanner.core.api.solver.Solver;\nimport org.optaplanner.core.api.solver.SolverFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\nimport com.google.common.util.concurrent.ListeningExecutorService;\nimport com.google.common.util.concurrent.MoreExecutors;\n\n/**\n * Configuration bean that creates {@link RouteOptimizerImpl route optimizer}'s dependencies.\n */\n@Dependent\nclass RouteOptimizerConfig {\n\n private final SolverFactory solverFactory;\n\n RouteOptimizerConfig(SolverFactory solverFactory) {\n this.solverFactory = solverFactory;\n }\n\n @Produces\n Solver solver() {\n return solverFactory.buildSolver();\n }\n\n @Produces\n ListeningExecutorService executor() {\n ExecutorService executorService = Executors.newFixedThreadPool(1);\n return MoreExecutors.listeningDecorator(executorService);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/RouteOptimizerImpl.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport java.util.ArrayList;\nimport java.util.List;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocation;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory;\nimport org.optaweb.vehiclerouting.service.location.DistanceMatrixRow;\nimport org.optaweb.vehiclerouting.service.location.LocationPlanner;\nimport org.optaweb.vehiclerouting.service.vehicle.VehiclePlanner;\n\n/**\n * Accumulates vehicles, depots and visits until there's enough data to start the optimization.\n * Solutions are published even if solving hasn't started yet due to missing facts (e.g. no vehicles or no visits).\n * Stops solver when vehicles or visits are reduced to zero.\n */\n@ApplicationScoped\nclass RouteOptimizerImpl implements LocationPlanner, VehiclePlanner {\n\n private final SolverManager solverManager;\n private final RouteChangedEventPublisher routeChangedEventPublisher;\n\n private final List vehicles = new ArrayList<>();\n private final List visits = new ArrayList<>();\n private PlanningDepot depot;\n\n @Inject\n RouteOptimizerImpl(SolverManager solverManager, RouteChangedEventPublisher routeChangedEventPublisher) {\n this.solverManager = solverManager;\n this.routeChangedEventPublisher = routeChangedEventPublisher;\n }\n\n @Override\n public void addLocation(Location domainLocation, DistanceMatrixRow distanceMatrixRow) {\n PlanningLocation location = PlanningLocationFactory.fromDomain(\n domainLocation,\n new DistanceMapImpl(distanceMatrixRow));\n // Unfortunately can't start solver with an empty solution (see https://issues.redhat.com/browse/PLANNER-776)\n if (depot == null) {\n depot = new PlanningDepot(location);\n publishSolution();\n } else {\n PlanningVisit visit = PlanningVisitFactory.fromLocation(location);\n visits.add(visit);\n if (vehicles.isEmpty()) {\n publishSolution();\n } else if (visits.size() == 1) {\n solverManager.startSolver(SolutionFactory.solutionFromVisits(vehicles, depot, visits));\n } else {\n solverManager.addVisit(visit);\n }\n }\n }\n\n @Override\n public void removeLocation(Location domainLocation) {\n if (visits.isEmpty()) {\n if (depot == null) {\n throw new IllegalArgumentException(\n \"Cannot remove \" + domainLocation + \" because there are no locations\");\n }\n if (depot.getId() != domainLocation.id()) {\n throw new IllegalArgumentException(\"Cannot remove \" + domainLocation + \" because it doesn't exist\");\n }\n depot = null;\n publishSolution();\n } else {\n if (depot.getId() == domainLocation.id()) {\n throw new IllegalStateException(\"You can only remove depot if there are no visits\");\n }\n if (!visits.removeIf(item -> item.getId() == domainLocation.id())) {\n throw new IllegalArgumentException(\"Cannot remove \" + domainLocation + \" because it doesn't exist\");\n }\n if (vehicles.isEmpty()) { // solver is not running\n publishSolution();\n } else if (visits.isEmpty()) { // solver is running\n solverManager.stopSolver();\n publishSolution();\n } else {\n // TODO maybe allow removing location by ID (only require the necessary information)\n solverManager.removeVisit(\n PlanningVisitFactory.fromLocation(PlanningLocationFactory.fromDomain(domainLocation)));\n }\n }\n }\n\n @Override\n public void addVehicle(Vehicle domainVehicle) {\n PlanningVehicle vehicle = PlanningVehicleFactory.fromDomain(domainVehicle);\n vehicle.setDepot(depot);\n vehicles.add(vehicle);\n if (visits.isEmpty()) {\n publishSolution();\n } else if (vehicles.size() == 1) {\n solverManager.startSolver(SolutionFactory.solutionFromVisits(vehicles, depot, visits));\n } else {\n solverManager.addVehicle(vehicle);\n }\n }\n\n @Override\n public void removeVehicle(Vehicle domainVehicle) {\n if (!vehicles.removeIf(vehicle -> vehicle.getId() == domainVehicle.id())) {\n throw new IllegalArgumentException(\"Cannot remove \" + domainVehicle + \" because it doesn't exist\");\n }\n if (visits.isEmpty()) { // solver is not running\n publishSolution();\n } else if (vehicles.isEmpty()) { // solver is running\n solverManager.stopSolver();\n publishSolution();\n } else {\n solverManager.removeVehicle(PlanningVehicleFactory.fromDomain(domainVehicle));\n }\n }\n\n @Override\n public void changeCapacity(Vehicle domainVehicle) {\n PlanningVehicle vehicle = vehicles.stream()\n .filter(item -> item.getId() == domainVehicle.id())\n .findFirst()\n .orElseThrow(() -> new IllegalArgumentException(\n \"Cannot change capacity of \" + domainVehicle + \" because it doesn't exist\"));\n vehicle.setCapacity(domainVehicle.capacity());\n if (!visits.isEmpty()) {\n solverManager.changeCapacity(vehicle);\n } else {\n publishSolution();\n }\n }\n\n @Override\n public void removeAllLocations() {\n solverManager.stopSolver();\n depot = null;\n visits.clear();\n publishSolution();\n }\n\n @Override\n public void removeAllVehicles() {\n solverManager.stopSolver();\n vehicles.clear();\n publishSolution();\n }\n\n private void publishSolution() {\n routeChangedEventPublisher.publishSolution(SolutionFactory.solutionFromVisits(vehicles, depot, visits));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/SolverManager.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport java.util.concurrent.Callable;\nimport java.util.concurrent.ExecutionException;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Event;\nimport javax.enterprise.inject.Default;\nimport javax.inject.Inject;\n\nimport org.optaplanner.core.api.solver.Solver;\nimport org.optaplanner.core.api.solver.event.BestSolutionChangedEvent;\nimport org.optaplanner.core.api.solver.event.SolverEventListener;\nimport org.optaweb.vehiclerouting.plugin.planner.change.AddVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.change.AddVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.change.ChangeVehicleCapacity;\nimport org.optaweb.vehiclerouting.plugin.planner.change.RemoveVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.change.RemoveVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.optaweb.vehiclerouting.service.error.ErrorEvent;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\nimport com.google.common.util.concurrent.ListenableFuture;\nimport com.google.common.util.concurrent.ListeningExecutorService;\nimport com.google.common.util.concurrent.MoreExecutors;\n\n/**\n * Manages a solver running in a different thread.\n * \n * Does following:\n *
\n * - Starts solver by running {@link Solver#solve(Object problem)} in a thread that's not the caller's thread.
\n * - Stops the solver (synchronously).
\n * - Adds problem fact changes to the solver.
\n * - Propagates any exception that happens in {@code Solver.solver()} (in a different thread) to the thread that\n * interacts with {@code SolverManager}.
\n * - Listens for best solution changes and publishes new best solutions via {@link RouteChangedEventPublisher}.
\n *
\n */\n@ApplicationScoped\n@Default\nclass SolverManager implements SolverEventListener {\n\n private static final Logger logger = LoggerFactory.getLogger(SolverManager.class);\n\n private final Solver solver;\n private final ListeningExecutorService executor;\n private final RouteChangedEventPublisher routeChangedEventPublisher;\n private final Event errorEvent;\n\n private ListenableFuture solverFuture;\n\n @Inject\n SolverManager(\n Solver solver,\n ListeningExecutorService executor,\n RouteChangedEventPublisher routeChangedEventPublisher,\n Event errorEvent) {\n this.solver = solver;\n this.executor = executor;\n this.routeChangedEventPublisher = routeChangedEventPublisher;\n this.errorEvent = errorEvent;\n this.solver.addEventListener(this);\n }\n\n @Override\n public void bestSolutionChanged(BestSolutionChangedEvent bestSolutionChangedEvent) {\n // CAUTION! This runs on the solver thread. Implications:\n // 1. The method should be as quick as possible to avoid blocking solver unnecessarily.\n // 2. This place is a potential source of race conditions.\n if (!bestSolutionChangedEvent.isEveryProblemChangeProcessed()) {\n logger.info(\"Ignoring a new best solution that has some problem facts missing\");\n return;\n }\n // TODO Race condition, if a servlet thread deletes that location in the middle of this method happening\n // on the solver thread. Make sure that location is still in the repository.\n // Maybe repair the solution OR ignore if it's inconsistent (log a WARNING).\n routeChangedEventPublisher.publishSolution(bestSolutionChangedEvent.getNewBestSolution()); // TODO @Async\n }\n\n void startSolver(VehicleRoutingSolution solution) {\n if (solverFuture != null) {\n throw new IllegalStateException(\"Solver start has already been requested\");\n }\n solverFuture = executor.submit((SolvingTask) () -> solver.solve(solution));\n solverFuture.addListener(\n // IMPORTANT: This is happening on the solver thread.\n // TODO maybe restart or somehow recover?\n () -> {\n if (!solver.isTerminateEarly()) {\n // Solver in daemon mode can't return from solve() unless it has been terminated early\n // (see #stopSolver()).\n // So this case is only possible when an exception is thrown during solver.solve().\n try {\n solverFuture.get();\n logger.error(\"The solver has stopped without being terminated early so at this point\"\n + \" it is expected to have crashed but there was no exception.\\n\"\n + \"If you see this other than during test execution it is probably a bug.\");\n errorEvent.fire(new ErrorEvent(\n this,\n \"Solver stopped without being terminated early and without throwing an exception.\"\n + \" This is a bug.\"));\n } catch (InterruptedException e) {\n Thread.currentThread().interrupt();\n throw new RuntimeException(\"Interrupted while retrieving the cause of solver failure\", e);\n } catch (ExecutionException e) {\n logger.error(\"Solver failed\", e);\n errorEvent.fire(new ErrorEvent(this, e.toString()));\n }\n }\n },\n MoreExecutors.directExecutor());\n }\n\n void stopSolver() {\n if (solverFuture != null) {\n // TODO what happens if solver hasn't started yet (solve() is called asynchronously)\n solver.terminateEarly();\n // make sure solver has terminated and propagate exceptions\n try {\n solverFuture.get();\n solverFuture = null;\n } catch (InterruptedException e) {\n Thread.currentThread().interrupt();\n throw new RuntimeException(\"Failed to stop solver\", e);\n } catch (ExecutionException e) {\n // Skipping the wrapper ExecutionException because it only tells that the problem occurred\n // in solverFuture.get() but that's obvious.\n throw new RuntimeException(\"Failed to stop solver\", e.getCause());\n }\n }\n }\n\n private void assertSolverIsAlive() {\n if (solverFuture == null) {\n throw new IllegalStateException(\"Solver has not started yet\");\n }\n if (solverFuture.isDone()) {\n try {\n solverFuture.get();\n } catch (InterruptedException e) {\n Thread.currentThread().interrupt();\n throw new RuntimeException(\"Solver has died\", e);\n } catch (ExecutionException e) {\n // Skipping the wrapper ExecutionException because it only tells that the problem occurred\n // in solverFuture.get() but that's obvious.\n throw new RuntimeException(\"Solver has died\", e.getCause());\n }\n throw new IllegalStateException(\"Solver has finished solving even though it operates in daemon mode\");\n }\n }\n\n void addVisit(PlanningVisit visit) {\n assertSolverIsAlive();\n solver.addProblemChange(new AddVisit(visit));\n }\n\n void removeVisit(PlanningVisit visit) {\n assertSolverIsAlive();\n solver.addProblemChange(new RemoveVisit(visit));\n }\n\n void addVehicle(PlanningVehicle vehicle) {\n assertSolverIsAlive();\n solver.addProblemChange(new AddVehicle(vehicle));\n }\n\n void removeVehicle(PlanningVehicle vehicle) {\n assertSolverIsAlive();\n solver.addProblemChange(new RemoveVehicle(vehicle));\n }\n\n void changeCapacity(PlanningVehicle vehicle) {\n assertSolverIsAlive();\n solver.addProblemChange(new ChangeVehicleCapacity(vehicle));\n }\n\n /**\n * An alias interface that fixates the Callable's type parameter. This avoids unchecked warnings in tests.\n */\n interface SolvingTask extends Callable {\n\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/VehicleRoutingConstraintProvider.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.optaplanner.core.api.score.stream.ConstraintCollectors.sum;\n\nimport org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore;\nimport org.optaplanner.core.api.score.stream.Constraint;\nimport org.optaplanner.core.api.score.stream.ConstraintFactory;\nimport org.optaplanner.core.api.score.stream.ConstraintProvider;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\n\npublic class VehicleRoutingConstraintProvider implements ConstraintProvider {\n\n @Override\n public Constraint[] defineConstraints(ConstraintFactory constraintFactory) {\n return new Constraint[] {\n vehicleCapacity(constraintFactory),\n distanceFromPreviousStandstill(constraintFactory),\n distanceFromLastVisitToDepot(constraintFactory)\n };\n }\n\n Constraint vehicleCapacity(ConstraintFactory constraintFactory) {\n return constraintFactory.forEach(PlanningVisit.class)\n .groupBy(PlanningVisit::getVehicle, sum(PlanningVisit::getDemand))\n .filter((vehicle, demand) -> demand > vehicle.getCapacity())\n .penalizeLong(HardSoftLongScore.ONE_HARD,\n (vehicle, demand) -> demand - vehicle.getCapacity())\n .asConstraint(\"vehicle capacity\");\n }\n\n Constraint distanceFromPreviousStandstill(ConstraintFactory constraintFactory) {\n return constraintFactory.forEach(PlanningVisit.class)\n .penalizeLong(HardSoftLongScore.ONE_SOFT,\n PlanningVisit::distanceFromPreviousStandstill)\n .asConstraint(\"distance from previous standstill\");\n }\n\n Constraint distanceFromLastVisitToDepot(ConstraintFactory constraintFactory) {\n return constraintFactory.forEach(PlanningVisit.class)\n .filter(PlanningVisit::isLast)\n .penalizeLong(HardSoftLongScore.ONE_SOFT,\n PlanningVisit::distanceToDepot)\n .asConstraint(\"distance from last visit to depot\");\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/change/AddVehicle.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.change;\n\nimport java.util.Objects;\n\nimport org.optaplanner.core.api.solver.change.ProblemChange;\nimport org.optaplanner.core.api.solver.change.ProblemChangeDirector;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\npublic class AddVehicle implements ProblemChange {\n\n private final PlanningVehicle vehicle;\n\n public AddVehicle(PlanningVehicle vehicle) {\n this.vehicle = Objects.requireNonNull(vehicle);\n }\n\n @Override\n public void doChange(VehicleRoutingSolution workingSolution, ProblemChangeDirector problemChangeDirector) {\n problemChangeDirector.addProblemFact(vehicle, workingSolution.getVehicleList()::add);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/change/AddVisit.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.change;\n\nimport java.util.Objects;\n\nimport org.optaplanner.core.api.solver.change.ProblemChange;\nimport org.optaplanner.core.api.solver.change.ProblemChangeDirector;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\npublic class AddVisit implements ProblemChange {\n\n private final PlanningVisit visit;\n\n public AddVisit(PlanningVisit visit) {\n this.visit = Objects.requireNonNull(visit);\n }\n\n @Override\n public void doChange(VehicleRoutingSolution workingSolution, ProblemChangeDirector problemChangeDirector) {\n problemChangeDirector.addEntity(visit, workingSolution.getVisitList()::add);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/change/ChangeVehicleCapacity.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.change;\n\nimport java.util.Objects;\n\nimport org.optaplanner.core.api.solver.change.ProblemChange;\nimport org.optaplanner.core.api.solver.change.ProblemChangeDirector;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\npublic class ChangeVehicleCapacity implements ProblemChange {\n\n private final PlanningVehicle vehicle;\n\n public ChangeVehicleCapacity(PlanningVehicle vehicle) {\n this.vehicle = Objects.requireNonNull(vehicle);\n }\n\n @Override\n public void doChange(VehicleRoutingSolution workingSolution, ProblemChangeDirector problemChangeDirector) {\n // No need to clone the workingVehicle because it is a planning entity, so it is already planning-cloned.\n // To learn more about problem fact changes, see:\n // https://www.optaplanner.org/docs/optaplanner/latest/repeated-planning/repeated-planning.html#problemChangeExample\n problemChangeDirector.changeProblemProperty(vehicle,\n workingVehicle -> workingVehicle.setCapacity(vehicle.getCapacity()));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/change/RemoveVehicle.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.change;\n\nimport java.util.Objects;\n\nimport org.optaplanner.core.api.solver.change.ProblemChange;\nimport org.optaplanner.core.api.solver.change.ProblemChangeDirector;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\npublic class RemoveVehicle implements ProblemChange {\n\n private final PlanningVehicle removedVehicle;\n\n public RemoveVehicle(PlanningVehicle removedVehicle) {\n this.removedVehicle = Objects.requireNonNull(removedVehicle);\n }\n\n @Override\n public void doChange(VehicleRoutingSolution workingSolution, ProblemChangeDirector problemChangeDirector) {\n // Look up a working copy of the vehicle\n PlanningVehicle workingVehicle = problemChangeDirector.lookUpWorkingObjectOrFail(removedVehicle);\n\n // Un-initialize all visits of this vehicle\n for (PlanningVisit visit : workingVehicle.getFutureVisits()) {\n problemChangeDirector.changeVariable(visit, \"previousStandstill\",\n planningVisit -> planningVisit.setPreviousStandstill(null));\n }\n\n // No need to clone the vehicleList because it is a planning entity collection, so it is already\n // planning-cloned.\n // To learn more about problem fact changes, see:\n // https://www.optaplanner.org/docs/optaplanner/latest/repeated-planning/repeated-planning.html#problemChangeExample\n\n // Remove the vehicle\n problemChangeDirector.removeProblemFact(workingVehicle, planningVehicle -> {\n if (!workingSolution.getVehicleList().remove(planningVehicle)) {\n throw new IllegalStateException(\n \"Working solution's vehicleList \"\n + workingSolution.getVehicleList()\n + \" doesn't contain the workingVehicle (\"\n + planningVehicle\n + \"). This is a bug!\");\n }\n });\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/change/RemoveVisit.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.change;\n\nimport java.util.Objects;\n\nimport org.optaplanner.core.api.solver.change.ProblemChange;\nimport org.optaplanner.core.api.solver.change.ProblemChangeDirector;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\npublic class RemoveVisit implements ProblemChange {\n\n private final PlanningVisit planningVisit;\n\n public RemoveVisit(PlanningVisit planningVisit) {\n this.planningVisit = Objects.requireNonNull(planningVisit);\n }\n\n @Override\n public void doChange(VehicleRoutingSolution workingSolution, ProblemChangeDirector problemChangeDirector) {\n // Look up a working copy of the visit\n PlanningVisit workingVisit = problemChangeDirector.lookUpWorkingObjectOrFail(planningVisit);\n\n // Fix the next visit and set its previousStandstill to the removed visit's previousStandstill\n PlanningVisit nextVisit = workingVisit.getNextVisit();\n if (nextVisit != null) { // otherwise it's the last visit\n problemChangeDirector.changeVariable(nextVisit, \"previousStandstill\",\n workingNextVisit -> workingNextVisit.setPreviousStandstill(workingVisit.getPreviousStandstill()));\n }\n\n // No need to clone the visitList because it is a planning entity collection, so it is already planning-cloned.\n // To learn more about problem fact changes, see:\n // https://www.optaplanner.org/docs/optaplanner/latest/repeated-planning/repeated-planning.html#problemChangeExample\n\n // Remove the visit\n problemChangeDirector.removeEntity(planningVisit, visit -> {\n if (!workingSolution.getVisitList().remove(visit)) {\n throw new IllegalStateException(\n \"Working solution's visitList \"\n + workingSolution.getVisitList()\n + \" doesn't contain the workingVisit (\"\n + visit\n + \"). This is a bug!\");\n }\n });\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/change/package-info.java",
"content": "/**\n * {@link org.optaplanner.core.api.solver.change.ProblemChange} implementations.\n * \n * Problem fact changes are difficult to write correctly. To understand the code and when implementing new fact changes,\n * read \n * ProblemChange documentation.\n */\npackage org.optaweb.vehiclerouting.plugin.planner.change;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/DistanceMap.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\n/**\n * Contains travel distances from a reference location to other locations.\n */\n@FunctionalInterface\npublic interface DistanceMap {\n\n /**\n * Get distance from a reference location to the given location. The actual physical quantity (distance or time)\n * and its units depend on the configuration of the routing engine and is not important for optimization.\n *\n * @param location location the distance of which will be returned\n * @return location's distance\n */\n long distanceTo(PlanningLocation location);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningDepot.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport java.util.Objects;\n\npublic class PlanningDepot {\n\n private final PlanningLocation location;\n\n public PlanningDepot(PlanningLocation location) {\n this.location = Objects.requireNonNull(location);\n }\n\n public long getId() {\n return location.getId();\n }\n\n public PlanningLocation getLocation() {\n return location;\n }\n\n @Override\n public String toString() {\n return \"PlanningDepot{\" +\n \"location=\" + location.getId() +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningLocation.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport java.util.Objects;\n\npublic class PlanningLocation {\n\n private final long id;\n // Only used to calculate angle.\n private final double latitude;\n private final double longitude;\n private final DistanceMap travelDistanceMap;\n\n PlanningLocation(long id, double latitude, double longitude, DistanceMap travelDistanceMap) {\n this.id = id;\n this.latitude = latitude;\n this.longitude = longitude;\n this.travelDistanceMap = Objects.requireNonNull(travelDistanceMap);\n }\n\n /**\n * ID of the corresponding domain location.\n *\n * @return domain location ID\n */\n public long getId() {\n return id;\n }\n\n /**\n * Distance to the given location.\n *\n * @param location other location\n * @return distance to the other location\n */\n public long distanceTo(PlanningLocation location) {\n if (this == location) {\n return 0L;\n }\n return travelDistanceMap.distanceTo(location);\n }\n\n /**\n * Angle between the given location and the direction EAST with {@code this} location being the vertex.\n *\n * @param location location that forms one side of the angle (not {@code null})\n * @return angle in radians in the range of -π to π\n */\n public double angleTo(PlanningLocation location) {\n // Euclidean distance (Pythagorean theorem) - not correct when the surface is a sphere\n double latitudeDifference = location.latitude - latitude;\n double longitudeDifference = location.longitude - longitude;\n return Math.atan2(latitudeDifference, longitudeDifference);\n }\n\n @Override\n public String toString() {\n return \"PlanningLocation{\" +\n \"latitude=\" + latitude +\n \",longitude=\" + longitude +\n \",travelDistanceMap=\" + travelDistanceMap +\n \",id=\" + id +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningLocationFactory.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport org.optaweb.vehiclerouting.domain.Location;\n\n/**\n * Creates {@link PlanningLocation}s.\n */\npublic class PlanningLocationFactory {\n\n private PlanningLocationFactory() {\n throw new AssertionError(\"Utility class\");\n }\n\n /**\n * Create planning location without a distance map. This location cannot be used for planning but can be used for\n * a problem fact change to remove a visit.\n *\n * @param location domain location\n * @return planning location without distance map\n */\n public static PlanningLocation fromDomain(Location location) {\n return fromDomain(location, PlanningLocationFactory::failFast);\n }\n\n /**\n * Create planning location from a domain location and a distance map.\n *\n * @param location domain location\n * @param distanceMap distance map of this planning location\n * @return planning location\n */\n public static PlanningLocation fromDomain(Location location, DistanceMap distanceMap) {\n return new PlanningLocation(\n location.id(),\n location.coordinates().latitude().doubleValue(),\n location.coordinates().longitude().doubleValue(),\n distanceMap);\n }\n\n /**\n * Create test location without distance map and coordinates. Coordinates will be initialized to zero.\n *\n * @param id location ID\n * @return planning location without distance map and coordinates\n */\n public static PlanningLocation testLocation(long id) {\n return testLocation(id, PlanningLocationFactory::failFast);\n }\n\n /**\n * Create test location with distance map and without coordinates. Coordinates will be initialized to zero.\n *\n * @param id location ID\n * @param distanceMap distance map\n * @return planning location with distance map and without coordinates\n */\n public static PlanningLocation testLocation(long id, DistanceMap distanceMap) {\n return new PlanningLocation(id, 0, 0, distanceMap);\n }\n\n private static long failFast(PlanningLocation location) {\n throw new IllegalStateException();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningVehicle.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport java.util.Iterator;\nimport java.util.NoSuchElementException;\n\nimport org.optaplanner.core.api.domain.lookup.PlanningId;\n\npublic class PlanningVehicle implements Standstill {\n\n @PlanningId\n private long id;\n private int capacity;\n private PlanningDepot depot;\n\n // Shadow variables\n private PlanningVisit nextVisit;\n\n PlanningVehicle() {\n // Hide public constructor in favor of the factory.\n }\n\n public long getId() {\n return id;\n }\n\n public void setId(long id) {\n this.id = id;\n }\n\n public int getCapacity() {\n return capacity;\n }\n\n public void setCapacity(int capacity) {\n this.capacity = capacity;\n }\n\n public PlanningDepot getDepot() {\n return depot;\n }\n\n public void setDepot(PlanningDepot depot) {\n this.depot = depot;\n }\n\n @Override\n public PlanningVisit getNextVisit() {\n return nextVisit;\n }\n\n @Override\n public void setNextVisit(PlanningVisit nextVisit) {\n this.nextVisit = nextVisit;\n }\n\n public Iterable getFutureVisits() {\n return () -> new Iterator() {\n PlanningVisit nextVisit = getNextVisit();\n\n @Override\n public boolean hasNext() {\n return nextVisit != null;\n }\n\n @Override\n public PlanningVisit next() {\n if (nextVisit == null) {\n throw new NoSuchElementException();\n }\n PlanningVisit out = nextVisit;\n nextVisit = nextVisit.getNextVisit();\n return out;\n }\n };\n }\n\n @Override\n public PlanningLocation getLocation() {\n return depot.getLocation();\n }\n\n @Override\n public String toString() {\n return \"PlanningVehicle{\" +\n \"capacity=\" + capacity +\n (depot == null ? \"\" : \",depot=\" + depot.getId()) +\n (nextVisit == null ? \"\" : \",nextVisit=\" + nextVisit.getId()) +\n \",id=\" + id +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningVehicleFactory.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport org.optaweb.vehiclerouting.domain.Vehicle;\n\n/**\n * Creates {@link PlanningVehicle} instances.\n */\npublic class PlanningVehicleFactory {\n\n private PlanningVehicleFactory() {\n throw new AssertionError(\"Utility class\");\n }\n\n /**\n * Create planning vehicle from domain vehicle.\n *\n * @param domainVehicle domain vehicle\n * @return planning vehicle\n */\n public static PlanningVehicle fromDomain(Vehicle domainVehicle) {\n return vehicle(domainVehicle.id(), domainVehicle.capacity());\n }\n\n /**\n * Create a testing vehicle with zero capacity.\n *\n * @param id vehicle's ID\n * @return new vehicle with zero capacity\n */\n public static PlanningVehicle testVehicle(long id) {\n return vehicle(id, 0);\n }\n\n /**\n * Create a testing vehicle with capacity.\n *\n * @param id vehicle's ID\n * @return new vehicle with the given capacity\n */\n public static PlanningVehicle testVehicle(long id, int capacity) {\n return vehicle(id, capacity);\n }\n\n private static PlanningVehicle vehicle(long id, int capacity) {\n PlanningVehicle vehicle = new PlanningVehicle();\n vehicle.setId(id);\n vehicle.setCapacity(capacity);\n return vehicle;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningVisit.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport org.optaplanner.core.api.domain.entity.PlanningEntity;\nimport org.optaplanner.core.api.domain.lookup.PlanningId;\nimport org.optaplanner.core.api.domain.variable.AnchorShadowVariable;\nimport org.optaplanner.core.api.domain.variable.PlanningVariable;\nimport org.optaplanner.core.api.domain.variable.PlanningVariableGraphType;\nimport org.optaweb.vehiclerouting.plugin.planner.weight.DepotAngleVisitDifficultyWeightFactory;\n\n@PlanningEntity(difficultyWeightFactoryClass = DepotAngleVisitDifficultyWeightFactory.class)\npublic class PlanningVisit implements Standstill {\n\n @PlanningId\n private long id;\n private PlanningLocation location;\n private int demand;\n\n // Planning variable: changes during planning, between score calculations.\n @PlanningVariable(valueRangeProviderRefs = { \"vehicleRange\", \"visitRange\" },\n graphType = PlanningVariableGraphType.CHAINED)\n private Standstill previousStandstill;\n\n // Shadow variables\n private PlanningVisit nextVisit;\n @AnchorShadowVariable(sourceVariableName = \"previousStandstill\")\n private PlanningVehicle vehicle;\n\n PlanningVisit() {\n // Hide public constructor in favor of the factory.\n }\n\n public long getId() {\n return id;\n }\n\n public void setId(long id) {\n this.id = id;\n }\n\n @Override\n public PlanningLocation getLocation() {\n return location;\n }\n\n public void setLocation(PlanningLocation location) {\n this.location = location;\n }\n\n public int getDemand() {\n return demand;\n }\n\n public void setDemand(int demand) {\n this.demand = demand;\n }\n\n public Standstill getPreviousStandstill() {\n return previousStandstill;\n }\n\n public void setPreviousStandstill(Standstill previousStandstill) {\n this.previousStandstill = previousStandstill;\n }\n\n @Override\n public PlanningVisit getNextVisit() {\n return nextVisit;\n }\n\n @Override\n public void setNextVisit(PlanningVisit nextVisit) {\n this.nextVisit = nextVisit;\n }\n\n public PlanningVehicle getVehicle() {\n return vehicle;\n }\n\n public void setVehicle(PlanningVehicle vehicle) {\n this.vehicle = vehicle;\n }\n\n // ************************************************************************\n // Complex methods\n // ************************************************************************\n\n /**\n * Distance from the previous standstill to this visit. This is used to calculate the travel cost of a chain\n * beginning with a vehicle (at a depot) and ending with the {@link #isLast() last} visit.\n * The chain ends with a visit, not a depot so the cost of returning from the last visit back to the depot\n * has to be added in a separate step using {@link #distanceToDepot()}.\n *\n * @return distance from previous standstill to this visit\n */\n public long distanceFromPreviousStandstill() {\n if (previousStandstill == null) {\n throw new IllegalStateException(\n \"This method must not be called when the previousStandstill (null) is not initialized yet.\");\n }\n return previousStandstill.getLocation().distanceTo(location);\n }\n\n /**\n * Distance from this visit back to the depot.\n *\n * @return distance from this visit back its vehicle's depot\n */\n public long distanceToDepot() {\n return location.distanceTo(vehicle.getLocation());\n }\n\n /**\n * Whether this visit is the last in a chain.\n *\n * @return true, if this visit has no {@link #getNextVisit() next} visit\n */\n public boolean isLast() {\n return nextVisit == null;\n }\n\n @Override\n public String toString() {\n return \"PlanningVisit{\" +\n (location == null ? \"\" : \"location=\" + location.getId()) +\n \",demand=\" + demand +\n (previousStandstill == null ? \"\" : \",previousStandstill='\" + previousStandstill.getLocation().getId()) +\n (nextVisit == null ? \"\" : \",nextVisit=\" + nextVisit.getId()) +\n (vehicle == null ? \"\" : \",vehicle=\" + vehicle.getId()) +\n \",id=\" + id +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/PlanningVisitFactory.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\n/**\n * Creates {@link PlanningVisit} instances.\n */\npublic class PlanningVisitFactory {\n\n static final int DEFAULT_VISIT_DEMAND = 1;\n\n private PlanningVisitFactory() {\n throw new AssertionError(\"Utility class\");\n }\n\n /**\n * Create visit with {@link #DEFAULT_VISIT_DEMAND}.\n *\n * @param location visit's location\n * @return new visit with the default demand\n */\n public static PlanningVisit fromLocation(PlanningLocation location) {\n return fromLocation(location, DEFAULT_VISIT_DEMAND);\n }\n\n /**\n * Create visit of a location with the given demand.\n *\n * @param location visit's location\n * @param demand visit's demand\n * @return visit with demand at the given location\n */\n public static PlanningVisit fromLocation(PlanningLocation location, int demand) {\n PlanningVisit visit = new PlanningVisit();\n visit.setId(location.getId());\n visit.setLocation(location);\n visit.setDemand(demand);\n return visit;\n }\n\n /**\n * Create a test visit with the given ID.\n *\n * @param id ID of the visit and its location\n * @return visit with an ID only\n */\n public static PlanningVisit testVisit(long id) {\n return fromLocation(PlanningLocationFactory.testLocation(id));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/SolutionFactory.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport java.util.ArrayList;\nimport java.util.List;\n\nimport org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore;\n\n/**\n * Creates {@link VehicleRoutingSolution} instances.\n */\npublic class SolutionFactory {\n\n private SolutionFactory() {\n throw new AssertionError(\"Utility class\");\n }\n\n /**\n * Create an empty solution. Empty solution has zero locations, depots, visits and vehicles and a zero score.\n *\n * @return empty solution\n */\n public static VehicleRoutingSolution emptySolution() {\n VehicleRoutingSolution solution = new VehicleRoutingSolution();\n solution.setVisitList(new ArrayList<>());\n solution.setDepotList(new ArrayList<>());\n solution.setVehicleList(new ArrayList<>());\n solution.setScore(HardSoftLongScore.ZERO);\n return solution;\n }\n\n /**\n * Create a new solution from given vehicles, depot and visits.\n * All vehicles will be placed in the depot.\n * \n * The returned solution's vehicles and locations are new collections so modifying the solution\n * won't affect the collections given as arguments.\n *
\n * Elements of the argument collections are NOT cloned.\n *\n * @param vehicles vehicles\n * @param depot depot\n * @param visits visits\n * @return solution containing the given vehicles, depot, visits and their locations\n */\n public static VehicleRoutingSolution solutionFromVisits(\n List vehicles,\n PlanningDepot depot,\n List visits) {\n VehicleRoutingSolution solution = new VehicleRoutingSolution();\n solution.setVehicleList(new ArrayList<>(vehicles));\n solution.setDepotList(new ArrayList<>(1));\n if (depot != null) {\n solution.getDepotList().add(depot);\n moveAllVehiclesToDepot(vehicles, depot);\n }\n solution.setVisitList(new ArrayList<>(visits));\n solution.setScore(HardSoftLongScore.ZERO);\n return solution;\n }\n\n private static void moveAllVehiclesToDepot(List vehicles, PlanningDepot depot) {\n vehicles.forEach(vehicle -> vehicle.setDepot(depot));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/Standstill.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport org.optaplanner.core.api.domain.entity.PlanningEntity;\nimport org.optaplanner.core.api.domain.variable.InverseRelationShadowVariable;\n\n@PlanningEntity\npublic interface Standstill {\n\n /**\n * The standstill's location.\n *\n * @return never {@code null}\n */\n PlanningLocation getLocation();\n\n /**\n * The next visit after this standstill.\n *\n * @return sometimes {@code null}\n */\n @InverseRelationShadowVariable(sourceVariableName = \"previousStandstill\")\n PlanningVisit getNextVisit();\n\n void setNextVisit(PlanningVisit nextVisit);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/VehicleRoutingSolution.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.domain;\n\nimport java.util.List;\n\nimport org.optaplanner.core.api.domain.solution.PlanningEntityCollectionProperty;\nimport org.optaplanner.core.api.domain.solution.PlanningScore;\nimport org.optaplanner.core.api.domain.solution.PlanningSolution;\nimport org.optaplanner.core.api.domain.solution.ProblemFactCollectionProperty;\nimport org.optaplanner.core.api.domain.valuerange.ValueRangeProvider;\nimport org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore;\n\n@PlanningSolution\npublic class VehicleRoutingSolution {\n\n @ProblemFactCollectionProperty\n private List depotList;\n @PlanningEntityCollectionProperty\n @ValueRangeProvider(id = \"vehicleRange\")\n private List vehicleList;\n @PlanningEntityCollectionProperty\n @ValueRangeProvider(id = \"visitRange\")\n private List visitList;\n @PlanningScore\n private HardSoftLongScore score;\n\n VehicleRoutingSolution() {\n // Hide public constructor in favor of the factory.\n }\n\n public List getDepotList() {\n return this.depotList;\n }\n\n public void setDepotList(List depotList) {\n this.depotList = depotList;\n }\n\n public List getVehicleList() {\n return this.vehicleList;\n }\n\n public void setVehicleList(List vehicleList) {\n this.vehicleList = vehicleList;\n }\n\n public List getVisitList() {\n return this.visitList;\n }\n\n public void setVisitList(List visitList) {\n this.visitList = visitList;\n }\n\n public HardSoftLongScore getScore() {\n return this.score;\n }\n\n public void setScore(HardSoftLongScore score) {\n this.score = score;\n }\n\n @Override\n public String toString() {\n return \"VehicleRoutingSolution{\" +\n \"depotList=\" + depotList +\n \", vehicleList=\" + vehicleList +\n \", visitList=\" + visitList +\n \", score=\" + score +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/domain/package-info.java",
"content": "/**\n * Domain model adjusted for OptaPlanner.\n */\npackage org.optaweb.vehiclerouting.plugin.planner.domain;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/package-info.java",
"content": "/**\n * Route optimization.\n */\npackage org.optaweb.vehiclerouting.plugin.planner;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/weight/DepotAngleVisitDifficultyWeightFactory.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.weight;\n\nimport static java.util.Comparator.comparingDouble;\nimport static java.util.Comparator.comparingLong;\n\nimport java.util.Comparator;\nimport java.util.Objects;\n\nimport org.optaplanner.core.impl.heuristic.selector.common.decorator.SelectionSorterWeightFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocation;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\n/**\n * On large data sets, the constructed solution looks like pizza slices.\n * The order of the slices depends on the {@link PlanningLocation#angleTo} implementation.\n */\npublic class DepotAngleVisitDifficultyWeightFactory\n implements SelectionSorterWeightFactory {\n\n @Override\n public DepotAngleVisitDifficultyWeight createSorterWeight(VehicleRoutingSolution solution, PlanningVisit visit) {\n PlanningDepot depot = solution.getDepotList().get(0);\n return new DepotAngleVisitDifficultyWeight(\n visit,\n // angle of the line from visit to depot relative to visit→east\n visit.getLocation().angleTo(depot.getLocation()),\n visit.getLocation().distanceTo(depot.getLocation())\n + depot.getLocation().distanceTo(visit.getLocation()));\n }\n\n static class DepotAngleVisitDifficultyWeight implements Comparable {\n\n private static final Comparator COMPARATOR =\n comparingDouble((DepotAngleVisitDifficultyWeight weight) -> weight.depotAngle)\n // Ascending (further from the depot are more difficult)\n .thenComparingLong(weight -> weight.depotRoundTripDistance)\n .thenComparing(weight -> weight.visit, comparingLong(PlanningVisit::getId));\n\n private final PlanningVisit visit;\n private final double depotAngle;\n private final long depotRoundTripDistance;\n\n DepotAngleVisitDifficultyWeight(PlanningVisit visit, double depotAngle, long depotRoundTripDistance) {\n this.visit = visit;\n this.depotAngle = depotAngle;\n this.depotRoundTripDistance = depotRoundTripDistance;\n }\n\n @Override\n public int compareTo(DepotAngleVisitDifficultyWeight other) {\n return COMPARATOR.compare(this, other);\n }\n\n @Override\n public boolean equals(Object o) {\n if (!(o instanceof DepotAngleVisitDifficultyWeight)) {\n return false;\n }\n return compareTo((DepotAngleVisitDifficultyWeight) o) == 0;\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(visit, depotAngle, depotRoundTripDistance);\n }\n\n @Override\n public String toString() {\n return \"DepotAngleVisitDifficultyWeight{\" +\n \"visit=\" + visit +\n \", depotAngle=\" + depotAngle +\n \", depotRoundTripDistance=\" + depotRoundTripDistance +\n '}';\n }\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/planner/weight/package-info.java",
"content": "/**\n * Implements\n * \n * planning entity difficulty comparison\n * \n * or\n * \n * planning variable strength comparison\n * \n * to enable advanced\n * \n * Construction Heuristic\n * \n * algorithms or\n * \n * sorted selection\n * .\n */\npackage org.optaweb.vehiclerouting.plugin.planner.weight;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/ClearResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport javax.inject.Inject;\nimport javax.ws.rs.POST;\nimport javax.ws.rs.Path;\n\nimport org.optaweb.vehiclerouting.service.location.LocationService;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleService;\n\n@Path(\"api/clear\")\npublic class ClearResource {\n\n private final LocationService locationService;\n private final VehicleService vehicleService;\n\n @Inject\n public ClearResource(LocationService locationService, VehicleService vehicleService) {\n this.locationService = locationService;\n this.vehicleService = vehicleService;\n }\n\n @POST\n public void clear() {\n // TODO do this in one step (=> new RoutingPlanService)\n vehicleService.removeAll();\n locationService.removeAll();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/DataSetDownloadResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport java.io.ByteArrayInputStream;\nimport java.io.IOException;\nimport java.io.InputStream;\nimport java.nio.charset.StandardCharsets;\n\nimport javax.ws.rs.GET;\nimport javax.ws.rs.Path;\nimport javax.ws.rs.Produces;\nimport javax.ws.rs.core.HttpHeaders;\nimport javax.ws.rs.core.MediaType;\nimport javax.ws.rs.core.Response;\n\nimport org.optaweb.vehiclerouting.service.demo.DemoService;\n\n/**\n * Serves the current data set as a downloadable YAML file.\n */\n@Path(\"api/dataset/export\")\n@Produces(\"text/x-yaml\")\npublic class DataSetDownloadResource {\n\n private final DemoService demoService;\n\n DataSetDownloadResource(DemoService demoService) {\n this.demoService = demoService;\n }\n\n @GET\n public Response exportDataSet() throws IOException {\n String dataSet = demoService.exportDataSet();\n byte[] dataSetBytes = dataSet.getBytes(StandardCharsets.UTF_8);\n try (InputStream is = new ByteArrayInputStream(dataSetBytes)) {\n return Response.ok()\n .header(HttpHeaders.CONTENT_DISPOSITION, \"attachment; filename=\\\"vrp_data_set.yaml\\\"\")\n .header(HttpHeaders.CONTENT_LENGTH, dataSetBytes.length)\n .type(new MediaType(\"text\", \"x-yaml\", StandardCharsets.UTF_8.name()))\n .entity(is)\n .build();\n }\n }\n\n // TODO exception handler\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/DemoResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport javax.inject.Inject;\nimport javax.ws.rs.POST;\nimport javax.ws.rs.Path;\nimport javax.ws.rs.PathParam;\n\nimport org.optaweb.vehiclerouting.service.demo.DemoService;\n\n@Path(\"api/demo/{name}\")\npublic class DemoResource {\n\n private final DemoService demoService;\n\n @Inject\n public DemoResource(DemoService demoService) {\n this.demoService = demoService;\n }\n\n /**\n * Load a demo data set.\n *\n * @param name data set name\n */\n @POST\n public void loadDemo(@PathParam(\"name\") String name) {\n demoService.loadDemo(name);\n }\n\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/LocationResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport javax.inject.Inject;\nimport javax.transaction.Transactional;\nimport javax.ws.rs.DELETE;\nimport javax.ws.rs.POST;\nimport javax.ws.rs.Path;\nimport javax.ws.rs.PathParam;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.plugin.rest.model.PortableLocation;\nimport org.optaweb.vehiclerouting.service.location.LocationService;\n\n@Path(\"api/location\")\npublic class LocationResource {\n\n private final LocationService locationService;\n\n @Inject\n public LocationResource(LocationService locationService) {\n this.locationService = locationService;\n }\n\n /**\n * Create new location.\n *\n * @param request new location description\n */\n @Transactional\n @POST\n public void addLocation(PortableLocation request) {\n locationService.createLocation(\n new Coordinates(request.getLatitude(), request.getLongitude()),\n request.getDescription());\n }\n\n /**\n * Delete location.\n *\n * @param id ID of the location to be deleted\n */\n @Transactional\n @DELETE\n @Path(\"{id}\")\n public void deleteLocation(@PathParam(\"id\") long id) {\n locationService.removeLocation(id);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/RouteEventResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport javax.annotation.PreDestroy;\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Observes;\nimport javax.inject.Inject;\nimport javax.ws.rs.GET;\nimport javax.ws.rs.Path;\nimport javax.ws.rs.Produces;\nimport javax.ws.rs.core.Context;\nimport javax.ws.rs.core.MediaType;\nimport javax.ws.rs.sse.OutboundSseEvent;\nimport javax.ws.rs.sse.Sse;\nimport javax.ws.rs.sse.SseBroadcaster;\nimport javax.ws.rs.sse.SseEventSink;\n\nimport org.optaweb.vehiclerouting.domain.RoutingPlan;\nimport org.optaweb.vehiclerouting.plugin.rest.model.PortableErrorMessage;\nimport org.optaweb.vehiclerouting.plugin.rest.model.PortableRoutingPlanFactory;\nimport org.optaweb.vehiclerouting.service.error.ErrorMessage;\nimport org.optaweb.vehiclerouting.service.route.RouteListener;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n@ApplicationScoped\n@Path(\"api/events\")\npublic class RouteEventResource {\n\n private static final Logger logger = LoggerFactory.getLogger(RouteEventResource.class);\n\n // TODO repository, not listener (service)\n private final RouteListener routeListener;\n\n private SseBroadcaster sseBroadcaster;\n private OutboundSseEvent.Builder eventBuilder;\n\n @Inject\n public RouteEventResource(RouteListener routeListener) {\n this.routeListener = routeListener;\n }\n\n // Handy during development.\n @PreDestroy\n public void closeBroadcaster() {\n if (sseBroadcaster != null) {\n logger.debug(\"Closing Server-Sent Events broadcaster.\");\n sseBroadcaster.close();\n }\n }\n\n public void observeRoute(@Observes RoutingPlan event) {\n if (sseBroadcaster != null) {\n sseBroadcaster.broadcast(eventBuilder\n .data(PortableRoutingPlanFactory.fromRoutingPlan(event))\n .name(\"route\")\n .comment(\"route update\")\n .build());\n }\n }\n\n public void observeError(@Observes ErrorMessage event) {\n if (sseBroadcaster != null) {\n sseBroadcaster.broadcast(eventBuilder\n .data(PortableErrorMessage.fromMessage(event))\n .name(\"errorMessage\")\n .comment(\"error message\")\n .build());\n }\n }\n\n @GET\n @Produces(MediaType.SERVER_SENT_EVENTS)\n public void sse(@Context Sse sse, @Context SseEventSink eventSink) {\n if (sseBroadcaster == null) {\n sseBroadcaster = sse.newBroadcaster();\n eventBuilder = sse.newEventBuilder()\n .mediaType(MediaType.APPLICATION_JSON_TYPE)\n .reconnectDelay(3000);\n }\n OutboundSseEvent sseEvent = eventBuilder\n .data(PortableRoutingPlanFactory.fromRoutingPlan(routeListener.getBestRoutingPlan()))\n .comment(\"best route\")\n .build();\n eventSink.send(sseEvent);\n sseBroadcaster.register(eventSink);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/ServerInfoResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.Arrays;\nimport java.util.List;\n\nimport javax.inject.Inject;\nimport javax.ws.rs.GET;\nimport javax.ws.rs.Path;\nimport javax.ws.rs.Produces;\nimport javax.ws.rs.core.MediaType;\n\nimport org.optaweb.vehiclerouting.plugin.rest.model.PortableCoordinates;\nimport org.optaweb.vehiclerouting.plugin.rest.model.RoutingProblemInfo;\nimport org.optaweb.vehiclerouting.plugin.rest.model.ServerInfo;\nimport org.optaweb.vehiclerouting.service.demo.DemoService;\nimport org.optaweb.vehiclerouting.service.region.BoundingBox;\nimport org.optaweb.vehiclerouting.service.region.RegionService;\n\n@Path(\"api/serverInfo\")\npublic class ServerInfoResource {\n\n private final DemoService demoService;\n private final RegionService regionService;\n\n @Inject\n public ServerInfoResource(DemoService demoService, RegionService regionService) {\n this.demoService = demoService;\n this.regionService = regionService;\n }\n\n @GET\n @Produces(MediaType.APPLICATION_JSON)\n public ServerInfo serverInfo() {\n BoundingBox boundingBox = regionService.boundingBox();\n List portableBoundingBox = Arrays.asList(\n PortableCoordinates.fromCoordinates(boundingBox.getSouthWest()),\n PortableCoordinates.fromCoordinates(boundingBox.getNorthEast()));\n List demos = demoService.demos().stream()\n .map(routingProblem -> new RoutingProblemInfo(\n routingProblem.name(),\n routingProblem.visits().size()))\n .collect(toList());\n return new ServerInfo(portableBoundingBox, regionService.countryCodes(), demos);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/VehicleResource.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest;\n\nimport javax.inject.Inject;\nimport javax.ws.rs.DELETE;\nimport javax.ws.rs.POST;\nimport javax.ws.rs.Path;\nimport javax.ws.rs.PathParam;\n\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleService;\n\n@Path(\"api/vehicle\")\npublic class VehicleResource {\n\n private final VehicleService vehicleService;\n\n @Inject\n public VehicleResource(VehicleService vehicleService) {\n this.vehicleService = vehicleService;\n }\n\n @POST\n public void addVehicle() {\n vehicleService.createVehicle();\n }\n\n /**\n * Delete vehicle.\n *\n * @param id ID of the vehicle to be deleted\n */\n @DELETE\n @Path(\"{id}\")\n public void removeVehicle(@PathParam(\"id\") long id) {\n vehicleService.removeVehicle(id);\n }\n\n @POST\n @Path(\"deleteAny\")\n public void removeAnyVehicle() {\n vehicleService.removeAnyVehicle();\n }\n\n @POST\n @Path(\"{id}/capacity\")\n public void changeCapacity(@PathParam(\"id\") long id, int capacity) {\n vehicleService.changeCapacity(id, capacity);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableCoordinates.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.math.BigDecimal;\nimport java.math.RoundingMode;\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\n\nimport com.fasterxml.jackson.annotation.JsonProperty;\n\n/**\n * {@link Coordinates} representation optimized for network transport.\n */\npublic class PortableCoordinates {\n\n /*\n * Five decimal places gives \"metric\" precision (±55 cm on equator). That's enough for visualising the track.\n * https://wiki.openstreetmap.org/wiki/Node#Structure\n */\n private static final int LATLNG_SCALE = 5;\n\n @JsonProperty(value = \"lat\")\n private final BigDecimal latitude;\n @JsonProperty(value = \"lng\")\n private final BigDecimal longitude;\n\n public static PortableCoordinates fromCoordinates(Coordinates coordinates) {\n Objects.requireNonNull(coordinates, \"coordinates must not be null\");\n return new PortableCoordinates(\n coordinates.latitude(),\n coordinates.longitude());\n }\n\n private static BigDecimal scale(BigDecimal number) {\n return number.setScale(Math.min(number.scale(), LATLNG_SCALE), RoundingMode.HALF_EVEN).stripTrailingZeros();\n }\n\n PortableCoordinates(BigDecimal latitude, BigDecimal longitude) {\n this.latitude = scale(latitude);\n this.longitude = scale(longitude);\n }\n\n public BigDecimal getLatitude() {\n return latitude;\n }\n\n public BigDecimal getLongitude() {\n return longitude;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n PortableCoordinates that = (PortableCoordinates) o;\n return Objects.equals(latitude, that.latitude) &&\n Objects.equals(longitude, that.longitude);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(latitude, longitude);\n }\n\n @Override\n public String toString() {\n return \"PortableCoordinates{\" +\n \"latitude=\" + latitude +\n \", longitude=\" + longitude +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableDistance.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\n\nimport com.fasterxml.jackson.annotation.JsonValue;\n\n/**\n * Portable representation of a {@link Distance distance}.\n */\npublic class PortableDistance {\n\n @JsonValue\n private final String distance;\n\n static PortableDistance fromDistance(Distance distance) {\n long seconds = (Objects.requireNonNull(distance).millis() + 500) / 1000;\n return new PortableDistance(String.format(\"%dh %dm %ds\", seconds / 3600, seconds / 60 % 60, seconds % 60));\n }\n\n private PortableDistance(String distance) {\n this.distance = distance;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n PortableDistance that = (PortableDistance) o;\n return distance.equals(that.distance);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(distance);\n }\n\n @Override\n public String toString() {\n return \"PortableDistance{\" +\n \"distance='\" + distance + '\\'' +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableErrorMessage.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.service.error.ErrorMessage;\n\n/**\n * Portable error message.\n */\npublic class PortableErrorMessage {\n\n private final String id;\n private final String text;\n\n public static PortableErrorMessage fromMessage(ErrorMessage message) {\n return new PortableErrorMessage(message.id, message.text);\n }\n\n PortableErrorMessage(String id, String text) {\n this.id = id;\n this.text = text;\n }\n\n public String getId() {\n return id;\n }\n\n public String getText() {\n return text;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n PortableErrorMessage that = (PortableErrorMessage) o;\n return id.equals(that.id) &&\n text.equals(that.text);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(id, text);\n }\n\n @Override\n public String toString() {\n return \"PortableErrorMessage{\" +\n \"id='\" + id + '\\'' +\n \", text='\" + text + '\\'' +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableLocation.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.math.BigDecimal;\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.Location;\n\nimport com.fasterxml.jackson.annotation.JsonCreator;\nimport com.fasterxml.jackson.annotation.JsonProperty;\n\n/**\n * {@link Location} representation convenient for marshalling.\n */\npublic class PortableLocation {\n\n private final long id;\n\n @JsonProperty(value = \"lat\", required = true)\n private final BigDecimal latitude;\n @JsonProperty(value = \"lng\", required = true)\n private final BigDecimal longitude;\n\n private final String description;\n\n static PortableLocation fromLocation(Location location) {\n Objects.requireNonNull(location, \"location must not be null\");\n return new PortableLocation(\n location.id(),\n location.coordinates().latitude(),\n location.coordinates().longitude(),\n location.description());\n }\n\n @JsonCreator\n public PortableLocation(\n @JsonProperty(value = \"id\") long id,\n @JsonProperty(value = \"lat\") BigDecimal latitude,\n @JsonProperty(value = \"lng\") BigDecimal longitude,\n @JsonProperty(value = \"description\") String description) {\n this.id = id;\n this.latitude = Objects.requireNonNull(latitude);\n this.longitude = Objects.requireNonNull(longitude);\n this.description = Objects.requireNonNull(description);\n }\n\n public long getId() {\n return id;\n }\n\n public BigDecimal getLatitude() {\n return latitude;\n }\n\n public BigDecimal getLongitude() {\n return longitude;\n }\n\n public String getDescription() {\n return description;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n PortableLocation that = (PortableLocation) o;\n return id == that.id &&\n description.equals(that.description) &&\n latitude.compareTo(that.latitude) == 0 &&\n longitude.compareTo(that.longitude) == 0;\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(id, description, latitude, longitude);\n }\n\n @Override\n public String toString() {\n return \"PortableLocation{\" +\n \"id=\" + id +\n \", description='\" + description + '\\'' +\n \", latitude=\" + latitude +\n \", longitude=\" + longitude +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableRoute.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.List;\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.Route;\n\nimport com.fasterxml.jackson.annotation.JsonFormat;\n\n/**\n * Vehicle {@link Route route} representation convenient for marshalling.\n */\nclass PortableRoute {\n\n private final PortableVehicle vehicle;\n private final PortableLocation depot;\n private final List visits;\n @JsonFormat(shape = JsonFormat.Shape.ARRAY)\n private final List> track;\n\n PortableRoute(\n PortableVehicle vehicle,\n PortableLocation depot,\n List visits,\n List> track) {\n this.vehicle = Objects.requireNonNull(vehicle);\n this.depot = Objects.requireNonNull(depot);\n this.visits = Objects.requireNonNull(visits);\n this.track = Objects.requireNonNull(track);\n }\n\n public PortableVehicle getVehicle() {\n return vehicle;\n }\n\n public PortableLocation getDepot() {\n return depot;\n }\n\n public List getVisits() {\n return visits;\n }\n\n public List> getTrack() {\n return track;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableRoutingPlan.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.List;\n\nimport org.optaweb.vehiclerouting.domain.RoutingPlan;\n\n/**\n * {@link RoutingPlan} representation convenient for marshalling.\n */\npublic class PortableRoutingPlan {\n\n private final PortableDistance distance;\n private final List vehicles;\n private final PortableLocation depot;\n private final List visits;\n private final List routes;\n\n PortableRoutingPlan(\n PortableDistance distance,\n List vehicles,\n PortableLocation depot,\n List visits,\n List routes) {\n // TODO require non-null\n this.distance = distance;\n this.vehicles = vehicles;\n this.depot = depot;\n this.visits = visits;\n this.routes = routes;\n }\n\n public PortableDistance getDistance() {\n return distance;\n }\n\n public List getVehicles() {\n return vehicles;\n }\n\n public PortableLocation getDepot() {\n return depot;\n }\n\n public List getVisits() {\n return visits;\n }\n\n public List getRoutes() {\n return routes;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableRoutingPlanFactory.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.ArrayList;\nimport java.util.List;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.domain.RoutingPlan;\nimport org.optaweb.vehiclerouting.domain.Vehicle;\n\n/**\n * Creates instances of {@link PortableRoutingPlan}.\n */\npublic class PortableRoutingPlanFactory {\n\n private PortableRoutingPlanFactory() {\n throw new AssertionError(\"Utility class\");\n }\n\n public static PortableRoutingPlan fromRoutingPlan(RoutingPlan routingPlan) {\n PortableDistance distance = PortableDistance.fromDistance(routingPlan.distance());\n List vehicles = portableVehicles(routingPlan.vehicles());\n PortableLocation depot = routingPlan.depot().map(PortableLocation::fromLocation).orElse(null);\n List visits = portableVisits(routingPlan.visits());\n List routes = routingPlan.routes().stream()\n .map(routeWithTrack -> new PortableRoute(\n PortableVehicle.fromVehicle(routeWithTrack.vehicle()),\n depot,\n portableVisits(routeWithTrack.visits()),\n portableTrack(routeWithTrack.track())))\n .collect(toList());\n return new PortableRoutingPlan(distance, vehicles, depot, visits, routes);\n }\n\n private static List> portableTrack(List> track) {\n ArrayList> portableTrack = new ArrayList<>();\n for (List segment : track) {\n List portableSegment = segment.stream()\n .map(PortableCoordinates::fromCoordinates)\n .collect(toList());\n portableTrack.add(portableSegment);\n }\n return portableTrack;\n }\n\n private static List portableVisits(List visits) {\n return visits.stream()\n .map(PortableLocation::fromLocation)\n .collect(toList());\n }\n\n private static List portableVehicles(List vehicles) {\n return vehicles.stream()\n .map(PortableVehicle::fromVehicle)\n .collect(toList());\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/PortableVehicle.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.Vehicle;\n\n/**\n * {@link Vehicle} representation suitable for network transport.\n */\npublic class PortableVehicle {\n\n private final long id;\n private final String name;\n private final int capacity;\n\n static PortableVehicle fromVehicle(Vehicle vehicle) {\n Objects.requireNonNull(vehicle, \"vehicle must not be null\");\n return new PortableVehicle(vehicle.id(), vehicle.name(), vehicle.capacity());\n }\n\n PortableVehicle(long id, String name, int capacity) {\n this.id = id;\n this.name = Objects.requireNonNull(name);\n this.capacity = capacity;\n }\n\n public long getId() {\n return id;\n }\n\n public String getName() {\n return name;\n }\n\n public int getCapacity() {\n return capacity;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) {\n return true;\n }\n if (o == null || getClass() != o.getClass()) {\n return false;\n }\n PortableVehicle vehicle = (PortableVehicle) o;\n return id == vehicle.id &&\n capacity == vehicle.capacity &&\n name.equals(vehicle.name);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(id, name, capacity);\n }\n\n @Override\n public String toString() {\n return \"PortableVehicle{\" +\n \"id=\" + id +\n \", name='\" + name + '\\'' +\n \", capacity=\" + capacity +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/RoutingProblemInfo.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.RoutingProblem;\n\n/**\n * Information about a {@link RoutingProblem routing problem instance}.\n */\npublic class RoutingProblemInfo {\n\n private final String name;\n private final int visits;\n\n public RoutingProblemInfo(String name, int visits) {\n this.name = Objects.requireNonNull(name);\n this.visits = visits;\n }\n\n /**\n * Routing problem instance name.\n *\n * @return name\n */\n public String getName() {\n return name;\n }\n\n /**\n * Number of visits in the routing problem instance.\n *\n * @return number of visits\n */\n public int getVisits() {\n return visits;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/rest/model/ServerInfo.java",
"content": "package org.optaweb.vehiclerouting.plugin.rest.model;\n\nimport java.util.List;\n\n/**\n * Server info suitable for network transport.\n */\npublic class ServerInfo {\n\n private final List boundingBox;\n private final List countryCodes;\n private final List demos;\n\n public ServerInfo(List boundingBox, List countryCodes, List demos) {\n this.boundingBox = boundingBox;\n this.countryCodes = countryCodes;\n this.demos = demos;\n }\n\n public List getBoundingBox() {\n return boundingBox;\n }\n\n public List getCountryCodes() {\n return countryCodes;\n }\n\n public List getDemos() {\n return demos;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/AirDistanceRouter.java",
"content": "package org.optaweb.vehiclerouting.plugin.routing;\n\nimport java.math.BigDecimal;\nimport java.util.Arrays;\nimport java.util.List;\nimport java.util.concurrent.TimeUnit;\n\nimport javax.enterprise.context.ApplicationScoped;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.service.distance.DistanceCalculator;\nimport org.optaweb.vehiclerouting.service.region.BoundingBox;\nimport org.optaweb.vehiclerouting.service.region.Region;\nimport org.optaweb.vehiclerouting.service.route.Router;\n\nimport io.quarkus.arc.properties.IfBuildProperty;\n\n@ApplicationScoped\n@IfBuildProperty(name = \"app.routing.engine\", stringValue = \"AIR\")\npublic class AirDistanceRouter implements Router, DistanceCalculator, Region {\n\n protected static final int TRAVEL_SPEED_KPH = 60;\n // Approximate Metric Equivalents for Degrees. At the equator for longitude and for latitude anywhere,\n // the following approximations are valid: 1° = 111 km (or 60 nautical miles) 0.1° = 11.1 km.\n protected static final double KILOMETERS_PER_DEGREE = 111;\n protected static final long MILLIS_IN_ONE_HOUR = TimeUnit.MILLISECONDS.convert(1, TimeUnit.HOURS);\n\n @Override\n public long travelTimeMillis(Coordinates from, Coordinates to) {\n BigDecimal latDiff = to.latitude().subtract(from.latitude());\n BigDecimal lngDiff = to.longitude().subtract(from.longitude());\n double distanceKilometers = Math.sqrt(latDiff.pow(2).add(lngDiff.pow(2)).doubleValue()) * KILOMETERS_PER_DEGREE;\n return (long) Math.floor(distanceKilometers / TRAVEL_SPEED_KPH * MILLIS_IN_ONE_HOUR);\n }\n\n @Override\n public List getPath(Coordinates from, Coordinates to) {\n return Arrays.asList(from, to);\n }\n\n @Override\n public BoundingBox getBounds() {\n return new BoundingBox(Coordinates.of(-90, -180), Coordinates.of(90, 180));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/Constants.java",
"content": "package org.optaweb.vehiclerouting.plugin.routing;\n\npublic class Constants {\n\n public static final String GRAPHHOPPER_PROFILE = \"optaweb_car\";\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/GraphHopperRouter.java",
"content": "package org.optaweb.vehiclerouting.plugin.routing;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.util.List;\nimport java.util.stream.StreamSupport;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.service.distance.DistanceCalculator;\nimport org.optaweb.vehiclerouting.service.distance.RoutingException;\nimport org.optaweb.vehiclerouting.service.region.BoundingBox;\nimport org.optaweb.vehiclerouting.service.region.Region;\nimport org.optaweb.vehiclerouting.service.route.Router;\n\nimport com.graphhopper.GHRequest;\nimport com.graphhopper.GHResponse;\nimport com.graphhopper.GraphHopper;\nimport com.graphhopper.ResponsePath;\nimport com.graphhopper.util.PointList;\nimport com.graphhopper.util.shapes.BBox;\n\nimport io.quarkus.arc.properties.IfBuildProperty;\n\n/**\n * Provides geographical information needed for route optimization.\n */\n@ApplicationScoped\n@IfBuildProperty(name = \"app.routing.engine\", stringValue = \"GRAPHHOPPER\", enableIfMissing = true)\nclass GraphHopperRouter implements Router, DistanceCalculator, Region {\n\n private final GraphHopper graphHopper;\n\n @Inject\n GraphHopperRouter(GraphHopper graphHopper) {\n this.graphHopper = graphHopper;\n }\n\n @Override\n public List getPath(Coordinates from, Coordinates to) {\n PointList points = getBestRoute(from, to).getPoints();\n return StreamSupport.stream(points.spliterator(), false)\n .map(ghPoint3D -> Coordinates.of(ghPoint3D.lat, ghPoint3D.lon))\n .collect(toList());\n }\n\n @Override\n public long travelTimeMillis(Coordinates from, Coordinates to) {\n return getBestRoute(from, to).getTime();\n }\n\n private ResponsePath getBestRoute(Coordinates from, Coordinates to) {\n GHRequest request = new GHRequest(\n from.latitude().doubleValue(),\n from.longitude().doubleValue(),\n to.latitude().doubleValue(),\n to.longitude().doubleValue()).setProfile(Constants.GRAPHHOPPER_PROFILE);\n GHResponse response = graphHopper.route(request);\n // TODO return wrapper that can hold both the result and error explanation instead of throwing exception\n if (response.hasErrors()) {\n throw new RoutingException(\"No route from (\" + from + \") to (\" + to + \")\", response.getErrors().get(0));\n }\n return response.getBest();\n }\n\n @Override\n public BoundingBox getBounds() {\n BBox bounds = graphHopper.getBaseGraph().getBounds();\n return new BoundingBox(\n Coordinates.of(bounds.minLat, bounds.minLon),\n Coordinates.of(bounds.maxLat, bounds.maxLon));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/RoutingConfig.java",
"content": "package org.optaweb.vehiclerouting.plugin.routing;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.MalformedURLException;\nimport java.net.ProtocolException;\nimport java.net.URL;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.util.Optional;\nimport java.util.stream.Stream;\n\nimport javax.enterprise.context.Dependent;\nimport javax.enterprise.inject.Produces;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.Profiles;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\nimport com.graphhopper.GraphHopper;\nimport com.graphhopper.config.CHProfile;\nimport com.graphhopper.config.Profile;\n\nimport io.quarkus.arc.DefaultBean;\nimport io.quarkus.arc.profile.UnlessBuildProfile;\nimport io.quarkus.arc.properties.IfBuildProperty;\n\n/**\n * Configuration bean that creates a GraphHopper instance and allows to configure the path to OSM file\n * through environment.\n */\n@Dependent\nclass RoutingConfig {\n\n private static final Logger logger = LoggerFactory.getLogger(RoutingConfig.class);\n\n private final Path osmDir;\n private final Path osmFile;\n private final Optional osmDownloadUrl;\n private final Path graphHopperDir;\n private final Path graphDir;\n\n @Inject\n RoutingConfig(RoutingProperties routingProperties) {\n osmDir = Paths.get(routingProperties.osmDir()).toAbsolutePath();\n osmFile = osmDir.resolve(routingProperties.osmFile()).toAbsolutePath();\n osmDownloadUrl = routingProperties.osmDownloadUrl();\n graphHopperDir = Paths.get(routingProperties.ghDir());\n String regionName = routingProperties.osmFile().replaceFirst(\"\\\\.osm\\\\.pbf$\", \"\");\n graphDir = graphHopperDir.resolve(regionName).toAbsolutePath();\n }\n\n /**\n * Avoids creating a real GraphHopper instance when running a @QuarkusTest.\n *\n * @return real GraphHopper\n */\n @UnlessBuildProfile(Profiles.TEST)\n @IfBuildProperty(name = \"app.routing.engine\", stringValue = \"GRAPHHOPPER\", enableIfMissing = true)\n @Produces\n @DefaultBean\n GraphHopper graphHopper() {\n GraphHopper graphHopper = new GraphHopper();\n graphHopper.setGraphHopperLocation(graphDir.toString());\n\n if (graphDirIsNotEmpty()) {\n logger.info(\"Loading existing GraphHopper graph from: {}\", graphDir);\n } else {\n if (Files.notExists(osmFile)) {\n initDirs();\n\n if (!osmDownloadUrl.isPresent() || osmDownloadUrl.get().trim().isEmpty()) {\n throw new IllegalStateException(\n \"The osmFile (\" + osmFile + \") does not exist\"\n + \" and no download URL was provided.\\n\"\n + \"Download the OSM file from https://download.geofabrik.de/ first\"\n + \" or provide an OSM file URL\"\n + \" using the app.routing.osm-download-url property.\");\n }\n downloadOsmFile(osmDownloadUrl.get(), osmFile);\n }\n logger.info(\"Importing OSM file: {}\", osmFile);\n graphHopper.setOSMFile(osmFile.toString());\n }\n\n /*\n * Define a profile for each type of request that's going to be made at runtime. We're only going to ask for the fastest\n * route for a car, so we only need one profile.\n *\n * Change the weighting to \"shortest\" (and delete the graph directory to re-import it) to optimize for shortest routes.\n *\n * Add a second profile with \"shortest\" weighting (and delete the graph directory) to be able to change travel cost\n * optimization goal at runtime.\n */\n graphHopper.setProfiles(new Profile(Constants.GRAPHHOPPER_PROFILE).setVehicle(\"car\").setWeighting(\"fastest\"));\n /*\n * Quick overview of routing modes:\n *\n * Flexible mode:\n * - Dijkstra or A*\n * - able to change requirements per request\n * Speed mode:\n * - \"Contraction Hierarchies\" algorithm (CH)\n * - still Dijkstra but on a \"shortcut graph\"\n * Hybrid mode\n * - landmark algorithm\n * - flexible and fast\n *\n * See https://www.graphhopper.com/blog/2017/08/14/flexible-routing-15-times-faster/.\n */\n // Use CH for the only profile we have.\n graphHopper.getCHPreparationHandler().setCHProfiles(new CHProfile(Constants.GRAPHHOPPER_PROFILE));\n graphHopper.importOrLoad();\n logger.info(\"GraphHopper graph loaded\");\n return graphHopper;\n }\n\n /**\n * Decide whether the graph can be loaded.\n *\n * @return true if the graph directory exists and is not empty\n */\n private boolean graphDirIsNotEmpty() {\n if (Files.notExists(graphDir)) {\n return false;\n }\n try (Stream graphDirFiles = Files.list(graphDir)) {\n // Defensive programming. Check if the graph dir is empty. That happens if the import fails\n // for example due to OutOfMemoryError.\n return graphDirFiles.findAny().isPresent();\n } catch (IOException e) {\n throw new RoutingEngineException(\"Cannot read contents of the graph directory (\" + graphDir + \")\", e);\n }\n }\n\n private void initDirs() {\n try {\n Files.createDirectories(osmDir);\n Files.createDirectories(graphHopperDir);\n } catch (IOException e) {\n throw new RoutingEngineException(\"Can't create directory for storing OSM download\", e);\n }\n }\n\n static void downloadOsmFile(String urlString, Path osmFile) {\n HttpURLConnection con;\n URL url;\n try {\n url = new URL(urlString);\n con = (HttpURLConnection) url.openConnection();\n } catch (MalformedURLException e) {\n throw new RoutingEngineException(\"The OSM file URL is malformed\", e);\n } catch (IOException e) {\n throw new RoutingEngineException(\"The OSM file cannot be downloaded\", e);\n }\n try {\n con.setRequestMethod(\"GET\");\n } catch (ProtocolException e) {\n throw new IllegalStateException(\"Can't set request method\", e);\n }\n\n con.setConnectTimeout(10000);\n con.setReadTimeout(10000);\n\n logger.info(\"Downloading OSM file from {}\", urlString);\n try {\n Files.copy(con.getInputStream(), osmFile);\n } catch (IOException e) {\n throw new RoutingEngineException(\"OSM file download failed\", e);\n }\n logger.info(\"File saved to {}\", osmFile);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/RoutingEngineException.java",
"content": "package org.optaweb.vehiclerouting.plugin.routing;\n\npublic class RoutingEngineException extends RuntimeException {\n\n RoutingEngineException(String message, Throwable cause) {\n super(message, cause);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/RoutingProperties.java",
"content": "package org.optaweb.vehiclerouting.plugin.routing;\n\nimport java.util.Optional;\n\nimport io.smallrye.config.ConfigMapping;\n\n@ConfigMapping(prefix = \"app.routing\")\npublic interface RoutingProperties {\n\n /**\n * Directory to read OSM files from.\n */\n String osmDir();\n\n /**\n * Directory where GraphHopper graphs are stored.\n */\n String ghDir();\n\n /**\n * OpenStreetMap file name.\n */\n String osmFile();\n\n /**\n * URL of an .osm.pbf file that will be downloaded in case the file doesn't exist on the file system.\n */\n Optional osmDownloadUrl();\n\n /**\n * Routing engine providing distances and paths.\n */\n RoutingEngine engine();\n\n enum RoutingEngine {\n AIR,\n GRAPHHOPPER\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/plugin/routing/package-info.java",
"content": "/**\n * Provides information based on geographical data, for example fastest and shortest distances between locations.\n */\npackage org.optaweb.vehiclerouting.plugin.routing;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/DemoProperties.java",
"content": "package org.optaweb.vehiclerouting.service.demo;\n\nimport java.util.Optional;\n\nimport io.smallrye.config.ConfigMapping;\n\n@ConfigMapping(prefix = \"app.demo\")\npublic interface DemoProperties {\n\n /**\n * Directory with demo data sets.\n */\n Optional dataSetDir();\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/DemoService.java",
"content": "package org.optaweb.vehiclerouting.service.demo;\n\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.List;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.domain.RoutingProblem;\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.service.demo.dataset.DataSetMarshaller;\nimport org.optaweb.vehiclerouting.service.location.LocationRepository;\nimport org.optaweb.vehiclerouting.service.location.LocationService;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleRepository;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleService;\n\n/**\n * Performs demo-related use cases.\n */\n@ApplicationScoped\npublic class DemoService {\n\n static final int MAX_TRIES = 10;\n\n private final RoutingProblemList routingProblems;\n private final LocationService locationService;\n private final LocationRepository locationRepository;\n private final VehicleService vehicleService;\n private final VehicleRepository vehicleRepository;\n private final DataSetMarshaller dataSetMarshaller;\n\n @Inject\n public DemoService(\n RoutingProblemList routingProblems,\n LocationService locationService,\n LocationRepository locationRepository,\n VehicleService vehicleService,\n VehicleRepository vehicleRepository,\n DataSetMarshaller dataSetMarshaller) {\n this.routingProblems = routingProblems;\n this.locationService = locationService;\n this.locationRepository = locationRepository;\n this.vehicleService = vehicleService;\n this.vehicleRepository = vehicleRepository;\n this.dataSetMarshaller = dataSetMarshaller;\n }\n\n public Collection demos() {\n return routingProblems.all();\n }\n\n public void loadDemo(String name) {\n RoutingProblem routingProblem = routingProblems.byName(name);\n // Add depot\n routingProblem.depot().ifPresent(depot -> addWithRetry(depot.coordinates(), depot.description()));\n\n // TODO start randomizing only after using all available cities (=> reproducibility for small demos)\n routingProblem.visits().forEach(visit -> addWithRetry(visit.coordinates(), visit.description()));\n routingProblem.vehicles().forEach(vehicleService::createVehicle);\n }\n\n private void addWithRetry(Coordinates coordinates, String description) {\n int tries = 0;\n while (tries < MAX_TRIES && !locationService.createLocation(coordinates, description).isPresent()) {\n tries++;\n }\n if (tries == MAX_TRIES) {\n throw new RuntimeException(\n \"Impossible to create a new location near \" + coordinates + \" after \" + tries + \" attempts\");\n }\n }\n\n public String exportDataSet() {\n // FIXME still relying on the fact that the first location in the repository is the depot\n List visits = new ArrayList<>(locationRepository.locations());\n Location depot = visits.isEmpty() ? null : visits.remove(0);\n List vehicles = vehicleRepository.vehicles();\n return dataSetMarshaller.marshal(new RoutingProblem(\n \"Custom Vehicle Routing instance\", vehicles, depot, visits));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/RoutingProblemConfig.java",
"content": "package org.optaweb.vehiclerouting.service.demo;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.io.File;\nimport java.io.FileInputStream;\nimport java.io.FileNotFoundException;\nimport java.io.IOException;\nimport java.io.InputStreamReader;\nimport java.io.Reader;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\nimport java.util.stream.Stream;\n\nimport javax.enterprise.context.Dependent;\nimport javax.enterprise.inject.Produces;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.RoutingProblem;\nimport org.optaweb.vehiclerouting.service.demo.dataset.DataSetMarshaller;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n/**\n * Configuration bean that produces the list of available routing problem data sets.\n */\n@Dependent\nclass RoutingProblemConfig {\n\n private static final Logger logger = LoggerFactory.getLogger(RoutingProblemConfig.class);\n private final DemoProperties demoProperties;\n private final DataSetMarshaller dataSetMarshaller;\n\n @Inject\n RoutingProblemConfig(DemoProperties demoProperties, DataSetMarshaller dataSetMarshaller) {\n this.demoProperties = demoProperties;\n this.dataSetMarshaller = dataSetMarshaller;\n }\n\n @Produces\n RoutingProblemList routingProblems() {\n Stream allProblems = Stream.concat(classPathProblems(), dataSetDirProblems());\n return new RoutingProblemList(allProblems);\n }\n\n private Stream classPathProblems() {\n return Stream.of(belgiumReader()).map(dataSetMarshaller::unmarshal);\n }\n\n private Stream dataSetDirProblems() {\n return dataSetDir().map(dir -> collectProblems(dir).stream()).orElse(Stream.empty());\n }\n\n private List collectProblems(Path dataSetDirPath) {\n try (Stream dataSetPaths = Files.list(dataSetDirPath)) {\n return dataSetPaths\n .map(Path::toFile)\n .filter(file -> file.getName().endsWith(\".yaml\") && file.exists() && file.canRead())\n .map(file -> {\n try {\n return new InputStreamReader(new FileInputStream(file), StandardCharsets.UTF_8);\n } catch (FileNotFoundException e) {\n logger.error(\"Problem with dataset file {}\", file, e);\n return null;\n }\n })\n .filter(Objects::nonNull)\n // TODO make unmarshalling exception checked, catch it and ignore broken files\n .map(dataSetMarshaller::unmarshal)\n // Returning the stream here has no point because the stream is always closed by the try-with-resources.\n .collect(toList());\n } catch (IOException e) {\n throw new IllegalStateException(\"Cannot list directory \" + dataSetDirPath, e);\n }\n }\n\n private Optional dataSetDir() {\n // TODO watch the dir (and make this a service that has local/data resource as a dependency -> is testable)\n Optional dataSetDirProperty = demoProperties.dataSetDir();\n if (!dataSetDirProperty.isPresent()) {\n logger.info(\"Data set directory (app.demo.data-set-dir) is not set.\");\n return Optional.empty();\n }\n Path dataSetDirPath = Paths.get(dataSetDirProperty.get());\n if (!isReadableDir(dataSetDirPath)) {\n logger.warn(\n \"Data set directory '{}' doesn't exist or cannot be read. No external data sets will be loaded.\",\n dataSetDirPath.toAbsolutePath());\n return Optional.empty();\n }\n return Optional.of(dataSetDirPath);\n }\n\n private static Reader belgiumReader() {\n return new InputStreamReader(\n DemoService.class.getResourceAsStream(\"belgium-cities.yaml\"),\n StandardCharsets.UTF_8);\n }\n\n private static boolean isReadableDir(Path path) {\n File file = path.toFile();\n return file.exists() && file.canRead() && file.isDirectory();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/RoutingProblemList.java",
"content": "package org.optaweb.vehiclerouting.service.demo;\n\nimport static java.util.function.Function.identity;\nimport static java.util.stream.Collectors.toMap;\n\nimport java.util.Collection;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.stream.Stream;\n\nimport org.optaweb.vehiclerouting.domain.RoutingProblem;\n\n/**\n * Utility class that holds a map of routing problem instances and allows to look them up by name.\n */\nclass RoutingProblemList {\n\n private final Map routingProblems;\n\n RoutingProblemList(Stream routingProblems) {\n this.routingProblems = Objects.requireNonNull(routingProblems)\n // TODO use file name as the key (that's more likely to be unique than data set name)\n .collect(toMap(RoutingProblem::name, identity()));\n }\n\n Collection all() {\n return routingProblems.values();\n }\n\n RoutingProblem byName(String name) {\n RoutingProblem routingProblem = routingProblems.get(name);\n if (routingProblem == null) {\n throw new IllegalArgumentException(\"Data set with name '\" + name + \"' doesn't exist\");\n }\n return routingProblem;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/dataset/DataSet.java",
"content": "package org.optaweb.vehiclerouting.service.demo.dataset;\n\nimport java.util.List;\n\n/**\n * Data set representation used for marshalling and unmarshalling.\n */\nclass DataSet {\n\n private String name;\n private List vehicles;\n private DataSetLocation depot;\n private List visits;\n\n /**\n * Data set name (a short description).\n *\n * @return data set name (may be {@code null})\n */\n public String getName() {\n return name;\n }\n\n public void setName(String name) {\n this.name = name;\n }\n\n /**\n * Vehicles.\n *\n * @return vehicles (may be {@code null})\n */\n public List getVehicles() {\n return vehicles;\n }\n\n public void setVehicles(List vehicles) {\n this.vehicles = vehicles;\n }\n\n /**\n * The depot.\n *\n * @return the depot (may be {@code null})\n */\n public DataSetLocation getDepot() {\n return depot;\n }\n\n public void setDepot(DataSetLocation depot) {\n this.depot = depot;\n }\n\n /**\n * Visits.\n *\n * @return visits (may be {@code null})\n */\n public List getVisits() {\n return visits;\n }\n\n public void setVisits(List visits) {\n this.visits = visits;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/dataset/DataSetLocation.java",
"content": "package org.optaweb.vehiclerouting.service.demo.dataset;\n\nimport com.fasterxml.jackson.annotation.JsonProperty;\n\n/**\n * Data set location.\n */\nclass DataSetLocation {\n\n private String label;\n @JsonProperty(value = \"lat\")\n private double latitude;\n @JsonProperty(value = \"lng\")\n private double longitude;\n\n private DataSetLocation() {\n // for unmarshalling\n }\n\n DataSetLocation(String label, double latitude, double longitude) {\n this.latitude = latitude;\n this.longitude = longitude;\n this.label = label;\n }\n\n /**\n * Location label.\n *\n * @return label\n */\n public String getLabel() {\n return label;\n }\n\n public void setLabel(String label) {\n this.label = label;\n }\n\n /**\n * Latitude.\n *\n * @return latitude\n */\n public double getLatitude() {\n return latitude;\n }\n\n public void setLatitude(double latitude) {\n this.latitude = latitude;\n }\n\n /**\n * Longitude.\n *\n * @return longitude\n */\n public double getLongitude() {\n return longitude;\n }\n\n public void setLongitude(double longitude) {\n this.longitude = longitude;\n }\n\n @Override\n public String toString() {\n return \"DataSetLocation{\" +\n \"label='\" + label + '\\'' +\n \", latitude=\" + latitude +\n \", longitude=\" + longitude +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/dataset/DataSetMarshaller.java",
"content": "package org.optaweb.vehiclerouting.service.demo.dataset;\n\nimport static java.util.stream.Collectors.toList;\n\nimport java.io.IOException;\nimport java.io.Reader;\nimport java.util.Collections;\nimport java.util.Optional;\n\nimport javax.enterprise.context.ApplicationScoped;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.LocationData;\nimport org.optaweb.vehiclerouting.domain.RoutingProblem;\nimport org.optaweb.vehiclerouting.domain.VehicleData;\nimport org.optaweb.vehiclerouting.domain.VehicleFactory;\n\nimport com.fasterxml.jackson.core.JsonProcessingException;\nimport com.fasterxml.jackson.databind.ObjectMapper;\nimport com.fasterxml.jackson.dataformat.yaml.YAMLFactory;\n\n/**\n * Data set marshaller using the YAML format.\n */\n@ApplicationScoped\npublic class DataSetMarshaller {\n\n private final ObjectMapper mapper;\n\n /**\n * Create marshaller using the default object mapper, which is set up to use YAML format.\n */\n DataSetMarshaller() {\n mapper = new ObjectMapper(new YAMLFactory());\n }\n\n /**\n * Constructor for testing purposes.\n *\n * @param mapper usually a mock object mapper\n */\n DataSetMarshaller(ObjectMapper mapper) {\n this.mapper = mapper;\n }\n\n /**\n * Unmarshal routing problem from a reader.\n *\n * @param reader a reader\n * @return routing problem\n */\n public RoutingProblem unmarshal(Reader reader) {\n // TODO throw a checked exception that will force the caller to handle the reading problem\n // (e.g. a bad format) and report it to the user or log an error\n return toDomain(unmarshalToDataSet(reader));\n }\n\n /**\n * Marshal routing problem to string.\n *\n * @param routingProblem routing problem\n * @return string containing the marshaled routing problem\n */\n public String marshal(RoutingProblem routingProblem) {\n return marshal(toDataSet(routingProblem));\n }\n\n DataSet unmarshalToDataSet(Reader reader) {\n try {\n return mapper.readValue(reader, DataSet.class);\n } catch (IOException e) {\n throw new IllegalStateException(\"Can't read demo data set\", e);\n }\n }\n\n String marshal(DataSet dataSet) {\n try {\n return mapper.writeValueAsString(dataSet);\n } catch (JsonProcessingException e) {\n throw new IllegalStateException(\"Failed to marshal data set (\" + dataSet.getName() + \")\", e);\n }\n }\n\n static DataSet toDataSet(RoutingProblem routingProblem) {\n DataSet dataSet = new DataSet();\n dataSet.setName(routingProblem.name());\n dataSet.setDepot(routingProblem.depot().map(DataSetMarshaller::toDataSet).orElse(null));\n dataSet.setVehicles(routingProblem.vehicles().stream()\n .map(DataSetMarshaller::toDataSet)\n .collect(toList()));\n dataSet.setVisits(routingProblem.visits().stream()\n .map(DataSetMarshaller::toDataSet)\n .collect(toList()));\n return dataSet;\n }\n\n static DataSetLocation toDataSet(LocationData locationData) {\n return new DataSetLocation(\n locationData.description(),\n locationData.coordinates().latitude().doubleValue(),\n locationData.coordinates().longitude().doubleValue());\n }\n\n static DataSetVehicle toDataSet(VehicleData vehicleData) {\n return new DataSetVehicle(vehicleData.name(), vehicleData.capacity());\n }\n\n static RoutingProblem toDomain(DataSet dataSet) {\n return new RoutingProblem(\n Optional.ofNullable(dataSet.getName()).orElse(\"\"),\n Optional.ofNullable(dataSet.getVehicles()).orElse(Collections.emptyList())\n .stream()\n .map(DataSetMarshaller::toDomain)\n .collect(toList()),\n Optional.ofNullable(dataSet.getDepot()).map(DataSetMarshaller::toDomain).orElse(null),\n Optional.ofNullable(dataSet.getVisits()).orElse(Collections.emptyList())\n .stream()\n .map(DataSetMarshaller::toDomain)\n .collect(toList()));\n }\n\n static LocationData toDomain(DataSetLocation dataSetLocation) {\n return new LocationData(\n Coordinates.of(dataSetLocation.getLatitude(), dataSetLocation.getLongitude()),\n dataSetLocation.getLabel());\n }\n\n static VehicleData toDomain(DataSetVehicle dataSetVehicle) {\n return VehicleFactory.vehicleData(dataSetVehicle.name, dataSetVehicle.capacity);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/dataset/DataSetVehicle.java",
"content": "package org.optaweb.vehiclerouting.service.demo.dataset;\n\nimport com.fasterxml.jackson.annotation.JsonCreator;\nimport com.fasterxml.jackson.annotation.JsonProperty;\n\n/**\n * Data set vehicle.\n */\npublic class DataSetVehicle {\n\n @JsonProperty\n final String name;\n @JsonProperty\n final int capacity;\n\n @JsonCreator\n public DataSetVehicle(@JsonProperty(\"name\") String name, @JsonProperty(\"capacity\") int capacity) {\n this.name = name;\n this.capacity = capacity;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/dataset/package-info.java",
"content": "/**\n * Data set marshalling and unmarshalling.\n */\npackage org.optaweb.vehiclerouting.service.demo.dataset;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/demo/package-info.java",
"content": "/**\n * Demo data set loading and exporting.\n */\npackage org.optaweb.vehiclerouting.service.demo;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/distance/DistanceCalculator.java",
"content": "package org.optaweb.vehiclerouting.service.distance;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\n\n/**\n * Calculates distances between coordinates.\n */\npublic interface DistanceCalculator {\n\n /**\n * Calculate travel time in milliseconds.\n *\n * @param from origin\n * @param to destination\n * @return travel time in milliseconds\n * @throws RoutingException when the distance between given coordinates cannot be calculated\n */\n long travelTimeMillis(Coordinates from, Coordinates to);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/distance/DistanceMatrixImpl.java",
"content": "package org.optaweb.vehiclerouting.service.distance;\n\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.concurrent.ConcurrentHashMap;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.service.location.DistanceMatrix;\nimport org.optaweb.vehiclerouting.service.location.DistanceMatrixRow;\n\n@ApplicationScoped\nclass DistanceMatrixImpl implements DistanceMatrix {\n\n private final DistanceCalculator distanceCalculator;\n private final Map> matrix = new HashMap<>();\n\n @Inject\n DistanceMatrixImpl(DistanceCalculator distanceCalculator) {\n this.distanceCalculator = distanceCalculator;\n }\n\n @Override\n public DistanceMatrixRow addLocation(Location newLocation) {\n Map distancesToOthers = updateMatrixLazily(newLocation);\n return locationId -> distancesToOthers.computeIfAbsent(locationId, wrongId -> {\n throw new IllegalArgumentException(\n \"Distance from \" + newLocation\n + \" to \" + wrongId\n + \" hasn't been recorded.\\n\"\n + \"We only know distances to \" + distancesToOthers.keySet());\n });\n }\n\n private Map updateMatrixLazily(Location location) {\n // Matrix == distance rows.\n // We're adding a whole new row with distances from the new location to existing ones.\n // We're also creating a new column by \"appending\" a new cell to each existing row.\n // This new column contains distances from each existing location to the new one.\n\n return matrix.computeIfAbsent(location, newLocation -> {\n // The map must be thread-safe because:\n // - we're updating it from the parallel stream below\n // - it is accessed from solver thread!\n Map distancesToOthers = new ConcurrentHashMap<>(); // the new row\n\n // distance to self is 0\n distancesToOthers.put(newLocation.id(), Distance.ZERO);\n\n // For all entries (rows) in the matrix:\n matrix.entrySet().stream().parallel().forEach(distanceRow -> {\n // Entry key is the existing (other) location.\n Location other = distanceRow.getKey();\n // Entry value is the data (cells) in the row (distances from the entry key location to any other).\n Map distancesFromOther = distanceRow.getValue();\n // Add a new cell to the row with the distance from the entry key location to the new location\n // (results in a new column at the end of the loop).\n distancesFromOther.put(newLocation.id(), calculateDistance(other, newLocation));\n // Add a cell to the new distance's row.\n distancesToOthers.put(other.id(), calculateDistance(newLocation, other));\n });\n\n return distancesToOthers;\n });\n }\n\n private Distance calculateDistance(Location from, Location to) {\n return Distance.ofMillis(distanceCalculator.travelTimeMillis(from.coordinates(), to.coordinates()));\n }\n\n @Override\n public Distance distance(Location from, Location to) {\n if (!matrix.containsKey(from)) {\n throw new IllegalArgumentException(\"Unknown 'from' location (\" + from + \")\");\n }\n Map distanceRow = matrix.get(from);\n if (!distanceRow.containsKey(to.id())) {\n throw new IllegalArgumentException(\"Unknown 'to' location (\" + to + \")\");\n }\n return distanceRow.get(to.id());\n }\n\n @Override\n public void put(Location from, Location to, Distance distance) {\n matrix.computeIfAbsent(from, location -> new ConcurrentHashMap<>()).put(to.id(), distance);\n }\n\n @Override\n public void removeLocation(Location location) {\n // Remove the distance matrix row (distances from the removed location to others).\n matrix.remove(location);\n // TODO also remove the \"column\" of the matrix (distances from others to the removed location) to avoid memory\n // leak.\n // But this probably requires making DistanceMatrixRow immutable (otherwise there's a risk of NPEs in solver)\n // and update PlanningLocations' distance maps through problem fact changes.\n }\n\n @Override\n public void clear() {\n matrix.clear();\n }\n\n /**\n * Number of rows in the matrix.\n *\n * @return number of rows\n */\n public int dimension() {\n return matrix.size();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/distance/DistanceRepository.java",
"content": "package org.optaweb.vehiclerouting.service.distance;\n\nimport java.util.Optional;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\n\n/**\n * Stores distances between locations.\n */\npublic interface DistanceRepository {\n\n void saveDistance(Location from, Location to, Distance distance);\n\n Optional getDistance(Location from, Location to);\n\n void deleteDistances(Location location);\n\n void deleteAll();\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/distance/RoutingException.java",
"content": "package org.optaweb.vehiclerouting.service.distance;\n\npublic class RoutingException extends RuntimeException {\n\n public RoutingException(String message, Throwable cause) {\n super(message, cause);\n }\n\n public RoutingException(String message) {\n super(message);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/distance/package-info.java",
"content": "/**\n * Distance matrix calculation.\n */\npackage org.optaweb.vehiclerouting.service.distance;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/error/ErrorEvent.java",
"content": "package org.optaweb.vehiclerouting.service.error;\n\nimport java.util.Objects;\n\npublic class ErrorEvent {\n\n public final String message;\n\n /**\n * Create a new {@code ApplicationEvent}.\n *\n * @param source the object on which the event initially occurred or with\n * which the event is associated (never {@code null})\n * @param message error message (never {@code null})\n */\n public ErrorEvent(Object source, String message) {\n this.message = Objects.requireNonNull(message);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/error/ErrorListener.java",
"content": "package org.optaweb.vehiclerouting.service.error;\n\nimport java.util.UUID;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Event;\nimport javax.enterprise.event.Observes;\nimport javax.inject.Inject;\n\n/**\n * Creates messages from error events and passes them to consumers.\n */\n@ApplicationScoped\npublic class ErrorListener {\n\n private final Event errorMessageEvent;\n\n @Inject\n public ErrorListener(Event errorMessageEvent) {\n this.errorMessageEvent = errorMessageEvent;\n }\n\n public void onErrorEvent(@Observes ErrorEvent event) {\n errorMessageEvent.fire(ErrorMessage.of(UUID.randomUUID().toString(), event.message));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/error/ErrorMessage.java",
"content": "package org.optaweb.vehiclerouting.service.error;\n\nimport java.util.Objects;\n\npublic class ErrorMessage {\n\n /**\n * Message ID (never {@code null}).\n */\n public final String id;\n /**\n * Message text (never {@code null}).\n */\n public final String text;\n\n public static ErrorMessage of(String id, String text) {\n return new ErrorMessage(id, text);\n }\n\n private ErrorMessage(String id, String text) {\n this.id = Objects.requireNonNull(id);\n this.text = Objects.requireNonNull(text);\n }\n\n @Override\n public String toString() {\n return \"ErrorMessage{\" +\n \"id='\" + id + '\\'' +\n \", text='\" + text + '\\'' +\n '}';\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/error/ErrorMessageConsumer.java",
"content": "package org.optaweb.vehiclerouting.service.error;\n\n/**\n * Consumes error messages.\n */\npublic interface ErrorMessageConsumer {\n\n /**\n * Consume an error message.\n *\n * @param message error message\n */\n void consumeMessage(ErrorMessage message);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/error/package-info.java",
"content": "/**\n * Handles error events. For example an uncaught exception can be turned into an error event that is sent to the client.\n */\npackage org.optaweb.vehiclerouting.service.error;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/location/DistanceMatrix.java",
"content": "package org.optaweb.vehiclerouting.service.location;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\n\n/**\n * Holds distances between every pair of locations.\n */\npublic interface DistanceMatrix {\n\n DistanceMatrixRow addLocation(Location location);\n\n void removeLocation(Location location);\n\n void clear();\n\n Distance distance(Location from, Location to);\n\n void put(Location from, Location to, Distance distance);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/location/DistanceMatrixRow.java",
"content": "package org.optaweb.vehiclerouting.service.location;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\n\n/**\n * Contains {@link Distance distances} from the location associated with this row to other locations.\n */\npublic interface DistanceMatrixRow {\n\n /**\n * Distance from this row's location to the given location.\n *\n * @param locationId target location\n * @return time it takes to travel to the given location\n */\n Distance distanceTo(long locationId);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/location/LocationPlanner.java",
"content": "package org.optaweb.vehiclerouting.service.location;\n\nimport org.optaweb.vehiclerouting.domain.Location;\n\n/**\n * Optimizes the routing plan in response to location-related changes in the routing problem.\n */\npublic interface LocationPlanner {\n\n void addLocation(Location location, DistanceMatrixRow distanceMatrixRow);\n\n void removeLocation(Location location);\n\n void removeAllLocations();\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/location/LocationRepository.java",
"content": "package org.optaweb.vehiclerouting.service.location;\n\nimport java.util.List;\nimport java.util.Optional;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\n\n/**\n * Defines repository operations on locations.\n */\npublic interface LocationRepository {\n\n /**\n * Create a location with a unique ID.\n *\n * @param coordinates location's coordinates\n * @param description description of the location\n * @return a new location\n */\n Location createLocation(Coordinates coordinates, String description);\n\n /**\n * Get all locations.\n *\n * @return all locations\n */\n List locations();\n\n /**\n * Remove a location with the given ID.\n *\n * @param id location ID\n * @return the removed location\n */\n Location removeLocation(long id);\n\n /**\n * Remove all locations from the repository.\n */\n void removeAll();\n\n /**\n * Find a location by its ID.\n *\n * @param locationId location's ID\n * @return an Optional containing location with the given ID or empty Optional if there is no location with such ID\n */\n Optional find(long locationId);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/location/LocationService.java",
"content": "package org.optaweb.vehiclerouting.service.location;\n\nimport static java.util.Comparator.comparingLong;\n\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Event;\nimport javax.inject.Inject;\nimport javax.transaction.Transactional;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.service.distance.DistanceRepository;\nimport org.optaweb.vehiclerouting.service.error.ErrorEvent;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\n/**\n * Performs location-related use cases.\n */\n@ApplicationScoped\npublic class LocationService {\n\n private static final Logger logger = LoggerFactory.getLogger(LocationService.class);\n\n private final LocationRepository repository;\n private final DistanceRepository distanceRepository;\n private final LocationPlanner planner; // TODO move to RoutingPlanService (SRP)\n private final DistanceMatrix distanceMatrix;\n private final Event errorEvent;\n\n @Inject\n LocationService(\n LocationRepository repository,\n DistanceRepository distanceRepository,\n LocationPlanner planner,\n DistanceMatrix distanceMatrix,\n Event errorEvent) {\n this.repository = repository;\n this.distanceRepository = distanceRepository;\n this.planner = planner;\n this.distanceMatrix = distanceMatrix;\n this.errorEvent = errorEvent;\n }\n\n public synchronized void addLocation(Location location) {\n Objects.requireNonNull(location);\n DistanceMatrixRow distanceMatrixRow = distanceMatrix.addLocation(location);\n planner.addLocation(location, distanceMatrixRow);\n }\n\n @Transactional\n public synchronized Optional createLocation(Coordinates coordinates, String description) {\n Objects.requireNonNull(coordinates);\n Objects.requireNonNull(description);\n // TODO if (router.isLocationAvailable(coordinates))\n Location location = repository.createLocation(coordinates, description);\n Optional distanceMatrixRow = addToMatrix(location);\n if (distanceMatrixRow.isPresent()) {\n planner.addLocation(location, distanceMatrixRow.get());\n return Optional.of(location);\n } else {\n repository.removeLocation(location.id());\n return Optional.empty();\n }\n }\n\n private Optional addToMatrix(Location location) {\n try {\n DistanceMatrixRow distanceMatrixRow = distanceMatrix.addLocation(location);\n repository.locations().stream()\n .filter(existingLocation -> !existingLocation.equals(location))\n .forEach(existingLocation -> {\n distanceRepository.saveDistance(location, existingLocation,\n distanceMatrixRow.distanceTo(existingLocation.id()));\n distanceRepository.saveDistance(existingLocation, location,\n distanceMatrix.distance(existingLocation, location));\n });\n return Optional.of(distanceMatrixRow);\n } catch (Exception e) {\n logger.error(\n \"Failed to calculate distances for location {}, it will be discarded\",\n location.fullDescription(), e);\n errorEvent.fire(new ErrorEvent(\n this,\n \"Failed to calculate distances for location \" + location.fullDescription()\n + \", it will be discarded.\\n\" + e.toString()));\n return Optional.empty();\n }\n }\n\n @Transactional\n public synchronized void removeLocation(long id) {\n Optional optionalLocation = repository.find(id);\n if (!optionalLocation.isPresent()) {\n errorEvent.fire(new ErrorEvent(this, \"Location [\" + id + \"] cannot be removed because it doesn't exist.\"));\n return;\n }\n Location removedLocation = optionalLocation.get();\n List locations = repository.locations();\n if (locations.size() > 1) {\n Location depot = locations.stream()\n .min(comparingLong(Location::id))\n .orElseThrow(() -> new IllegalStateException(\n \"Impossible. Locations have size (\" + locations.size() + \") but the stream is empty.\"));\n if (removedLocation.equals(depot)) {\n errorEvent.fire(new ErrorEvent(this, \"You can only remove depot if there are no visits.\"));\n return;\n }\n }\n\n planner.removeLocation(removedLocation);\n repository.removeLocation(id);\n distanceMatrix.removeLocation(removedLocation);\n distanceRepository.deleteDistances(removedLocation);\n }\n\n @Transactional\n public synchronized void removeAll() {\n planner.removeAllLocations();\n repository.removeAll();\n distanceMatrix.clear();\n distanceRepository.deleteAll();\n }\n\n public void populateDistanceMatrix() {\n repository.locations()\n .forEach(from -> repository.locations().stream()\n .filter(to -> !to.equals(from))\n .forEach(to -> distanceMatrix.put(from, to, distanceRepository.getDistance(from, to)\n .orElseThrow(() -> new IllegalStateException(\"Distance from: [\" + from + \"] to: [\" + to\n + \"] is missing in the distance repository. This should not happen.\")))));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/location/package-info.java",
"content": "/**\n * Use cases that involve {@link org.optaweb.vehiclerouting.domain.Location locations}.\n */\npackage org.optaweb.vehiclerouting.service.location;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/region/BoundingBox.java",
"content": "package org.optaweb.vehiclerouting.service.region;\n\nimport java.util.Objects;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\n\n/**\n * Bounding box.\n */\npublic class BoundingBox {\n\n private final Coordinates southWest;\n private final Coordinates northEast;\n\n /**\n * Create bounding box. The box must have non-zero dimensions and the corners must be south-west and north-east.\n *\n * @param southWest south-west corner (minimal latitude and longitude)\n * @param northEast north-east corner (maximal latitude and longitude)\n */\n public BoundingBox(Coordinates southWest, Coordinates northEast) {\n this.southWest = Objects.requireNonNull(southWest);\n this.northEast = Objects.requireNonNull(northEast);\n if (southWest.latitude().compareTo(northEast.latitude()) >= 0) {\n throw new IllegalArgumentException(\n \"South-west corner latitude (\"\n + southWest.latitude()\n + \"N) must be less than north-east corner latitude (\"\n + northEast.latitude()\n + \"N)\");\n }\n if (southWest.longitude().compareTo(northEast.longitude()) >= 0) {\n throw new IllegalArgumentException(\n \"South-west corner longitude (\"\n + southWest.longitude()\n + \"E) must be less than north-east corner longitude (\"\n + northEast.longitude()\n + \"E)\");\n }\n }\n\n /**\n * South-west corner of the bounding box.\n *\n * @return south-west corner (minimal latitude and longitude)\n */\n public Coordinates getSouthWest() {\n return southWest;\n }\n\n /**\n * North-east corner of the bounding box.\n *\n * @return north-east corner (maximal latitude and longitude)\n */\n public Coordinates getNorthEast() {\n return northEast;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/region/Region.java",
"content": "package org.optaweb.vehiclerouting.service.region;\n\npublic interface Region {\n\n BoundingBox getBounds();\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/region/RegionProperties.java",
"content": "package org.optaweb.vehiclerouting.service.region;\n\nimport java.util.List;\nimport java.util.Optional;\n\nimport io.smallrye.config.ConfigMapping;\n\n@ConfigMapping(prefix = \"app.region\")\npublic interface RegionProperties {\n\n /**\n * Get country codes specified for the loaded OSM file (working region).\n * The codes are expected to be in the ISO 3166-1 alpha-2 format.\n *\n * @return list of country codes (never {@code null})\n */\n Optional> countryCodes();\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/region/RegionService.java",
"content": "package org.optaweb.vehiclerouting.service.region;\n\nimport java.util.List;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\n\n/**\n * Provides information about the working region.\n */\n@ApplicationScoped\npublic class RegionService {\n\n private final RegionProperties regionProperties;\n private final Region region;\n\n @Inject\n RegionService(RegionProperties regionProperties, Region region) {\n this.regionProperties = regionProperties;\n this.region = region;\n }\n\n /**\n * Country codes matching the working region.\n *\n * @return country codes (never {@code null})\n */\n public List countryCodes() {\n return regionProperties.countryCodes().orElse(List.of());\n }\n\n /**\n * Bounding box of the working region.\n *\n * @return bounding box of the working region.\n */\n public BoundingBox boundingBox() {\n return region.getBounds();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/region/package-info.java",
"content": "/**\n * Provides information about the application's working region.\n */\npackage org.optaweb.vehiclerouting.service.region;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/reload/ReloadService.java",
"content": "package org.optaweb.vehiclerouting.service.reload;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Observes;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.service.location.LocationRepository;\nimport org.optaweb.vehiclerouting.service.location.LocationService;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleRepository;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleService;\n\nimport io.quarkus.runtime.StartupEvent;\n\n/**\n * Reloads data from repositories when the application starts.\n */\n@ApplicationScoped\npublic class ReloadService {\n\n private final VehicleRepository vehicleRepository;\n private final VehicleService vehicleService;\n private final LocationRepository locationRepository;\n private final LocationService locationService;\n\n @Inject\n ReloadService(\n VehicleRepository vehicleRepository,\n VehicleService vehicleService,\n LocationRepository locationRepository,\n LocationService locationService) {\n this.vehicleRepository = vehicleRepository;\n this.vehicleService = vehicleService;\n this.locationRepository = locationRepository;\n this.locationService = locationService;\n }\n\n public void reload(@Observes StartupEvent startupEvent) {\n vehicleRepository.vehicles().forEach(vehicleService::addVehicle);\n locationService.populateDistanceMatrix();\n locationRepository.locations().forEach(locationService::addLocation);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/reload/package-info.java",
"content": "/**\n * Loads the application state from repositories when it starts.\n */\npackage org.optaweb.vehiclerouting.service.reload;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/route/RouteChangedEvent.java",
"content": "package org.optaweb.vehiclerouting.service.route;\n\nimport java.util.Collection;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\n\nimport org.optaweb.vehiclerouting.domain.Distance;\n\n/**\n * Event published when the routing plan has been updated either by discovering a better route or by a change\n * in the problem specification (vehicles, visits).\n */\npublic class RouteChangedEvent {\n\n private final Distance distance;\n private final List vehicleIds;\n private final Long depotId;\n private final List visitIds;\n private final Collection routes;\n\n /**\n * Create a new ApplicationEvent.\n *\n * @param source the object on which the event initially occurred (never {@code null})\n * @param distance total distance of all vehicle routes\n * @param vehicleIds vehicle IDs\n * @param depotId depot ID (may be {@code null} if there are no locations)\n * @param visitIds IDs of visits\n * @param routes vehicle routes\n */\n public RouteChangedEvent(\n Object source,\n Distance distance,\n List vehicleIds,\n Long depotId,\n List visitIds,\n Collection routes) {\n this.distance = Objects.requireNonNull(distance);\n this.vehicleIds = Objects.requireNonNull(vehicleIds);\n this.depotId = depotId; // may be null (no depot)\n this.visitIds = Objects.requireNonNull(visitIds);\n this.routes = Objects.requireNonNull(routes);\n }\n\n /**\n * IDs of all vehicles.\n *\n * @return vehicle IDs\n */\n public List vehicleIds() {\n return vehicleIds;\n }\n\n /**\n * Routes of all vehicles.\n *\n * @return vehicle routes\n */\n public Collection routes() {\n return routes;\n }\n\n /**\n * Routing plan distance.\n *\n * @return distance (never {@code null})\n */\n public Distance distance() {\n return distance;\n }\n\n /**\n * The depot ID.\n *\n * @return depot ID\n */\n public Optional depotId() {\n return Optional.ofNullable(depotId);\n }\n\n public List visitIds() {\n return visitIds;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/route/RouteListener.java",
"content": "package org.optaweb.vehiclerouting.service.route;\n\nimport static java.util.stream.Collectors.toList;\nimport static java.util.stream.Collectors.toMap;\n\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Map;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Event;\nimport javax.enterprise.event.Observes;\nimport javax.inject.Inject;\n\nimport org.optaweb.vehiclerouting.Profiles;\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.domain.Route;\nimport org.optaweb.vehiclerouting.domain.RouteWithTrack;\nimport org.optaweb.vehiclerouting.domain.RoutingPlan;\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.service.location.LocationRepository;\nimport org.optaweb.vehiclerouting.service.vehicle.VehicleRepository;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\nimport io.quarkus.arc.profile.UnlessBuildProfile;\n\n/**\n * Handles route updates emitted by optimization plugin.\n */\n@ApplicationScoped\n@UnlessBuildProfile(Profiles.TEST)\npublic class RouteListener {\n\n private static final Logger logger = LoggerFactory.getLogger(RouteListener.class);\n\n private final Router router;\n private final VehicleRepository vehicleRepository;\n private final LocationRepository locationRepository;\n private final Event routingPlanEvent;\n\n // TODO maybe remove state from the service and get best route from a repository\n private RoutingPlan bestRoutingPlan;\n\n @Inject\n RouteListener(\n Router router,\n VehicleRepository vehicleRepository,\n LocationRepository locationRepository,\n Event routingPlanEvent) {\n this.router = router;\n this.vehicleRepository = vehicleRepository;\n this.locationRepository = locationRepository;\n this.routingPlanEvent = routingPlanEvent;\n bestRoutingPlan = RoutingPlan.empty();\n }\n\n // TODO maybe @ObservesAsync?\n public void onApplicationEvent(@Observes RouteChangedEvent event) {\n // TODO persist the best solution\n Location depot = event.depotId().flatMap(locationRepository::find).orElse(null);\n try {\n // TODO Introduce problem revision (every modification increases revision number, event will only\n // be published if revision numbers match) to avoid looking for missing/extra vehicles/visits.\n // This will also make it possible to get rid of the try-catch approach.\n Map vehicleMap = event.vehicleIds().stream()\n .collect(toMap(vehicleId -> vehicleId, this::findVehicleById));\n Map visitMap = event.visitIds().stream()\n .collect(toMap(visitId -> visitId, this::findLocationById));\n\n List routes = event.routes().stream()\n // list of deep locations\n .map(shallowRoute -> new Route(\n vehicleMap.get(shallowRoute.vehicleId),\n findLocationById(shallowRoute.depotId),\n shallowRoute.visitIds.stream()\n .map(visitMap::get)\n .collect(toList())))\n // add tracks\n .map(route -> new RouteWithTrack(route, track(route.depot(), route.visits())))\n .collect(toList());\n bestRoutingPlan = new RoutingPlan(\n event.distance(),\n new ArrayList<>(vehicleMap.values()),\n depot,\n new ArrayList<>(visitMap.values()),\n routes);\n routingPlanEvent.fire(bestRoutingPlan);\n } catch (IllegalStateException e) {\n logger.warn(\"Discarding an outdated routing plan: {}\", e.toString());\n }\n }\n\n private Vehicle findVehicleById(long id) {\n return vehicleRepository.find(id).orElseThrow(() -> new IllegalStateException(\n \"Vehicle {id=\" + id + \"} not found in the repository\"));\n }\n\n private Location findLocationById(long id) {\n return locationRepository.find(id).orElseThrow(() -> new IllegalStateException(\n \"Location {id=\" + id + \"} not found in the repository\"));\n }\n\n private List> track(Location depot, List route) {\n if (route.isEmpty()) {\n return Collections.emptyList();\n }\n ArrayList itinerary = new ArrayList<>();\n itinerary.add(depot);\n itinerary.addAll(route);\n itinerary.add(depot);\n List> paths = new ArrayList<>();\n for (int i = 0; i < itinerary.size() - 1; i++) {\n Location fromLocation = itinerary.get(i);\n Location toLocation = itinerary.get(i + 1);\n List path = router.getPath(fromLocation.coordinates(), toLocation.coordinates());\n paths.add(path);\n }\n return paths;\n }\n\n public RoutingPlan getBestRoutingPlan() {\n return bestRoutingPlan;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/route/Router.java",
"content": "package org.optaweb.vehiclerouting.service.route;\n\nimport java.util.List;\n\nimport org.optaweb.vehiclerouting.domain.Coordinates;\n\n/**\n * Provides paths between locations.\n */\npublic interface Router {\n\n /**\n * Get path between two locations.\n *\n * @param from starting location\n * @param to destination\n * @return list of coordinates describing the path between given locations.\n */\n List getPath(Coordinates from, Coordinates to);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/route/ShallowRoute.java",
"content": "package org.optaweb.vehiclerouting.service.route;\n\nimport static java.util.stream.Collectors.joining;\n\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.stream.Stream;\n\n// TODO maybe remove this once we fork planning domain from optaplanner-examples\n// because then we can hold a reference to the original location\n\n/**\n * Lightweight route description consisting of vehicle and location IDs instead of entities.\n * This makes it easier to quickly construct and share result of route optimization\n * without converting planning domain objects to business domain objects.\n * Specifically, some information may be lost when converting business domain objects to planning domain\n * because it's not needed for optimization (e.g. location address)\n * and so it's impossible to reconstruct the original business object without looking into the repository.\n */\npublic class ShallowRoute {\n\n /**\n * Vehicle ID.\n */\n public final long vehicleId;\n /**\n * Depot ID.\n */\n public final long depotId;\n /**\n * Visit IDs (immutable, never {@code null}).\n */\n public final List visitIds;\n\n /**\n * Create shallow route.\n *\n * @param vehicleId vehicle ID\n * @param depotId depot ID\n * @param visitIds visit IDs\n */\n public ShallowRoute(long vehicleId, long depotId, List visitIds) {\n this.vehicleId = vehicleId;\n this.depotId = depotId;\n this.visitIds = Collections.unmodifiableList(new ArrayList<>(Objects.requireNonNull(visitIds)));\n }\n\n @Override\n public String toString() {\n String route = Stream.concat(Stream.of(depotId), visitIds.stream())\n .map(Object::toString)\n .collect(joining(\"->\", \"[\", \"]\"));\n return vehicleId + \": \" + route;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/route/package-info.java",
"content": "/**\n * Handles {@link org.optaweb.vehiclerouting.domain.RoutingPlan route} updates.\n */\npackage org.optaweb.vehiclerouting.service.route;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/vehicle/VehiclePlanner.java",
"content": "package org.optaweb.vehiclerouting.service.vehicle;\n\nimport org.optaweb.vehiclerouting.domain.Vehicle;\n\n/**\n * Optimizes the routing plan in response to vehicle-related changes in the routing problem.\n */\npublic interface VehiclePlanner {\n\n void addVehicle(Vehicle vehicle);\n\n void removeVehicle(Vehicle vehicle);\n\n void removeAllVehicles();\n\n void changeCapacity(Vehicle vehicle);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/vehicle/VehicleRepository.java",
"content": "package org.optaweb.vehiclerouting.service.vehicle;\n\nimport java.util.List;\nimport java.util.Optional;\n\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.domain.VehicleData;\n\n/**\n * Defines repository operations on vehicles.\n */\npublic interface VehicleRepository {\n\n /**\n * Create a vehicle with a unique ID.\n *\n * @param capacity vehicle's capacity\n * @return a new vehicle\n */\n Vehicle createVehicle(int capacity);\n\n /**\n * Create a vehicle from the given data.\n *\n * @param vehicleData vehicle data\n * @return a new vehicle\n */\n Vehicle createVehicle(VehicleData vehicleData);\n\n /**\n * Get all vehicles.\n *\n * @return all vehicles\n */\n List vehicles();\n\n /**\n * Remove a vehicle with the given ID.\n *\n * @param id vehicle's ID\n * @return the removed vehicle\n */\n Vehicle removeVehicle(long id);\n\n /**\n * Remove all vehicles from the repository.\n */\n void removeAll();\n\n /**\n * Find a vehicle by its ID.\n *\n * @param vehicleId vehicle's ID\n * @return an Optional containing vehicle with the given ID or empty Optional if there is no vehicle with such ID\n */\n Optional find(long vehicleId);\n\n Vehicle changeCapacity(long vehicleId, int capacity);\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/vehicle/VehicleService.java",
"content": "package org.optaweb.vehiclerouting.service.vehicle;\n\nimport static java.util.Comparator.comparingLong;\n\nimport java.util.Objects;\nimport java.util.Optional;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.inject.Inject;\nimport javax.transaction.Transactional;\n\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.domain.VehicleData;\n\n@ApplicationScoped\npublic class VehicleService {\n\n static final int DEFAULT_VEHICLE_CAPACITY = 10;\n\n private final VehiclePlanner planner;\n private final VehicleRepository vehicleRepository;\n\n @Inject\n public VehicleService(VehiclePlanner planner, VehicleRepository vehicleRepository) {\n this.planner = planner;\n this.vehicleRepository = vehicleRepository;\n }\n\n @Transactional\n public Vehicle createVehicle() {\n Vehicle vehicle = vehicleRepository.createVehicle(DEFAULT_VEHICLE_CAPACITY);\n addVehicle(vehicle);\n return vehicle;\n }\n\n @Transactional\n public Vehicle createVehicle(VehicleData vehicleData) {\n Vehicle vehicle = vehicleRepository.createVehicle(vehicleData);\n addVehicle(vehicle);\n return vehicle;\n }\n\n public void addVehicle(Vehicle vehicle) {\n planner.addVehicle(Objects.requireNonNull(vehicle));\n }\n\n @Transactional\n public void removeVehicle(long vehicleId) {\n Vehicle vehicle = vehicleRepository.removeVehicle(vehicleId);\n planner.removeVehicle(vehicle);\n }\n\n public synchronized void removeAnyVehicle() {\n Optional first = vehicleRepository.vehicles().stream().min(comparingLong(Vehicle::id));\n first.map(Vehicle::id).ifPresent(this::removeVehicle);\n }\n\n @Transactional\n public void removeAll() {\n planner.removeAllVehicles();\n vehicleRepository.removeAll();\n }\n\n @Transactional\n public void changeCapacity(long vehicleId, int capacity) {\n Vehicle updatedVehicle = vehicleRepository.changeCapacity(vehicleId, capacity);\n planner.changeCapacity(updatedVehicle);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/java/org/optaweb/vehiclerouting/service/vehicle/package-info.java",
"content": "/**\n * Performs use cases that involve vehicles.\n */\npackage org.optaweb.vehiclerouting.service.vehicle;\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/resources/.gitignore",
"content": "/application-local.properties\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/resources/application.properties",
"content": "# App configuration\napp.demo.data-set-dir=local/dataset\napp.region.country-codes=BE\napp.routing.osm-dir=local/openstreetmap\napp.routing.gh-dir=local/graphhopper\napp.routing.osm-file=belgium-latest.osm.pbf\napp.routing.engine=GRAPHHOPPER\n%test.app.routing.engine=GRAPHHOPPER\n\n# OptaPlanner\nquarkus.optaplanner.solver.daemon=true\nquarkus.optaplanner.solver.termination.spent-limit=1m\n\n# Enable CORS filter.\nquarkus.http.cors=true\n\n# Logging\nquarkus.log.level=INFO\nquarkus.log.min-level=DEBUG\nquarkus.log.category.\"org.optaweb\".level=${LOG_LEVEL_APP:INFO}\nquarkus.log.category.\"org.optaplanner\".level=${LOG_LEVEL_OPTAPLANNER:INFO}\nquarkus.log.category.\"org.drools\".level=${LOG_LEVEL_DROOLS:INFO}\nquarkus.log.category.\"org.hibernate\".level=${LOG_LEVEL_HIBERNATE:INFO}\nquarkus.log.category.\"org.jboss.resteasy\".level=${LOG_LEVEL_RESTEASY:INFO}\n\n# In development mode, the working directory is ./target but local files are expected to survive mvn clean,\n# so they should be one level above target.\n%dev.app.demo.data-set-dir=../local/dataset\n%dev.app.routing.osm-dir=../local/openstreetmap\n%dev.app.routing.gh-dir=../local/graphhopper\n\n############\n# Datasource\n############\n\n# [PostgreSQL] - recommended for production\n%postgresql.quarkus.datasource.db-kind=postgresql\n%postgresql.quarkus.datasource.jdbc.url=jdbc:postgresql://${DATABASE_HOST:postgresql}:5432/${DATABASE_NAME:optaweb_vrp_database}\n%postgresql.quarkus.datasource.username=${DATABASE_USER}\n%postgresql.quarkus.datasource.password=${DATABASE_PASSWORD}\n%postgresql.quarkus.hibernate-orm.database.generation=update\n\n# [Default] - works out of the box, good for development\n# - using an embedded DB with relative path: http://h2database.com/html/features.html#embedded_databases\n# - not closing the DB automatically: http://h2database.com/html/features.html#closing_a_database\nquarkus.datasource.db-kind=h2\nquarkus.datasource.jdbc.url=jdbc:h2:file:${app.persistence.h2-dir:../local/db}/${app.persistence.h2-filename:optaweb_vrp_database};DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=false\nquarkus.datasource.username=sa\nquarkus.datasource.password=\nquarkus.hibernate-orm.database.generation=update\n\n# [Tests]\n# - using an in-memory DB: http://h2database.com/html/features.html#in_memory_databases\n# - not closing the DB automatically: http://h2database.com/html/features.html#closing_a_database\n%test.quarkus.datasource.db-kind=h2\n%test.quarkus.datasource.jdbc.url=jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE\n%test.quarkus.datasource.username=sa\n%test.quarkus.datasource.password=\n%test.quarkus.hibernate-orm.database.generation=create-drop\n\n%test.app.region.country-codes=AT,DE\n\n###############\n# Cypress tests\n###############\n%test-cypress.app.region.country-codes=DE\n%test-cypress.app.routing.osm-dir=target-classes/src/test/resources/org/optaweb/vehiclerouting/plugin/routing\n%test-cypress.app.routing.osm-file=planet_12.032,53.0171_12.1024,53.0491.osm.pbf\n%test-cypress.optaplanner.solver.termination.spent-limit=10s\n%test-cypress.quarkus.datasource.db-kind=h2\n%test-cypress.quarkus.datasource.jdbc.url=jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE\n%test-cypress.quarkus.datasource.username=sa\n%test-cypress.quarkus.datasource.password=\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/resources/org/optaweb/vehiclerouting/service/demo/belgium-cities.yaml",
"content": "---\nname: \"Belgium cities\"\nvehicles:\n - name: \"Vehicle 1\"\n capacity: 10\n - name: \"Vehicle 2\"\n capacity: 10\n - name: \"Vehicle 3\"\n capacity: 10\n - name: \"Vehicle 4\"\n capacity: 10\n - name: \"Vehicle 5\"\n capacity: 10\n - name: \"Vehicle 6\"\n capacity: 10\ndepot:\n label: \"Brussels\"\n lat: 50.85\n lng: 4.35\nvisits:\n - label: \"Aalst\"\n lat: 50.933333\n lng: 4.033333\n - label: \"Anderlecht\"\n lat: 50.833333\n lng: 4.333333\n - label: \"Antwerp\"\n lat: 51.217778\n lng: 4.400278\n - label: \"Beringen\"\n lat: 51.033333\n lng: 5.216667\n - label: \"Bruges\"\n lat: 51.216667\n lng: 3.233333\n - label: \"Charleroi\"\n lat: 50.4\n lng: 4.433333\n - label: \"Chatelet\"\n lat: 50.4\n lng: 4.516667\n - label: \"Dendermonde\"\n lat: 51.033333\n lng: 4.1\n - label: \"Geel\"\n lat: 51.166667\n lng: 5.0\n - label: \"Genk\"\n lat: 50.966667\n lng: 5.5\n - label: \"Ghent\"\n lat: 51.05\n lng: 3.733333\n - label: \"Halle\"\n lat: 50.733333\n lng: 4.233333\n - label: \"Hasselt\"\n lat: 50.93\n lng: 5.34\n - label: \"Ixelles\"\n lat: 50.833333\n lng: 4.366667\n - label: \"Kortrijk\"\n lat: 50.833333\n lng: 3.266667\n - label: \"La Louviere\"\n lat: 50.466667\n lng: 4.183333\n - label: \"Leuven\"\n lat: 50.883333\n lng: 4.7\n - label: \"Liege\"\n lat: 50.633333\n lng: 5.566667\n - label: \"Lier\"\n lat: 51.133333\n lng: 4.566667\n - label: \"Lokeren\"\n lat: 51.1\n lng: 3.983333\n - label: \"Mechelen\"\n lat: 51.016667\n lng: 4.466667\n - label: \"Molenbeek\"\n lat: 50.857778\n lng: 4.315833\n - label: \"Mons\"\n lat: 50.45\n lng: 3.95\n - label: \"Namur\"\n lat: 50.466667\n lng: 4.866667\n - label: \"Ninove\"\n lat: 50.833333\n lng: 4.016667\n - label: \"Roeselare\"\n lat: 50.933333\n lng: 3.116667\n - label: \"Schaerbeek\"\n lat: 50.866667\n lng: 4.383333\n - label: \"Seraing\"\n lat: 50.583333\n lng: 5.5\n - label: \"Sint Niklaas\"\n lat: 51.166667\n lng: 4.133333\n - label: \"Sint Truiden\"\n lat: 50.8\n lng: 5.183333\n - label: \"Tienen\"\n lat: 50.8\n lng: 4.933333\n - label: \"Tournai\"\n lat: 50.6\n lng: 3.383333\n - label: \"Turnhout\"\n lat: 51.316667\n lng: 4.95\n - label: \"Uccle\"\n lat: 50.8\n lng: 4.333333\n - label: \"Verviers\"\n lat: 50.583333\n lng: 5.85\n - label: \"Vilvoorde\"\n lat: 50.933333\n lng: 4.416667\n - label: \"Waregem\"\n lat: 50.883333\n lng: 3.416667\n - label: \"Wavre\"\n lat: 50.716667\n lng: 4.6\n - label: \"Ypres\"\n lat: 50.85\n lng: 2.883333\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/main/resources/solverConfig.xml",
"content": "\n\n \n \n\n org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution\n org.optaweb.vehiclerouting.plugin.planner.domain.Standstill\n org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit\n\n \n org.optaweb.vehiclerouting.plugin.planner.VehicleRoutingConstraintProvider\n ONLY_DOWN\n \n\n \n FIRST_FIT_DECREASING\n \n \n \n \n \n \n true\n \n \n true\n \n \n \n \n 200\n \n \n 1\n \n \n\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/TestConfig.java",
"content": "package org.optaweb.vehiclerouting;\n\nimport javax.enterprise.context.Dependent;\nimport javax.enterprise.inject.Produces;\n\nimport org.mockito.Mockito;\nimport org.optaweb.vehiclerouting.service.route.RouteListener;\n\nimport com.graphhopper.GraphHopper;\n\nimport io.quarkus.arc.profile.IfBuildProfile;\nimport io.quarkus.test.junit.QuarkusTest;\n\n@Dependent\npublic class TestConfig {\n\n /**\n * Creates a GraphHopper mock that may be used when running a {@link QuarkusTest @QuarkusTest}.\n *\n * @return mock GraphHopper\n */\n @IfBuildProfile(Profiles.TEST)\n @Produces\n public GraphHopper graphHopper() {\n return Mockito.mock(GraphHopper.class);\n }\n\n /**\n * Creates a mock route listener to avoid things like touching database and WebSocket.\n *\n * @return mock RouteListener\n */\n @IfBuildProfile(Profiles.TEST)\n @Produces\n public RouteListener routeListener() {\n return Mockito.mock(RouteListener.class);\n }\n\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/CoordinatesTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.math.BigDecimal;\n\nimport org.junit.jupiter.api.Test;\n\nclass CoordinatesTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new Coordinates(null, BigDecimal.ZERO));\n assertThatNullPointerException().isThrownBy(() -> new Coordinates(BigDecimal.ZERO, null));\n }\n\n @Test\n void coordinates_should_be_equals_when_numerically_equal() {\n Coordinates coordinates = new Coordinates(BigDecimal.valueOf(987.1234), BigDecimal.valueOf(-0.1111));\n assertThat(coordinates).isEqualTo(coordinates);\n\n BigDecimal ONE_POINT_ZERO = new BigDecimal(\"1.0\");\n BigDecimal MINUS_ZERO = BigDecimal.ZERO.negate();\n\n Coordinates coordinates01 = new Coordinates(BigDecimal.ZERO, BigDecimal.ONE);\n assertThat(new Coordinates(MINUS_ZERO, ONE_POINT_ZERO))\n .isEqualTo(coordinates01)\n .hasSameHashCodeAs(coordinates01);\n\n Coordinates coordinates10 = new Coordinates(BigDecimal.ONE, BigDecimal.ZERO);\n assertThat(new Coordinates(ONE_POINT_ZERO, MINUS_ZERO))\n .isEqualTo(coordinates10)\n .hasSameHashCodeAs(coordinates10);\n }\n\n @Test\n void should_not_equal() {\n assertThat(new Coordinates(BigDecimal.ONE, BigDecimal.TEN))\n .isNotEqualTo(null)\n .isNotEqualTo(BigDecimal.valueOf(11))\n .isNotEqualTo(new Coordinates(BigDecimal.ONE, BigDecimal.ONE))\n .isNotEqualTo(new Coordinates(BigDecimal.TEN, BigDecimal.TEN));\n }\n\n @Test\n void valueOf_and_getters() {\n double latitude = Math.E;\n double longitude = Math.PI;\n Coordinates coordinates = Coordinates.of(latitude, longitude);\n assertThat(coordinates.latitude()).isEqualTo(BigDecimal.valueOf(latitude));\n assertThat(coordinates.longitude()).isEqualTo(BigDecimal.valueOf(longitude));\n }\n\n @Test\n void toString_should_contain_latitude_and_longitude() {\n String pi = \"3.14159265358979323846\";\n assertThat(new Coordinates(BigDecimal.ONE, new BigDecimal(pi))).hasToString(\"[1, \" + pi + \"]\");\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/CountryCodeValidatorTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\nimport static org.optaweb.vehiclerouting.domain.CountryCodeValidator.validate;\n\nimport java.util.ArrayList;\nimport java.util.Arrays;\n\nimport org.junit.jupiter.api.Test;\n\nclass CountryCodeValidatorTest {\n\n @Test\n void should_fail_on_invalid_country_codes() {\n assertThatNullPointerException().isThrownBy(() -> validate(null));\n assertThatNullPointerException().isThrownBy(() -> validate(Arrays.asList(\"US\", null, \"CA\")));\n assertThatIllegalArgumentException().isThrownBy(() -> validate(Arrays.asList(\"XX\")));\n assertThatIllegalArgumentException().isThrownBy(() -> validate(Arrays.asList(\"CZE\")));\n assertThatIllegalArgumentException().isThrownBy(() -> validate(Arrays.asList(\"D\")));\n assertThatIllegalArgumentException().isThrownBy(() -> validate(Arrays.asList(\"\")));\n assertThatIllegalArgumentException().isThrownBy(() -> validate(Arrays.asList(\"US\", \"XY\", \"CA\")));\n }\n\n @Test\n void should_ignore_case_and_convert_to_upper_case() {\n assertThat(validate(Arrays.asList(\"us\"))).containsExactly(\"US\");\n }\n\n @Test\n void should_allow_multiple_values() {\n assertThat(validate(Arrays.asList(\"US\", \"ca\"))).containsExactly(\"US\", \"CA\");\n }\n\n @Test\n void should_allow_empty_list() {\n assertThat(validate(new ArrayList<>())).isEmpty();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/DistanceTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatCode;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\n\nimport org.junit.jupiter.api.Test;\n\nclass DistanceTest {\n\n @Test\n void distance_millis_should_be_same_as_the_given_value() {\n long millis = 123_999;\n assertThat(Distance.ofMillis(millis).millis()).isEqualTo(millis);\n }\n\n @Test\n void toString_should_contain_units_and_be_human_readable() {\n assertThat(Distance.ofMillis(3600_000 * 37 + 60_000 * 3 + 24_000)).hasToString(\"37h 3m 24s 0ms\");\n assertThat(Distance.ofMillis(3601_000)).hasToString(\"1h 0m 1s 0ms\");\n assertThat(Distance.ofMillis(5_123)).hasToString(\"0h 0m 5s 123ms\");\n }\n\n @Test\n void time_must_be_positive_or_zero() {\n assertThatIllegalArgumentException().isThrownBy(() -> Distance.ofMillis(-1)).withMessageContaining(\"(-1)\");\n assertThatCode(() -> Distance.ofMillis(0)).doesNotThrowAnyException();\n }\n\n @Test\n void equals_hashCode() {\n long millis = 37;\n Distance distance = Distance.ofMillis(millis);\n assertThat(distance)\n .isEqualTo(distance)\n .isEqualTo(Distance.ofMillis(millis))\n .isNotEqualTo(null)\n .isNotEqualTo(millis)\n .isNotEqualTo(Distance.ofMillis(millis + 1))\n .hasSameHashCodeAs(Distance.ofMillis(millis));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/LocationDataTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.math.BigDecimal;\n\nimport org.junit.jupiter.api.Test;\n\nclass LocationDataTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new LocationData(null, \"\"));\n assertThatNullPointerException().isThrownBy(() -> new LocationData(Coordinates.of(1, 1), null));\n }\n\n @Test\n void locations_are_equal_if_they_have_same_properties() {\n Coordinates coordinates0 = new Coordinates(BigDecimal.ZERO, BigDecimal.ZERO);\n Coordinates coordinates1 = new Coordinates(BigDecimal.ONE, BigDecimal.ONE);\n String description = \"test description\";\n LocationData equalLocationData = new LocationData(coordinates0, description);\n\n final LocationData locationData = new LocationData(coordinates0, description);\n\n assertThat(locationData)\n // different coordinates\n .isNotEqualTo(new LocationData(coordinates1, description))\n // different description\n .isNotEqualTo(new LocationData(coordinates0, \"xyz\"))\n // null\n .isNotEqualTo(null)\n // different type with equal properties\n .isNotEqualTo(new Location(0, coordinates0, description))\n // same object -> OK\n .isEqualTo(locationData)\n // same properties -> OK\n .isEqualTo(equalLocationData)\n // equal objects => same hashCode\n .hasSameHashCodeAs(equalLocationData);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/LocationTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.math.BigDecimal;\n\nimport org.junit.jupiter.api.Test;\n\nclass LocationTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new Location(0, null, \"\"));\n assertThatNullPointerException().isThrownBy(() -> new Location(0, Coordinates.of(1, 1), null));\n }\n\n @Test\n void locations_are_identified_based_on_id() {\n final Coordinates coordinates0 = new Coordinates(BigDecimal.ZERO, BigDecimal.ZERO);\n final Coordinates coordinates1 = new Coordinates(BigDecimal.ONE, BigDecimal.ONE);\n final String description = \"test description\";\n final long id = 0;\n\n final Location location = new Location(id, coordinates0, description);\n\n assertThat(location)\n // different ID\n .isNotEqualTo(new Location(1, coordinates0, description))\n // null\n .isNotEqualTo(null)\n // different class\n .isNotEqualTo(new LocationData(coordinates0, description))\n // same object -> OK\n .isEqualTo(location)\n // same properties -> OK\n .isEqualTo(new Location(id, coordinates0, description))\n // same ID, different coordinate -> OK\n .isEqualTo(new Location(id, coordinates1, description))\n // same ID, different description -> OK\n .isEqualTo(new Location(id, coordinates0, \"xyz\"));\n }\n\n @Test\n void equal_locations_must_have_same_hashcode() {\n long id = 1;\n assertThat(new Location(id, Coordinates.of(1, 1), \"description 1\"))\n .hasSameHashCodeAs(new Location(id, Coordinates.of(2, 2), \"description 2\"));\n }\n\n @Test\n void constructor_without_description_should_create_empty_description() {\n assertThat(new Location(7, Coordinates.of(3.14, 4.13)).description()).isEmpty();\n }\n\n @Test\n void toString_should_contain_id_and_description() {\n Coordinates coordinates = Coordinates.of(1, 1);\n\n assertThat(new Location(7, coordinates, \"\")).hasToString(\"7\");\n assertThat(new Location(5, coordinates, \"home\")).hasToString(\"5: 'home'\");\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/RouteTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThatExceptionOfType;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Collections;\nimport java.util.List;\n\nimport org.junit.jupiter.api.Test;\n\nclass RouteTest {\n\n private final Vehicle vehicle = VehicleFactory.testVehicle(4);\n private final Location depot = new Location(1, Coordinates.of(5, 5));\n private final Location visit1 = new Location(2, Coordinates.of(5, 5));\n private final Location visit2 = new Location(3, Coordinates.of(5, 5));\n\n @Test\n void constructor_args_not_null() {\n assertThatNullPointerException().isThrownBy(() -> new Route(null, depot, Collections.emptyList()));\n assertThatNullPointerException().isThrownBy(() -> new Route(vehicle, null, Collections.emptyList()));\n assertThatNullPointerException().isThrownBy(() -> new Route(vehicle, depot, null));\n }\n\n @Test\n void visits_should_not_contain_depot() {\n assertThatIllegalArgumentException()\n .isThrownBy(() -> new Route(vehicle, depot, Arrays.asList(depot, visit1)))\n .withMessageContaining(depot.toString());\n assertThatIllegalArgumentException()\n .isThrownBy(() -> new Route(vehicle, depot, Arrays.asList(visit1, depot, visit2)))\n .withMessageContaining(depot.toString());\n }\n\n @Test\n void no_visit_should_be_visited_twice_by_the_same_vehicle() {\n assertThatIllegalArgumentException()\n .isThrownBy(() -> new Route(vehicle, depot, Arrays.asList(visit1, visit1)))\n .withMessageContaining(\"(1)\");\n }\n\n @Test\n void cannot_modify_visits_externally() {\n ArrayList visits = new ArrayList<>();\n visits.add(visit1);\n List routeVisits = new Route(vehicle, depot, visits).visits();\n\n assertThatExceptionOfType(UnsupportedOperationException.class)\n .isThrownBy(routeVisits::clear);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/RouteWithTrackTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static java.util.Collections.emptyList;\nimport static org.assertj.core.api.Assertions.assertThatExceptionOfType;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.List;\n\nimport org.junit.jupiter.api.Test;\n\nclass RouteWithTrackTest {\n\n private final Vehicle vehicle = VehicleFactory.testVehicle(4);\n private final Location depot = new Location(1, Coordinates.of(5, 5));\n private final Location visit1 = new Location(2, Coordinates.of(5, 5));\n private final Location visit2 = new Location(3, Coordinates.of(5, 5));\n\n @Test\n void constructor_args_not_null() {\n Route route = new Route(vehicle, depot, emptyList());\n assertThatNullPointerException().isThrownBy(() -> new RouteWithTrack(route, null));\n assertThatNullPointerException().isThrownBy(() -> new RouteWithTrack(null, emptyList()));\n }\n\n @Test\n void cannot_modify_track_externally() {\n Route route = new Route(vehicle, depot, Arrays.asList(visit1, visit2));\n ArrayList> track = new ArrayList<>();\n track.add(Arrays.asList(Coordinates.of(1.0, 2.0)));\n\n List> routeTrack = new RouteWithTrack(route, track).track();\n assertThatExceptionOfType(UnsupportedOperationException.class)\n .isThrownBy(routeTrack::clear);\n }\n\n @Test\n void when_route_is_empty_track_must_be_empty() {\n Route emptyRoute = new Route(vehicle, depot, emptyList());\n ArrayList> track = new ArrayList<>();\n track.add(Arrays.asList(Coordinates.of(1.0, 2.0)));\n\n assertThatIllegalArgumentException().isThrownBy(() -> new RouteWithTrack(emptyRoute, track));\n }\n\n @Test\n void when_route_is_nonempty_track_must_be_nonempty() {\n Route route = new Route(vehicle, depot, Arrays.asList(visit1, visit2));\n ArrayList> emptyTrack = new ArrayList<>();\n\n assertThatIllegalArgumentException().isThrownBy(() -> new RouteWithTrack(route, emptyTrack));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/RoutingPlanTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static java.util.Arrays.asList;\nimport static java.util.Collections.emptyList;\nimport static java.util.Collections.singletonList;\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatCode;\nimport static org.assertj.core.api.Assertions.assertThatExceptionOfType;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.util.ArrayList;\nimport java.util.List;\n\nimport org.junit.jupiter.api.Test;\n\nclass RoutingPlanTest {\n\n private final Distance distance = Distance.ofMillis(1);\n private final Vehicle vehicle = VehicleFactory.testVehicle(1);\n private final List vehicles = singletonList(vehicle);\n private final Location depot = new Location(1, Coordinates.of(5, 5));\n private final Location visit = new Location(2, Coordinates.of(3, 3));\n private final RouteWithTrack emptyRoute = new RouteWithTrack(new Route(vehicle, depot, emptyList()), emptyList());\n // Track is not important (we don't check if track starts and ends in the depot and goes through all visits)\n private final List> nonEmptyTrack = singletonList(singletonList(Coordinates.of(5, 5)));\n\n @Test\n void constructor_args_not_null() {\n assertThatNullPointerException()\n .isThrownBy(() -> new RoutingPlan(null, vehicles, depot, emptyList(), emptyList()));\n assertThatNullPointerException()\n .isThrownBy(() -> new RoutingPlan(distance, null, depot, emptyList(), emptyList()));\n assertThatNullPointerException()\n .isThrownBy(() -> new RoutingPlan(distance, vehicles, depot, null, emptyList()));\n assertThatNullPointerException()\n .isThrownBy(() -> new RoutingPlan(distance, vehicles, depot, emptyList(), null));\n // depot can be null\n // TODO create a factory that will prevent passing a null depot accidentally\n }\n\n @Test\n void no_visits_without_a_depot() {\n List> track = singletonList(singletonList(visit.coordinates()));\n RouteWithTrack routeWithTrack = new RouteWithTrack(new Route(vehicle, depot, singletonList(visit)), track);\n assertThatIllegalArgumentException().isThrownBy(() -> new RoutingPlan(\n distance, vehicles, null, singletonList(visit), singletonList(routeWithTrack)));\n }\n\n @Test\n void no_routes_without_a_depot() {\n assertThatIllegalArgumentException()\n .isThrownBy(() -> new RoutingPlan(distance, vehicles, null, emptyList(), singletonList(emptyRoute)));\n }\n\n @Test\n void there_must_be_one_route_per_vehicle_when_there_is_a_depot() {\n assertThatIllegalArgumentException()\n .isThrownBy(() -> new RoutingPlan(distance, vehicles, depot, emptyList(), emptyList()))\n .withMessageContaining(\"Vehicles (1): [\")\n .withMessageContaining(\"Routes' vehicleIds (0): []\");\n }\n\n @Test\n void routes_vehicle_references_must_be_consistent_with_vehicles_in_routing_plan() {\n List unexpectedVehicles = singletonList(VehicleFactory.testVehicle(vehicle.id() + 1));\n List routes = singletonList(emptyRoute);\n assertThatIllegalArgumentException()\n .isThrownBy(() -> new RoutingPlan(distance, unexpectedVehicles, depot, emptyList(), routes))\n .withMessageContaining(\"Vehicles (1): [\")\n .withMessageContaining(\"Routes' vehicleIds (1): [\" + vehicle.id() + \"]\");\n }\n\n @Test\n void routes_visit_references_must_be_consistent_with_visits_in_routing_plan() {\n Vehicle vehicle1 = VehicleFactory.testVehicle(1);\n Vehicle vehicle2 = VehicleFactory.testVehicle(2);\n\n Location depot = new Location(100, Coordinates.of(0, 0), \"depot\");\n Location visit1 = new Location(101, Coordinates.of(1, 1), \"visit1\");\n Location visit2 = new Location(102, Coordinates.of(2, 2), \"visit2\");\n Location visit3 = new Location(103, Coordinates.of(3, 3), \"visit3\");\n\n assertThatCode(() -> new RoutingPlan(\n distance,\n emptyList(), // no vehicles\n depot,\n singletonList(visit1),\n emptyList() // => no routes (no visits visited)\n )).doesNotThrowAnyException();\n\n assertThatIllegalArgumentException().isThrownBy(() -> new RoutingPlan(\n distance,\n singletonList(vehicle1),\n depot,\n asList(visit1, visit2),\n singletonList(\n // visit3 extra\n new RouteWithTrack(new Route(vehicle1, depot, asList(visit1, visit2, visit3)), nonEmptyTrack))))\n .withMessageContaining(visit3.toString());\n\n Location visit4 = new Location(104, Coordinates.of(4, 4), \"visit4\");\n assertThatIllegalArgumentException().isThrownBy(() -> new RoutingPlan(\n distance,\n asList(vehicle1, vehicle2),\n depot,\n asList(visit1, visit2, visit3),\n // visit3 missing, visit4 extra\n asList(\n new RouteWithTrack(new Route(vehicle1, depot, asList(visit1, visit4)), nonEmptyTrack),\n new RouteWithTrack(new Route(vehicle2, depot, singletonList(visit2)), nonEmptyTrack))))\n .withMessageContaining(visit4.toString());\n }\n\n @Test\n void cannot_modify_collections_externally() {\n // Use modifiable collections as the input\n ArrayList vehicles = new ArrayList<>();\n ArrayList visits = new ArrayList<>();\n ArrayList routes = new ArrayList<>();\n vehicles.add(vehicle);\n visits.add(visit);\n routes.add(new RouteWithTrack(new Route(vehicle, depot, singletonList(visit)), nonEmptyTrack));\n\n RoutingPlan routingPlan = new RoutingPlan(distance, vehicles, depot, visits, routes);\n List planVehicles = routingPlan.vehicles();\n List planVisits = routingPlan.visits();\n List planRoutes = routingPlan.routes();\n\n assertThatExceptionOfType(UnsupportedOperationException.class).isThrownBy(planVehicles::clear);\n assertThatExceptionOfType(UnsupportedOperationException.class).isThrownBy(planVisits::clear);\n assertThatExceptionOfType(UnsupportedOperationException.class).isThrownBy(planRoutes::clear);\n }\n\n @Test\n void empty_routing_plan_should_be_empty() {\n RoutingPlan empty = RoutingPlan.empty();\n assertThat(empty.distance()).isEqualTo(Distance.ZERO);\n assertThat(empty.vehicles()).isEmpty();\n assertThat(empty.depot()).isEmpty();\n assertThat(empty.visits()).isEmpty();\n assertThat(empty.routes()).isEmpty();\n }\n\n @Test\n void isEmpty() {\n assertThat(RoutingPlan.empty().isEmpty()).isTrue();\n assertThat(new RoutingPlan(Distance.ZERO, emptyList(), depot, emptyList(), emptyList()).isEmpty()).isFalse();\n assertThat(new RoutingPlan(Distance.ZERO, vehicles, null, emptyList(), emptyList()).isEmpty()).isFalse();\n assertThat(new RoutingPlan(Distance.ZERO, vehicles, depot, emptyList(), singletonList(emptyRoute)).isEmpty())\n .isFalse();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/VehicleDataTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport org.junit.jupiter.api.Test;\n\nclass VehicleDataTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new VehicleData(null, 1));\n }\n\n @Test\n void vehicles_are_equal_if_they_have_same_properties() {\n String name = \"vehicle name\";\n int capacity = 20;\n\n VehicleData vehicleData = new VehicleData(name, capacity);\n\n assertThat(vehicleData)\n // different name\n .isNotEqualTo(new VehicleData(\"\", capacity))\n // different capacity\n .isNotEqualTo(new VehicleData(name, capacity + 1))\n // null\n .isNotEqualTo(null)\n // different type with equal properties\n .isNotEqualTo(new Vehicle(0, name, capacity))\n // same object -> OK\n .isEqualTo(vehicleData)\n // same properties -> OK\n .isEqualTo(new VehicleData(name, capacity));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/VehicleFactoryTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\n\nimport org.junit.jupiter.api.Test;\n\nclass VehicleFactoryTest {\n\n @Test\n void createVehicle() {\n long vehicleId = 4;\n String name = \"Vehicle four\";\n int capacity = 99;\n\n Vehicle vehicle = VehicleFactory.createVehicle(vehicleId, name, capacity);\n\n assertThat(vehicle.id()).isEqualTo(vehicleId);\n assertThat(vehicle.name()).isEqualTo(name);\n assertThat(vehicle.capacity()).isEqualTo(capacity);\n }\n\n @Test\n void vehicleData() {\n String name = \"vehicle name\";\n int capacity = 1000;\n\n VehicleData vehicleData = VehicleFactory.vehicleData(name, capacity);\n assertThat(vehicleData.name()).isEqualTo(name);\n assertThat(vehicleData.capacity()).isEqualTo(capacity);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/domain/VehicleTest.java",
"content": "package org.optaweb.vehiclerouting.domain;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport org.junit.jupiter.api.Test;\n\nclass VehicleTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new Vehicle(0, null, 0));\n }\n\n @Test\n void vehicles_are_identified_based_on_id() {\n final long id = 0;\n final String description = \"test description\";\n final int capacity = 1;\n final Vehicle vehicle = new Vehicle(id, description, capacity);\n\n assertThat(vehicle)\n // different ID\n .isNotEqualTo(new Vehicle(id + 1, description, capacity))\n // null\n .isNotEqualTo(null)\n // different class\n .isNotEqualTo(id)\n // same object -> OK\n .isEqualTo(vehicle)\n // same properties -> OK\n .isEqualTo(new Vehicle(id, description, capacity))\n // same ID, different description -> OK\n .isEqualTo(new Vehicle(id, description + \"x\", capacity))\n // same ID, different capacity -> OK\n .isEqualTo(new Vehicle(id, description, capacity + 1));\n }\n\n @Test\n void equal_vehicles_must_have_same_hashcode() {\n long id = 1;\n assertThat(new Vehicle(id, \"description 1\", 1))\n .hasSameHashCodeAs(new Vehicle(id, \"description 2\", 2));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceEntityTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport org.junit.jupiter.api.Test;\n\nclass DistanceEntityTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n DistanceKey dKey = new DistanceKey(1, 2);\n assertThatNullPointerException().isThrownBy(() -> new DistanceEntity(null, 100L));\n assertThatNullPointerException().isThrownBy(() -> new DistanceEntity(dKey, null));\n }\n\n @Test\n void equals() {\n final long from = 10;\n final long to = 2000;\n final DistanceKey distanceKey = new DistanceKey(from, to);\n final long distance = 50001;\n\n DistanceEntity distanceEntity = new DistanceEntity(distanceKey, distance);\n assertThat(distanceEntity)\n .isEqualTo(distanceEntity)\n .isEqualTo(new DistanceEntity(new DistanceKey(from, to), distance))\n .isNotEqualTo(null)\n .isNotEqualTo(distanceKey)\n .isNotEqualTo(new DistanceEntity(distanceKey, distance + 1))\n .isNotEqualTo(new DistanceEntity(new DistanceKey(to, from), distance));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceRepositoryImplTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.mockito.ArgumentMatchers.any;\nimport static org.mockito.Mockito.verify;\nimport static org.mockito.Mockito.when;\n\nimport java.util.Optional;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.ArgumentCaptor;\nimport org.mockito.Captor;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\n\n@ExtendWith(MockitoExtension.class)\nclass DistanceRepositoryImplTest {\n\n @Mock\n private DistanceCrudRepository crudRepository;\n @InjectMocks\n private DistanceRepositoryImpl repository;\n @Captor\n private ArgumentCaptor distanceEntityArgumentCaptor;\n\n private final Location from = new Location(1, Coordinates.of(7, -4.0));\n private final Location to = new Location(2, Coordinates.of(5, 9.0));\n\n @Test\n void should_save_distance() {\n long distance = 956766417;\n repository.saveDistance(from, to, Distance.ofMillis(distance));\n verify(crudRepository).persist(distanceEntityArgumentCaptor.capture());\n DistanceEntity distanceEntity = distanceEntityArgumentCaptor.getValue();\n assertThat(distanceEntity.getDistance()).isEqualTo(distance);\n assertThat(distanceEntity.getKey().getFromId()).isEqualTo(from.id());\n assertThat(distanceEntity.getKey().getToId()).isEqualTo(to.id());\n }\n\n @Test\n void should_return_distance_when_entity_is_found() {\n DistanceKey distanceKey = new DistanceKey(from.id(), to.id());\n long distance = 10305;\n DistanceEntity distanceEntity = new DistanceEntity(distanceKey, distance);\n when(crudRepository.findByIdOptional(distanceKey)).thenReturn(Optional.of(distanceEntity));\n assertThat(repository.getDistance(from, to)).contains(Distance.ofMillis(distance));\n }\n\n @Test\n void should_return_negative_number_when_distance_not_found() {\n when(crudRepository.findByIdOptional(any(DistanceKey.class))).thenReturn(Optional.empty());\n assertThat(repository.getDistance(from, to)).isEmpty();\n }\n\n @Test\n void should_delete_distance_by_location_id() {\n repository.deleteDistances(from);\n verify(crudRepository).deleteByFromIdOrToId(from.id());\n }\n\n @Test\n void should_delete_all_distances() {\n repository.deleteAll();\n verify(crudRepository).deleteAll();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/DistanceRepositoryIntegrationTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\n\nimport javax.inject.Inject;\n\nimport org.junit.jupiter.api.BeforeEach;\nimport org.junit.jupiter.api.Test;\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\n\nimport io.quarkus.test.TestTransaction;\nimport io.quarkus.test.junit.QuarkusTest;\n\n@QuarkusTest\nclass DistanceRepositoryIntegrationTest {\n\n @Inject\n DistanceCrudRepository crudRepository;\n\n private DistanceRepositoryImpl repository;\n\n @BeforeEach\n void setUp() {\n repository = new DistanceRepositoryImpl(crudRepository);\n }\n\n @Test\n @TestTransaction\n void panache_repository_should_persist_and_delete_distances() {\n DistanceKey key = new DistanceKey(1, 2);\n DistanceEntity entity = new DistanceEntity(key, 730107L);\n\n crudRepository.persist(entity);\n\n assertThat(crudRepository.count()).isOne();\n assertThat(crudRepository.findById(key)).isEqualTo(entity);\n\n crudRepository.deleteById(key);\n assertThat(crudRepository.count()).isZero();\n }\n\n static DistanceEntity distance(long fromId, long toId) {\n return new DistanceEntity(new DistanceKey(fromId, toId), 1L);\n }\n\n @Test\n @TestTransaction\n void delete_by_fromId_or_toId() {\n DistanceEntity distance23 = distance(2, 3);\n DistanceEntity distance32 = distance(3, 2);\n\n crudRepository.persist(distance(1, 2));\n crudRepository.persist(distance(2, 1));\n crudRepository.persist(distance23);\n crudRepository.persist(distance32);\n crudRepository.persist(distance(3, 1));\n crudRepository.persist(distance(1, 3));\n\n assertThat(crudRepository.count()).isEqualTo(6);\n crudRepository.deleteByFromIdOrToId(1L);\n assertThat(crudRepository.count()).isEqualTo(2);\n assertThat(crudRepository.findAll().stream()).containsExactly(distance23, distance32);\n }\n\n @Test\n @TestTransaction\n void should_return_saved_distance() {\n Location location1 = new Location(1, Coordinates.of(7, -4.0));\n Location location2 = new Location(2, Coordinates.of(5, 9.0));\n\n Distance distance = Distance.ofMillis(956766417);\n repository.saveDistance(location1, location2, distance);\n assertThat(repository.getDistance(location1, location2)).contains(distance);\n }\n\n @Test\n void should_return_negative_number_when_distance_not_found() {\n Location location1 = new Location(1, Coordinates.of(7, -4.0));\n Location location2 = new Location(2, Coordinates.of(5, 9.0));\n\n assertThat(repository.getDistance(location1, location2)).isEmpty();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/LocationEntityTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport java.math.BigDecimal;\n\nimport org.junit.jupiter.api.Test;\n\nclass LocationEntityTest {\n\n @Test\n void constructor_params_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new LocationEntity(0, null, BigDecimal.ZERO, \"\"));\n assertThatNullPointerException().isThrownBy(() -> new LocationEntity(0, BigDecimal.ZERO, null, \"\"));\n assertThatNullPointerException().isThrownBy(() -> new LocationEntity(0, BigDecimal.ZERO, BigDecimal.ONE, null));\n }\n\n @Test\n void getters() {\n int id = 10;\n BigDecimal latitude = BigDecimal.valueOf(0.101);\n BigDecimal longitude = BigDecimal.valueOf(101.0);\n String description = \"Description.\";\n LocationEntity locationEntity = new LocationEntity(id, latitude, longitude, description);\n assertThat(locationEntity.getId()).isEqualTo(id);\n assertThat(locationEntity.getLongitude()).isEqualTo(longitude);\n assertThat(locationEntity.getLatitude()).isEqualTo(latitude);\n assertThat(locationEntity.getDescription()).isEqualTo(description);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/LocationRepositoryImplTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.mockito.ArgumentMatchers.anyLong;\nimport static org.mockito.Mockito.verify;\nimport static org.mockito.Mockito.when;\n\nimport java.util.Optional;\nimport java.util.stream.Stream;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.ArgumentCaptor;\nimport org.mockito.Captor;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\n\n@ExtendWith(MockitoExtension.class)\nclass LocationRepositoryImplTest {\n\n @Mock\n private LocationCrudRepository crudRepository;\n @InjectMocks\n private LocationRepositoryImpl repository;\n @Captor\n private ArgumentCaptor locationEntityCaptor;\n\n private final Location testLocation = new Location(76, Coordinates.of(1.2, 3.4), \"description\");\n\n private static LocationEntity locationEntity(Location location) {\n return new LocationEntity(\n location.id(),\n location.coordinates().latitude(),\n location.coordinates().longitude(),\n location.description());\n }\n\n @Test\n void should_create_location() {\n // arrange\n Coordinates savedCoordinates = Coordinates.of(0.00213, 32.777);\n String savedDescription = \"new location\";\n\n // act\n Location newLocation = repository.createLocation(savedCoordinates, savedDescription);\n\n // assert\n // -- the correct values were used to save the entity\n verify(crudRepository).persist(locationEntityCaptor.capture());\n LocationEntity savedLocation = locationEntityCaptor.getValue();\n assertThat(savedLocation.getLatitude()).isEqualTo(savedCoordinates.latitude());\n assertThat(savedLocation.getLongitude()).isEqualTo(savedCoordinates.longitude());\n assertThat(savedLocation.getDescription()).isEqualTo(savedDescription);\n\n // -- created domain location has the expected values\n assertThat(newLocation.coordinates()).isEqualTo(savedCoordinates);\n assertThat(newLocation.description()).isEqualTo(savedDescription);\n }\n\n @Test\n void remove_created_location_by_id() {\n LocationEntity locationEntity = locationEntity(testLocation);\n final long id = testLocation.id();\n when(crudRepository.findByIdOptional(id)).thenReturn(Optional.of(locationEntity));\n\n Location removed = repository.removeLocation(id);\n assertThat(removed).isEqualTo(testLocation);\n verify(crudRepository).deleteById(id);\n }\n\n @Test\n void removing_nonexistent_location_should_fail() {\n when(crudRepository.findByIdOptional(anyLong())).thenReturn(Optional.empty());\n\n // removing nonexistent location should fail and its ID should appear in the exception message\n int uniqueNonexistentId = 7173;\n assertThatIllegalArgumentException()\n .isThrownBy(() -> repository.removeLocation(uniqueNonexistentId))\n .withMessageContaining(String.valueOf(uniqueNonexistentId));\n }\n\n @Test\n void remove_all_locations() {\n repository.removeAll();\n verify(crudRepository).deleteAll();\n }\n\n @Test\n void get_all_locations() {\n LocationEntity locationEntity = locationEntity(testLocation);\n when(crudRepository.streamAll()).thenReturn(Stream.of(locationEntity));\n assertThat(repository.locations()).containsExactly(testLocation);\n }\n\n @Test\n void find_by_id() {\n LocationEntity locationEntity = locationEntity(testLocation);\n when(crudRepository.findByIdOptional(testLocation.id())).thenReturn(Optional.of(locationEntity));\n assertThat(repository.find(testLocation.id())).contains(testLocation);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/LocationRepositoryIntegrationTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\n\nimport java.math.BigDecimal;\n\nimport javax.inject.Inject;\n\nimport org.junit.jupiter.api.BeforeEach;\nimport org.junit.jupiter.api.Test;\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Location;\n\nimport io.quarkus.test.TestTransaction;\nimport io.quarkus.test.junit.QuarkusTest;\n\n@QuarkusTest\nclass LocationRepositoryIntegrationTest {\n\n @Inject\n LocationCrudRepository crudRepository;\n private LocationRepositoryImpl repository;\n\n @BeforeEach\n void setUp() {\n repository = new LocationRepositoryImpl(crudRepository);\n }\n\n @Test\n @TestTransaction\n void db_schema() {\n // https://wiki.openstreetmap.org/wiki/Node#Structure\n final BigDecimal maxLatitude = new BigDecimal(\"90.0000000\");\n final BigDecimal maxLongitude = new BigDecimal(\"214.7483647\");\n final BigDecimal minLatitude = maxLatitude.negate();\n final BigDecimal minLongitude = maxLongitude.negate();\n final String description = \"...\";\n\n LocationEntity minLocation = new LocationEntity(0, minLatitude, minLongitude, description);\n LocationEntity maxLocation = new LocationEntity(0, maxLatitude, maxLongitude, description);\n crudRepository.persist(minLocation);\n crudRepository.persist(maxLocation);\n assertThat(minLocation.getId()).isNotZero();\n assertThat(maxLocation.getId()).isNotZero();\n\n assertThat(crudRepository.findById(minLocation.getId())).isEqualTo(minLocation);\n assertThat(crudRepository.findById(maxLocation.getId())).isEqualTo(maxLocation);\n }\n\n @Test\n @TestTransaction\n void remove_created_location() {\n Coordinates coordinates = Coordinates.of(0.00213, 32.777);\n assertThat(crudRepository.count()).isZero();\n Location location = repository.createLocation(coordinates, \"\");\n assertThat(location.coordinates()).isEqualTo(coordinates);\n assertThat(crudRepository.count()).isOne();\n\n Location removed = repository.removeLocation(location.id());\n assertThat(removed).isEqualTo(location);\n\n // removing the same location twice should fail\n assertThatIllegalArgumentException().isThrownBy(() -> repository.removeLocation(location.id()));\n\n // removing nonexistent location should fail and its ID should appear in the exception message\n int uniqueNonexistentId = 7173;\n assertThatIllegalArgumentException().isThrownBy(() -> repository.removeLocation(uniqueNonexistentId))\n .withMessageContaining(String.valueOf(uniqueNonexistentId));\n }\n\n @Test\n @TestTransaction\n void get_and_remove_all_locations() {\n int locationCount = 8;\n for (int i = 0; i < locationCount; i++) {\n repository.createLocation(Coordinates.of(1.0, i / 100.0), \"\");\n }\n\n assertThat(crudRepository.count()).isEqualTo(locationCount);\n\n // get a sample location entity from the repository\n LocationEntity testEntity = crudRepository\n .findByIdOptional((long) locationCount)\n .orElseThrow(IllegalStateException::new);\n Location testLocation = new Location(\n testEntity.getId(),\n new Coordinates(testEntity.getLatitude(), testEntity.getLongitude()));\n\n assertThat(repository.locations())\n .hasSize(locationCount)\n .contains(testLocation);\n\n repository.removeAll();\n assertThat(crudRepository.count()).isZero();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/VehicleEntityTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\n\nimport org.junit.jupiter.api.Test;\n\nclass VehicleEntityTest {\n\n @Test\n void getters() {\n long id = 321;\n String name = \"Vehicle XY\";\n int capacity = 11;\n VehicleEntity vehicleEntity = new VehicleEntity(id, name, capacity);\n assertThat(vehicleEntity.getId()).isEqualTo(id);\n assertThat(vehicleEntity.getName()).isEqualTo(name);\n assertThat(vehicleEntity.getCapacity()).isEqualTo(capacity);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/persistence/VehicleRepositoryImplTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.persistence;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.mockito.ArgumentMatchers.anyLong;\nimport static org.mockito.Mockito.verify;\nimport static org.mockito.Mockito.when;\n\nimport java.util.Optional;\nimport java.util.stream.Stream;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.ArgumentCaptor;\nimport org.mockito.Captor;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.domain.VehicleData;\nimport org.optaweb.vehiclerouting.domain.VehicleFactory;\n\n@ExtendWith(MockitoExtension.class)\nclass VehicleRepositoryImplTest {\n\n @Mock\n private VehicleCrudRepository crudRepository;\n @InjectMocks\n private VehicleRepositoryImpl repository;\n @Captor\n private ArgumentCaptor vehicleEntityCaptor;\n\n private final Vehicle testVehicle = VehicleFactory.createVehicle(19, \"vehicle name\", 1100);\n\n private static VehicleEntity vehicleEntity(Vehicle vehicle) {\n return new VehicleEntity(vehicle.id(), vehicle.name(), vehicle.capacity());\n }\n\n @Test\n void should_create_vehicle() {\n // arrange\n int savedCapacity = 1;\n\n // act\n Vehicle newVehicle = repository.createVehicle(savedCapacity);\n\n // assert\n // -- the correct values were used to save the entity\n verify(crudRepository).persist(vehicleEntityCaptor.capture());\n VehicleEntity savedVehicle = vehicleEntityCaptor.getValue();\n assertThat(savedVehicle.getName()).isNotNull();\n assertThat(savedVehicle.getCapacity()).isEqualTo(savedCapacity);\n\n // -- created domain vehicle has the expected values\n assertThat(newVehicle.name()).isNotNull();\n assertThat(newVehicle.capacity()).isEqualTo(savedCapacity);\n }\n\n @Test\n void create_vehicle_from_given_data() {\n // arrange\n String name = \"x\";\n int capacity = 111;\n VehicleData vehicleData = VehicleFactory.vehicleData(name, capacity);\n\n // act\n Vehicle newVehicle = repository.createVehicle(vehicleData);\n\n // assert\n assertThat(newVehicle.name()).isEqualTo(name);\n assertThat(newVehicle.capacity()).isEqualTo(capacity);\n }\n\n @Test\n void remove_created_vehicle_by_id() {\n VehicleEntity vehicleEntity = vehicleEntity(testVehicle);\n final long id = testVehicle.id();\n when(crudRepository.findByIdOptional(id)).thenReturn(Optional.of(vehicleEntity));\n\n Vehicle removed = repository.removeVehicle(id);\n assertThat(removed).isEqualTo(testVehicle);\n verify(crudRepository).deleteById(id);\n }\n\n @Test\n void removing_nonexistent_vehicle_should_fail() {\n when(crudRepository.findByIdOptional(anyLong())).thenReturn(Optional.empty());\n\n // removing nonexistent vehicle should fail and its ID should appear in the exception message\n int uniqueNonexistentId = 7173;\n assertThatIllegalArgumentException()\n .isThrownBy(() -> repository.removeVehicle(uniqueNonexistentId))\n .withMessageContaining(String.valueOf(uniqueNonexistentId));\n }\n\n @Test\n void remove_all_vehicles() {\n repository.removeAll();\n verify(crudRepository).deleteAll();\n }\n\n @Test\n void get_all_vehicles() {\n VehicleEntity vehicleEntity = vehicleEntity(testVehicle);\n when(crudRepository.streamAll()).thenReturn(Stream.of(vehicleEntity));\n assertThat(repository.vehicles()).containsExactly(testVehicle);\n }\n\n @Test\n void find_by_id() {\n VehicleEntity vehicleEntity = vehicleEntity(testVehicle);\n when(crudRepository.findByIdOptional(testVehicle.id())).thenReturn(Optional.of(vehicleEntity));\n assertThat(repository.find(testVehicle.id())).contains(testVehicle);\n }\n\n @Test\n void update() {\n long vehicleId = 123;\n String name = \"xy\";\n int capacity = 80;\n\n VehicleEntity vehicleEntity = new VehicleEntity(vehicleId, name, capacity - 10);\n when(crudRepository.findByIdOptional(vehicleId)).thenReturn(Optional.of(vehicleEntity));\n\n Vehicle vehicle = repository.changeCapacity(vehicleId, capacity);\n verify(crudRepository).flush();\n\n assertThat(vehicleEntity.getCapacity()).isEqualTo(capacity);\n\n assertThat(vehicle.id()).isEqualTo(vehicleId);\n assertThat(vehicle.name()).isEqualTo(name);\n assertThat(vehicle.capacity()).isEqualTo(capacity);\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/DistanceMapImplTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatNullPointerException;\n\nimport org.junit.jupiter.api.Test;\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocation;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory;\nimport org.optaweb.vehiclerouting.service.location.DistanceMatrixRow;\n\nclass DistanceMapImplTest {\n\n @Test\n void matrix_row_must_not_be_null() {\n assertThatNullPointerException().isThrownBy(() -> new DistanceMapImpl(null));\n }\n\n @Test\n void distance_map_should_return_value_from_distance_matrix_row() {\n PlanningLocation location2 = PlanningLocationFactory.testLocation(2);\n Distance distance = Distance.ofMillis(45000);\n DistanceMatrixRow matrixRow = locationId -> distance;\n DistanceMapImpl distanceMap = new DistanceMapImpl(matrixRow);\n assertThat(distanceMap.distanceTo(location2)).isEqualTo(distance.millis());\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/MockSolver.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.mockito.ArgumentMatchers.any;\nimport static org.mockito.ArgumentMatchers.eq;\nimport static org.mockito.ArgumentMatchers.same;\nimport static org.mockito.Mockito.verify;\n\nimport org.mockito.Mockito;\nimport org.optaplanner.core.api.solver.change.ProblemChange;\nimport org.optaplanner.test.api.solver.change.MockProblemChangeDirector;\n\npublic class MockSolver {\n\n private final Solution_ workingSolution;\n private final MockProblemChangeDirector changeDirector;\n\n public static MockSolver build(Solution_ solution) {\n MockProblemChangeDirector spy = Mockito.spy(new MockProblemChangeDirector());\n return new MockSolver<>(solution, spy);\n }\n\n private MockSolver(Solution_ workingSolution, MockProblemChangeDirector changeDirector) {\n this.workingSolution = workingSolution;\n this.changeDirector = changeDirector;\n }\n\n // ************************************************************************\n // Problem change API from Solver.\n // ************************************************************************\n\n public void addProblemChange(ProblemChange problemChange) {\n problemChange.doChange(workingSolution, changeDirector);\n }\n\n // ************************************************************************\n // Lookup API from MockProblemChangeDirector.\n // ************************************************************************\n\n public MockProblemChangeDirector.LookUpMockBuilder whenLookingUp(Object forObject) {\n return changeDirector.whenLookingUp(forObject);\n }\n\n // ************************************************************************\n // Simplified verification API.\n // ************************************************************************\n\n public void verifyEntityAdded(Object entity) {\n verify(changeDirector).addEntity(same(entity), any());\n }\n\n public void verifyEntityRemoved(Object entity) {\n verify(changeDirector).removeEntity(same(entity), any());\n }\n\n public void verifyVariableChanged(Object entity, String variableName) {\n verify(changeDirector).changeVariable(same(entity), eq(variableName), any());\n }\n\n public void verifyProblemFactAdded(Object fact) {\n verify(changeDirector).addProblemFact(same(fact), any());\n }\n\n public void verifyProblemFactRemoved(Object fact) {\n verify(changeDirector).removeProblemFact(same(fact), any());\n }\n\n public void verifyProblemPropertyChanged(Object entityOrFact) {\n verify(changeDirector).changeProblemProperty(same(entityOrFact), any());\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/RouteChangedEventPublisherTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static java.util.Arrays.asList;\nimport static java.util.Collections.emptyList;\nimport static java.util.Collections.singletonList;\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.mockito.ArgumentMatchers.any;\nimport static org.mockito.Mockito.verify;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory.testLocation;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory.testVehicle;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory.testVisit;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory.solutionFromVisits;\n\nimport javax.enterprise.event.Event;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore;\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.optaweb.vehiclerouting.service.route.RouteChangedEvent;\nimport org.optaweb.vehiclerouting.service.route.ShallowRoute;\n\n@ExtendWith(MockitoExtension.class)\nclass RouteChangedEventPublisherTest {\n\n @Mock\n private Event publisher;\n @InjectMocks\n private RouteChangedEventPublisher routeChangedEventPublisher;\n\n @Test\n void should_covert_solution_to_event_and_publish_it() {\n routeChangedEventPublisher.publishSolution(SolutionFactory.emptySolution());\n verify(publisher).fire(any(RouteChangedEvent.class));\n }\n\n @Test\n void empty_solution_should_have_zero_routes_vehicles_etc() {\n VehicleRoutingSolution solution = SolutionFactory.emptySolution();\n\n RouteChangedEvent event = RouteChangedEventPublisher.solutionToEvent(solution, this);\n\n assertThat(event.vehicleIds()).isEmpty();\n assertThat(event.depotId()).isEmpty();\n assertThat(event.visitIds()).isEmpty();\n assertThat(event.routes()).isEmpty();\n assertThat(event.distance()).isEqualTo(Distance.ZERO);\n }\n\n @Test\n void solution_with_vehicles_and_no_depot_should_have_zero_routes() {\n long vehicleId = 1;\n PlanningVehicle vehicle = testVehicle(vehicleId);\n VehicleRoutingSolution solution = solutionFromVisits(singletonList(vehicle), null, emptyList());\n\n RouteChangedEvent event = RouteChangedEventPublisher.solutionToEvent(solution, this);\n\n assertThat(event.vehicleIds()).containsExactly(vehicleId);\n assertThat(event.depotId()).isEmpty();\n assertThat(event.visitIds()).isEmpty();\n assertThat(event.routes()).isEmpty();\n assertThat(event.distance()).isEqualTo(Distance.ZERO);\n }\n\n @Test\n void nonempty_solution_without_vehicles_should_have_zero_routes_but_contain_visits() {\n long depotId = 1;\n long visitId = 2;\n VehicleRoutingSolution solution = solutionFromVisits(\n emptyList(),\n new PlanningDepot(testLocation(depotId)),\n singletonList(testVisit(visitId)));\n\n RouteChangedEvent event = RouteChangedEventPublisher.solutionToEvent(solution, this);\n\n assertThat(event.vehicleIds()).isEmpty();\n assertThat(event.depotId()).contains(depotId);\n assertThat(event.visitIds()).containsExactly(visitId);\n assertThat(event.routes()).isEmpty();\n assertThat(event.distance()).isEqualTo(Distance.ZERO);\n }\n\n @Test\n void initialized_solution_should_have_one_route_per_vehicle() {\n // arrange\n long vehicleId1 = 1001;\n long vehicleId2 = 2001;\n PlanningVehicle vehicle1 = testVehicle(vehicleId1);\n PlanningVehicle vehicle2 = testVehicle(vehicleId2);\n\n long depotId = 1;\n long visitId1 = 2;\n long visitId2 = 3;\n PlanningDepot depot = new PlanningDepot(testLocation(depotId));\n PlanningVisit visit1 = testVisit(visitId1);\n PlanningVisit visit2 = testVisit(visitId2);\n\n VehicleRoutingSolution solution = solutionFromVisits(\n asList(vehicle1, vehicle2),\n depot,\n asList(visit1, visit2));\n\n // Send both vehicles to both visits\n // V1\n // \\\n // |---> visit1 ---> visit2\n // /\n // V2\n for (PlanningVehicle vehicle : solution.getVehicleList()) {\n vehicle.setNextVisit(visit1);\n visit1.setPreviousStandstill(vehicle);\n }\n visit1.setNextVisit(visit2);\n visit2.setPreviousStandstill(visit1);\n\n long softScore = -544564731;\n solution.setScore(HardSoftLongScore.ofSoft(softScore));\n\n // act\n RouteChangedEvent event = RouteChangedEventPublisher.solutionToEvent(solution, this);\n\n // assert\n assertThat(event.routes()).hasSameSizeAs(solution.getVehicleList());\n assertThat(event.routes().stream().mapToLong(value -> value.vehicleId))\n .containsExactlyInAnyOrder(vehicleId1, vehicleId2);\n\n for (ShallowRoute route : event.routes()) {\n assertThat(route.depotId).isEqualTo(depot.getId());\n // visits shouldn't include the depot\n assertThat(route.visitIds).containsExactly(visitId1, visitId2);\n }\n\n assertThat(event.vehicleIds()).containsExactlyInAnyOrder(vehicleId1, vehicleId2);\n assertThat(event.depotId()).contains(depotId);\n assertThat(event.visitIds()).containsExactlyInAnyOrder(visitId1, visitId2);\n assertThat(event.distance()).isEqualTo(Distance.ofMillis(-softScore));\n }\n\n @Test\n void fail_fast_if_vehicles_next_visit_doesnt_exist() {\n PlanningVehicle vehicle = testVehicle(1);\n vehicle.setNextVisit(testVisit(2));\n\n VehicleRoutingSolution solution = solutionFromVisits(\n singletonList(vehicle),\n new PlanningDepot(testLocation(1)),\n singletonList(testVisit(3)));\n\n assertThatIllegalArgumentException()\n .isThrownBy(() -> RouteChangedEventPublisher.solutionToEvent(solution, this))\n .withMessageContaining(\"Visit\");\n }\n\n @Test\n void vehicle_without_a_depot_is_illegal_if_depot_exists() {\n PlanningDepot depot = new PlanningDepot(testLocation(1));\n PlanningVehicle vehicle = testVehicle(1);\n VehicleRoutingSolution solution = solutionFromVisits(singletonList(vehicle), depot, emptyList());\n vehicle.setDepot(null);\n assertThatIllegalArgumentException()\n .isThrownBy(() -> RouteChangedEventPublisher.solutionToEvent(solution, this))\n .withMessageContaining(\"Vehicle\");\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/RouteOptimizerImplTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatCode;\nimport static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;\nimport static org.assertj.core.api.Assertions.assertThatIllegalStateException;\nimport static org.mockito.ArgumentMatchers.any;\nimport static org.mockito.Mockito.clearInvocations;\nimport static org.mockito.Mockito.never;\nimport static org.mockito.Mockito.verify;\nimport static org.mockito.Mockito.verifyNoInteractions;\nimport static org.optaweb.vehiclerouting.domain.VehicleFactory.createVehicle;\nimport static org.optaweb.vehiclerouting.domain.VehicleFactory.testVehicle;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory.fromDomain;\n\nimport java.util.Arrays;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.ArgumentCaptor;\nimport org.mockito.Captor;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.optaweb.vehiclerouting.domain.Coordinates;\nimport org.optaweb.vehiclerouting.domain.Distance;\nimport org.optaweb.vehiclerouting.domain.Location;\nimport org.optaweb.vehiclerouting.domain.Vehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.optaweb.vehiclerouting.service.location.DistanceMatrixRow;\n\n@ExtendWith(MockitoExtension.class)\nclass RouteOptimizerImplTest {\n\n private final DistanceMatrixRow matrixRow = locationId -> Distance.ZERO;\n private final Location location1 = new Location(1, Coordinates.of(1.0, 0.1));\n private final Location location2 = new Location(2, Coordinates.of(0.2, 2.2));\n private final Location location3 = new Location(3, Coordinates.of(3.4, 5.6));\n\n @Captor\n private ArgumentCaptor solutionArgumentCaptor;\n @Captor\n private ArgumentCaptor vehicleArgumentCaptor;\n\n @Mock\n private SolverManager solverManager;\n @Mock\n private RouteChangedEventPublisher routeChangedEventPublisher;\n @InjectMocks\n private RouteOptimizerImpl routeOptimizer;\n\n @Test\n void solution_with_depot_and_no_visits_should_be_published() {\n // arrange\n Long[] vehicleIds = { 2L, 3L, 5L, 7L, 11L };\n Arrays.stream(vehicleIds).forEach(vehicleId -> routeOptimizer.addVehicle(testVehicle(vehicleId)));\n clearInvocations(routeChangedEventPublisher);\n\n // act\n routeOptimizer.addLocation(location1, matrixRow);\n\n // assert\n verifyNoInteractions(solverManager);\n VehicleRoutingSolution solution = verifyPublishingPreliminarySolution();\n assertThat(solution.getVehicleList())\n .extracting(PlanningVehicle::getId)\n .containsExactlyInAnyOrder(vehicleIds);\n assertThat(solution.getDepotList()).extracting(PlanningDepot::getId).containsExactly(location1.id());\n assertThat(solution.getVisitList()).isEmpty();\n }\n\n @Test\n void solution_with_vehicles_and_no_depot_should_be_published() {\n // arrange\n final long vehicleId = 7;\n final Vehicle vehicle = testVehicle(vehicleId);\n\n // act 1\n routeOptimizer.addVehicle(vehicle);\n\n // assert 1\n verifyNoInteractions(solverManager);\n VehicleRoutingSolution solutionWithOneVehicle = verifyPublishingPreliminarySolution();\n assertThat(solutionWithOneVehicle.getVehicleList())\n .extracting(PlanningVehicle::getId)\n .containsExactly(vehicleId);\n assertThat(solutionWithOneVehicle.getDepotList()).isEmpty();\n assertThat(solutionWithOneVehicle.getVisitList()).isEmpty();\n\n // act 2\n clearInvocations(routeChangedEventPublisher);\n routeOptimizer.removeVehicle(vehicle);\n\n // assert 2\n verifyNoInteractions(solverManager);\n VehicleRoutingSolution emptySolution = verifyPublishingPreliminarySolution();\n assertThat(emptySolution.getVehicleList()).isEmpty();\n assertThat(emptySolution.getDepotList()).isEmpty();\n assertThat(emptySolution.getVisitList()).isEmpty();\n }\n\n @Test\n void removing_wrong_vehicle_should_fail_fast() {\n // arrange\n final long vehicleId = 7;\n final Vehicle vehicle = testVehicle(vehicleId);\n final Vehicle nonExistentVehicle = testVehicle(vehicleId + 1);\n routeOptimizer.addVehicle(vehicle);\n\n // act & assert\n assertThatIllegalArgumentException()\n .isThrownBy(() -> routeOptimizer.removeVehicle(nonExistentVehicle))\n .withMessageContaining(\"exist\");\n }\n\n @Test\n void removing_wrong_location_should_fail_fast() {\n // no locations\n assertThatIllegalArgumentException()\n .isThrownBy(() -> routeOptimizer.removeLocation(location1))\n .withMessageContaining(\"no locations\");\n\n // only depot\n routeOptimizer.addLocation(location1, matrixRow);\n assertThatIllegalArgumentException()\n .isThrownBy(() -> routeOptimizer.removeLocation(location3))\n .withMessageContaining(\"exist\");\n\n // depot and a visit\n routeOptimizer.addLocation(location2, matrixRow);\n assertThatIllegalArgumentException()\n .isThrownBy(() -> routeOptimizer.removeLocation(location3))\n .withMessageContaining(\"exist\");\n }\n\n @Test\n void added_vehicle_should_be_moved_to_the_depot_even_if_solver_is_not_yet_solving() {\n // arrange\n // -- depot\n routeOptimizer.addLocation(location1, matrixRow);\n // -- vehicles\n routeOptimizer.addVehicle(testVehicle(7));\n routeOptimizer.addVehicle(testVehicle(8));\n\n // act\n // -- first visit\n routeOptimizer.addLocation(location2, matrixRow);\n\n // assert\n VehicleRoutingSolution solution = verifySolverStartedWithSolution();\n assertThat(solution.getVehicleList())\n .hasSize(2)\n .allMatch(vehicle -> vehicle.getDepot().getId() == location1.id());\n\n assertThat(solution.getDepotList()).isNotEmpty();\n assertThat(solution.getVisitList()).isNotEmpty();\n }\n\n @Test\n void solver_should_start_when_vehicle_is_added_and_there_is_at_least_one_visit() {\n // arrange\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verifyNoInteractions(solverManager);\n\n // act\n routeOptimizer.addVehicle(testVehicle(9));\n\n // assert\n VehicleRoutingSolution solution = verifySolverStartedWithSolution();\n assertThat(solution.getVehicleList()).hasSize(1);\n assertThat(solution.getVisitList()).hasSize(1);\n }\n\n @Test\n void each_location_should_have_a_distance_map_after_it_is_added() {\n long millis = 8079;\n routeOptimizer.addLocation(location1, locationId -> Distance.ofMillis(millis));\n\n VehicleRoutingSolution solution = verifyPublishingPreliminarySolution();\n assertThat(solution.getDepotList()).hasSize(1);\n assertThat(solution.getDepotList().get(0).getLocation().distanceTo(fromDomain(location2))).isEqualTo(millis);\n }\n\n @Test\n void solver_should_start_when_two_locations_added_and_there_is_at_least_one_vehicle() {\n // add 1 vehicle, 2 locations\n routeOptimizer.addVehicle(testVehicle(1));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n\n // solving has started after adding a second location (=> depot + visit)\n VehicleRoutingSolution solution = verifySolverStartedWithSolution();\n\n assertThat(solution.getDepotList()).hasSize(1);\n assertThat(solution.getDepotList().get(0).getLocation().getId()).isEqualTo(location1.id());\n assertThat(solution.getVisitList()).hasSize(1);\n assertThat(solution.getVisitList().get(0).getLocation().getId()).isEqualTo(location2.id());\n }\n\n @Test\n void solver_should_not_start_nor_stop_when_modifying_location_and_there_are_no_vehicles() {\n // add 2 locations\n routeOptimizer.addLocation(location1, matrixRow);\n clearInvocations(routeChangedEventPublisher);\n routeOptimizer.addLocation(location2, matrixRow);\n\n // solving did not start due to missing vehicles\n verify(solverManager, never()).startSolver(any());\n // but preliminary solution is published\n VehicleRoutingSolution solution1 = verifyPublishingPreliminarySolution();\n assertThat(solution1.getVehicleList()).isEmpty();\n assertThat(solution1.getDepotList()).hasSize(1);\n assertThat(solution1.getVisitList()).hasSize(1);\n\n // add a third location and remove another one\n routeOptimizer.addLocation(location3, matrixRow);\n clearInvocations(routeChangedEventPublisher);\n routeOptimizer.removeLocation(location2);\n\n // no interactions with solver (start/stop/problem fact changes) because\n // it hasn't started (due to missing vehicles)\n verifyNoInteractions(solverManager);\n // but preliminary solution is published\n VehicleRoutingSolution solution2 = verifyPublishingPreliminarySolution();\n assertThat(solution2.getVehicleList()).isEmpty();\n assertThat(solution1.getDepotList()).hasSize(1);\n assertThat(solution1.getVisitList()).hasSize(1);\n }\n\n @Test\n void solver_should_stop_and_publish_when_last_vehicle_is_removed() {\n Vehicle vehicle = testVehicle(23);\n routeOptimizer.addVehicle(vehicle);\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n clearInvocations(routeChangedEventPublisher);\n\n routeOptimizer.removeVehicle(vehicle);\n verify(solverManager).stopSolver();\n VehicleRoutingSolution solution = verifyPublishingPreliminarySolution();\n assertThat(solution.getVehicleList()).isEmpty();\n }\n\n @Test\n void solver_should_stop_when_locations_reduced_to_one() {\n // add 1 vehicle, 2 locations\n routeOptimizer.addVehicle(testVehicle(0));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n clearInvocations(routeChangedEventPublisher);\n\n // remove 1 location from running solver\n routeOptimizer.removeLocation(location2);\n\n verify(solverManager).stopSolver();\n\n VehicleRoutingSolution solution = verifyPublishingPreliminarySolution();\n assertThat(solution.getVisitList()).isEmpty();\n assertThat(solution.getDepotList()).hasSize(1);\n assertThat(solution.getVehicleList()).hasSize(1);\n }\n\n @Test\n void removing_depot_impossible_when_there_are_other_locations() {\n routeOptimizer.addVehicle(testVehicle(0));\n // add 2 locations\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n\n assertThatIllegalStateException()\n .isThrownBy(() -> routeOptimizer.removeLocation(location1))\n .withMessageContaining(\"depot\");\n }\n\n @Test\n void when_depot_is_added_all_vehicles_should_be_moved_to_it() {\n // given 2 vehicles\n long vehicleId1 = 8;\n long vehicleId2 = 113;\n routeOptimizer.addVehicle(testVehicle(vehicleId1));\n routeOptimizer.addVehicle(testVehicle(vehicleId2));\n clearInvocations(routeChangedEventPublisher);\n\n // when a depot is added\n routeOptimizer.addLocation(location1, matrixRow);\n\n // then all vehicles must be in the depot\n VehicleRoutingSolution solution1 = verifyPublishingPreliminarySolution();\n assertThat(solution1.getVehicleList())\n .extracting(PlanningVehicle::getId)\n .containsExactlyInAnyOrder(vehicleId1, vehicleId2);\n assertThat(solution1.getVehicleList()).allMatch(vehicle -> vehicle.getDepot().getId() == location1.id());\n assertThat(solution1.getDepotList()).extracting(PlanningDepot::getId).containsExactly(location1.id());\n\n // if we remove the depot\n clearInvocations(routeChangedEventPublisher);\n routeOptimizer.removeLocation(location1);\n\n // then published solution's depot list is empty\n VehicleRoutingSolution solution2 = verifyPublishingPreliminarySolution();\n assertThat(solution2.getVehicleList())\n .extracting(PlanningVehicle::getId)\n .containsExactlyInAnyOrder(vehicleId1, vehicleId2);\n assertThat(solution2.getDepotList()).isEmpty();\n\n // and it's possible to add a new depot\n routeOptimizer.addLocation(location2, matrixRow);\n }\n\n @Test\n void adding_location_to_running_solver_must_happen_through_problem_fact_change() {\n // arrange\n routeOptimizer.addVehicle(testVehicle(55));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n // act\n routeOptimizer.addLocation(location3, matrixRow);\n // assert\n verify(solverManager).addVisit(any(PlanningVisit.class));\n }\n\n @Test\n void removing_location_from_solver_with_more_than_two_locations_must_happen_through_problem_fact_change() {\n // arrange: set up a situation where solver is running with 1 depot and 2 visits\n long vehicleId = 0;\n routeOptimizer.addVehicle(testVehicle(vehicleId));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n\n // add second visit to avoid stopping solver manager after removing a visit below\n routeOptimizer.addLocation(location3, matrixRow);\n verify(solverManager).addVisit(any(PlanningVisit.class));\n\n // act\n routeOptimizer.removeLocation(location2);\n\n // assert\n ArgumentCaptor visitArgumentCaptor = ArgumentCaptor.forClass(PlanningVisit.class);\n verify(solverManager).removeVisit(visitArgumentCaptor.capture());\n assertThat(visitArgumentCaptor.getValue().getId()).isEqualTo(location2.id());\n // solver still running\n verify(solverManager, never()).stopSolver();\n }\n\n @Test\n void adding_vehicle_to_running_solver_must_happen_through_problem_fact_change() {\n // arrange\n routeOptimizer.addVehicle(testVehicle(1));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n\n // act\n routeOptimizer.addVehicle(testVehicle(22));\n\n // assert\n verify(solverManager).addVehicle(vehicleArgumentCaptor.capture());\n PlanningVehicle vehicle = vehicleArgumentCaptor.getValue();\n assertThat(vehicle.getDepot().getId()).isEqualTo(location1.id());\n }\n\n @Test\n void removing_vehicle_from_running_solver_with_more_than_one_vehicle_must_happen_through_problem_fact_change() {\n // arrange: set up a situation where solver is running with 2 vehicles\n final long vehicleId1 = 10;\n final long vehicleId2 = 20;\n routeOptimizer.addVehicle(testVehicle(vehicleId1));\n routeOptimizer.addVehicle(testVehicle(vehicleId2));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n\n // act\n routeOptimizer.removeVehicle(testVehicle(vehicleId1));\n\n // assert\n verify(solverManager).removeVehicle(any(PlanningVehicle.class));\n // solver still running\n verify(solverManager, never()).stopSolver();\n }\n\n @Test\n void changing_vehicle_capacity_should_take_effect_when_solver_is_started_or_be_published() {\n // 1 depot, 1 vehicle\n final long vehicleId = 1;\n final int oldCapacity = 7;\n final int newCapacity = 12;\n Vehicle vehicle = createVehicle(vehicleId, \"\", oldCapacity);\n routeOptimizer.addVehicle(vehicle);\n routeOptimizer.addLocation(location1, matrixRow);\n clearInvocations(routeChangedEventPublisher);\n\n // change capacity when solver is not running\n routeOptimizer.changeCapacity(createVehicle(vehicleId, \"\", newCapacity));\n verifyNoInteractions(solverManager);\n VehicleRoutingSolution preliminarySolution = verifyPublishingPreliminarySolution();\n assertThat(preliminarySolution.getVehicleList().get(0).getCapacity()).isEqualTo(newCapacity);\n\n // start solver\n routeOptimizer.addLocation(location2, matrixRow);\n\n VehicleRoutingSolution solution = verifySolverStartedWithSolution();\n assertThat(solution.getVehicleList().get(0).getCapacity()).isEqualTo(newCapacity);\n }\n\n @Test\n void changing_vehicle_capacity_must_happen_through_problem_fact_change_when_solver_is_running() {\n // 1 vehicle, 1 depot, 1 visit\n final int capacity = 14816;\n final long vehicleId = 10;\n routeOptimizer.addVehicle(testVehicle(vehicleId));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n\n routeOptimizer.changeCapacity(createVehicle(vehicleId, \"\", capacity));\n\n verify(solverManager).changeCapacity(any(PlanningVehicle.class));\n }\n\n @Test\n void changing_vehicle_capacity_must_fail_fast_if_the_vehicle_does_not_exist() {\n // 1 vehicle, 1 depot, 1 visit\n final long vehicleId = 10;\n routeOptimizer.addVehicle(testVehicle(vehicleId));\n\n assertThatIllegalArgumentException()\n .isThrownBy(() -> routeOptimizer.changeCapacity(testVehicle(vehicleId + 1)))\n .withMessageContaining(\"exist\");\n }\n\n @Test\n void remove_all_locations_should_stop_solver_and_publish_preliminary_solution() {\n // set up a situation where solver is running with 1 depot and 2 visits\n long vehicleId = 10;\n routeOptimizer.addVehicle(testVehicle(vehicleId));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n routeOptimizer.addLocation(location3, matrixRow);\n clearInvocations(routeChangedEventPublisher);\n\n routeOptimizer.removeAllLocations();\n\n verify(solverManager).stopSolver();\n\n VehicleRoutingSolution solution = verifyPublishingPreliminarySolution();\n assertThat(solution.getVehicleList()).hasSize(1);\n assertThat(solution.getDepotList()).isEmpty();\n assertThat(solution.getVisitList()).isEmpty();\n }\n\n @Test\n void remove_all_vehicles_should_stop_solver_and_publish_preliminary_solution() {\n long vehicleId = 10;\n routeOptimizer.addVehicle(testVehicle(vehicleId));\n routeOptimizer.addLocation(location1, matrixRow);\n routeOptimizer.addLocation(location2, matrixRow);\n verify(solverManager).startSolver(any(VehicleRoutingSolution.class));\n routeOptimizer.addLocation(location3, matrixRow);\n clearInvocations(routeChangedEventPublisher);\n\n routeOptimizer.removeAllVehicles();\n\n verify(solverManager).stopSolver();\n\n VehicleRoutingSolution solution = verifyPublishingPreliminarySolution();\n assertThat(solution.getVehicleList()).isEmpty();\n assertThat(solution.getDepotList()).hasSize(1);\n assertThat(solution.getVisitList()).hasSize(2);\n }\n\n @Test\n void removing_all_locations_should_not_fail_when_solver_is_not_solving() {\n assertThatCode(() -> routeOptimizer.removeAllLocations()).doesNotThrowAnyException();\n }\n\n @Test\n void removing_all_vehicles_should_not_fail_when_solver_is_not_solving() {\n assertThatCode(() -> routeOptimizer.removeAllVehicles()).doesNotThrowAnyException();\n }\n\n private VehicleRoutingSolution verifyPublishingPreliminarySolution() {\n verify(routeChangedEventPublisher).publishSolution(solutionArgumentCaptor.capture());\n return solutionArgumentCaptor.getValue();\n }\n\n private VehicleRoutingSolution verifySolverStartedWithSolution() {\n verify(solverManager).startSolver(solutionArgumentCaptor.capture());\n return solutionArgumentCaptor.getValue();\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/SolverExceptionTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatExceptionOfType;\nimport static org.mockito.ArgumentMatchers.any;\nimport static org.mockito.Mockito.verify;\nimport static org.mockito.Mockito.verifyNoInteractions;\nimport static org.mockito.Mockito.when;\n\nimport javax.enterprise.event.Event;\n\nimport org.assertj.core.api.ThrowableAssert.ThrowingCallable;\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.ArgumentCaptor;\nimport org.mockito.Captor;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.optaplanner.core.api.solver.Solver;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.optaweb.vehiclerouting.service.error.ErrorEvent;\n\nimport com.google.common.util.concurrent.ListenableFutureTask;\nimport com.google.common.util.concurrent.ListeningExecutorService;\n\n@ExtendWith(MockitoExtension.class)\nclass SolverExceptionTest {\n\n @Mock\n private Solver solver;\n @Mock\n private ListeningExecutorService executor;\n @Mock\n private Event eventPublisher;\n @Captor\n ArgumentCaptor errorEventArgumentCaptor;\n @InjectMocks\n private SolverManager solverManager;\n\n @Test\n void should_publish_error_if_solver_stops_solving_without_being_terminated() {\n // arrange\n // Prepare a future that will be returned by mock executor\n ListenableFutureTask task = ListenableFutureTask.create(SolutionFactory::emptySolution);\n when(executor.submit(any(SolverManager.SolvingTask.class))).thenReturn(task);\n // Run it synchronously (otherwise the test would be unreliable!)\n task.run();\n\n // act\n solverManager.startSolver(SolutionFactory.emptySolution());\n\n // assert\n verify(eventPublisher).fire(errorEventArgumentCaptor.capture());\n assertThat(errorEventArgumentCaptor.getValue().message).contains(\"This is a bug.\");\n }\n\n @Test\n void should_not_publish_error_if_solver_is_terminated_early() {\n // arrange\n // Prepare a future that will be returned by mock executor\n ListenableFutureTask task = ListenableFutureTask.create(SolutionFactory::emptySolution);\n when(executor.submit(any(SolverManager.SolvingTask.class))).thenReturn(task);\n // Pretend the solver has been terminated by stopSolver()...\n when(solver.isTerminateEarly()).thenReturn(true);\n\n // act\n solverManager.startSolver(SolutionFactory.emptySolution());\n task.run(); // ...so that when this invokes the success callback, it won't publish an error\n\n // assert\n verifyNoInteractions(eventPublisher);\n }\n\n @Test\n void should_propagate_any_exception_from_solver() {\n // arrange\n // Prepare a future that will be returned by mock executor\n String exceptionMessage = \"msg 123\";\n ListenableFutureTask task = ListenableFutureTask.create(() -> {\n throw new TestException(exceptionMessage);\n });\n when(executor.submit(any(SolverManager.SolvingTask.class))).thenReturn(task);\n // act (1)\n // Run it synchronously (otherwise the test would be unreliable!)\n task.run();\n solverManager.startSolver(SolutionFactory.emptySolution());\n\n // assert (1)\n verify(eventPublisher).fire(errorEventArgumentCaptor.capture());\n assertThat(errorEventArgumentCaptor.getValue().message)\n .contains(TestException.class.getName())\n .contains(exceptionMessage);\n\n PlanningVisit planningVisit = PlanningVisitFactory.testVisit(1);\n PlanningVehicle planningVehicle = PlanningVehicleFactory.testVehicle(1);\n\n // act & assert (2)\n assertTestExceptionThrownDuringOperation(() -> solverManager.addVisit(planningVisit));\n assertTestExceptionThrownDuringOperation(() -> solverManager.removeVisit(planningVisit));\n assertTestExceptionThrownDuringOperation(() -> solverManager.addVehicle(planningVehicle));\n assertTestExceptionThrownDuringOperation(() -> solverManager.removeVehicle(planningVehicle));\n\n assertTestExceptionThrownWhenStoppingSolver(solverManager);\n }\n\n private static void assertTestExceptionThrownDuringOperation(ThrowingCallable runnable) {\n assertTestExceptionThrownDuring(runnable, \"died\");\n }\n\n private static void assertTestExceptionThrownWhenStoppingSolver(SolverManager routeOptimizer) {\n assertTestExceptionThrownDuring(routeOptimizer::stopSolver, \"stop\");\n }\n\n private static void assertTestExceptionThrownDuring(ThrowingCallable runnable, String message) {\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(runnable)\n .withMessageContaining(message)\n .withCauseInstanceOf(TestException.class);\n }\n\n private static class TestException extends RuntimeException {\n\n TestException(String message) {\n super(message);\n }\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/SolverIntegrationTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static java.util.Collections.singletonList;\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.fail;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory.testLocation;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory.fromLocation;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory.testVisit;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory.emptySolution;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory.solutionFromVisits;\n\nimport java.util.Arrays;\nimport java.util.List;\nimport java.util.concurrent.ExecutionException;\nimport java.util.concurrent.ExecutorService;\nimport java.util.concurrent.Executors;\nimport java.util.concurrent.Future;\nimport java.util.concurrent.Semaphore;\nimport java.util.concurrent.TimeUnit;\n\nimport org.junit.jupiter.api.AfterEach;\nimport org.junit.jupiter.api.BeforeEach;\nimport org.junit.jupiter.api.Disabled;\nimport org.junit.jupiter.api.Test;\nimport org.optaplanner.core.api.solver.Solver;\nimport org.optaplanner.core.api.solver.SolverFactory;\nimport org.optaplanner.core.api.solver.event.BestSolutionChangedEvent;\nimport org.optaplanner.core.api.solver.event.SolverEventListener;\nimport org.optaplanner.core.config.solver.SolverConfig;\nimport org.optaweb.vehiclerouting.plugin.planner.change.AddVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.change.RemoveVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\nclass SolverIntegrationTest {\n\n private static final Logger logger = LoggerFactory.getLogger(SolverIntegrationTest.class);\n // Set a benevolent timeout to avoid issues in the CI environment.\n private static final int PFC_PROPAGATION_TIMEOUT_MILLIS = 10_000;\n\n private SolverConfig solverConfig;\n private ExecutorService executor;\n private ProblemChangeProcessingMonitor monitor;\n private Future futureSolution;\n\n @BeforeEach\n void setUp() {\n solverConfig = SolverConfig.createFromXmlResource(Constants.SOLVER_CONFIG);\n solverConfig.setDaemon(true);\n executor = Executors.newSingleThreadExecutor();\n monitor = new ProblemChangeProcessingMonitor();\n }\n\n @AfterEach\n void tearDown() throws InterruptedException {\n executor.shutdown();\n executor.awaitTermination(1, TimeUnit.SECONDS);\n }\n\n @Disabled(\"Solver fails fast on empty value ranges\") // TODO file an OptaPlanner ticket for empty value ranges\n @Test\n void solver_in_daemon_mode_should_not_fail_on_empty_solution() {\n Solver solver =\n SolverFactory. create(solverConfig).buildSolver();\n assertThat(solver.solve(emptySolution())).isNotNull();\n }\n\n // TODO remove vehicle, change capacity, change demand...\n\n @Test\n void removing_visits_should_not_fail() {\n long distance = 1;\n PlanningVehicle vehicle = PlanningVehicleFactory.testVehicle(1);\n VehicleRoutingSolution solution = solutionFromVisits(\n singletonList(vehicle),\n new PlanningDepot(testLocation(1, location -> distance)),\n singletonList(fromLocation(testLocation(2, location -> distance))));\n\n Solver solver =\n SolverFactory. create(solverConfig).buildSolver();\n solver.addEventListener(monitor);\n startSolver(solver, solution);\n\n for (int id = 3; id < 6; id++) {\n logger.info(\"Add visit ({})\", id);\n monitor.beforeProblemChange();\n solver.addProblemChange(new AddVisit(fromLocation(testLocation(id, location -> distance))));\n assertThat(monitor.awaitAllProblemChanges(PFC_PROPAGATION_TIMEOUT_MILLIS)).isTrue();\n }\n\n List visitIds = Arrays.asList(5, 2, 3);\n for (int id : visitIds) {\n logger.info(\"Remove visit ({})\", id);\n assertThat(solver.isEveryProblemChangeProcessed()).isTrue();\n monitor.beforeProblemChange();\n solver.addProblemChange(new RemoveVisit(testVisit(id)));\n assertThat(solver.isEveryProblemChangeProcessed()).isFalse(); // probably not 100% safe\n // Notice that it's not possible to check individual problem fact changes completion.\n // When we receive a BestSolutionChangedEvent with unprocessed PFCs,\n // we don't know how many of them there are.\n if (!monitor.awaitAllProblemChanges(PFC_PROPAGATION_TIMEOUT_MILLIS)) {\n assertThat(terminateSolver(solver)).isNotNull();\n fail(\"Problem fact change hasn't been completed\");\n }\n }\n\n assertThat(terminateSolver(solver)).isNotNull();\n }\n\n private void startSolver(Solver solver, VehicleRoutingSolution solution) {\n futureSolution = executor.submit(() -> solver.solve(solution));\n }\n\n private VehicleRoutingSolution terminateSolver(Solver solver) {\n solver.terminateEarly();\n try {\n return futureSolution.get();\n } catch (InterruptedException e) {\n Thread.currentThread().interrupt();\n fail(\"Interrupted\", e);\n } catch (ExecutionException e) {\n fail(\"Solving failed\", e);\n }\n throw new AssertionError();\n }\n\n static class ProblemChangeProcessingMonitor implements SolverEventListener {\n\n private static final Logger logger = LoggerFactory.getLogger(ProblemChangeProcessingMonitor.class);\n\n private final Semaphore problemChanges = new Semaphore(0);\n\n void beforeProblemChange() {\n int permitsDrained = problemChanges.drainPermits();\n logger.debug(\"Before PFC (permits drained: {})\", permitsDrained);\n }\n\n boolean awaitAllProblemChanges(int milliseconds) {\n // Available permits may rarely be > 0 if the PFC completes before we start waiting,\n // or if the solution has improved since we called beforePFC() => the test is not completely reliable.\n logger.debug(\"WAIT (completed PFCs: {})\", problemChanges.availablePermits());\n try {\n if (problemChanges.tryAcquire(milliseconds, TimeUnit.MILLISECONDS)) {\n logger.info(\"Problem Fact Change DONE\");\n return true;\n }\n } catch (InterruptedException e) {\n Thread.currentThread().interrupt();\n fail(\"Interrupted\", e);\n }\n return false;\n }\n\n @Override\n public void bestSolutionChanged(BestSolutionChangedEvent event) {\n // This happens on solver thread\n if (!event.isEveryProblemChangeProcessed()) {\n logger.debug(\"UNPROCESSED\");\n } else if (!event.getNewBestScore().isSolutionInitialized()) {\n logger.debug(\"UNINITIALIZED ({})\", event.getNewBestScore());\n } else {\n logger.debug(\"New best solution (COMPLETE)\");\n problemChanges.release();\n }\n }\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/SolverManagerIntegrationTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static java.util.Collections.singletonList;\nimport static org.assertj.core.api.Assertions.assertThatCode;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory.solutionFromVisits;\n\nimport java.util.concurrent.Semaphore;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Observes;\nimport javax.inject.Inject;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.Timeout;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.DistanceMap;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocation;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\nimport org.optaweb.vehiclerouting.service.route.RouteChangedEvent;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\nimport io.quarkus.test.junit.QuarkusTest;\nimport io.quarkus.test.junit.TestProfile;\n\n@QuarkusTest\n@TestProfile(SolverTestProfile.class)\nclass SolverManagerIntegrationTest {\n\n @Inject\n SolverManager solverManager;\n @Inject\n RouteChangedEventSemaphore routeChangedEventSemaphore;\n\n private static DistanceMap mockDistanceMap() {\n return location -> 60;\n }\n\n @Test\n @Timeout(value = 60)\n void solver_should_be_in_daemon_mode() throws InterruptedException {\n PlanningVehicle vehicle = PlanningVehicleFactory.testVehicle(1);\n PlanningLocation depot = PlanningLocationFactory.testLocation(1, mockDistanceMap());\n PlanningLocation visit = PlanningLocationFactory.testLocation(2, mockDistanceMap());\n VehicleRoutingSolution solution = solutionFromVisits(\n singletonList(vehicle),\n new PlanningDepot(depot),\n singletonList(PlanningVisitFactory.fromLocation(visit)));\n solverManager.startSolver(solution);\n\n // Waits until the solution is initialized. There is only 1 possible step => no more than 1 RouteChangedEvent.\n routeChangedEventSemaphore.waitForRouteUpdate();\n // The best solution has been updated. We know the score must be -1hard/-120soft because that's\n // the only possible solution. The termination property is set exactly to this score => we know\n // the solver is now terminated.\n\n // If the solver is in daemon mode, it doesn't return from solve() although solving has ended.\n // Instead, it's actively waiting for a PFC and will restart once it arrives from the outside (the test thread).\n // If it's not in daemon mode, it returns from solve() method once the termination condition is met\n // and the following PFC attempt fails.\n assertThatCode(() -> solverManager.changeCapacity(vehicle)).doesNotThrowAnyException();\n }\n\n @ApplicationScoped\n static class RouteChangedEventSemaphore {\n\n private static final Logger logger = LoggerFactory.getLogger(RouteChangedEventSemaphore.class);\n private final Semaphore semaphore = new Semaphore(0);\n\n public void onApplicationEvent(@Observes RouteChangedEvent event) {\n logger.info(\"DISTANCE: {}\", event.distance());\n semaphore.release();\n }\n\n void waitForRouteUpdate() throws InterruptedException {\n semaphore.acquire();\n int remainingPermits = semaphore.availablePermits();\n if (remainingPermits > 0) {\n throw new IllegalStateException(\n \"Only 1 RouteChangedEvent was expected but there were at least \" + (remainingPermits + 1));\n }\n }\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/SolverManagerTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.api.Assertions.assertThatExceptionOfType;\nimport static org.assertj.core.api.Assertions.assertThatIllegalStateException;\nimport static org.mockito.AdditionalAnswers.answer;\nimport static org.mockito.ArgumentMatchers.any;\nimport static org.mockito.Mockito.never;\nimport static org.mockito.Mockito.verify;\nimport static org.mockito.Mockito.when;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory.testVisit;\n\nimport java.util.concurrent.ExecutionException;\nimport java.util.concurrent.Future;\n\nimport org.junit.jupiter.api.Test;\nimport org.junit.jupiter.api.extension.ExtendWith;\nimport org.mockito.ArgumentCaptor;\nimport org.mockito.Captor;\nimport org.mockito.InjectMocks;\nimport org.mockito.Mock;\nimport org.mockito.junit.jupiter.MockitoExtension;\nimport org.mockito.stubbing.Answer1;\nimport org.optaplanner.core.api.solver.Solver;\nimport org.optaplanner.core.api.solver.event.BestSolutionChangedEvent;\nimport org.optaweb.vehiclerouting.plugin.planner.change.AddVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.change.AddVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.change.ChangeVehicleCapacity;\nimport org.optaweb.vehiclerouting.plugin.planner.change.RemoveVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.change.RemoveVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\nimport com.google.common.util.concurrent.ListenableFuture;\nimport com.google.common.util.concurrent.ListeningExecutorService;\n\n@ExtendWith(MockitoExtension.class)\nclass SolverManagerTest {\n\n private final VehicleRoutingSolution solution = SolutionFactory.emptySolution();\n private final PlanningVehicle testVehicle = PlanningVehicleFactory.testVehicle(1);\n private final PlanningVisit testVisit = PlanningVisitFactory.testVisit(1);\n\n @Captor\n private ArgumentCaptor solutionArgumentCaptor;\n @Mock\n private BestSolutionChangedEvent bestSolutionChangedEvent;\n @Mock\n private ListenableFuture solverFuture;\n\n @Mock\n private Solver solver;\n @Mock\n private ListeningExecutorService executor;\n @Mock\n private RouteChangedEventPublisher routeChangedEventPublisher;\n @InjectMocks\n private SolverManager solverManager;\n\n private void returnSolverFutureWhenSolverIsStarted() {\n // always run the runnable submitted to executor (that's what every executor does)\n // we can then verify that solver.solve() has been called\n when(executor.submit(any(SolverManager.SolvingTask.class))).thenAnswer(\n answer((Answer1, SolverManager.SolvingTask>) callable -> {\n callable.call();\n return solverFuture;\n }));\n }\n\n @Test\n void should_listen_for_best_solution_events() {\n verify(solver).addEventListener(solverManager);\n }\n\n @Test\n void ignore_new_best_solutions_when_unprocessed_fact_changes() {\n // arrange\n when(bestSolutionChangedEvent.isEveryProblemChangeProcessed()).thenReturn(false);\n\n // act\n solverManager.bestSolutionChanged(bestSolutionChangedEvent);\n\n // assert\n verify(bestSolutionChangedEvent, never()).getNewBestSolution();\n verify(routeChangedEventPublisher, never()).publishSolution(any());\n }\n\n @Test\n void publish_new_best_solution_if_all_fact_changes_processed() {\n VehicleRoutingSolution solution = SolutionFactory.emptySolution();\n when(bestSolutionChangedEvent.isEveryProblemChangeProcessed()).thenReturn(true);\n when(bestSolutionChangedEvent.getNewBestSolution()).thenReturn(solution);\n\n solverManager.bestSolutionChanged(bestSolutionChangedEvent);\n\n verify(routeChangedEventPublisher).publishSolution(solutionArgumentCaptor.capture());\n VehicleRoutingSolution event = solutionArgumentCaptor.getValue();\n assertThat(event).isSameAs(solution);\n }\n\n @Test\n void startSolver_should_start_solver() {\n returnSolverFutureWhenSolverIsStarted();\n solverManager.startSolver(solution);\n verify(solver).solve(solution);\n\n // cannot start solver that is already solving\n assertThatIllegalStateException()\n .isThrownBy(() -> solverManager.startSolver(solution));\n }\n\n @Test\n void stopSolver_should_terminate_solver() {\n returnSolverFutureWhenSolverIsStarted();\n solverManager.startSolver(solution);\n solverManager.stopSolver();\n verify(solver).terminateEarly();\n\n // another stopSolver() does nothing\n solverManager.stopSolver();\n // This verifies there were no more invocations of terminateEarly() without clearing all invocations.\n // Not using Mockito.clearInvocations() only because it doesn't like generic arguments.\n verify(solver).terminateEarly();\n }\n\n @Test\n void reset_interrupted_flag() throws ExecutionException, InterruptedException {\n returnSolverFutureWhenSolverIsStarted();\n // start solver\n solverManager.startSolver(solution);\n when(solverFuture.isDone()).thenReturn(true);\n when(solverFuture.get()).thenThrow(InterruptedException.class);\n\n PlanningVisit visit = testVisit(0);\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.removeVisit(visit));\n assertThat(Thread.interrupted()).isTrue();\n\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.stopSolver());\n assertThat(Thread.interrupted()).isTrue();\n }\n\n @Test\n void change_operations_should_fail_if_solver_has_not_started_yet() {\n assertThatIllegalStateException()\n .isThrownBy(() -> solverManager.addVehicle(testVehicle))\n .withMessageContaining(\"started\");\n assertThatIllegalStateException()\n .isThrownBy(() -> solverManager.removeVehicle(testVehicle))\n .withMessageContaining(\"started\");\n assertThatIllegalStateException()\n .isThrownBy(() -> solverManager.changeCapacity(testVehicle))\n .withMessageContaining(\"started\");\n assertThatIllegalStateException()\n .isThrownBy(() -> solverManager.addVisit(testVisit))\n .withMessageContaining(\"started\");\n assertThatIllegalStateException()\n .isThrownBy(() -> solverManager.removeVisit(testVisit))\n .withMessageContaining(\"started\");\n }\n\n @Test\n void change_operations_should_fail_is_solver_has_died() throws ExecutionException, InterruptedException {\n returnSolverFutureWhenSolverIsStarted();\n solverManager.startSolver(solution);\n when(solverFuture.isDone()).thenReturn(true);\n when(solverFuture.get()).thenThrow(ExecutionException.class);\n\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.addVehicle(testVehicle))\n .withMessageContaining(\"died\");\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.removeVehicle(testVehicle))\n .withMessageContaining(\"died\");\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.changeCapacity(testVehicle))\n .withMessageContaining(\"died\");\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.addVisit(testVisit))\n .withMessageContaining(\"died\");\n assertThatExceptionOfType(RuntimeException.class)\n .isThrownBy(() -> solverManager.removeVisit(testVisit))\n .withMessageContaining(\"died\");\n }\n\n @Test\n void change_operations_should_submit_problem_fact_changes_to_solver() {\n returnSolverFutureWhenSolverIsStarted();\n solverManager.startSolver(solution);\n when(solverFuture.isDone()).thenReturn(false);\n\n solverManager.addVehicle(testVehicle);\n verify(solver).addProblemChange(any(AddVehicle.class));\n\n solverManager.removeVehicle(testVehicle);\n verify(solver).addProblemChange(any(RemoveVehicle.class));\n\n solverManager.changeCapacity(testVehicle);\n verify(solver).addProblemChange(any(ChangeVehicleCapacity.class));\n\n solverManager.addVisit(testVisit);\n verify(solver).addProblemChange(any(AddVisit.class));\n\n solverManager.removeVisit(testVisit);\n verify(solver).addProblemChange(any(RemoveVisit.class));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/SolverTestProfile.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport java.util.HashMap;\nimport java.util.Map;\n\nimport io.quarkus.test.junit.QuarkusTestProfile;\n\npublic class SolverTestProfile implements QuarkusTestProfile {\n\n @Override\n public Map getConfigOverrides() {\n HashMap config = new HashMap<>();\n config.put(\"quarkus.optaplanner.solver.termination.best-score-limit\", \"-1hard/-120soft\");\n return config;\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/VehicleRoutingConstraintProviderTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner;\n\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningLocationFactory.testLocation;\nimport static org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisitFactory.fromLocation;\n\nimport org.junit.jupiter.api.Test;\nimport org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore;\nimport org.optaplanner.test.api.score.stream.ConstraintVerifier;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.DistanceMap;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningDepot;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.Standstill;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\nclass VehicleRoutingConstraintProviderTest {\n\n private final ConstraintVerifier constraintVerifier =\n ConstraintVerifier.build(\n new VehicleRoutingConstraintProvider(),\n VehicleRoutingSolution.class,\n Standstill.class,\n PlanningVisit.class);\n\n private static DistanceMap distanceToAll(long distance) {\n return location -> distance;\n }\n\n private static void route(PlanningVehicle vehicle, PlanningVisit... visits) {\n Standstill previousStandstill = vehicle;\n\n for (PlanningVisit visit : visits) {\n visit.setVehicle(vehicle);\n visit.setPreviousStandstill(previousStandstill);\n previousStandstill.setNextVisit(visit);\n previousStandstill = visit;\n }\n }\n\n @Test\n void vehicle_capacity_penalized_1vehicle_1visit() {\n int demand = 100;\n int capacity = 5;\n\n PlanningVehicle vehicle = PlanningVehicleFactory.testVehicle(1, capacity);\n vehicle.setDepot(new PlanningDepot(testLocation(1, distanceToAll(0))));\n\n PlanningVisit visit = fromLocation(testLocation(2, distanceToAll(0)), demand);\n\n route(vehicle, visit);\n\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::vehicleCapacity)\n .given(visit)\n .penalizesBy(demand - capacity);\n }\n\n @Test\n void vehicle_capacity_penalized_1vehicle_3visits() {\n int demand1 = 4;\n int demand2 = 3;\n int demand3 = 9;\n int capacity = 5;\n\n PlanningVehicle vehicle = PlanningVehicleFactory.testVehicle(1, capacity);\n vehicle.setDepot(new PlanningDepot(testLocation(0, distanceToAll(0))));\n\n PlanningVisit visit1 = fromLocation(testLocation(1, distanceToAll(0)), demand1);\n PlanningVisit visit2 = fromLocation(testLocation(2, distanceToAll(0)), demand2);\n PlanningVisit visit3 = fromLocation(testLocation(3, distanceToAll(0)), demand3);\n\n route(vehicle, visit1, visit2, visit3);\n\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::vehicleCapacity)\n .given(visit1, visit2, visit3)\n .penalizesBy(demand1 + demand2 + demand3 - capacity);\n }\n\n @Test\n void capacity_not_penalized_when_greater_or_equal_to_demand() {\n int demand1 = 4;\n int demand2 = 3;\n int demand3 = 9;\n int totalDemand = demand1 + demand2 + demand3;\n\n PlanningVehicle vehicle = PlanningVehicleFactory.testVehicle(1, totalDemand);\n vehicle.setDepot(new PlanningDepot(testLocation(0, distanceToAll(0))));\n\n PlanningVisit visit1 = fromLocation(testLocation(1, distanceToAll(0)), demand1);\n PlanningVisit visit2 = fromLocation(testLocation(2, distanceToAll(0)), demand2);\n PlanningVisit visit3 = fromLocation(testLocation(3, distanceToAll(0)), demand3);\n\n route(vehicle, visit1, visit2, visit3);\n\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::vehicleCapacity)\n .given(visit1, visit2, visit3)\n .penalizesBy(0);\n\n // test values near the constraint boundary\n vehicle.setCapacity(totalDemand + 1);\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::vehicleCapacity)\n .given(visit1, visit2, visit3)\n .penalizesBy(0);\n }\n\n @Test\n void vehicles_capacity_constraint_should_work_for_multiple_vehicles() {\n int demand1a = 11;\n int demand1b = 12;\n int demand1c = 14;\n int demand2a = 3000;\n int demand2b = 2500;\n int demand2c = 8000;\n int capacity1 = demand1a + demand1b + demand1c;\n int capacity2 = demand2a + demand2b + demand2c;\n\n PlanningDepot depot = new PlanningDepot(testLocation(0, distanceToAll(0)));\n\n PlanningVehicle vehicle1 = PlanningVehicleFactory.testVehicle(1, capacity1);\n vehicle1.setDepot(depot);\n PlanningVehicle vehicle2 = PlanningVehicleFactory.testVehicle(2, capacity2);\n vehicle2.setDepot(depot);\n\n PlanningVisit visit1 = fromLocation(testLocation(1, distanceToAll(0)), demand1a);\n PlanningVisit visit2 = fromLocation(testLocation(2, distanceToAll(0)), demand1b);\n PlanningVisit visit3 = fromLocation(testLocation(3, distanceToAll(0)), demand1c);\n PlanningVisit visit4 = fromLocation(testLocation(4, distanceToAll(0)), demand2a);\n PlanningVisit visit5 = fromLocation(testLocation(5, distanceToAll(0)), demand2b);\n PlanningVisit visit6 = fromLocation(testLocation(6, distanceToAll(0)), demand2c);\n\n route(vehicle1, visit1, visit2, visit3);\n route(vehicle2, visit4, visit5, visit6);\n\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::vehicleCapacity)\n .given(visit1, visit2, visit3, visit4, visit5, visit6)\n .penalizesBy(0);\n\n vehicle1.setCapacity(capacity1 - 3);\n vehicle2.setCapacity(capacity2 - 7);\n\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::vehicleCapacity)\n .given(visit1, visit2, visit3, visit4, visit5, visit6)\n .penalizesBy(10);\n }\n\n @Test\n void distance_2vehicles() {\n int fromDepot1 = 1000;\n int fromDepot2 = 2000;\n PlanningDepot depot1 = new PlanningDepot(testLocation(0, distanceToAll(fromDepot1)));\n PlanningDepot depot2 = new PlanningDepot(testLocation(0, distanceToAll(fromDepot2)));\n\n PlanningVehicle vehicle1 = PlanningVehicleFactory.testVehicle(1, Integer.MAX_VALUE);\n vehicle1.setDepot(depot1);\n PlanningVehicle vehicle2 = PlanningVehicleFactory.testVehicle(1, Integer.MAX_VALUE);\n vehicle2.setDepot(depot2);\n\n int fromA = 17;\n int fromB = 11;\n int fromC = 37;\n int fromD = 123;\n int fromE = 77;\n int fromF = 99;\n PlanningVisit visitA = fromLocation(testLocation(1, distanceToAll(fromA)));\n PlanningVisit visitB = fromLocation(testLocation(2, distanceToAll(fromB)));\n PlanningVisit visitC = fromLocation(testLocation(3, distanceToAll(fromC)));\n PlanningVisit visitD = fromLocation(testLocation(4, distanceToAll(fromD)));\n PlanningVisit visitE = fromLocation(testLocation(5, distanceToAll(fromE)));\n PlanningVisit visitF = fromLocation(testLocation(6, distanceToAll(fromF)));\n\n route(vehicle1, visitA, visitB, visitC);\n route(vehicle2, visitD, visitE, visitF);\n\n // vehicle 1: depot→last\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::distanceFromPreviousStandstill)\n .given(vehicle1, visitA, visitB, visitC)\n .penalizesBy(fromDepot1 + fromA + fromB);\n\n // vehicle 1: last→depot\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::distanceFromLastVisitToDepot)\n .given(vehicle1, visitA, visitB, visitC)\n .penalizesBy(fromC);\n\n // vehicle 2: depot→last\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::distanceFromPreviousStandstill)\n .given(vehicle2, visitD, visitE, visitF)\n .penalizesBy(fromDepot2 + fromD + fromE);\n\n // vehicle 2: last→depot\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::distanceFromLastVisitToDepot)\n .given(vehicle2, visitD, visitE, visitF)\n .penalizesBy(fromF);\n\n // vehicles 1+2: depot→last\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::distanceFromPreviousStandstill)\n .given(vehicle1, vehicle2, visitA, visitB, visitC, visitD, visitE, visitF)\n .penalizesBy(fromDepot1 + fromDepot2 + fromA + fromB + fromD + fromE);\n\n // vehicles 1+2: last→depot\n constraintVerifier.verifyThat(VehicleRoutingConstraintProvider::distanceFromLastVisitToDepot)\n .given(vehicle1, vehicle2, visitA, visitB, visitC, visitD, visitE, visitF)\n .penalizesBy(fromC + fromF);\n\n // score\n constraintVerifier.verifyThat()\n .given(vehicle1, vehicle2, visitA, visitB, visitC, visitD, visitE, visitF)\n .scores(HardSoftLongScore.ofSoft(\n -(fromDepot1 + fromDepot2 + fromA + fromB + fromC + fromD + fromE + fromF)));\n }\n}\n"
},
{
"path": "optaweb-vehicle-routing-backend/src/test/java/org/optaweb/vehiclerouting/plugin/planner/change/AddVehicleTest.java",
"content": "package org.optaweb.vehiclerouting.plugin.planner.change;\n\nimport static org.assertj.core.api.Assertions.assertThat;\n\nimport org.junit.jupiter.api.Test;\nimport org.optaweb.vehiclerouting.plugin.planner.MockSolver;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicle;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVehicleFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.SolutionFactory;\nimport org.optaweb.vehiclerouting.plugin.planner.domain.VehicleRoutingSolution;\n\nclass AddVehicleTest {\n\n @Test\n void add_vehicle_should_add_vehicle() {\n VehicleRoutingSolution solution = SolutionFactory.emptySolution();\n\n MockSolver