Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add error descriptions to FileError #44

Merged
merged 2 commits into from
Feb 24, 2022
Merged

Add error descriptions to FileError #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bd2a95
Add error descriptions to `FileError`
sushichop Feb 24, 2022
0463cb8
Tests only for Darwin
sushichop Feb 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- Change the type of intPermission to `UInt16`. [#41](https://github.com/sushichop/Puppy/pull/41)
- Output a message prompting to override. [#42](https://github.com/sushichop/Puppy/pull/42)
- Use String type for filePermission. [#43](https://github.com/sushichop/Puppy/pull/43)
- Add error descriptions to `FileError`. [#44](https://github.com/sushichop/Puppy/pull/44)

## [0.4.0](https://github.com/sushichop/Puppy/releases/tag/0.4.0) (2022-01-31)

Expand Down
25 changes: 16 additions & 9 deletions Sources/Puppy/FileError.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
import Foundation

public enum FileError: Error, Equatable {
public enum FileError: Error, Equatable, LocalizedError {
case isNotFile(url: URL)
case invalidPermission(at: URL, filePermission: String)
case creatingDirectoryFailed(at: URL)
case creatingFileFailed(at: URL)
case writingFailed(at: URL)
case invalidPermission(at: URL, filePermission: String)
}

public enum FileDeletingError: Error, Equatable, LocalizedError {
case failed(at: URL)
case openingForWritingFailed(at: URL)
case deletingFailed(at: URL)

public var errorDescription: String? {
switch self {
case .failed(at: let url):
return "failed to delete the file: \(url)"
case .isNotFile(url: let url):
return "\(url) is not a file"
case .invalidPermission(at: let url, filePermission: let filePermission):
return "invalid file permission. file: \(url), permission: \(filePermission)"
case .creatingDirectoryFailed(at: let url):
return "failed to create a directory: \(url)"
case .creatingFileFailed(at: let url):
return "failed to create a file: \(url)"
case .openingForWritingFailed(at: let url):
return "failed to open a file for writing: \(url)"
case .deletingFailed(at: let url):
return "failed to delete a file: \(url)"
}
}
}
10 changes: 5 additions & 5 deletions Sources/Puppy/FileLogger.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,22 @@ public class FileLogger: BaseLogger {
}
}

public func delete(_ url: URL) -> Result<URL, FileDeletingError> {
public func delete(_ url: URL) -> Result<URL, FileError> {
queue!.sync {
Result { try FileManager.default.removeItem(at: url) }
.map { url }
.mapError { _ in
FileDeletingError.failed(at: url)
FileError.deletingFailed(at: url)
}
}
}

public func delete(_ url: URL, completion: @escaping (Result<URL, FileDeletingError>) -> Void) {
public func delete(_ url: URL, completion: @escaping (Result<URL, FileError>) -> Void) {
queue!.async {
let result = Result { try FileManager.default.removeItem(at: url) }
.map { url }
.mapError { _ in
FileDeletingError.failed(at: url)
FileError.deletingFailed(at: url)
}
completion(result)
}
Expand Down Expand Up @@ -105,7 +105,7 @@ public class FileLogger: BaseLogger {
do {
fileHandle = try FileHandle(forWritingTo: fileURL)
} catch {
throw FileError.writingFailed(at: fileURL)
throw FileError.openingForWritingFailed(at: fileURL)
}
}
}
Expand Down
119 changes: 70 additions & 49 deletions Tests/PuppyTests/FileLoggerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,87 @@ final class FileLoggerTests: XCTestCase {
let emptyFileURL = URL(fileURLWithPath: "").absoluteURL // file:///private/tmp/
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.notfile0", fileURL: emptyFileURL)) { error in
XCTAssertEqual(error as? FileError, .isNotFile(url: emptyFileURL))
XCTAssertEqual(error.localizedDescription, "\(emptyFileURL) is not a file")
}

let directoryURL = URL(fileURLWithPath: "./").absoluteURL // file:///private/tmp/
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.notfile1", fileURL: directoryURL)) { error in
XCTAssertEqual(error as? FileError, .isNotFile(url: directoryURL))
XCTAssertEqual(error.localizedDescription, "\(directoryURL) is not a file")
}
}

func testFilePermission() throws {
let fileURL = URL(fileURLWithPath: "./permission600.log").absoluteURL
let fileLogger = try FileLogger("com.example.yourapp.filelogger.permission600", fileURL: fileURL, filePermission: "600")
let log = Puppy()
log.add(fileLogger)
log.trace("permission, TRACE message using FileLogger")
log.verbose("permission, VERBOSE message using FileLogger")
fileLogger.flush()

let attribute = try FileManager.default.attributesOfItem(atPath: fileURL.path)
// swiftlint:disable force_cast
let permission = attribute[FileAttributeKey.posixPermissions] as! UInt16
// swiftlint:enable force_cast

#if os(Windows)
// NOTE: If the file is writable, its permission is always "700" on Windows.
// Reference: https://github.com/apple/swift-corelibs-foundation/blob/main/Sources/Foundation/FileManager%2BWin32.swift
let expectedPermission = UInt16("700", radix: 8)!
#else
let expectedPermission = UInt16("600", radix: 8)!
#endif // os(Windows)
XCTAssertEqual(permission, expectedPermission)

_ = fileLogger.delete(fileURL)
log.remove(fileLogger)
}

func testFilePermissionError() throws {
let permission800FileURL = URL(fileURLWithPath: "./permission800.log").absoluteURL
let filePermission800 = "800"
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.permission800", fileURL: permission800FileURL, filePermission: filePermission800)) { error in
XCTAssertEqual(error as? FileError, .invalidPermission(at: permission800FileURL, filePermission: filePermission800))
XCTAssertEqual(error.localizedDescription, "invalid file permission. file: \(permission800FileURL), permission: \(filePermission800)")
}

let permissionABCFileURL = URL(fileURLWithPath: "./permissionABC.log").absoluteURL
let filePermissionABC = "ABC"
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.permissionABC", fileURL: permissionABCFileURL, filePermission: filePermissionABC)) { error in
XCTAssertEqual(error as? FileError, .invalidPermission(at: permissionABCFileURL, filePermission: filePermissionABC))
XCTAssertEqual(error.localizedDescription, "invalid file permission. file: \(permissionABCFileURL), permission: \(filePermissionABC)")
}
}

#if canImport(Darwin)
func testWritingError() throws {
let fileURL = URL(fileURLWithPath: "./readonly.log").absoluteURL
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.readonly", fileURL: fileURL, filePermission: "400")) { error in
XCTAssertEqual(error as? FileError, .openingForWritingFailed(at: fileURL))
XCTAssertEqual(error.localizedDescription, "failed to open a file for writing: \(fileURL)")
// swiftlint:disable force_try
try! FileManager.default.removeItem(at: fileURL)
// swiftlint:enable force_try
}
}
#endif // canImport(Darwin)

#if canImport(Darwin)
func testCreatingError() throws {
let fileURLNotAbleToCreateDirectory = URL(fileURLWithPath: "/foo/bar.log").absoluteURL // file:///foo/bar.log
let directoryURLNotAbleToCreateDirectory = URL(fileURLWithPath: "/foo/").absoluteURL // file:///foo
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.notcreatedirectory",
fileURL: fileURLNotAbleToCreateDirectory)) { error in
XCTAssertEqual(error as? FileError, .creatingDirectoryFailed(at: directoryURLNotAbleToCreateDirectory))
XCTAssertEqual(error.localizedDescription, "failed to create a directory: \(directoryURLNotAbleToCreateDirectory)")
}

