swift 5.1 docker setup (#133)

* swift 5.1 docker setup

motivation: support swift 5.1

changes:
* use formal swift docker images
* refactor docker-compose to seperate unit tests, integration tests and full test suites
* add docker compose file for swift 5.1, will add CI job once merged
* update swiftformat version to 0.40.12

Author: tomerd

docker/Dockerfile

@@ -1,59 +1,36 @@
-ARG ubuntu_version=16.04
-FROM ubuntu:$ubuntu_version
+ARG swift_version=5.0
+ARG ubuntu_version=bionic
+FROM swift:$swift_version-$ubuntu_version
 # needed to do again after FROM due to docker limitation
+ARG swift_version
 ARG ubuntu_version
 
-ARG DEBIAN_FRONTEND=noninteractive
-# do not start services during installation as this will fail and log a warning / error.
-RUN echo "#!/bin/sh\nexit 0" > /usr/sbin/policy-rc.d
+# set as UTF-8
+RUN apt-get update && apt-get install -y locales locales-all
+ENV LC_ALL en_US.UTF-8
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US.UTF-8
 
-# basic dependencies
-RUN apt-get update && apt-get install -y wget git build-essential software-properties-common pkg-config locales expect
-RUN apt-get update && apt-get install -y libicu-dev libblocksruntime0 libssl-dev
-
-# local
-RUN locale-gen en_US.UTF-8
-RUN locale-gen en_US en_US.UTF-8
-RUN dpkg-reconfigure locales
-RUN echo 'export LANG=en_US.UTF-8' >> $HOME/.profile
-RUN echo 'export LANGUAGE=en_US:en' >> $HOME/.profile
-RUN echo 'export LC_ALL=en_US.UTF-8' >> $HOME/.profile
-
-# known_hosts
-RUN mkdir -p $HOME/.ssh
-RUN touch $HOME/.ssh/known_hosts
-RUN ssh-keyscan github.com 2> /dev/null >> $HOME/.ssh/known_hosts
-
-# clang
-RUN apt-get update && apt-get install -y clang-3.9
-RUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-3.9 100
-RUN update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-3.9 100
-
-# modern curl, if needed
-ARG install_curl_from_source
-RUN apt-get update && apt-get install -y curl libcurl4-openssl-dev libz-dev
+# dependencies
+RUN apt-get update && apt-get install -y wget
+RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools expect # used by integration tests
+RUN apt-get update && apt-get install -y libssl-dev
 
 # ruby and jazzy for docs generation
-ARG skip_ruby_from_ppa
-RUN [ -n "$skip_ruby_from_ppa" ] || apt-add-repository -y ppa:brightbox/ruby-ng
-RUN [ -n "$skip_ruby_from_ppa" ] || { apt-get update && apt-get install -y ruby2.4 ruby2.4-dev; }
-RUN [ -z "$skip_ruby_from_ppa" ] || { apt-get update && apt-get install -y ruby ruby-dev; }
-RUN apt-get update && apt-get install -y libsqlite3-dev
+RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev
 RUN gem install jazzy --no-ri --no-rdoc
 
-# swift
-ARG swift_version=4.0.3
-ARG swift_flavour=RELEASE
-ARG swift_builds_suffix=release
+# tools
+RUN mkdir -p $HOME/.tools
+RUN echo 'export PATH="$HOME/.tools:$PATH"' >> $HOME/.profile
+
+# script to allow mapping framepointers on linux (until part of the toolchain)
+RUN wget -q https://raw.githubusercontent.com/apple/swift/master/utils/symbolicate-linux-fatal -O $HOME/.tools/symbolicate-linux-fatal
+RUN chmod 755 $HOME/.tools/symbolicate-linux-fatal
 
-RUN mkdir $HOME/.swift
-RUN wget -q "https://swift.org/builds/swift-${swift_version}-${swift_builds_suffix}/ubuntu$(echo $ubuntu_version | sed 's/\.//g')/swift-${swift_version}-${swift_flavour}/swift-${swift_version}-${swift_flavour}-ubuntu${ubuntu_version}.tar.gz" -O $HOME/swift.tar.gz
-RUN tar xzf $HOME/swift.tar.gz --directory $HOME/.swift --strip-components=1
-RUN echo 'export PATH="$HOME/.swift/usr/bin:$PATH"' >> $HOME/.profile
-RUN echo 'export LINUX_SOURCEKIT_LIB_PATH="$HOME/.swift/usr/lib"' >> $HOME/.profile
+# swiftformat (until part of the toolchain)
 
-# script to allow mapping framepointers on linux
-RUN mkdir -p $HOME/.scripts
-RUN wget -q https://raw.githubusercontent.com/apple/swift/master/utils/symbolicate-linux-fatal -O $HOME/.scripts/symbolicate-linux-fatal
-RUN chmod 755 $HOME/.scripts/symbolicate-linux-fatal
-RUN echo 'export PATH="$HOME/.scripts:$PATH"' >> $HOME/.profile
+ARG swiftformat_version=0.40.12
+RUN git clone --branch $swiftformat_version --depth 1 https://github.com/nicklockwood/SwiftFormat $HOME/.tools/swift-format
+RUN cd $HOME/.tools/swift-format && swift build -c release
+RUN ln -s $HOME/.tools/swift-format/.build/release/swiftformat $HOME/.tools/swiftformat

docker/docker-compose.1604.51.yaml

@@ -0,0 +1,19 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-nio-ssl:16.04-5.1
+    build:
+      args:
+        ubuntu_version: "xenial"
+        swift_version: "5.1"
+
+  unit-tests:
+    image: swift-nio-ssl:16.04-5.1
+
+  integration-tests:
+    image: swift-nio-ssl:16.04-5.1
+
+  test:
+    image: swift-nio-ssl:16.04-5.1

docker/docker-compose.1804.50.yaml

@@ -6,9 +6,14 @@ services:
     image: swift-nio-ssl:18.04-5.0
     build:
       args:
-        ubuntu_version: "18.04"
+        ubuntu_version: "bionic"
         swift_version: "5.0"
-        skip_ruby_from_ppa: "true"
+
+  unit-tests:
+    image: swift-nio-ssl:18.04-5.0
+
+  integration-tests:
+    image: swift-nio-ssl:18.04-5.0
 
   test:
     image: swift-nio-ssl:18.04-5.0

docker/docker-compose.yaml

@@ -1,6 +1,6 @@
 # this file is not designed to be run directly
 # instead, use the docker-compose.<os>.<swift> files
-# eg docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.1604.41.yaml run test
+# eg docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.1804.50.yaml run test
 version: "3"
 
 services:
@@ -23,6 +23,14 @@ services:
     <<: *common
     command: /bin/bash -cl "./scripts/sanity.sh"
 
+  unit-tests:
+    <<: *common
+    command: /bin/bash -cl "swift test -Xswiftc -warnings-as-errors"
+
+  integration-tests:
+    <<: *common
+    command: /bin/bash -cl "./scripts/integration_tests.sh"
+
   test:
     <<: *common
     command: /bin/bash -cl "swift test -Xswiftc -warnings-as-errors && ./scripts/integration_tests.sh"