feat: testable DependenciesResolverRunner, YAML support, assets support (#30)

* chore: ignore SPM folders

* chore: add BinaryDependenciesConfiguration (#9)

* chore: add yams (#7)

* chore: add config reader (#10)

* fix: make sure that tests can be ran with                 `BinaryDependencyManager` target (#8)

* fix: rename BinaryDependenciesManager to binary_dependencies_manager

* fix: Make sure that target naming is CamelCase and tests works

* fix: add Utils which is used from the Manager and the Runenr

* fix: Add binary file to exclude

* chpore: fix imports

---------

Co-authored-by: Paul Taykalo <[email protected]>

* chore: chore: add CLI and GitHub (#12)

* chore: add Asset to Dependency (#13)

* chore: add version (#11)

* chore: public interface (#14)

* chore: add BinaryDependenciesDownloader (#16)

* chore: add GenericError (#17)

* chore: add version to the BinaryDependenciesManager (#18)

* chore: refactor resolve command (#15)

* chore: refactor resolve command

* chore: update resolve command

* chore: add precondition

* chore: add easter egg

* chore: store dependenciesResolver

* chore: fix unwrapping

* chore: update file manager protocol (#20)

* chore: remove unneded downloadSourceCode method (#26)

* fix: resolve command (#23)

* chore: update CleanCommand (#22)

* chore: validate CLI run exit code (#24)

* chore: Utils tests target (#25)

* chore: add copyItem to FileManagerProtocol (#33)

* chore: add ChecksumCalculatorProtocol (#32)

* ci: add test workflow [refactor branch] (#28)

* ci: add test workflow

* fix(ci): linux build

* chore: specify derived data for xcodebuild

* chore: update Sources/BinaryDependencyManager/Utils/BinaryDependenciesConfigurationReader.swift

* chore: refactor runner (#19)

* chore: refactor DepeneciesResolverRunner

* chore: Tests cleanup (#34)

* Remove deduplication and simplify test setup

* A bit refactored tests

* fix: failing test with uuid neste temp dir

* fix: unwrapping

* chore: bump min target (#35)

---------

Co-authored-by: Paul Taykalo <[email protected]>

* chore: refactor download tests (#36)

* fix: ci compilation (#38)

* chore: refactor tests (#37)

* chore: standartize file URLs and update tests (#39)

---------

Co-authored-by: Paul Taykalo <[email protected]>

Author: nekrich

.github/workflows/test.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+      - chore/refactor
 
 jobs:
   test:
@@ -13,16 +14,16 @@ jobs:
     strategy:
       matrix:
         include:
-          - os: macos-latest
+          - os: macos-15
             build-system: swift
             swift-version: '6.1'
+            xcode-version: '16.4'
           - os: ubuntu-latest
             build-system: swift
             swift-version: '6.1'
-          # Will uncomment when target names are fixed.
-          # - os: macos-15
-          #   build-system: xcodebuild
-          #   xcode-version: '16.4'
+          - os: macos-15
+            build-system: xcodebuild
+            xcode-version: '16.4'
 
     runs-on: ${{ matrix.os }}
 
@@ -39,7 +40,9 @@ jobs:
     #     swift-version: ${{ matrix.swift-version }}
 
     - name: Setup Xcode
-      if: matrix.build-system == 'xcodebuild'
+      # Select Xcode for swift and xcodebuild.
+      # We need 6.1 swift and setup-swift@v2 is broken.
+      if: matrix.xcode-version != ''
       run: sudo xcode-select -s '/Applications/Xcode_${{ matrix.xcode-version }}.app'
 
     - name: Cache Swift packages
@@ -71,6 +74,7 @@ jobs:
         xcodebuild \
           -scheme ${{ env.package_name }} \
           -destination 'platform=macOS' \
+          -derivedDataPath DerivedData \
           -collect-test-diagnostics never \
           RUN_CLANG_STATIC_ANALYZER=NO \
           COMPILER_INDEX_STORE_ENABLE=NO \
@@ -82,6 +86,7 @@ jobs:
         xcodebuild \
           -scheme ${{ env.package_name }} \
           -destination 'platform=macOS' \
+          -derivedDataPath DerivedData \
           -collect-test-diagnostics never \
           RUN_CLANG_STATIC_ANALYZER=NO \
           COMPILER_INDEX_STORE_ENABLE=NO \

.gitignore

@@ -7,3 +7,5 @@ DerivedData/
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
 *.zip
+Binary/binary-dependencies-manager
+/.swiftpm

Package.resolved

@@ -6,34 +6,63 @@ import PackageDescription
 let package = Package(
     name: "binary-dependencies-manager",
     platforms: [
-        .macOS(.v11),
+        .macOS(.v14),
     ],
     products: [
         // Products define the executables and libraries a package produces, making them visible to other packages.
         .executable(
             name: "binary-dependencies-manager",
-            targets: ["BinaryDependenciesManager"]
+            targets: ["CommandLine"]
         ),
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMajor(from: "1.5.1")),
         .package(url: "https://github.com/apple/swift-crypto.git", .upToNextMajor(from: "3.12.3")),
+        .package(url: "https://github.com/jpsim/Yams.git", .upToNextMajor(from: "6.0.1")),
     ],
 
     targets: [
-        // Targets are the basic building blocks of a package, defining a module or a test suite.
-        // Targets can depend on other targets in this package and products from dependencies.
+
         .executableTarget(
-            name: "BinaryDependenciesManager",
+            name: "CommandLine",
             dependencies: [
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                "BinaryDependencyManager",
+                "Utils",
+            ]
+        ),
+
+        .target(
+            name: "BinaryDependencyManager",
+            dependencies: [
+                "Utils",
+                .product(name: "Yams", package: "Yams"),
+            ]
+        ),
+
+        .target(
+            name: "Utils",
+            dependencies: [
                 .product(name: "Crypto", package: "swift-crypto"),
             ]
         ),
 
         .testTarget(
-            name: "DependenciesResolverTests",
-            dependencies: ["BinaryDependenciesManager"]
+            name: "BinaryDependencyManagerTests",
+            dependencies: [
+                .target(name: "BinaryDependencyManager"),
+            ]
         ),
+
+        .testTarget(
+            name: "UtilsTests",
+            dependencies: [
+                .target(name: "Utils"),
+            ]
+        ),
+    ],
+
+    swiftLanguageVersions: [
+        .version("6")
     ]
 )

Package.swift

@@ -51,42 +51,74 @@ Run the tool by specifying the required paths:
 
 ```sh
 ./Binary/binary-dependencies-manager \
-  --dependencies path/to/dependencies.json \
+  --config path/to/.binary-dependencies.yaml \
   --cache path/to/cache \
   --output path/to/output
 ```
 
-- `--dependencies`: Path to your `dependencies.json` file (see format below)
+- `--config`, `-c`: Path to your `.binary-dependencies.yaml` file (see format below)
+- `--output`, `-o`: Directory where resolved dependencies will be extracted
 - `--cache`: Directory to use for caching downloads
-- `--output`: Directory where resolved dependencies will be extracted
 
 ## Example `dependencies.json`
 ```json
 [
   {
     "repo": "MyOrg/MyLibrary",
     "tag": "1.2.3",
-    "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
-    "contents": "XCFrameworks/MyLibrary.xcframework",
-    "pattern": "MyLibrary.xcframework.zip",
-    "output": "MyLibrary"
+    "assets": {
+      "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+      "contents": "XCFrameworks/MyLibrary.xcframework",
+      "pattern": "MyLibrary.xcframework.zip",
+      "output": "MyLibrary"
+    }
   },
   {
     "repo": "AnotherOrg/AnotherBinary",
     "tag": "0.9.0",
-    "checksum": "d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
+    "checksum": "7ab14dda40c47f9c4d1829b4c214898e4c61a2d3055c773169b7291d0f48cd0c",
     "pattern": "AnotherBinary.zip"
   }
 ]
 ```
 
+```yaml
+---
+minimumVersion: 0.0.5
+outputDirectory: Dependencies
+cacheDirectory: .cache/binary-dependencies/
+dependencies:
+  - repo: MyOrg/MyLibrary
+    tag: 1.2.3
+    assets:
+      - contents: XCFrameworks/MyLibrary.xcframework
+        checksum: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+        pattern: MyLibrary.xcframework.zip
+        output: MyLibrary
+  - repo: AnotherOrg/AnotherBinary
+    tag: 0.9.0
+    checksum: 7ab14dda40c47f9c4d1829b4c214898e4c61a2d3055c773169b7291d0f48cd0c
+    pattern: AnotherBinary.zip
+```
+## Top level parameters
+- `minimumVersion` (optional): Minimum required binary-dependencies-manager version. Optional. Defaults to the current version.
+- `outputDirectory` (optional): Path to the output directory. Optional. Defaults to `Dependencies/Binary`.
+- `cacheDirectory` (optional): Path to the cache directory. Optional. Defaults to the `.cache/binary-dependencies`.
+
+
 ## Dependency Parameters
 - `repo` (**required**): GitHub repository in the format `owner/repo` (e.g., `apple/swift-argument-parser`)
 - `tag` (**required**): Release tag to download (e.g., `1.0.0`)
+- `assets` (optional): A list of multiple binary assets to download from a given repo release.
+
+> ℹ️ If no assets are provided you can specify asset parameters as a dependency parameters to download a single release artifact.
+
+## Asset Parameters
 - `checksum` (**required**): SHA256 checksum of the zip archive for integrity verification
 - `contents` (optional): If provided, only the contents of this directory inside the archive will be extracted to the output directory
 - `pattern` (optional): Pattern to select a specific artifact from the release (useful if multiple assets are present)
-- `output` (optional): Subdirectory name to use for this dependency in the output directory (useful for organizing multiple artifacts)
+- `output` (optional): Subdirectory name to use for this dependency asset in the output directory (useful for organizing multiple artifacts)
+
 
 ## Example Scenarios
 - **Download a single artifact:**