Improvements on #24

.github/workflows/build-and-release.yml

@@ -12,10 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         macos: ['macos-12']
-        xcode: ['14.1.0']
-        command: ['build']
-        scheme: ['StellarCLI','StellarEnv']
-        destination: ['platform=macOS']
+        xcode: ['14.2.0']
     steps:
       - name: Switch xcode to ${{ matrix.xcode }}
         run: sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
@@ -30,13 +27,7 @@ jobs:
       - name: Show buildable schemes
         working-directory: ./Stellar
         run: xcodebuild -list
-      - name: Show eligible build destinations for ${{ matrix.scheme }}
-        working-directory: ./Stellar
-        run: xcodebuild -showdestinations -scheme ${{ matrix.scheme }}
-      - name: Run command ${{ matrix.command }} on ${{ matrix.scheme }} for destination ${{ matrix.destination }}
-        working-directory: ./Stellar
-        run: xcodebuild ${{ matrix.command }} -scheme ${{ matrix.scheme }} -destination "${{ matrix.destination }}"
-      - name: Archive using ${{ matrix.scheme }} for destination ${{ matrix.destination }}
+      - name: Build products for release
         working-directory: ./Stellar
         run: swift build -c release --arch arm64 --arch x86
       - name: Copy Templates.bundle
@@ -58,7 +49,7 @@ jobs:
           release_name: Release ${{ github.ref }}
           draft: false # just for testing
           prerelease: false # just for testing
-      - name: Upload StellarCLI
+      - name: Upload StellarCLI release asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
@@ -67,7 +58,7 @@ jobs:
           asset_path: ./Stellar/.build/apple/Products/Release/StellarCLI.zip
           asset_name: StellarCLI.zip
           asset_content_type: application/zip
-      - name: Upload StellarEnv
+      - name: Upload StellarEnv release asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}

.github/workflows/run-tests.yml

@@ -6,7 +6,7 @@ on:
       - master
   pull_request:
     branches:
-      - master
+      - '**'
 
 jobs:
   build:
@@ -15,9 +15,9 @@ jobs:
       fail-fast: false
       matrix:
         macos: ['macos-12']
-        xcode: ['14.1.0']
+        xcode: ['14.2.0']
         command: ['test']
-        scheme: ['StellarCLI']
+        scheme: ['StellarCLI', 'StellarEnv']
         destination: ['platform=macOS']
     steps:
       - name: Switch xcode to ${{ matrix.xcode }}

Stellar/.swiftpm/xcode/xcshareddata/xcschemes/StellarEnv.xcscheme

@@ -42,16 +42,6 @@
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "StellarTests"
-               BuildableName = "StellarTests"
-               BlueprintName = "StellarTests"
-               ReferencedContainer = "container:">
-            </BuildableReference>
-         </TestableReference>
          <TestableReference
             skipped = "NO">
             <BuildableReference

Stellar/Package.swift

