ci: add test, fmt, lint workflows

ethanndickson · ethanndickson · commit 78dfe0e59986 · 2024-12-16T15:45:21.000+11:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,57 @@
+name: ci
+
+on:
+  pull_request:
+    paths-ignore:
+      - "README.md"
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "README.md"
+
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: test
+    runs-on: ${{ github.repository_owner == 'coder' && 'depot-macos-latest' || 'macos-latest'}}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 1
+      - name: Switch XCode Version
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '16.0.0'
+      - run: |
+          make test
+        working-directory: Coder Desktop
+  format:
+    name: format
+    runs-on: ${{ github.repository_owner == 'coder' && 'depot-macos-latest' || 'macos-latest'}}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 1
+      - run: |
+          make fmt
+        working-directory: Coder Desktop
+  lint:
+    name: lint
+    runs-on: ${{ github.repository_owner == 'coder' && 'depot-macos-latest' || 'macos-latest'}}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 1
+      - name: Install Swiftlint
+        run: |
+          brew install swiftlint
+      - run: |
+          make lint
+        working-directory: Coder Desktop
diff --git a/Coder Desktop/.swiftlint.yml b/Coder Desktop/.swiftlint.yml
@@ -1,7 +1,10 @@
 disabled_rules:
   - todo
   - trailing_comma
+  - blanket_disable_command # Used by Protobuf
+  - opening_brace # Handled by SwiftFormat
 type_name:
   allowed_symbols: "_"
 identifier_name:
   allowed_symbols: "_"
+  min_length: 1
diff --git a/Coder Desktop/Coder Desktop.xcodeproj/project.pbxproj b/Coder Desktop/Coder Desktop.xcodeproj/project.pbxproj
@@ -721,6 +721,7 @@
 				CURRENT_PROJECT_VERSION = 1;
 				DEVELOPMENT_TEAM = 4399GN35BJ;
 				GENERATE_INFOPLIST_FILE = YES;
+				MACOSX_DEPLOYMENT_TARGET = 14.6;
 				MARKETING_VERSION = 1.0;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.coder.Coder-DesktopUITests";
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -737,6 +738,7 @@
 				CURRENT_PROJECT_VERSION = 1;
 				DEVELOPMENT_TEAM = 4399GN35BJ;
 				GENERATE_INFOPLIST_FILE = YES;
+				MACOSX_DEPLOYMENT_TARGET = 14.6;
 				MARKETING_VERSION = 1.0;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.coder.Coder-DesktopUITests";
 				PRODUCT_NAME = "$(TARGET_NAME)";
