chore: Run CLI unit tests in CI #1799

jbelkins · 2024-10-23T15:36:09Z

Issue #

Description of changes

I discovered that the CLI unit tests were failing due to an inability to read the build message & mapping files during tests. The test is fixed, and CLI unit tests are added to CI for visibility going forward.

Specific changes:

Adds unit tests for AWSSDKSwiftCLI to continuous integration. Tests are run on Mac and Linux, oldest & newest OS. (CLI unit tests are not run on any Apple platform simulators.)
The SPRCLI project does not contain unit tests, but it is built to ensure it builds without error.
The FeaturesReader type is modified to ensure that it accesses the right location during testing.
A few code fixes to ensure the project builds successfully.

New/existing dependencies impact assessment, if applicable

No new dependencies were added to this change.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

jbelkins · 2024-10-23T18:18:21Z

SPRCLI/Sources/SPR/Process+SPR.swift

@@ -6,7 +6,6 @@
 //

 import Foundation
-import PackageDescription


This is an old remnant of the AWSSDKSwiftCLI dependency on the swift-package-manager package.

jbelkins · 2024-10-23T18:18:42Z

SPRCLI/Package.swift

@@ -9,7 +9,7 @@ let package = Package(
    ],
    dependencies: [
        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.0"),
-        .package(url: "https://github.com/awslabs/aws-sdk-swift", from: "0.46.0"),
+        .package(url: "https://github.com/awslabs/aws-sdk-swift", from: "1.0.0"),


GA AWS SDK now used by the SPRCLI tools.

jbelkins · 2024-10-23T18:20:11Z

SPRCLI/Sources/SPR/UpdateList.swift

-                .appending(component: version)
+                .appendingPathComponent(scope)
+                .appendingPathComponent(name)
+                .appendingPathComponent(version)


You will see several places where the method appending(component:) is replaced by the older & now deprecated .appendingPathComponent(_:) so that these tools will compile on Swift 5.9.

jbelkins · 2024-10-23T18:20:38Z

SPRCLI/Sources/SPR/UploadMetadata.swift

@@ -47,7 +47,8 @@ extension SPRPublisher {
    }

    private func createMetadata() -> PackageInfo {
-        let now = Date().ISO8601Format()
+        let formatter = ISO8601DateFormatter()
+        let now = formatter.string(from: Date())


Another new method replaced by an older one for compatibility with older Swift.

jbelkins · 2024-10-23T18:22:51Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/Features.swift

@@ -8,25 +8,26 @@
 import Foundation
 import AWSCLIUtils

-struct FeaturesReader: Decodable {
-    private let requestFilePath: String
-    private let mappingFilePath: String


Instead of taking individual paths to files, this type assumes the individual files are in the parent of the current working directory (which will be the repo's root).

jbelkins · 2024-10-23T18:24:22Z

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Models/ReleaseNotesBuilderTests.swift

-                mappingFilePath: "feature-service-id.json"
-            )
+            features: FeaturesReader().getFeaturesFromFile(),
+            featuresIDToServiceName: FeaturesReader().getFeaturesIDToServiceNameDictFromFile()


During tests, the FeaturesReader just reads the feature & map files out of the temp project root created for testing.

jbelkins · 2024-10-23T18:25:14Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/ReleaseNotesBuilder.swift

@@ -15,7 +15,8 @@ struct ReleaseNotesBuilder {
    let repoOrg: PrepareRelease.Org
    let repoType: PrepareRelease.Repo
    let commits: [String]
-    var featuresReader: FeaturesReader = FeaturesReader()
+    let features: Features
+    let featuresIDToServiceName: [String: String]


ReleaseNotesBuilders takes the feature list & mapping as inputs rather than reading them itself.

jbelkins · 2024-10-23T18:25:59Z

.github/workflows/continuous-integration.yml

@@ -15,7 +15,7 @@ jobs:
      matrix:
        # This matrix runs tests on iOS sim & Mac, on oldest & newest supported Xcodes
        runner:
-          - macos-13
+          - macos-14


macos-14 is used for running min Xcode instead of macos-13. This matches the macOS used in Catapult.

jbelkins · 2024-10-23T18:26:50Z

.github/workflows/continuous-integration.yml

+          swift test
+          cd ../SPRCLI
+          unset AWS_SWIFT_SDK_USE_LOCAL_DEPS
+          swift build


Macs test & build CLI tools only directly on the Mac, not on simulators.

jbelkins · 2024-10-23T18:27:17Z

.github/workflows/continuous-integration.yml

+          swift test
+          cd ../SPRCLI
+          unset AWS_SWIFT_SDK_USE_LOCAL_DEPS
+          swift build


All Linux jobs build & test the CLI tools.

jbelkins · 2024-10-23T18:28:26Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Commands/AWSSDKSwiftCLI/Subcommands/PrepareRelease.swift

@@ -235,13 +235,16 @@ struct PrepareRelease {
        previousVersion: Version
    ) throws {
        let commits = try Process.git.listOfCommitsBetween("HEAD", "\(previousVersion)")
-
+        let featuresReader = FeaturesReader(repoPath: repoPath)


PrepareRelease configures & runs the FeatureReader with its own repoPath, then the features & mapping are injected into the ReleaseNotesBuilder.

jbelkins · 2024-10-23T18:29:48Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/ReleaseNotesBuilder.swift

-        let features = try featuresReader.getFeaturesFromFile()
-        let mapping = try featuresReader.getFeaturesIDToServiceNameDictFromFile()
-        return buildServiceFeatureSection(features, mapping) + buildServiceDocSection(features, mapping)
+        return buildServiceFeatureSection(features, featuresIDToServiceName) + buildServiceDocSection(features, featuresIDToServiceName)


Here, the injected features & mapping are used directly to generate the release notes content.

jbelkins · 2024-10-23T18:30:16Z

SPRCLI/Sources/SPR/SPRPublisher.swift

@@ -65,7 +65,7 @@ public struct SPRPublisher {
    }

    private mutating func setOptions() async {
-        await SDKLoggingSystem.initialize(logLevel: .error)
+        await SDKLoggingSystem().initialize(logLevel: .error)


We changed this interface before GA.

sichanyoo

Will approve when E2E tests pass

This reverts commit cdd65ac.

jbelkins · 2024-10-23T20:33:22Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Commands/AWSSDKSwiftCLI/Subcommands/PrepareRelease.swift

@@ -235,13 +235,16 @@ struct PrepareRelease {
        previousVersion: Version
    ) throws {
        let commits = try Process.git.listOfCommitsBetween("HEAD", "\(previousVersion)")
-
+        let featuresReader = FeaturesReader()
+


Features reader is used to read the build message & mapping, then the read data is passed into the release notes builder.

… dir

This reverts commit 3bba2eb.

jbelkins · 2024-10-23T21:54:07Z

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Models/ReleaseNotesBuilderTests.swift

@@ -12,7 +12,7 @@ import XCTest
 /*
 *  Regression tests for protection against change in generated release notes markdown content.
 */
-class ReleaseNotesBuilderTests: XCTestCase {
+class ReleaseNotesBuilderTests: CLITestCase {


This test now inherits from CLITestCase, which sets up a temporary directory structure that allows the Trebuchet files to be written to the workspace directory.

jbelkins · 2024-10-23T21:56:11Z

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/CLITestCase.swift

@@ -11,8 +11,14 @@ import AWSCLIUtils

 class CLITestCase: XCTestCase {
    let tmpPath = "tmp"
+    let projectPath = "aws-sdk-swift-or-smithy-swift"


The directory at tmpPath now serves as the "workspace" dir.
A "project directory" named projectPath is created within.

This structure allows Trebuchet build files to be written to the same relative location in tests as in actual use.

jbelkins added 11 commits October 23, 2024 10:35

chore: Run CLI unit tests in CI

231adf4

Fix 'Failed to load data for file at path ../build-request.json' error

f18b7e8

Fix SPRCLI tests, fix path methods

dd803d8

Remove reference to PackageDescription from SPRCLI

e26ee0d

Use older form of file URL initializer

5c17a4d

Fix SPRCLI build, move it to AWS SDK 1.0+

e6aa350

Move CI from macos-13 to macos-14

45a3bbf

build SPRCLI only, no tests

1288bf2

Run CLI unit tests on Linux too

c5bffb5

Update path references

17f8c72

Fix date formatter

84d9220

jbelkins commented Oct 23, 2024

View reviewed changes

jbelkins marked this pull request as ready for review October 23, 2024 18:33

jbelkins requested a review from sichanyoo October 23, 2024 18:45

sichanyoo reviewed Oct 23, 2024

View reviewed changes

jbelkins added 3 commits October 23, 2024 15:00

Merge remote-tracking branch 'origin/main' into jbe/cli_unti_tests_in_ci

4bac8e3

Dummy build request & mapping files added

cdd65ac

FeaturesReader now always reads from CWD

9782279

Revert "Dummy build request & mapping files added"

3bba2eb

This reverts commit cdd65ac.

jbelkins commented Oct 23, 2024

View reviewed changes

jbelkins requested a review from sichanyoo October 23, 2024 20:34

jbelkins added 4 commits October 23, 2024 16:43

Code & tests now fixed to read Trebuchet files from parent of project…

d3cdd34

… dir

Revert "Revert "Dummy build request & mapping files added""

465ee53

This reverts commit 3bba2eb.

chore: Updates version to 1.0.27

5604554

Remove Trebuchet build files

835f097

jbelkins commented Oct 23, 2024

View reviewed changes

jbelkins added 4 commits October 23, 2024 16:57

Merge remote-tracking branch 'origin/main' into jbe/cli_unti_tests_in_ci

3ed9e1d

Fix comment

cc376b2

Revert version files

df03510

Revert version files

681870b

sichanyoo approved these changes Oct 23, 2024

View reviewed changes

jbelkins merged commit e45efb8 into main Oct 23, 2024
29 checks passed

jbelkins deleted the jbe/cli_unti_tests_in_ci branch October 23, 2024 23:23

jbelkins mentioned this pull request Oct 23, 2024

Run AWSSDKSwiftCLI unit tests in CI #1732

Closed

2 tasks

jbelkins added a commit that referenced this pull request Oct 28, 2024

chore: Run CLI unit tests in CI (#1799)

6b89e23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Run CLI unit tests in CI #1799

chore: Run CLI unit tests in CI #1799

jbelkins commented Oct 23, 2024 •

edited

Loading

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024 •

edited

Loading

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024 •

edited

Loading

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

sichanyoo left a comment

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

jbelkins Oct 23, 2024

chore: Run CLI unit tests in CI #1799

chore: Run CLI unit tests in CI #1799

Conversation

jbelkins commented Oct 23, 2024 • edited Loading

Issue #

Description of changes

New/existing dependencies impact assessment, if applicable

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbelkins Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbelkins Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sichanyoo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbelkins commented Oct 23, 2024 •

edited

Loading

jbelkins Oct 23, 2024 •

edited

Loading

jbelkins Oct 23, 2024 •

edited

Loading