let fileURLNotAbleToCreateFile = URL(fileURLWithPath: "/foo.log").absoluteURL // file:///foo.log
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.notcreatefile",
fileURL: fileURLNotAbleToCreateFile)) { error in
XCTAssertEqual(error as? FileError, .creatingFileFailed(at: fileURLNotAbleToCreateFile))
XCTAssertEqual(error.localizedDescription, "failed to create a file: \(fileURLNotAbleToCreateFile)")
}
}
#endif // canImport(Darwin)
Expand All @@ -84,16 +144,16 @@ final class FileLoggerTests: XCTestCase {
case .success(let url):
XCTAssertEqual(existentFileURL, url)
case .failure:
XCTFail("shuould not be failed, but was failed")
XCTFail("should not be failed, but was failed")
}

let resultFailure = fileLogger.delete(noExistentFileURL)
switch resultFailure {
case .success:
XCTFail("should not be successful, but was successful")
case .failure(let error):
XCTAssertEqual(error as FileDeletingError, .failed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete the file: \(noExistentFileURL)")
XCTAssertEqual(error as FileError, .deletingFailed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete a file: \(noExistentFileURL)")
}
}

Expand All @@ -109,7 +169,7 @@ final class FileLoggerTests: XCTestCase {
XCTAssertEqual(existentFileURL, url)
expSuccess.fulfill()
case .failure:
XCTFail("shuould not be failed, but was failed")
XCTFail("should not be failed, but was failed")
}
}

