Merge branch 'ChargingStation' into 'master'

Charging station

See merge request !28

.gitlab-ci.yml

@@ -6,24 +6,12 @@ stages:
 - windows
 - linux
 
-#masterJobLinux:
-#  stage: linux
-#  image: maven:3-jdk-8
-#  before_script:
-#  - apt-get update
-#  - apt-get install -y openjfx
-#  script: 
-#  - mvn -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -B  clean deploy --settings settings.xml
-#  - cat target/site/jacoco/index.html
-#  - mvn package sonar:sonar -s settings.xml
-#  only:
-#  - master
-
 masterJobWindowsRpc:
   stage: windows
   script:
   - cd rpc
   - mvn -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -B  clean deploy --settings ..\settings.xml
+  - mvn package sonar:sonar --settings ..\settings.xml -DskipTests
   tags:
   - Windows10
   only:
@@ -35,6 +23,7 @@ masterJobWindowsRestful:
   - cd restful
   # TODO: we have to skip tests for now, because most tests require a running instance of zookeeper
   - mvn -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -B  clean deploy --settings ..\settings.xml -DskipTests
+  - mvn package sonar:sonar --settings ..\settings.xml -DskipTests
   tags:
   - Windows10
   only:
@@ -61,22 +50,32 @@ branchJobWindowsRestful:
   except:
     - master
 
-#BranchJobLinux:
-#  tags:
-#    - docker
-#  stage: linux
-#  image: maven:3-jdk-8
-#  before_script:
-#  - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-#  script:
-##  - apt-get update
-##  - apt-get install -y openjfx
-#  - cd restful
-#  - ./run_test.sh
-##  - docker tag rmi-server:latest $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
-##  - docker tag rmi-server:latest $CI_REGISTRY_IMAGE:latest
-##  - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
-##  - docker push $CI_REGISTRY_IMAGE:latest
-#  #  - mvn -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -B  clean install --settings settings.xml
-#  except:
-#  - master
+# run tests
+branchJobLinux:
+  tags:
+    - docker
+  stage: linux
+  script:
+    - cd docker
+    - ./build.sh
+    - ./run_test.sh
+  except:
+    - master
+
+# build, test and publish docker images
+masterJobLinux:
+  tags:
+    - docker
+  stage: linux
+  before_script:
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+  script:
+    - cd docker
+    - ./build.sh
+    - ./run_test.sh
+    - docker tag rpc-server:latest $CI_REGISTRY_IMAGE:rpc
+    - docker tag restful-server:latest $CI_REGISTRY_IMAGE:restful
+    - docker push $CI_REGISTRY_IMAGE:rpc
+    - docker push $CI_REGISTRY_IMAGE:restful
+  only:
+    - master

README.md

@@ -5,6 +5,47 @@
 
 Server repository contains a project binding all modules for running the _simulator_ together with _visualization_ using client/server architecture. The project is based on _SmartFoxServer_ development kit and therefore has to be deployed on running _SmartFoxServer 2X_ server. To provide accessible web application, the _visualization_ project has to be built to _.war_ file and then deployed as a web application on the embedded in SFS _Jetty_ server.
 