diff --git a/Coder Desktop/Coder Desktop.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Coder Desktop/Coder Desktop.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/Coder Desktop/Coder Desktop.xctestplan b/Coder Desktop/Coder Desktop.xctestplan
@@ -25,6 +25,7 @@
       }
     },
     {
+      "enabled" : false,
       "parallelizable" : true,
       "target" : {
         "containerPath" : "container:Coder Desktop.xcodeproj",
diff --git a/Coder Desktop/Coder Desktop/Theme.swift b/Coder Desktop/Coder Desktop/Theme.swift
@@ -8,5 +8,6 @@ enum Theme {
 
         static let rectCornerRadius: CGFloat = 4
     }
+
     static let defaultVisibleAgents = 5
 }
diff --git a/Coder Desktop/Coder Desktop/Views/Agents.swift b/Coder Desktop/Coder Desktop/Views/Agents.swift
@@ -6,7 +6,7 @@ struct Agents<VPN: VPNService, S: Session>: View {
     @State private var viewAll = false
     private let defaultVisibleRows = 5
 
-    internal let inspection = Inspection<Self>()
+    let inspection = Inspection<Self>()
 
     var body: some View {
         Group {
diff --git a/Coder Desktop/Coder Desktop/Views/LoginForm.swift b/Coder Desktop/Coder Desktop/Views/LoginForm.swift
@@ -11,7 +11,7 @@ struct LoginForm<C: Client, S: Session>: View {
     @State private var loading: Bool = false
     @FocusState private var focusedField: LoginField?
 
-    internal let inspection = Inspection<Self>()
+    let inspection = Inspection<Self>()
 
     var body: some View {
         VStack {
@@ -56,7 +56,7 @@ struct LoginForm<C: Client, S: Session>: View {
             .onReceive(inspection.notice) { self.inspection.visit(self, $0) } // ViewInspector
     }
 
-    internal func submit() async {
+    func submit() async {
         loginError = nil
         guard sessionToken != "" else {
             loginError = .invalidToken
@@ -67,7 +67,7 @@ struct LoginForm<C: Client, S: Session>: View {
             return
         }
         loading = true
-        defer { loading = false}
+        defer { loading = false }
         let client = C(url: url, token: sessionToken)
         do {
             _ = try await client.user("me")
@@ -135,8 +135,8 @@ struct LoginForm<C: Client, S: Session>: View {
                 Button("Sign In") {
                     Task { await submit() }
                 }
-                    .buttonStyle(.borderedProminent)
-                    .keyboardShortcut(.defaultAction)
+                .buttonStyle(.borderedProminent)
+                .keyboardShortcut(.defaultAction)
             }.padding(.top, 5)
         }
     }
diff --git a/Coder Desktop/Coder Desktop/Views/Util.swift b/Coder Desktop/Coder Desktop/Views/Util.swift
@@ -1,7 +1,7 @@
 import Combine
 
 // This is required for inspecting stateful views
-internal final class Inspection<V> {
+final class Inspection<V> {
     let notice = PassthroughSubject<UInt, Never>()
     var callbacks = [UInt: (V) -> Void]()
 
diff --git a/Coder Desktop/Coder Desktop/Views/VPNMenu.swift b/Coder Desktop/Coder Desktop/Views/VPNMenu.swift
@@ -4,7 +4,7 @@ struct VPNMenu<VPN: VPNService, S: Session>: View {
     @EnvironmentObject var vpn: VPN
     @EnvironmentObject var session: S
 
-    internal let inspection = Inspection<Self>()
+    let inspection = Inspection<Self>()
 
     var body: some View {
         // Main stack
diff --git a/Coder Desktop/Coder Desktop/Views/VPNState.swift b/Coder Desktop/Coder Desktop/Views/VPNState.swift
@@ -3,7 +3,7 @@ import SwiftUI
 struct VPNState<VPN: VPNService>: View {
     @EnvironmentObject var vpn: VPN
 
-    internal let inspection = Inspection<Self>()
+    let inspection = Inspection<Self>()
 
     var body: some View {
         Group {
diff --git a/Coder Desktop/Coder DesktopTests/AgentsTests.swift b/Coder Desktop/Coder DesktopTests/AgentsTests.swift
@@ -1,7 +1,7 @@
 @testable import Coder_Desktop
+import SwiftUI
 import Testing
 import ViewInspector
-import SwiftUI
 
 @Suite(.timeLimit(.minutes(1)))
 struct AgentsTests {
@@ -47,7 +47,7 @@ struct AgentsTests {
 
         let forEach = try view.inspect().find(ViewType.ForEach.self)
         #expect(forEach.count == Theme.defaultVisibleAgents)
-        #expect(throws: Never.self) { try view.inspect().find(link: "a1.coder")}
+        #expect(throws: Never.self) { try view.inspect().find(link: "a1.coder") }
     }
 
     @Test
diff --git a/Coder Desktop/Coder DesktopTests/LoginFormTests.swift b/Coder Desktop/Coder DesktopTests/LoginFormTests.swift
@@ -1,7 +1,7 @@
 @testable import Coder_Desktop
-import ViewInspector
-import Testing
 import SwiftUI
+import Testing
+import ViewInspector
 
 @Suite(.timeLimit(.minutes(1)))
 struct LoginTests {
diff --git a/Coder Desktop/Coder DesktopTests/Util.swift b/Coder Desktop/Coder DesktopTests/Util.swift
@@ -67,10 +67,10 @@ struct MockClient: Client {
 }
 
 struct MockErrorClient: Client {
-    init(url: URL, token: String?) {}
-    func user(_ ident: String) async throws -> Coder_Desktop.User {
+    init(url _: URL, token _: String?) {}
+    func user(_: String) async throws -> Coder_Desktop.User {
         throw ClientError.badResponse
     }
 }
 
-extension Inspection: @retroactive InspectionEmissary { }
+extension Inspection: @retroactive InspectionEmissary {}
diff --git a/Coder Desktop/Coder DesktopTests/VPNMenuTests.swift b/Coder Desktop/Coder DesktopTests/VPNMenuTests.swift
@@ -1,7 +1,7 @@
 @testable import Coder_Desktop
+import SwiftUI
 import Testing
 import ViewInspector
-import SwiftUI
 
 @Suite(.timeLimit(.minutes(1)))
 struct VPNMenuTests {
diff --git a/Coder Desktop/Coder DesktopTests/VPNStateTests.swift b/Coder Desktop/Coder DesktopTests/VPNStateTests.swift
@@ -1,7 +1,7 @@
 @testable import Coder_Desktop
-import ViewInspector
-import Testing
 import SwiftUI
+import Testing
+import ViewInspector
 
 @Suite(.timeLimit(.minutes(1)))
 struct VPNStateTests {
diff --git a/Coder Desktop/Coder DesktopUITests/Coder_DesktopUITests.swift b/Coder Desktop/Coder DesktopUITests/Coder_DesktopUITests.swift
@@ -7,7 +7,8 @@ final class Coder_DesktopUITests: XCTestCase {
         // In UI tests it is usually best to stop immediately when a failure occurs.
         continueAfterFailure = false
 
-        // In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this.
+        // In UI tests it’s important to set the initial state - such as
+        // interface orientation - required for your tests before they run. The setUp method is a good place to do this.
     }
 
     override func tearDownWithError() throws {
diff --git a/Coder Desktop/Coder DesktopUITests/Coder_DesktopUITestsLaunchTests.swift b/Coder Desktop/Coder DesktopUITests/Coder_DesktopUITestsLaunchTests.swift
@@ -1,7 +1,7 @@
 import XCTest
 
 final class Coder_DesktopUITestsLaunchTests: XCTestCase {
-    override class var runsForEachTargetApplicationUIConfiguration: Bool {
+    override static var runsForEachTargetApplicationUIConfiguration: Bool {
         true
     }
 
diff --git a/Coder Desktop/Makefile b/Coder Desktop/Makefile
@@ -0,0 +1,33 @@
+ifdef CI
+LINTFLAGS := --reporter github-actions-logging
+FMTFLAGS := --lint --reporter github-actions-log
+else
+LINTFLAGS :=
+FMTFLAGS :=
+endif
+
+PROJECT := "Coder Desktop.xcodeproj"
+SCHEME := "Coder Desktop"
+
+fmt:
+	swiftformat $(FMTFLAGS) .
+
+test:
+	xcodebuild test \
+	-project $(PROJECT) \
+	-scheme $(SCHEME) \
+	-testPlan $(SCHEME) \
+	-skipPackagePluginValidation \
+	CODE_SIGNING_REQUIRED=NO \
+	CODE_SIGNING_ALLOWED=NO \
+	| LC_ALL="en_US.UTF-8" xcpretty
+
+lint:
+	swiftlint \
+	--working-directory ../ \
+	--strict \
+	--quiet $(LINTFLAGS)
+
+clean:
+	xcodebuild clean \
+	-project $(PROJECT)
diff --git a/Coder Desktop/Proto/Receiver.swift b/Coder Desktop/Proto/Receiver.swift
@@ -1,6 +1,6 @@
 import Foundation
-import SwiftProtobuf
 import os
+import SwiftProtobuf
 
 /// An actor that reads data from a `DispatchIO` channel, and deserializes it into VPN protocol messages.
 actor Receiver<RecvMsg: Message> {
@@ -19,7 +19,7 @@ actor Receiver<RecvMsg: Message> {
     private func readLen() async throws -> UInt32 {
         let lenD: Data = try await withCheckedThrowingContinuation { continuation in
             var lenData = Data()
-            dispatch.read(offset: 0, length: 4, queue: queue) {done, data, error in
+            dispatch.read(offset: 0, length: 4, queue: queue) { done, data, error in
                 guard error == 0 else {
                     let errStrPtr = strerror(error)
                     let errStr = String(validatingUTF8: errStrPtr!)!
@@ -39,7 +39,7 @@ actor Receiver<RecvMsg: Message> {
     private func readMsg(_ length: UInt32) async throws -> RecvMsg {
         let msgData: Data = try await withCheckedThrowingContinuation { continuation in
             var msgData = Data()
-            dispatch.read(offset: 0, length: Int(length), queue: queue) {done, data, error in
+            dispatch.read(offset: 0, length: Int(length), queue: queue) { done, data, error in
                 guard error == 0 else {
                     let errStrPtr = strerror(error)
                     let errStr = String(validatingUTF8: errStrPtr!)!
diff --git a/Coder Desktop/Proto/Speaker.swift b/Coder Desktop/Proto/Speaker.swift
diff --git a/Coder Desktop/Proto/vpn.pb.swift b/Coder Desktop/Proto/vpn.pb.swift
diff --git a/Coder Desktop/ProtoTests/ProtoTests.swift b/Coder Desktop/ProtoTests/ProtoTests.swift
diff --git a/Coder Desktop/ProtoTests/SpeakerTests.swift b/Coder Desktop/ProtoTests/SpeakerTests.swift
diff --git a/Coder Desktop/VPN/PacketTunnelProvider.swift b/Coder Desktop/VPN/PacketTunnelProvider.swift

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`}`
`26`	`26`	`},`
`27`	`27`	`{`
	`28`	`+ "enabled" : false,`
`28`	`29`	`"parallelizable" : true,`
`29`	`30`	`"target" : {`
`30`	`31`	`"containerPath" : "container:Coder Desktop.xcodeproj",`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ enum Theme {`
`8`	`8`
`9`	`9`	`static let rectCornerRadius: CGFloat = 4`
`10`	`10`	`}`
	`11`	`+`
`11`	`12`	`static let defaultVisibleAgents = 5`
`12`	`13`	`}`