Fix failing CI Builds (swift-server#52)

* Exclude some files from soundness.sh

Motivation:

CI was failing as our soundness.sh script detected unacceptable language
in our repo that cannot be avoided.

Modifications:

* excluded `CODE_OF_CONDUCT.md` from soundness check as it deliberately gives
  examples of what unacceptable language looks like
* excluded all `*Config.swift` files from soundness check as Kafka
  configuration properties rely terminology which is considered
  unacceptable

Result:

The soundness CI check succeeds.

* Include SwiftFormat in Dockerfile

Motivation:

CI failed because SwiftFormat was not installed on in our Docker container and needed by the `soundness.sh` script.

Modifications:

* add instructions for installing `nicklockwood/SwiftFormat` to
  `Dockerfile`

Result:

SwiftFormat is available to the `soundness.sh` script.

* Adjust copyright header soundness check

Modifications:

* add copyright header to `Sources/Crdkafka/shim.h`
* exclude `librdkafka` from copyright header check

* Fix conflicting container names/ports

Motivation:

* CI was occasionally failing because of conflicting container
  names/ports

Modifications:

* remove explicit `container_name`s and `port`s in `docker-compose.yaml`

* SwiftFormat: --disable hoist(Try|Await)

* Run SwiftFormat

Author: felixschlegel

.swiftformat

@@ -19,5 +19,7 @@
 --disable redundantReturn
 --disable preferKeyPath
 --disable sortedSwitchCases
+--disable hoistTry
+--disable hoistAwait
 
 # rules

Sources/Crdkafka/shim.h

@@ -1,3 +1,17 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-kafka-gsoc open source project
+//
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
 #ifndef __RD_KAFKA_SHIM_H__
 #define __RD_KAFKA_SHIM_H__
 #include <librdkafka/rdkafka.h>

Sources/SwiftKafka/KafkaProducer.swift

@@ -221,7 +221,7 @@ public actor KafkaProducer {
                 valueBuffer.count,
                 keyBytes,
                 keyBytes?.count ?? 0,
-                UnsafeMutableRawPointer(bitPattern: messageIDCounter)
+                UnsafeMutableRawPointer(bitPattern: self.messageIDCounter)
             )
         }
 

docker/Dockerfile

@@ -11,6 +11,16 @@ RUN wget -qO - http://packages.confluent.io/deb/7.2/archive.key | apt-key add -
 RUN add-apt-repository "deb http://packages.confluent.io/deb/ $(lsb_release -cs) main" -y
 RUN apt-get install librdkafka-dev -y
 
+# 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.51.8
+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
+
 WORKDIR /swift-kafka-gsoc
 
 COPY . /swift-kafka-gsoc

docker/docker-compose.yaml

@@ -4,20 +4,13 @@ services:
 
   zookeeper:
     image: ubuntu/zookeeper
-    container_name: zookeeper
-    ports:
-      - "2181:2181"
 
   kafka:
     image: ubuntu/kafka
-    container_name: kafka_broker
     depends_on:
       - zookeeper
-    ports:
-      - "9092:9092"
     environment:
       ZOOKEEPER_HOST: zookeeper
-      ZOOKEEPER_PORT: 2181
 
   swift-kafka-gsoc:
     depends_on:
@@ -27,10 +20,9 @@ services:
       dockerfile: docker/Dockerfile
     environment:
       KAFKA_HOST: kafka
-      KAFKA_PORT: 9092
 
   # Swift on Server CI
-  # e.g. docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.57.yaml run test  
+  # e.g. docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.57.yaml run test
 
   runtime-setup:
     image: swift-kafka-gsoc:default
@@ -55,11 +47,10 @@ services:
     depends_on: [kafka, runtime-setup]
     environment:
       KAFKA_HOST: kafka
-      KAFKA_PORT: 9092    
     command: /bin/bash -xcl "swift $${SWIFT_TEST_VERB-test} $${WARN_AS_ERROR_ARG-} $${SANITIZER_ARG-} $${IMPORT_CHECK_ARG-}"
 
   # util
 
   shell:
     <<: *common
-    entrypoint: /bin/bash
+    entrypoint: /bin/bash

scripts/soundness.sh

@@ -30,9 +30,22 @@ unacceptable_terms=(
     -e slav[e]
     -e sanit[y]
 )
-if git grep --color=never -i "${unacceptable_terms[@]}" > /dev/null; then
+
+# We have to exclude the code of conduct because it gives examples of unacceptable language.
+# We have to exclude *Config.swift files as they need to map to Kafka terminology
+# which is considered unacceptable by us.
+exclude_files=(
+    CODE_OF_CONDUCT.md
+    *Config.swift
+)
+for word in "${exclude_files[@]}"; do
+    exclude_files+=(":(exclude)$word")
+done
+exclude_files_str=$(printf " %s" "${exclude_files[@]}")
+
+if git grep --color=never -i "${unacceptable_terms[@]}" -- . $exclude_files_str > /dev/null; then
     printf "\033[0;31mUnacceptable language found.\033[0m\n"
-    git grep -i "${unacceptable_terms[@]}"
+    git grep -i "${unacceptable_terms[@]}" -- . $exclude_files_str
     exit 1
 fi
 printf "\033[0;32mokay.\033[0m\n"
@@ -59,7 +72,8 @@ for language in swift-or-c bash dtrace python; do
   matching_files=( -name '*' )
   case "$language" in
       swift-or-c)
-        exceptions=( -name Package.swift )
+        # we don't add our own headers to the librdkafka submodule
+        exceptions=( -path '*Sources/Crdkafka/librdkafka/*' -o -name Package.swift )
         matching_files=( -name '*.swift' -o -name '*.c' -o -name '*.h' )
         cat > "$tmp" <<"EOF"
 //===----------------------------------------------------------------------===//