prepare for oss (#8)

tomerd · ktoso · web-flow · commit b735bbe4ddb2 · 2020-10-14T11:10:37.000+09:00
* prepare for oss

motivation: setup ci as part of getting ready for oss

changes:
* adjust docker setup
* adjust scripts

* some benchmarks can't work on 5.0 because they benchmark 5.2+ features

Co-authored-by: Konrad `ktoso` Malawski &lt;konrad_malawski@apple.com&gt;
diff --git a/Package.swift b/Package.swift
@@ -9,7 +9,8 @@ let package = Package(
         .library(name: "TracingOpenTelemetrySupport", targets: ["TracingOpenTelemetrySupport"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", from: "0.0.1"),
+        // FIXME: changes to https when public
+        .package(url: "git@github.com:apple/swift-distributed-tracing-baggage.git", from: "0.0.1"),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
diff --git a/Sources/_TracingBenchmarks/SpanAttributesDSLBenchmark.swift b/Sources/_TracingBenchmarks/SpanAttributesDSLBenchmark.swift
@@ -11,6 +11,8 @@
 //
 //===----------------------------------------------------------------------===//
 
+#if swift(>=5.2)
+
 import _TracingBenchmarkTools
 import Tracing
 import TracingOpenTelemetrySupport
@@ -130,3 +132,5 @@ func bench_set_Int_dsl(times: Int) throws {
         span.attributes.http.statusCode = 200
     }
 }
+
+#endif
diff --git a/Sources/_TracingBenchmarks/main.swift b/Sources/_TracingBenchmarks/main.swift
@@ -36,6 +36,8 @@ private func registerBenchmark(_ name: String, _ function: @escaping (Int) -> Vo
     registerBenchmark(BenchmarkInfo(name: name, runFunction: function, tags: tags))
 }
 
+#if swift(>=5.2)
 registerBenchmark(SpanAttributesDSLBenchmarks)
+#endif
 
 main()
diff --git a/dev/Dockerfile-5.0.3 b/dev/Dockerfile-5.0.3
diff --git a/dev/Dockerfile-5.1 b/dev/Dockerfile-5.1
diff --git a/dev/Dockerfile-5.2 b/dev/Dockerfile-5.2
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -0,0 +1,32 @@
+ARG swift_version=5.0
+ARG ubuntu_version=bionic
+ARG base_image=swift:$swift_version-$ubuntu_version
+FROM $base_image
+# needed to do again after FROM due to docker limitation
+ARG swift_version
+ARG ubuntu_version
+
+# 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
+
+# dependencies
+RUN apt-get update && apt-get install -y wget
+RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools curl jq # used by integration tests
+
+# ruby and jazzy for docs generation
+RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev
+RUN gem install jazzy --no-ri --no-rdoc
+
+# tools
+RUN mkdir -p $HOME/.tools
+RUN echo 'export PATH="$HOME/.tools:$PATH"' >> $HOME/.profile
+
+# swiftformat (until part of the toolchain)
+
+ARG swiftformat_version=0.44.6
+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
diff --git a/docker/docker-compose.1804.50.yaml b/docker/docker-compose.1804.50.yaml
@@ -0,0 +1,16 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-distributed-tracing:18.04-5.0
+    build:
+      args:
+        ubuntu_version: "bionic"
+        swift_version: "5.0"
+
+  test:
+    image: swift-distributed-tracing:18.04-5.0
+
+  shell:
+    image: swift-distributed-tracing:18.04-5.0
diff --git a/docker/docker-compose.1804.51.yaml b/docker/docker-compose.1804.51.yaml
@@ -0,0 +1,18 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-distributed-tracing:18.04-5.1
+    build:
+      args:
+        ubuntu_version: "bionic"
+        swift_version: "5.1"
+
+  test:
+    image: swift-distributed-tracing:18.04-5.1
+    environment: []
+      #- SANITIZER_ARG=--sanitize=thread
+
+  shell:
+    image: swift-distributed-tracing:18.04-5.1
diff --git a/docker/docker-compose.1804.52.yaml b/docker/docker-compose.1804.52.yaml
@@ -0,0 +1,18 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-distributed-tracing:18.04-5.2
+    build:
+      args:
+        ubuntu_version: "bionic"
+        swift_version: "5.2"
+
+  test:
+    image: swift-distributed-tracing:18.04-5.2
+    environment: []
+      #- SANITIZER_ARG=--sanitize=thread
+
+  shell:
+    image: swift-distributed-tracing:18.04-5.2
diff --git a/docker/docker-compose.1804.53.yaml b/docker/docker-compose.1804.53.yaml
@@ -0,0 +1,17 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-distributed-tracing:18.04-5.3
+    build:
+      args:
+        base_image: "swiftlang/swift:nightly-5.3-bionic"
+
+  test:
+    image: swift-distributed-tracing:18.04-5.3
+    environment: []
+      #- SANITIZER_ARG=--sanitize=thread
+
+  shell:
+    image: swift-distributed-tracing:18.04-5.3
diff --git a/docker/docker-compose.yaml b/docker/docker-compose.yaml
@@ -0,0 +1,52 @@
+# 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.1804.50.yaml run test
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-distributed-tracing:default
+    build:
+      context: .
+      dockerfile: Dockerfile
+
+  common: &common
+    image: swift-distributed-tracing:default
+    depends_on: [runtime-setup]
+    volumes:
+      - ~/.ssh:/root/.ssh
+      - ..:/code:z
+    working_dir: /code
+    cap_drop:
+      - CAP_NET_RAW
+      - CAP_NET_BIND_SERVICE
+
+  sanity:
+    <<: *common
+    command: /bin/bash -xcl "./scripts/sanity.sh"
+
+  docs:
+    <<: *common
+    environment:
+      - CI
+    command: /bin/bash -xcl "./scripts/generate_docs.sh"
+
+  test:
+    <<: *common
+    security_opt: # FIXME: temp while private
+      - label=type:container_runtime_t
+    volumes: # FIXME: temp while private
+      - ..:/code:z
+      - ~/.ssh:/root/.ssh
+      - $SSH_AUTH_SOCK:/tmp/ssh-agent:z
+    environment: # FIXME: temp while private
+      - SSH_AUTH_SOCK=/tmp/ssh-agent
+      - GIT_SSH_COMMAND=ssh -vv -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no    
+    command: /bin/bash -xcl "swift test -Xswiftc -warnings-as-errors $${SANITIZER_ARG-}"
+
+  # util
+
+  shell:
+    <<: *common
+    entrypoint: /bin/bash

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`//`
`12`	`12`	`//===----------------------------------------------------------------------===//`
`13`	`13`
	`14`	`+#if swift(>=5.2)`
	`15`	`+`
`14`	`16`	`import _TracingBenchmarkTools`
`15`	`17`	`import Tracing`
`16`	`18`	`import TracingOpenTelemetrySupport`
`@@ -130,3 +132,5 @@ func bench_set_Int_dsl(times: Int) throws {`
`130`	`132`	`span.attributes.http.statusCode = 200`
`131`	`133`	`}`
`132`	`134`	`}`
	`135`	`+`
	`136`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@ private func registerBenchmark(_ name: String, _ function: @escaping (Int) -> Vo`
`36`	`36`	`registerBenchmark(BenchmarkInfo(name: name, runFunction: function, tags: tags))`
`37`	`37`	`}`
`38`	`38`
	`39`	`+#if swift(>=5.2)`
`39`	`40`	`registerBenchmark(SpanAttributesDSLBenchmarks)`
	`41`	`+#endif`
`40`	`42`
`41`	`43`	`main()`