Merge pull request #29 from sio2project/Michcioperz-master

Debian packaging v2

Co-authored-by: Michał Sidor <public+git@meekchopp.es>

Author: b-chmiel

.dockerignore

@@ -0,0 +1 @@
+boxes/

.gitignore

@@ -21,3 +21,17 @@ pin.log
 .idea
 .cache
 __pycache__
+
+debian/.debhelper/
+debian/debhelper-build-stamp
+debian/files
+debian/*.substvars
+debian/sio2jail/
+obj-*/
+ccache/
+install/
+obj-x86*
+out/
+
+.vscode/
+.devcontainer/

CMakeLists.txt

@@ -13,8 +13,8 @@ ENDIF()
 IF(NOT DEFINED ARCH)
     SET(ARCH "NATIVE")
 ENDIF()
-IF(NOT ARCH MATCHES "i386|x86_64|NATIVE")
-    MESSAGE(FATAL_ERROR "ARCH should be one of i386, x86_64, NATIVE")
+IF(NOT ARCH MATCHES "i386|x86_64|amd64|NATIVE")
+    MESSAGE(FATAL_ERROR "ARCH should be one of i386, amd64, NATIVE")
 ENDIF()
 
 IF(NOT DEFINED WITH_CLANG_TIDY)
@@ -43,7 +43,7 @@ ENDIF()
 IF(ARCH STREQUAL "i386")
     SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32")
     SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32")
-ELSEIF(ARCH STREQUAL "x86_64")
+ELSEIF(ARCH MATCHES "amd64|x86_64")
     SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m64")
     SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m64")
 ENDIF()

Dockerfile

@@ -0,0 +1,24 @@
+FROM debian:bullseye
+
+RUN apt-get update && \
+	export DEBIAN_FRONTEND=noninteractive && \
+	apt-get install -y \
+	build-essential \
+	libcap-dev \
+	libtclap-dev \
+	libseccomp-dev \
+	libseccomp2 \
+	cmake \
+	g++-multilib \
+	gcc-multilib \
+	wget \
+	devscripts \
+	lintian \
+	debhelper \
+	ccache \
+	fakeroot
+
+ENV LIBRARY_PATH=/usr/lib/x86_64-linux-gnu
+ENV DEB_BUILD_OPTIONS "lang=en-US ccache nocheck"
+WORKDIR /app
+CMD ["/bin/bash"]

Makefile

@@ -0,0 +1,59 @@
+CC := g++
+INSTALL_PREFIX = $(HOME)/.local
+CONTAINER_NAME = sio2jail-dev-container
+CCACHE := $(shell ccache --version 2>/dev/null)
+
+ifdef CCACHE
+	CC := ccache
+endif
+
+define run_in_docker
+	docker build -t sio2jail-dev .
+	- docker run -v $(shell pwd)/ccache:/ccache -v $(shell pwd):/app -e CCACHE_DIR=/ccache --rm --name $(CONTAINER_NAME) -d -it sio2jail-dev bash
+	docker exec $(CONTAINER_NAME) $(1)
+	docker exec $(CONTAINER_NAME) rm -rf build
+	docker stop $(CONTAINER_NAME)
+endef
+
+install: clean
+	mkdir -p ccache
+	mkdir -p ccache/tmp
+	cmake -DCMAKE_CXX_COMPILER_LAUNCHER=$(CC) -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$(INSTALL_PREFIX) . -B ./build
+	make -C build 
+	make -C build install
+
+deb:
+	mkdir -p out
+	fakeroot debuild -us -uc -b
+	mv ../*.deb out/
+
+release: install deb
+	mkdir -p out
+	mv $(INSTALL_PREFIX)/bin/sio2jail out/
+
+release-docker: clean-docker
+	$(call run_in_docker,make release)
+
+install-docker: clean-docker
+	$(call run_in_docker,make install)
+
+deb-docker: clean-docker
+	$(call run_in_docker,make deb)
+
+test:
+	make -C build check
+
+clean:
+	- rm -rf build
+	- rm -rf out
+	- rm -rf obj-*
+	- rm -rf install
+	- rm -rf bin
+	- rm -rf debian/.debhelper
+	- rm -rf debian/sio2jail
+	- rm debian/files
+	- rm debian/sio2jail.substvars
+
+clean-docker:
+	- docker run -v $(shell pwd):/app --rm --name $(CONTAINER_NAME) -d -it sio2jail-dev bash
+	docker exec $(CONTAINER_NAME) make clean

README.md

@@ -1,8 +1,25 @@
 sio2jail
 ========
 
+Building in Docker
+--------
+
+Available commands: 
+
+* `make release-docker ` - build sio2jail binary and 
+.deb package. 
+
+* `make install-docker` - build sio2jail binary.
+
+* `make deb-docker` - build sio2jail .deb package.
 
-building
+* `make clean-docker` - clean up all temporary files.
+
+The output files are placed in `./out/` directory.
+
+For further reference and configuration see `./Makefile`.
+
+Building manually
 --------
 
 You need a CMake, a C/C++ compiler with multilib support and python2. Any
@@ -15,6 +32,9 @@ install files to ~/local directory run:
     cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$HOME/local ..
     make && make install
 
+For building with default configuration, see scripts in
+`./Makefile`.
+
 Our sio2jail uses some external libraries and programs:
   * libcap
   * libseccomp (>= 2.3.0)
@@ -55,7 +75,7 @@ option (STATIC by default):
 There is also a possibility to control whether output binary should run on other
 architecture than the default one (or force given architecture):
 
-    -DARCH=i386|x86_64
+    -DARCH=i386|amd64
 
 Note, that when using ARCH other than build host architecture it may be necessary
 (depending on libraries installation) to build sio2jail with custom libseccomp (more
@@ -66,7 +86,7 @@ ignore system libseccomp run:
 
     cmake -DWITH_DOCS=NO -DLIBTCLAP_PREFIX=/opt/tclap -DLIBSECCOMP_BUILD_OWN=YES ..
 
-running
+Running
 -------
 
 You may need to run
@@ -80,14 +100,14 @@ Additionally, if you want to use sandboxing on older Debian kernels, you'll need
 For both settings, you may also put these options in your /etc/sysctl.conf.
 This will make the settings persist across reboots.
 
-running tests
+Running tests
 -------------
 
 To run test suit use 'check' target, e.g in build directory run:
 
     make check
 
-notes for developers
+Notes for developers
 --------------------
 
 To manually run clang-format on each file run:

debian/README

@@ -0,0 +1 @@
+../README.md

debian/changelog

@@ -0,0 +1,5 @@
+sio2jail (1.4.3) UNRELEASED; urgency=medium
+
+  * Initial Release.
+
+ -- Michał Sidor <michcioperz@asirpa.iscute.ovh>  Sun, 12 Jan 2020 15:24:25 +0100

debian/compat

@@ -0,0 +1 @@
+11

debian/control

@@ -0,0 +1,16 @@
+Source: sio2jail
+Section: utils
+Priority: optional
+Maintainer: Oi Admins <oi-admins@dasie.mimuw.edu.pl>
+Build-Depends: debhelper (>= 11), cmake
+Standards-Version: 4.1.3
+Homepage: https://github.com/sio2project/sio2jail
+Vcs-Browser: https://github.com/sio2project/sio2jail
+Vcs-Git: https://github.com/sio2project/sio2jail.git
+
+Package: sio2jail
+Architecture: any
+Depends: ${shlibs:Depends}, ${misc:Depends}
+Description: Sandbox for programming contests.
+  A tool for supervising execution of programs 
+  submitted in algorithmic competitions.