+# Server 2.0
+## Install
+```bash
+$ mvn clean install -DskipTests -settings=../settings.xml
+```
+After installation, the executables can be found in restful/target and rpc/target directory.
+To use them, please refer to corresponding instructions:
+[rpc](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/server/blob/master/rpc/README.md)
+and 
+[restful](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/server/blob/master/restful/README.md)
+
+## Docker(optional)
+Build the docker images:
+```bash
+$ cd docker
+$ ./build.sh
+```
+Test:
+```bash
+$ cd docker
+$ ./run_test.sh
+```
+README of [restful](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/server/blob/master/restful/README.md)
+includes instructions of how to use docker to run this project.
+
+## Just have a look
+If you don't want to compile the whole project and just want to have a taste of this project,
+you can simply run:
+```bash
+$ cd docker
+$ docker-compose up
+``` 
+This will start a pure backend application. Now you can use the 
+[RESTful API](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/server/blob/master/restful/README.md)
+to play with the simulation.
+API doc can be found at [127.0.0.1:8090/swagger-ui.html](127.0.0.1:8090/swagger-ui.html)
+
+To try it with visualization, download 
+[visualization project](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/visualization),
+uncomment the `nginx` part of `docker/docker-compose.yml`, comment or remove the `ports` field of `server`.
+
 # Portable version
 
 A portable version for Windows of the SmartFoxServer based simulator together with a portable PostgreSQL database is available as [archive](https://github.com/MontiSim/server/releases/download/portable/distributed-simulator.zip). Running the portable version can be done by running the `start-script.bat` file, provided in the archive.

docker/Dockerfile

+FROM maven:3-jdk-8 AS montisim-server-builder
+
+WORKDIR /app
+
+COPY . .
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends metis && \
+    rm -rf /var/lib/apt/lists/* && \
+    mvn install -s settings.xml -DskipTests   && \
+    cp rpc/target/rpc-*-jar-with-dependencies.jar rpc/target/rpc.jar && \
+    find restful/target -regex '.*restful-[0-9.]+\.jar' | \
+    xargs -i cp {} restful/target/restful.jar

docker/build.sh

+#!/usr/bin/env bash
+
+CURR_DIR=$(pwd)
+
+cd ..
+docker build -f "${CURR_DIR}/Dockerfile" -t montisim-server-builder .
+
+cd rpc
+./build.sh
+
+cd ../restful
+./build.sh

docker/docker-compose.yml

@@ -3,45 +3,59 @@ version: "3"
 
 services:
   zoo1:
-    image: zookeeper
+    image: zookeeper:3.4
     restart: always
     hostname: zoo1
-    ports:
-      - 2181:2181
     environment:
       ZOO_MY_ID: 1
       ZOO_SERVERS: server.1=0.0.0.0:2888:3888
 
-  web:
-    image: montisim-server
-    ports:
-      - 5001:5001
-    depends_on:
-      - rmi-server
-      - rpc-server
-    volumes:
-      - ../research/web:/app
-
   rmi-server:
-    image: rmi-server:latest
+    image: registry.git.rwth-aachen.de/monticore/embeddedmontiarc/simulators/rmimodelserver:latest
     depends_on:
       - zoo1
-#    ports:
-#      - 10101:10101
     restart: always
-#    hostname: rmi-server
     environment:
-      ZOO_SERVERS: zoo1
+      ZOO_SERVERS: zoo1:2181
+    entrypoint:
+      - java
+      - -cp
+      - rmi-model-server.jar
+      - -Djava.rmi.server.codebase=file:rmi-model-server.jar
+      - -Djava.rmi.server.useLocalHostname
+      - rwth.rmi.model.server.RMIServer
+      - "10101"
+      - autopilots
+      - no_time
+      - os=linux
 
   rpc-server:
-    image: rpc-server:latest
+    image: registry.git.rwth-aachen.de/monticore/embeddedmontiarc/simulators/server:rpc
     depends_on:
       - zoo1
-#    ports:
-#      - 6000:6000
-#      - 8787:8787
     restart: always
     environment:
-      ZOO_SERVERS: zoo1
-    volumes:
-      - ../rpc/target:/app
+      ZOO_SERVERS: zoo1:2181
+      # uncomment below to enable multi-sector trajectory re-planning
+  #      SIM_SERVER: server
+  #      SIM_PORT: 8090
+
+  server:
+    image: registry.git.rwth-aachen.de/monticore/embeddedmontiarc/simulators/server:restful
+    depends_on:
+      - zoo1
+    ports:
+      - 8090:8090
+    restart: always
+    environment:
+      ZOO_SERVERS: zoo1:2181
+
+#  nginx:
+#    image: nginx:1.17
+#    ports:
+#      - 8090:8090
+#    restart: always
+#    volumes:
+#      - ./nginx.conf:/etc/nginx/nginx.conf:ro
+#      # edit line below to use visualization
+#      - /path/to/visualization/src/main/webapp:/app

docker/nginx.conf

+#user  nobody;
+worker_processes  1;
+
+#error_log  logs/error.log;
+#error_log  logs/error.log  notice;
+#error_log  logs/error.log  info;
+
+#pid        logs/nginx.pid;
+
+
+events {
+    worker_connections  1024;
+}
+
+
+http {
+    include       mime.types;
+    default_type  application/octet-stream;
+
+    #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+    #                  '$status $body_bytes_sent "$http_referer" '
+    #                  '"$http_user_agent" "$http_x_forwarded_for"';
+
+    #access_log  logs/access.log  main;
+
+    sendfile        on;
+    client_max_body_size 50m;
+    #tcp_nopush     on;
+
+    #keepalive_timeout  0;
+    keepalive_timeout  65;
+
+    gzip  on;
+
+    # montisim-server-restful backend
+    server {
+        listen 8090;
+        server_name 127.0.0.1;
+
+        root /app;
+        add_header Access-Control-Allow-Origin * always;
+        add_header Access-Control-Allow-Methods '*' always;
+
+        location / {
+            proxy_pass http://server:8090;
+        }
+    }
+
+   # include servers/*;
+}

docker/postgres/Dockerfile

-FROM postgres:latest
-
-COPY ./db-create-script.sql /docker-entrypoint-initdb.d/
\ No newline at end of file

restful/run_test.sh → docker/run_test.sh

@@ -26,8 +26,8 @@ SIMULATOR_DIR="${CURR_DIR}/../rpc"
 
 # prepare docker image for rpc-server
 #cd $SIMULATOR_DIR
-#mvn clean install -s ../settings.xml -DskipTests
-#./build.sh
+# mvn clean install -s ../settings.xml -DskipTests
+#../restful/build.sh
 
 # create network
 docker network create simulation-network
@@ -37,6 +37,7 @@ docker run \
     --network="simulation-network" \
     -d \
     --name=zookeeper \
+    -e "ZOO_MAX_CLIENT_CNXNS=1024" \
     zookeeper:latest
 
 # start autopilot server(RMIServer)
@@ -47,7 +48,7 @@ docker run \
     -e "ZOO_SERVERS=zookeeper" \
     registry.git.rwth-aachen.de/monticore/embeddedmontiarc/simulators/rmimodelserver:latest \
     java -cp rmi-model-server.jar -Djava.rmi.server.codebase=file:rmi-model-server.jar \
-    -Djava.rmi.server.hostname=localhost rwth.rmi.model.server.RMIServer 10101 autopilots no_time os_linux
+    -Djava.rmi.server.useLocalHostname rwth.rmi.model.server.RMIServer 10101 autopilots no_time os_linux
 
 docker run \
     --network="simulation-network" \
@@ -56,19 +57,19 @@ docker run \
     --name=rpc-server \
     rpc-server:latest
 
-cd $CURR_DIR
-docker build -t server-test-runner -f TestDockerfile ..
-docker run --rm --network="simulation-network" -e "ZOO_SERVERS=zookeeper" server-test-runner sh -c "cd restful && mvn test -s ../settings.xml"
-
-# build simulator
-#cd $SIMULATOR_DIR
-#mvn install -s ../settings.xml -DskipTests
+cd ${CURR_DIR}
+#docker build -t server-test-runner -f ./docker/TestDockerfile .
+docker run \
+    --rm --network="simulation-network" \
+    -e "ZOO_SERVERS=zookeeper" \
+    montisim-server-builder sh -c "cd restful && mvn test -s ../settings.xml" \
+    2>&1 | tee result.txt
 
-#cd "${SIMULATOR_DIR}/target"
-# start rpc-server(remote simulator)
-#java -cp "rpc-1.0.0-SNAPSHOT-jar-with-dependencies.jar:." server.rpc.RpcServer 6000 > /dev/null &
+dockerCleanUp
 
-#cd $CURR_DIR
-#mvn test -s ../settings.xml
+tail -10 result.txt | grep "BUILD SUCCESS"
+# code=0 if "BUILD SUCCESS" is found in the end of result.txt
+code=$?
+echo $code
+exit $code
 
-dockerCleanUp

libs/fmu_for_linux/compile.sh

+#!/usr/bin/env bash
+
+# This script re-compile all *.fmu files in the current directory using
+# current available c++ compiler. This makes the fmu files compatible with
+# the host OS.
+
+# For example if you have .fmu files exported from ModelicaEditor running
+# in Windows but you need linux version. To make these .fmu files compatible
+# with linux, you should:
+#   1. import and re-export the Windows version .fmu files using linux ModelicaEditor
+#   2. copy this script in the same directory where the re-exported .fmu files are located
+#   3. run this script with ./recompile_fmu.sh
+#   4. all .fmu files should be re-compiled and compatible with linux
+
+tmp_dir=./unzip_dir
+
+function compile() {
+  filename="$1"
+  unzip $filename -d $tmp_dir
+  cd ${tmp_dir}/sources && ./configure && make
+  cd ../..
+  zip -r $filename $tmp_dir
+  rm -rf $tmp_dir
+  echo "$filename"
+}
+
+for f in ./*.fmu; do
+    compile "$f"
+done
+

libs/fmu_for_linux/recompile_fmu.sh

+#!/usr/bin/env bash
+
+# This script re-compile all *.fmu files in the current directory using
+# current available c++ compiler. This makes the fmu files compatible with
+# the host OS.
+
+# For example if you have .fmu files exported from ModelicaEditor running
+# in Windows but you need linux version. To make these .fmu files compatible
+# with linux, you should:
+#   1. import and re-export the Windows version .fmu files using linux ModelicaEditor
+#   2. copy this script in the same directory where the re-exported .fmu files are located
+#   3. run this script with ./recompile_fmu.sh
+#   4. all .fmu files should be re-compiled and compatible with linux
+
+tmp_dir=./unzip_dir
+
+function compile() {
+  filename="$1"
+  unzip $filename -d $tmp_dir
+  cd ${tmp_dir}/sources && ./configure && make
+  cd ../..
+  zip -r $filename $tmp_dir
+  rm -rf $tmp_dir
+  echo "$filename"
+}
+
+for f in ./*.fmu; do
+    compile "$f"
+done
+

license/se/license.txt

+******************************************************************************
+ MontiCAR Modeling Family, www.se-rwth.de
+ Copyright (c) 2017, Software Engineering Group at RWTH Aachen,
+ All rights reserved.
+
+ This project is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 3.0 of the License, or (at your option) any later version.
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this project. If not, see <http://www.gnu.org/licenses/>.
+*******************************************************************************

main/resources/aachen.sim

-/* (c) https://github.com/MontiCore/monticore */
-sim Aachen {
-    sim_duration 4h;
-    
-    time 12:00;
-
-    map_name Aachen.osm;
-
-    car1(150.0,120.0,0.0)->(212.0,296.0,0.0);
-}

main/resources/aachen2.sim

-/* (c) https://github.com/MontiCore/monticore */
-sim Aachen {
-    sim_duration 4h;
-
-    time 12:00;
-
-    map_name Aachen.osm;
-
-    car1(150.0,120.0,0.0)->(212.0,296.0,0.0);
-    car2(212.0,296.0,0.0)->(150.0,120.0,0.0)
-}

main/resources/config.properties

-map=/extensions/AllInOne/aachen.osm
-mapName=Aachen2
-flat_map=true
-map_overlap=210
-map_sector_width=1000
-map_sector_length=1000
-max_sector_users=20
-weather_rain=0
-frame_loop_frequency=30
-cache_buffer=8500
-rmi_host=127.0.0.1
-rmi_port=10101
-v_model=AutopilotAdapter

restful/Dockerfile

@@ -2,9 +2,12 @@ FROM openjdk:8-jdk
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y openjfx && apt-get install -y metis && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends metis && \
+    rm -rf /var/lib/apt/lists/*
 
-COPY ./app.jar ./
-COPY ./app.db ./classes/app.db
+COPY --from=montisim-server-builder:latest /app/restful/target/restful.jar ./app.jar
+COPY --from=montisim-server-builder:latest ./app/restful/target/classes/app.db ./classes/app.db
+COPY --from=montisim-server-builder:latest ./app/restful/target/classes/default.car ./classes/default.car
 
 CMD java -jar app.jar

restful/README.md

@@ -7,11 +7,11 @@ retrieving the results.
 ## Install
 Install using maven:
 ```
-$ mvn clean install -settings=../settings.xml
+$ mvn clean install -settings=../settings.xml -DskipTests
 ```
 Run the server:
 ```
-$ java -jar ./target/restful-2.1.0-SNAPSHOT.jar
+$ java -jar ./target/restful-2.2.0-SNAPSHOT.jar
 ```
 
 It is also fine to start the server using your IDE, the main class is located at `src/main/java/server/restful/Server.java`.
@@ -79,7 +79,11 @@ Several options are available in there.
 
 ## Docker
 Since the server depends on multiple services, it is a good choice to run them all in docker
-containers. We can start all dependencies with docker at once:
+containers. First built docker images with `rpc/build.sh` and `restful/build.sh` and then
+edit the last line in `dev.yml` to add path to your local visualization files. 
+You can comment out the nginx service if you don't need visualization, 
+but in that case, please also uncomment line 49 of `dev.yml`
+Finally, start the project with: 
 ```
 $ docker-compose -f dev.yml up 
 ```
@@ -90,12 +94,7 @@ $ docker-compose -f dev.yml up --scale rmi-server=10 rmi-server
 $ docker-compose -f dev.yml up --scale rpc-server=3 rpc-server
 ```
 
-To build the docker image, first build the jar with maven and then:
-```
-$ ./build.sh
-```
-
-## Development with Docker
+## Developing with Docker
 The development always involves debugging, with docker, debugging has to be done via remote debugger.
 `dev.yml` already configured the restful server to run in debug mode, the JVM listens for debugging request
 at **localhost:8787**. 
@@ -129,11 +128,6 @@ rpc-server-debugger:
 ``` 
 It starts a rpc server that listen on port **8788** for debugging.
 
-## Test
-```
-$ ./run_test.sh
-```
-
 ## Visualization
 By default, visualization is not enabled in the server. 
 To enable visualization, put the static files under `restful/src/main/resources/resources`.
@@ -143,6 +137,18 @@ copy everything from [webapp directory](https://git.rwth-aachen.de/monticore/Emb
 `restful/src/main/resources/resources`.
 Start the restful server, the visualization client will be available at [http://127.0.0.1:8090/index.html](http://127.0.0.1:8090/index.html)
 
+It is highly recommended for frontend developers to use reverse proxy to serve
+the frontend files. Because otherwise, you need to recompile the restful module 
+every time you changed something in your code. For example, to use nginx as reverse proxy, 
+we provided a configuration(`nginx.conf`) for that. 
+You should 
+   1. update `root /app` to point it to your static files, such as `root /path/to/visualization/src/webapp`
+   2. update `proxy_pass http://server:8090;` to fit your case. If you started the restful server with `java -jar ...jar` command,
+   it should be `proxy_pass http://127.0.0.1:8090;`
+After you installed nginx, start it with this config file.
+
+If you use docker, you only need to update the last line of `dev.yml` in order to 
+use nginx.
 
 ## Simulation via RESTful API
 After the server started, simulation tasks can be configured via the RESTful APIs.
@@ -160,3 +166,11 @@ The sequence should be: