Merge pull request #1 from c-jimenez/dev/dockerize_simulators

Now docker is used by default to build the project. DISABLE_DOCKER ma…

Author: c-jimenez

README.md

@@ -21,6 +21,17 @@ These 3 applications are communicating using the MQTT protocol and the simulated
 ## Install and build
 
 ### Pre-requisites
+The project can be be built using ether docker or natively.
+
+### With Docker
+Docker must be installed.
+
+Run the makefile target:
+```
+make docker-build-images
+```
+
+### Without Docker
 
 * Open OCPP library (see [Build and installation procedure](https://github.com/c-jimenez/open-ocpp#build))
 * [Paho MQTT library](https://www.eclipse.org/paho/) 1.3.8 or greater
@@ -38,7 +49,7 @@ On Debian the pre-requisites (except for Open OCPP) can be installed using the f
 
 ```
 sudo apt install python3 python3-pip mosquitto libpaho-mqtt-dev
-python3 -m pip install kivy paho-mqtt
+python3 -m pip install -r requirements.txt
 ```
 
 ### Build options
@@ -55,6 +66,8 @@ An helper makefile is available at project's level to simplify the use of CMake.
 
 ```make gcc-native``` or ```make clang-native``` or ```make gcc-native BUILD_TYPE=Debug``` or ```make clang-native BUILD_TYPE=Debug```
 
+The option ```DISABLE_DOCKER=1``` allows to build natively without docker.
+
 This makefile also contains the corresponding cleaning targets :
 
 ```make clean-gcc-native``` or ```make clean-clang-native```

docker/Dockerfile

@@ -0,0 +1,27 @@
+FROM debian:bullseye-slim AS open-ocpp-simu-compile
+
+SHELL ["/bin/bash", "-c"]
+
+ARG user=default
+ARG group=default
+ARG uid=1000
+ARG gid=1000
+
+# -y by default for apt-get
+RUN echo "APT::Get::Assume-Yes "true";" >> /etc/apt/apt.conf.d/aptconf
+
+
+RUN apt-get update && apt-get install build-essential clang cmake python3 python3-pip python3-venv wget libpaho-mqtt-dev git openssl libssl-dev sqlite3 libsqlite3-dev\
+&&  apt-get -q autoremove  &&  rm -rf "/var/lib/apt/lists/*"
+
+RUN git clone https://github.com/c-jimenez/open-ocpp.git
+
+RUN cd open-ocpp && make gcc-native && make install-gcc-native
+
+RUN apt-get update && apt-get install pkg-config &&  apt-get -q autoremove  &&  rm -rf "/var/lib/apt/lists/*"
+
+# Ensure user exist within container with same uid/gid
+RUN groupadd -g ${gid} ${group} && useradd -m -u ${uid} -g ${gid} ${user}
+
+USER ${uid}:${gid}
+ENTRYPOINT ["/bin/bash"]

docker/Dockerfile_cp_simulator

@@ -0,0 +1,22 @@
+FROM open-ocpp-simu-compile
+
+ARG simu_user=cp_simu
+ARG simu_group=cp_simu
+ARG simu_uid=1001
+ARG simu_gid=1001
+
+USER root
+# Ensure user exist within container with same uid/gid
+RUN groupadd -g ${simu_gid} ${simu_group} && useradd -m -u ${simu_uid} -g ${simu_gid} ${simu_user}
+RUN mkdir -p /var/chargepoint
+RUN chown ${simu_uid}:${simu_gid} /var/chargepoint
+COPY gcc_native/config.ini /var/chargepoint/config.ini
+RUN chown ${simu_uid}:${simu_gid} /var/chargepoint/config.ini
+
+COPY gcc_native  /cp_simulator
+
+USER cp_simu
+
+WORKDIR "/var/chargepoint"
+
+ENTRYPOINT  ["/cp_simulator/chargepoint"]

docker/Entrypoint/entrypoint.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+export PATH=/usr/bin/:$PATH
+$1 ${@:2}

makefile

@@ -15,18 +15,39 @@ PARALLEL_BUILD?=-j 4
 # Build type can be either Debug or Release
 BUILD_TYPE?=Debug
 
+# If set to 1, compilation is done natively on the current os otherwise a dedicated docker container is used to build the project
+DISABLE_DOCKER?=0
+
+
+DOCKER_COMPILE_IMAGE=open-ocpp-simu-compile
+
+
 # Default target
 default: gcc-native
 
 # Silent makefile
-.SILENT:
+#.SILENT:
 
 # Install prefix
 ifneq ($(strip $(INSTALL_PREFIX)),)
 CMAKE_INSTALL_PREFIX:=-D CMAKE_INSTALL_PREFIX=$(INSTALL_PREFIX)
 CMAKE_INSTALL_PREFIX_CMD:=--prefix $(INSTALL_PREFIX)
 endif
 
+
+INTERACTIVE:=$(shell [ -t 0 ] && echo 1)
+ifdef INTERACTIVE
+DOCKER_INTERACTIVE=-ti
+else
+DOCKER_INTERACTIVE=-i
+endif
+ifeq ($(DISABLE_DOCKER),0)
+DOCKER_RUN=docker run $(DOCKER_INTERACTIVE) --rm -v $(ROOT_DIR):$(ROOT_DIR):rw -w $(ROOT_DIR) -e http_proxy="${http_proxy}" -e https_proxy="${https_proxy}" -e no_proxy="${no_proxy}" $(DOCKER_COMPILE_IMAGE) docker/Entrypoint/entrypoint.sh
+else
+DOCKER_RUN=
+endif
+
+
 # Build/clean all targets
 all: gcc-native clang-native
 clean: clean-gcc-native clean-clang-native
@@ -38,7 +59,7 @@ GCC_NATIVE_BIN_DIR:=$(BIN_DIR)/gcc_native
 gcc-native: $(GCC_NATIVE_BUILD_DIR)/Makefile
 	@echo "Starting gcc-native build..."
 	@mkdir -p $(GCC_NATIVE_BIN_DIR)
-	@make --silent -C $(GCC_NATIVE_BUILD_DIR) $(VERBOSE) $(PARALLEL_BUILD)
+	${DOCKER_RUN} eval "make --silent -C $(GCC_NATIVE_BUILD_DIR) $(VERBOSE) $(PARALLEL_BUILD)"
 	@echo "gcc-native build done!"
 
 clean-gcc-native:
@@ -50,7 +71,8 @@ $(GCC_NATIVE_BUILD_DIR)/Makefile:
 	@echo "Generating gcc-native makefiles..."
 	@mkdir -p $(GCC_NATIVE_BUILD_DIR)
 	@mkdir -p $(GCC_NATIVE_BIN_DIR)
-	@cd $(GCC_NATIVE_BUILD_DIR) && export CC=gcc && export CXX=g++ && cmake -D CMAKE_BUILD_TYPE=$(BUILD_TYPE) -D TARGET=native -D BIN_DIR=$(GCC_NATIVE_BIN_DIR) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)
+	${DOCKER_RUN} eval "cd $(GCC_NATIVE_BUILD_DIR) && CC=gcc CXX=g++ cmake -D CMAKE_BUILD_TYPE=$(BUILD_TYPE) -D TARGET=native -D BIN_DIR=$(GCC_NATIVE_BIN_DIR) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)"
+	
 
 
 # Targets for clang-native build
@@ -59,7 +81,7 @@ CLANG_NATIVE_BIN_DIR:=$(BIN_DIR)/clang_native
 clang-native: $(CLANG_NATIVE_BUILD_DIR)/Makefile
 	@echo "Starting clang native build..."
 	@mkdir -p $(CLANG_NATIVE_BIN_DIR)
-	@make --silent -C $(CLANG_NATIVE_BUILD_DIR) $(VERBOSE) $(PARALLEL_BUILD)
+	@${DOCKER_RUN} eval "make --silent -C $(CLANG_NATIVE_BUILD_DIR) $(VERBOSE) $(PARALLEL_BUILD)"
 	@echo "clang native build done!"
 
 clean-clang-native:
@@ -71,4 +93,23 @@ $(CLANG_NATIVE_BUILD_DIR)/Makefile:
 	@echo "Generating clang-native makefiles..."
 	@mkdir -p $(CLANG_NATIVE_BUILD_DIR)
 	@mkdir -p $(CLANG_NATIVE_BIN_DIR)
-	@cd $(CLANG_NATIVE_BUILD_DIR) && export CC=clang && export CXX=clang++ && cmake -D CMAKE_BUILD_TYPE=$(BUILD_TYPE) -D TARGET=native -D _CMAKE_TOOLCHAIN_PREFIX=llvm- -D BIN_DIR=$(CLANG_NATIVE_BIN_DIR) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)
+	@${DOCKER_RUN} eval "cd $(CLANG_NATIVE_BUILD_DIR) && CC=clang CXX=clang++ cmake -D CMAKE_BUILD_TYPE=$(BUILD_TYPE) -D TARGET=native -D _CMAKE_TOOLCHAIN_PREFIX=llvm- -D BIN_DIR=$(CLANG_NATIVE_BIN_DIR) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)"
+
+
+DOCKER_BUILD=docker build --build-arg http_proxy="${http_proxy}" --build-arg https_proxy="${https_proxy}" --build-arg no_proxy="${no_proxy}" --build-arg uid=$$(id -u) --build-arg gid=$$(id -g)
+DOCKER_SIMULATOR_IMAGE=open-ocpp-cp-simulator
+docker-build-images: docker-build-simu-compile docker-build-cp-simulator
+
+docker-build-simu-compile:
+	@${DOCKER_BUILD}  -f docker/Dockerfile -t $(DOCKER_COMPILE_IMAGE)  $(ROOT_DIR)/docker
+
+docker-build-cp-simulator:
+	@${DOCKER_BUILD}  -f docker/Dockerfile_cp_simulator -t $(DOCKER_SIMULATOR_IMAGE)  $(ROOT_DIR)/bin/
+
+
+run-simu:
+	docker run $(DOCKER_INTERACTIVE) --rm  --network=host --name ocpp-simu $(DOCKER_SIMULATOR_IMAGE)
+	
+run-launcher:
+	docker run $(DOCKER_INTERACTIVE) --rm  --network=host --name ocpp-launcher --entrypoint /cp_simulator/launcher $(DOCKER_SIMULATOR_IMAGE)
+

requirements.txt

@@ -0,0 +1,2 @@
+kivy
+paho-mqtt

src/chargepoint/config/config.ini

@@ -19,7 +19,7 @@ CallRequestTimeout=2000
 ChargeBoxSerialNumber=S/N9876543210
 ChargePointModel=Open OCPP Simulated CP
 ChargePointSerialNumber=S/N0123456789
-ChargePointVendor=Open OCPP
+ChargePointVendor=OpenOCPP
 FirmwareVersion=0.1
 Iccid=
 Imsi=