@@ -5,7 +5,7 @@ import PackageDescription
 
 let package = Package(
     name: "Stellar",
-    platforms: [.macOS(.v13)],
+    platforms: [.macOS(.v12)],
     products: [
         .executable(
             name: "StellarCLI",
@@ -19,17 +19,11 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMajor(from: "1.0.0")),
+        .package(url: "https://github.com/apple/swift-tools-support-core.git", .upToNextMajor(from: "0.5.2")),
         .package(url: "https://github.com/SwiftGen/StencilSwiftKit.git", .upToNextMajor(from: "2.8.0")),
-        .package(url: "https://github.com/JohnSundell/ShellOut.git", .upToNextMajor(from: "2.3.0")),
-        .package(url: "https://github.com/apple/swift-tools-support-core.git", from: "0.3.0")
+        .package(url: "https://github.com/JohnSundell/ShellOut.git", .upToNextMajor(from: "2.3.0"))
     ],
     targets: [
-        .executableTarget(
-            name: "StellarEnv",
-            dependencies: [
-                .product(name: "ArgumentParser", package: "swift-argument-parser"),
-                .target(name: "StellarCore")],
-            path: "Sources/Env"),
         .executableTarget(
             name: "StellarCLI",
             dependencies: [
@@ -40,16 +34,18 @@ let package = Package(
             name: "StellarCore",
             dependencies: [
                 .product(name: "ShellOut", package: "ShellOut"),
-                .product(name: "TSCBasic", package: "swift-tools-support-core"),
-                .product(name: "StencilSwiftKit", package: "StencilSwiftKit")
+                .product(name: "StencilSwiftKit", package: "StencilSwiftKit"),
+                .product(name: "TSCBasic", package: "swift-tools-support-core")
+
             ],
             path: "Sources/Core",
             resources: [.copy("Resources")]),
-        .testTarget(
-            name: "StellarEnvTests",
-            dependencies: ["StellarEnv"],
-            path: "Tests/Env",
-            resources: [.copy("Tests")]),
+        .executableTarget(
+            name: "StellarEnv",
+            dependencies: [
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                .target(name: "StellarCore")],
+            path: "Sources/Env"),
         .testTarget(
             name: "StellarCLITests",
             dependencies: ["StellarCLI"],
@@ -58,6 +54,10 @@ let package = Package(
             name: "StellarCoreTests",
             dependencies: ["StellarCore"],
             path: "Tests/Core",
-            resources: [.copy("Resources")])
+            resources: [.copy("Resources")]),
+        .testTarget(
+            name: "StellarEnvTests",
+            dependencies: ["StellarEnv"],
+            path: "Tests/Env")
     ]
 )

Stellar/Sources/Core/Constants/Constants.swift

@@ -7,14 +7,11 @@ struct Constants {
     static let executor = "Executor"
 }
 
-struct HintTemplateNames {
-    static let actionCreatedOnDefaultPath = "ActionCreatedOnDefaultPath.stencil"
-}
-
 struct FileConstants {
     static let versionsFile = ".stellar-version"
     static let binFolder = ".stellar-bin"
-    static let binName = ".stellar"
+    static let binName = "stellar"
+    static let toolFolder = ".stellar"
     static let envInstallDirectory = "/usr/local/bin"
     static let envBinName = "stellarenv"
 }
@@ -29,25 +26,25 @@ struct GitHubAPI {
     static let tokenFile = ".GITHUB-TOKEN"
 
     static var gitHubToken: String = {
-        let tokenFileURL = URLManager().systemLocation()
+        let tokenFileURL = URLManager().homeStellarLocation()
             .appendingPathComponent(GitHubAPI.tokenFile)
 
         guard FileManager.default.fileExists(at: tokenFileURL) else {
             print(tokenFileURL.path)
-            fatalError("Missing \(GitHubAPI.tokenFile) in \(FileConstants.binName) directory")
+            fatalError("Missing \(GitHubAPI.tokenFile) in ~/\(FileConstants.toolFolder) directory.")
         }
 
         let token = try? String(contentsOf: tokenFileURL)
+            .trimmingCharacters(in: .whitespacesAndNewlines)
         return token ?? ""
     }()
 
 }
 
 struct RemoteConstants {
     static let releaseZip = "release.zip"
-    static let stellarPackage = "\(stellarCLI).zip"
     static let stellarCLI = "StellarCLI"
-
+    static let stellarCLIZipAsset = "\(stellarCLI).zip"
     static let stellarEnvCLI = "StellarEnv"
-    static let stellarEnvPackage = "\(stellarEnvCLI).zip"
+    static let stellarEnvZipAsset = "\(stellarEnvCLI).zip"
 }

Stellar/Sources/Core/FileManaging/FileManager+FileManaging.swift

@@ -80,29 +80,27 @@ extension FileManager: FileManaging {
         try moveItem(atPath: location.path, toPath: destination.path)
     }
 
-    /// Creates a temporary directory and evaluates a closure with the directory path as an argument.
+    /// Create a temporary directory and evaluates a closure with the directory path as an argument.
     ///
     ///
     /// - Parameters:
     ///   - path: when specified this path is used as root of the temporary directory.
     ///           If not the system temporary directory path is used.
-    ///   - prefix: The prefix to the temporary file name.
-    ///   - autoRemove: If enabled try to delete the whole directory tree otherwise remove only if its empty.
+    ///   - prefix: The prefix of the temporary directory.
+    ///   - autoRemove: If true, it tries to delete the temporary directory after executing the closure.
     ///   - closure: A closure to execute that receives the absolute path of the directory as an argument.
-    ///              If `body` has a return value, that value is also used as the return value of the function.
-    /// - Returns: `Result` specified
+    /// - Returns: The value returned by the closure.
     public func withTemporaryDirectory<Result>(path: String? = nil,
                                                prefix: String = "TempDir",
-                                               autoRemove: Bool = true ,
+                                               autoRemove: Bool = true,
                                                _ closure: (URL) throws -> Result) throws -> Result {
-        // Construct path to the temporary directory.
         let folderName = "\(prefix)-\(UUID().uuidString)"
-        let directoryPath = URL(fileURLWithPath: (path ?? NSTemporaryDirectory()), isDirectory: true).appendingPathComponent(folderName, isDirectory: true)
-        try FileManager.default.createDirectory(atPath: directoryPath.path, withIntermediateDirectories: true)
+        let location = URL(fileURLWithPath: (path ?? NSTemporaryDirectory()), isDirectory: true).appendingPathComponent(folderName, isDirectory: true)
+        try createDirectory(at: location, withIntermediateDirectories: true)
 
-        let res = try closure(directoryPath)
+        let res = try closure(location)
         if autoRemove {
-            try? FileManager.default.removeItem(atPath: directoryPath.path)
+            try? removeItem(at: location)
         }
         return res
     }

Stellar/Sources/Core/Installer/BundleUpdater.swift

@@ -16,8 +16,10 @@ public final class BundleUpdater: BundleUpdating {
 
     // MARK: - Public Properties
 
-    public var cliInstaller: CLIInstaller
-    public var envInstaller: EnvInstaller
+    public let cliInstaller: CLIInstaller
+    public let envInstaller: EnvInstaller
+
+    private let logger = Logger()
 
     public var releaseProvider: ReleaseProviding {
         cliInstaller.releaseProvider
@@ -48,15 +50,15 @@ public final class BundleUpdater: BundleUpdating {
     // MARK: - Private Functions
 
     private func updateBundle(toVersion version: String) throws -> URL? {
-        // Version is not available locally, we would to retrive it remotely.
+        // Version is not available locally, we retrive it remotely.
         if try versionResolver.isVersionInstalled(version) == false {
-            Logger().log("Version \(version) not found locally. Installing...")
+            logger.log("Version \(version) not found locally. Installing...")
             return try cliInstaller.install(version: version)
         }
 
         // Attempt to get the path of the release.
         guard let versionPath = try versionResolver.pathForVersion(version)?.path else {
-            Logger().log("Failed to use version \(version). Aborting the process...")
+            logger.log("Failed to use version \(version). Aborting the process...")
             return nil
         }
 
@@ -65,36 +67,36 @@ public final class BundleUpdater: BundleUpdating {
 
     private func updateBundleToLatestVersion() throws -> URL? {
         guard let release = try releaseProvider.latestRelease() else {
-            Logger().log("No remote version found")
+            logger.log("No remote version found")
             return nil
         }
 
-        let versionURL = try updateCLI(toRemoteVersion: release)
-        try updateENV(toRemoteVersion: release)
+        let versionURL = try updateCLIToLatestVersion(release.version)
+        try updateENVToLatestVersion(release.version)
 
-        Logger().log("Stellar version \(release.description) installed")
+        logger.log("Stellar version \(release.description) installed")
 
         return versionURL
     }
 
-    private func updateCLI(toRemoteVersion version: RemoteRelease) throws -> URL? {
+    private func updateCLIToLatestVersion(_ version: SemVer) throws -> URL? {
         if let latestLocalVersion = try cliInstaller.latestInstalledVersion() {
-            guard version.version > latestLocalVersion.version else {
-                Logger().log("There are not updates available")
+            guard version > latestLocalVersion.version else {
+                logger.log("Version \(latestLocalVersion) is installed and greater than latest available \(version)")
                 return nil
             }
 
-            Logger().log("Installing new version available \(version)")
+            logger.log("Installing new version available \(version)")
         } else {
-            Logger().log("No local version available. Installing latest version \(version)")
+            logger.log("No local version available. Installing latest version \(version)")
         }
 
         // Install version of stellar
         return try cliInstaller.install(version: version.description)
     }
 
-    private func updateENV(toRemoteVersion version: RemoteRelease) throws {
-        Logger().log("Updating stellarenv")
+    private func updateENVToLatestVersion(_ version: SemVer) throws {
+        logger.log("Updating stellarenv")
         try envInstaller.install(version: version.description)
     }