Fix Linux build, add Docker dir for CI

Author: MaxDesiatov

.gitignore

@@ -7,6 +7,6 @@ DerivedData/
 .netrc
 .swiftpm
 tmp
-Artifacts
-Bundles
+/Artifacts
+/Bundles
 .vscode

Docker/Dockerfile

@@ -0,0 +1,17 @@
+ARG swift_version=5.7
+ARG ubuntu_version=jammy
+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
+
+# tools
+RUN mkdir -p $HOME/.tools
+RUN echo 'export PATH="$HOME/.tools:$PATH"' >> $HOME/.profile

Docker/docker-compose.2204.59.yaml

@@ -0,0 +1,19 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-sdk-generator:22.04-5.9
+    build:
+      args:
+        base_image: "swiftlang/swift:nightly-5.9-jammy"
+
+  test:
+    image: swift-sdk-generator:22.04-5.9
+    environment:
+      # - WARN_AS_ERROR_ARG=-Xswiftc -warnings-as-errors # need to fix S-CL-F sendability first
+      - IMPORT_CHECK_ARG=--explicit-target-dependency-import-check error
+      # - SANITIZER_ARG=--sanitize=thread # TSan broken still
+
+  shell:
+    image: swift-sdk-generator:22.04-5.9

Docker/docker-compose.2204.main.yaml

@@ -0,0 +1,19 @@
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-sdk-generator:22.04-main
+    build:
+      args:
+        base_image: "swiftlang/swift:nightly-main-jammy"
+
+  test:
+    image: swift-sdk-generator:22.04-main
+    environment:
+      # - WARN_AS_ERROR_ARG=-Xswiftc -warnings-as-errors # need to fix S-CL-F sendability first
+      - IMPORT_CHECK_ARG=--explicit-target-dependency-import-check error
+      # - SANITIZER_ARG=--sanitize=thread # TSan broken still
+
+  shell:
+    image: swift-sdk-generator:22.04-main

Docker/docker-compose.yaml

@@ -0,0 +1,34 @@
+# 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.2204.59.yaml run test
+version: "3"
+
+services:
+
+  runtime-setup:
+    image: swift-sdk-generator:default
+    build:
+      context: .
+      dockerfile: Dockerfile
+
+  common: &common
+    image: swift-sdk-generator:default
+    depends_on: [runtime-setup]
+    volumes:
+      - ~/.ssh:/root/.ssh
+      - ..:/code:z
+    working_dir: /code
+
+  soundness:
+    <<: *common
+    command: /bin/bash -xcl "swift -version && uname -a && ./Utilities/soundness.sh"
+
+  test:
+    <<: *common
+    command: /bin/bash -xcl "./Utilities/test.sh $${WARN_AS_ERROR_ARG-} $${SANITIZER_ARG-} $${IMPORT_CHECK_ARG-}"
+
+  # util
+
+  shell:
+    <<: *common
+    entrypoint: /bin/bash

Package.swift

@@ -36,7 +36,8 @@ let package = Package(
         .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
         .product(name: "AsyncHTTPClient", package: "async-http-client"),
         .product(name: "SystemPackage", package: "swift-system"),
-      ]
+      ],
+      exclude: ["Dockerfiles"]
     ),
     .testTarget(
       name: "SwiftSDKGeneratorTests",

Sources/SwiftSDKGenerator/DestinationsGenerator+Entrypoint.swift

@@ -149,7 +149,7 @@ extension SwiftSDKGenerator {
     logGenerationStep("Building a Docker image with the run-time triple environment...")
     try await buildDockerImage(
       name: imageName,
-      dockerfileDirectory: pathsConfiguration.sourceRoot
+      dockerfileDirectory: FilePath(#file)
         .appending("Dockerfiles")
         .appending("Ubuntu")
         .appending(versionsConfiguration.ubuntuVersion)

Dockerfiles/Ubuntu/22.04/Dockerfile Sources/SwiftSDKGenerator/Dockerfiles/Ubuntu/22.04/Dockerfile

@@ -102,6 +102,8 @@ public final class LocalSwiftSDKGenerator: SwiftSDKGenerator {
       throw GeneratorError.unknownMacOSVersion(macOSVersion)
     }
     return Triple(cpu: cpu, vendor: .apple, os: .macosx(version: "\(majorMacOSVersion).0"))
+    #elseif os(Linux)
+    return Triple(cpu: cpu, vendor: .unknown, os: .linux)
     #else
     fatalError("Triple detection not implemented for the platform that this generator was built on.")
     #endif

Sources/SwiftSDKGenerator/LocalSwiftSDKGenerator.swift

@@ -16,6 +16,17 @@ public struct Triple: CustomStringConvertible {
     case x86_64
     case arm64
 
+    public init?(rawValue: String) {
+      switch rawValue {
+        case "x86_64":
+          self = .x86_64
+        case "aarch64", "arm64":
+          self = .arm64
+        default:
+          return nil
+      }
+    }
+
     /// Returns the value of `cpu` converted to a convention used by Swift on Linux, i.e. `arm64` becomes `aarch64`.
     var linuxConventionName: String {
       switch self {
@@ -30,7 +41,7 @@ public struct Triple: CustomStringConvertible {
     case unknown
   }
 
-  enum OS: CustomStringConvertible {
+  enum OS: Hashable, CustomStringConvertible {
     case linux
     case darwin(version: String)
     case macosx(version: String)

Sources/SwiftSDKGenerator/SystemUtils/Triple.swift

@@ -43,9 +43,8 @@ final class EndToEndTests: XCTestCase {
     XCTAssertTrue(installOutput.contains("successfully installed"))
 
     let testPackageURL = FileManager.default.temporaryDirectory.appending(path: "swift-sdk-generator-test").path
-    print(testPackageURL)
     let testPackageDir = FilePath(testPackageURL)
-    try fm.removeItem(atPath: testPackageDir.string)
+    try? fm.removeItem(atPath: testPackageDir.string)
     try fm.createDirectory(atPath: testPackageDir.string, withIntermediateDirectories: true)
 
     try await Shell.run("swift package init --type executable", currentDirectory: testPackageDir)

Tests/EndToEndTests.swift

@@ -65,7 +65,7 @@ for language in swift-or-c bash python; do
   matching_files=( -name '*' )
   case "$language" in
       swift-or-c)
-        exceptions=( -name "Package.swift" -o -path "./Examples/*" -o -path "./Fixtures/*" -o -path "./IntegrationTests/*" -o -path "./Tests/ExtraTests/*" -o -path "./Tests/PackageLoadingTests/Inputs/*"  )
+        exceptions=( -name "Package.swift" -o -path "./Examples/*" -o -path "./Fixtures/*" -o -path "./IntegrationTests/*" -o -path "./Tests/*"  )
         matching_files=( -name '*.swift' -o -name '*.c' -o -name '*.h' )
         cat > "$tmp" <<"EOF"
 //===----------------------------------------------------------------------===//

Utilities/ci.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+##===----------------------------------------------------------------------===##
+##
+## This source file is part of the Swift open source project
+##
+## Copyright (c) YEARS Apple Inc. and the Swift project authors
+## Licensed under Apache License v2.0 with Runtime Library Exception
+##
+## See http://swift.org/LICENSE.txt for license information
+## See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+##
+##===----------------------------------------------------------------------===##
+
+set -ex
+
+if [ "$(uname)" = Darwin ]; then
+    swift test $@
+else
+    swift build $@
+fi