Expand All @@ -119,8 +179,8 @@ final class FileLoggerTests: XCTestCase {
case .success:
XCTFail("should not be successful, but was successful")
case .failure(let error):
XCTAssertEqual(error as FileDeletingError, .failed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete the file: \(noExistentFileURL)")
XCTAssertEqual(error as FileError, .deletingFailed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete a file: \(noExistentFileURL)")
expFailure.fulfill()
}
}
Expand All @@ -144,8 +204,8 @@ final class FileLoggerTests: XCTestCase {
_ = try fileLogger.delete(noExistentFileURL).get()
XCTFail("error should be thrown while awaiting, but it was not thrown")
} catch {
XCTAssertEqual(error as? FileDeletingError, .failed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete the file: \(noExistentFileURL)")
XCTAssertEqual(error as? FileError, .deletingFailed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete a file: \(noExistentFileURL)")
}
}

Expand All @@ -171,8 +231,8 @@ final class FileLoggerTests: XCTestCase {
_ = try result.get()
XCTFail("error should be thrown while awaiting, but it was not thrown")
} catch {
XCTAssertEqual(error as? FileDeletingError, .failed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete the file: \(noExistentFileURL)")
XCTAssertEqual(error as? FileError, .deletingFailed(at: noExistentFileURL))
XCTAssertEqual(error.localizedDescription, "failed to delete a file: \(noExistentFileURL)")
expFailure.fulfill()
}
}
Expand Down Expand Up @@ -213,43 +273,4 @@ final class FileLoggerTests: XCTestCase {

wait(for: [exp], timeout: 5.0)
}

func testFilePermission() throws {
let fileURL = URL(fileURLWithPath: "./permission600.log").absoluteURL
let fileLogger = try FileLogger("com.example.yourapp.filelogger.permission600", fileURL: fileURL, filePermission: "600")
let log = Puppy()
log.add(fileLogger)
log.trace("permission, TRACE message using FileLogger")
log.verbose("permission, VERBOSE message using FileLogger")
fileLogger.flush()

let attribute = try FileManager.default.attributesOfItem(atPath: fileURL.path)
// swiftlint:disable force_cast
let permission = attribute[FileAttributeKey.posixPermissions] as! UInt16
// swiftlint:enable force_cast

#if os(Windows)
// NOTE: If the file is writable, its permission is always "700" on Windows.
// Reference: https://github.com/apple/swift-corelibs-foundation/blob/main/Sources/Foundation/FileManager%2BWin32.swift
let expectedPermission = UInt16("700", radix: 8)!
#else
let expectedPermission = UInt16("600", radix: 8)!
#endif // os(Windows)
XCTAssertEqual(permission, expectedPermission)

_ = fileLogger.delete(fileURL)
log.remove(fileLogger)
}

func testFilePermissionError() throws {
let permission800FileURL = URL(fileURLWithPath: "./permission800.log").absoluteURL
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.permission800", fileURL: permission800FileURL, filePermission: "800")) { error in
XCTAssertEqual(error as? FileError, .invalidPermission(at: permission800FileURL, filePermission: "800"))
}

let permissionABCFileURL = URL(fileURLWithPath: "./permissionABC.log").absoluteURL
XCTAssertThrowsError(try FileLogger("com.example.yourapp.filelogger.permissionABC", fileURL: permissionABCFileURL, filePermission: "ABC")) { error in
XCTAssertEqual(error as? FileError, .invalidPermission(at: permissionABCFileURL, filePermission: "ABC"))
}
}
}