diff --git a/.gitignore b/.gitignore index 312d1f6..62ce0ff 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,36 @@ + +# Created by https://www.gitignore.io/api/swift,xcode,macos +# Edit at https://www.gitignore.io/?templates=swift,xcode,macos + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Swift ### # Xcode # # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore @@ -33,30 +66,33 @@ timeline.xctimeline playground.xcworkspace # Swift Package Manager -# # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies. # Packages/ # Package.pins # Package.resolved .build/ +# Add this line if you want to avoid checking in Xcode SPM integration. +# .swiftpm/xcode # CocoaPods -# # We recommend against adding the Pods directory to your .gitignore. However # you should judge for yourself, the pros and cons are mentioned at: # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control -# # Pods/ +# Add this line if you want to avoid checking in source code from the Xcode workspace +# *.xcworkspace # Carthage -# # Add this line if you want to avoid checking in source code from Carthage dependencies. # Carthage/Checkouts Carthage/Build +# Accio dependency management +Dependencies/ +.accio/ + # fastlane -# # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the # screenshots whenever they are needed. # For more information about the recommended setup visit: @@ -66,3 +102,31 @@ fastlane/report.xml fastlane/Preview.html fastlane/screenshots/**/*.png fastlane/test_output + +# Code Injection +# After new code Injection tools there's a generated folder /iOSInjectionProject +# https://github.com/johnno1962/injectionforxcode + +iOSInjectionProject/ + +### Xcode ### +# Xcode +# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore + +## User settings + +## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9) + +## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4) + +## Xcode Patch +*.xcodeproj/* +!*.xcodeproj/project.pbxproj +!*.xcodeproj/xcshareddata/ +!*.xcworkspace/contents.xcworkspacedata +/*.gcno + +### Xcode Patch ### +**/xcshareddata/WorkspaceSettings.xcsettings + +# End of https://www.gitignore.io/api/swift,xcode,macos diff --git a/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/SwiftLogger.xcscheme similarity index 56% rename from Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme rename to .swiftpm/xcode/xcshareddata/xcschemes/SwiftLogger.xcscheme index 3fdcd78..0aa4bb4 100644 --- a/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme +++ b/.swiftpm/xcode/xcshareddata/xcschemes/SwiftLogger.xcscheme @@ -1,6 +1,6 @@ + BlueprintIdentifier = "SwiftLogger" + BuildableName = "SwiftLogger" + BlueprintName = "SwiftLogger" + ReferencedContainer = "container:"> + + + + @@ -26,31 +40,20 @@ buildConfiguration = "Debug" selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" - codeCoverageEnabled = "YES" - shouldUseLaunchSchemeArgsEnv = "YES"> + shouldUseLaunchSchemeArgsEnv = "YES" + codeCoverageEnabled = "YES"> + BlueprintIdentifier = "SwiftLoggerTests" + BuildableName = "SwiftLoggerTests" + BlueprintName = "SwiftLoggerTests" + ReferencedContainer = "container:"> - - - - - - - - - - - - + BlueprintIdentifier = "SwiftLogger" + BuildableName = "SwiftLogger" + BlueprintName = "SwiftLogger" + ReferencedContainer = "container:"> diff --git a/.travis.yml b/.travis.yml index 073ed9c..6708a38 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,14 @@ -language: swift -osx_image: xcode10.2 -xcode_project: Logger.xcodeproj -script: xcodebuild test -project Logger.xcodeproj -scheme Logger -destination 'platform=iOS Simulator,name=iPhone XS,OS=12.2' -after_success: bash <(curl -s https://codecov.io/bash) \ No newline at end of file +os: + osx +language: + swift +osx_image: + xcode11.2 +script: + - sw_vers + - swift build + - swift test --enable-code-coverage +after_success: + - xcrun llvm-cov report .build/debug/SwiftLoggerPackageTests.xctest/Contents/MacOS/SwiftLoggerPackageTests -instr-profile .build/debug/codecov/default.profdata + - xcrun llvm-cov export -format="lcov" .build/debug/SwiftLoggerPackageTests.xctest/Contents/MacOS/SwiftLoggerPackageTests -instr-profile .build/debug/codecov/default.profdata > info.lcov + - bash <(curl https://codecov.io/bash) diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj deleted file mode 100644 index d13be27..0000000 --- a/Logger.xcodeproj/project.pbxproj +++ /dev/null @@ -1,514 +0,0 @@ -// !$*UTF8*$! -{ - archiveVersion = 1; - classes = { - }; - objectVersion = 50; - objects = { - -/* Begin PBXBuildFile section */ - 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */; }; - 2E58D35F21316C3500BEF81A /* libLogger.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 2EBF4B3A2122AA34008E4117 /* libLogger.a */; }; - 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; - 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */; }; - 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */; }; - 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */; }; - 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B492122AF53008E4117 /* NullLogger.swift */; }; - 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */; }; - 2EBF4B572122B598008E4117 /* DiskLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B542122B598008E4117 /* DiskLogger.swift */; }; - 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B552122B598008E4117 /* FileWriter.swift */; }; - 2EBF4B592122B598008E4117 /* FileRotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* FileRotate.swift */; }; - 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D621329CA30058EEFC /* LoggetTests.swift */; }; - 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */; }; - 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077DA2132B0320058EEFC /* FileSystem.swift */; }; - 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E02135C61100EB3683 /* FileRotateTests.swift */; }; - 2ED103E32135D3FB00EB3683 /* FileWriterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */; }; - 2ED103E52138553B00EB3683 /* DiskLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */; }; -/* End PBXBuildFile section */ - -/* Begin PBXContainerItemProxy section */ - 2E58D36021316C3500BEF81A /* PBXContainerItemProxy */ = { - isa = PBXContainerItemProxy; - containerPortal = 2EBF4B322122AA34008E4117 /* Project object */; - proxyType = 1; - remoteGlobalIDString = 2EBF4B392122AA34008E4117; - remoteInfo = Logger; - }; -/* End PBXContainerItemProxy section */ - -/* Begin PBXCopyFilesBuildPhase section */ - 2EBF4B382122AA34008E4117 /* CopyFiles */ = { - isa = PBXCopyFilesBuildPhase; - buildActionMask = 2147483647; - dstPath = "include/$(PRODUCT_NAME)"; - dstSubfolderSpec = 16; - files = ( - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXCopyFilesBuildPhase section */ - -/* Begin PBXFileReference section */ - 2E58D35A21316C3500BEF81A /* UnitTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UnitTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; - 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LogStringConvertibleTests.swift; sourceTree = ""; }; - 2E58D35E21316C3500BEF81A /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; - 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; - 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; - 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LogStringConvertible.swift; sourceTree = ""; }; - 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AgregateLogger.swift; sourceTree = ""; }; - 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConsoleLogger.swift; sourceTree = ""; }; - 2EBF4B492122AF53008E4117 /* NullLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NullLogger.swift; sourceTree = ""; }; - 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSFileHandle+Swift.h"; sourceTree = ""; }; - 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSFileHandle+Swift.m"; sourceTree = ""; }; - 2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Logger-Bridging-Header.h"; sourceTree = ""; }; - 2EBF4B542122B598008E4117 /* DiskLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DiskLogger.swift; sourceTree = ""; }; - 2EBF4B552122B598008E4117 /* FileWriter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileWriter.swift; sourceTree = ""; }; - 2EBF4B562122B598008E4117 /* FileRotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileRotate.swift; sourceTree = ""; }; - 2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = ""; }; - 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = ""; }; - 2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = ""; }; - 2ED103E02135C61100EB3683 /* FileRotateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileRotateTests.swift; sourceTree = ""; }; - 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileWriterTests.swift; sourceTree = ""; }; - 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DiskLoggerTests.swift; sourceTree = ""; }; - 2EDA8AE8213ACCFF00FE5840 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = ""; }; -/* End PBXFileReference section */ - -/* Begin PBXFrameworksBuildPhase section */ - 2E58D35721316C3500BEF81A /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - 2E58D35F21316C3500BEF81A /* libLogger.a in Frameworks */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; - 2EBF4B372122AA34008E4117 /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXFrameworksBuildPhase section */ - -/* Begin PBXGroup section */ - 2E58D35B21316C3500BEF81A /* UnitTests */ = { - isa = PBXGroup; - children = ( - 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, - 2ED077D621329CA30058EEFC /* LoggetTests.swift */, - 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */, - 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */, - 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */, - 2ED103E02135C61100EB3683 /* FileRotateTests.swift */, - 2E58D35E21316C3500BEF81A /* Info.plist */, - ); - path = UnitTests; - sourceTree = ""; - }; - 2EBF4B312122AA34008E4117 = { - isa = PBXGroup; - children = ( - 2EDA8AE8213ACCFF00FE5840 /* README.md */, - 2EBF4B3C2122AA34008E4117 /* Logger */, - 2E58D35B21316C3500BEF81A /* UnitTests */, - 2EBF4B3B2122AA34008E4117 /* Products */, - ); - sourceTree = ""; - }; - 2EBF4B3B2122AA34008E4117 /* Products */ = { - isa = PBXGroup; - children = ( - 2EBF4B3A2122AA34008E4117 /* libLogger.a */, - 2E58D35A21316C3500BEF81A /* UnitTests.xctest */, - ); - name = Products; - sourceTree = ""; - }; - 2EBF4B3C2122AA34008E4117 /* Logger */ = { - isa = PBXGroup; - children = ( - 2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */, - 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */, - 2EBF4B3D2122AA34008E4117 /* Logger.swift */, - 2EBF4B462122AF53008E4117 /* Loggers */, - ); - path = Logger; - sourceTree = ""; - }; - 2EBF4B462122AF53008E4117 /* Loggers */ = { - isa = PBXGroup; - children = ( - 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */, - 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */, - 2EBF4B492122AF53008E4117 /* NullLogger.swift */, - 2EBF4B4D2122B034008E4117 /* DiskLogger */, - ); - path = Loggers; - sourceTree = ""; - }; - 2EBF4B4D2122B034008E4117 /* DiskLogger */ = { - isa = PBXGroup; - children = ( - 2EBF4B542122B598008E4117 /* DiskLogger.swift */, - 2EBF4B552122B598008E4117 /* FileWriter.swift */, - 2EBF4B562122B598008E4117 /* FileRotate.swift */, - 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */, - 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */, - 2ED077DA2132B0320058EEFC /* FileSystem.swift */, - ); - path = DiskLogger; - sourceTree = ""; - }; -/* End PBXGroup section */ - -/* Begin PBXNativeTarget section */ - 2E58D35921316C3500BEF81A /* UnitTests */ = { - isa = PBXNativeTarget; - buildConfigurationList = 2E58D36221316C3500BEF81A /* Build configuration list for PBXNativeTarget "UnitTests" */; - buildPhases = ( - 2E58D35621316C3500BEF81A /* Sources */, - 2E58D35721316C3500BEF81A /* Frameworks */, - 2E58D35821316C3500BEF81A /* Resources */, - ); - buildRules = ( - ); - dependencies = ( - 2E58D36121316C3500BEF81A /* PBXTargetDependency */, - ); - name = UnitTests; - productName = UnitTests; - productReference = 2E58D35A21316C3500BEF81A /* UnitTests.xctest */; - productType = "com.apple.product-type.bundle.unit-test"; - }; - 2EBF4B392122AA34008E4117 /* Logger */ = { - isa = PBXNativeTarget; - buildConfigurationList = 2EBF4B412122AA34008E4117 /* Build configuration list for PBXNativeTarget "Logger" */; - buildPhases = ( - 2EBF4B362122AA34008E4117 /* Sources */, - 2EBF4B372122AA34008E4117 /* Frameworks */, - 2EBF4B382122AA34008E4117 /* CopyFiles */, - ); - buildRules = ( - ); - dependencies = ( - ); - name = Logger; - productName = Logger; - productReference = 2EBF4B3A2122AA34008E4117 /* libLogger.a */; - productType = "com.apple.product-type.library.static"; - }; -/* End PBXNativeTarget section */ - -/* Begin PBXProject section */ - 2EBF4B322122AA34008E4117 /* Project object */ = { - isa = PBXProject; - attributes = { - LastSwiftUpdateCheck = 1000; - LastUpgradeCheck = 1000; - ORGANIZATIONNAME = "Wojciech Nagrodzki"; - TargetAttributes = { - 2E58D35921316C3500BEF81A = { - CreatedOnToolsVersion = 10.0; - LastSwiftMigration = 1020; - }; - 2EBF4B392122AA34008E4117 = { - CreatedOnToolsVersion = 10.0; - LastSwiftMigration = 1020; - }; - }; - }; - buildConfigurationList = 2EBF4B352122AA34008E4117 /* Build configuration list for PBXProject "Logger" */; - compatibilityVersion = "Xcode 9.3"; - developmentRegion = en; - hasScannedForEncodings = 0; - knownRegions = ( - en, - Base, - ); - mainGroup = 2EBF4B312122AA34008E4117; - productRefGroup = 2EBF4B3B2122AA34008E4117 /* Products */; - projectDirPath = ""; - projectRoot = ""; - targets = ( - 2EBF4B392122AA34008E4117 /* Logger */, - 2E58D35921316C3500BEF81A /* UnitTests */, - ); - }; -/* End PBXProject section */ - -/* Begin PBXResourcesBuildPhase section */ - 2E58D35821316C3500BEF81A /* Resources */ = { - isa = PBXResourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXResourcesBuildPhase section */ - -/* Begin PBXSourcesBuildPhase section */ - 2E58D35621316C3500BEF81A /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, - 2ED103E32135D3FB00EB3683 /* FileWriterTests.swift in Sources */, - 2ED103E52138553B00EB3683 /* DiskLoggerTests.swift in Sources */, - 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */, - 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */, - 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; - 2EBF4B362122AA34008E4117 /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */, - 2EBF4B572122B598008E4117 /* DiskLogger.swift in Sources */, - 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */, - 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, - 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */, - 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */, - 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */, - 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */, - 2EBF4B592122B598008E4117 /* FileRotate.swift in Sources */, - 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXSourcesBuildPhase section */ - -/* Begin PBXTargetDependency section */ - 2E58D36121316C3500BEF81A /* PBXTargetDependency */ = { - isa = PBXTargetDependency; - target = 2EBF4B392122AA34008E4117 /* Logger */; - targetProxy = 2E58D36021316C3500BEF81A /* PBXContainerItemProxy */; - }; -/* End PBXTargetDependency section */ - -/* Begin XCBuildConfiguration section */ - 2E58D36321316C3500BEF81A /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CODE_SIGN_STYLE = Automatic; - INFOPLIST_FILE = UnitTests/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - "@loader_path/Frameworks", - ); - PRODUCT_BUNDLE_IDENTIFIER = com.wnagrodzki.UnitTests; - PRODUCT_NAME = "$(TARGET_NAME)"; - SWIFT_VERSION = 5.0; - TARGETED_DEVICE_FAMILY = "1,2"; - }; - name = Debug; - }; - 2E58D36421316C3500BEF81A /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CODE_SIGN_STYLE = Automatic; - INFOPLIST_FILE = UnitTests/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - "@loader_path/Frameworks", - ); - PRODUCT_BUNDLE_IDENTIFIER = com.wnagrodzki.UnitTests; - PRODUCT_NAME = "$(TARGET_NAME)"; - SWIFT_VERSION = 5.0; - TARGETED_DEVICE_FAMILY = "1,2"; - }; - name = Release; - }; - 2EBF4B3F2122AA34008E4117 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_ENABLE_OBJC_WEAK = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - CODE_SIGN_IDENTITY = "iPhone Developer"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = dwarf; - ENABLE_STRICT_OBJC_MSGSEND = YES; - ENABLE_TESTABILITY = YES; - GCC_C_LANGUAGE_STANDARD = gnu11; - GCC_DYNAMIC_NO_PIC = NO; - GCC_NO_COMMON_BLOCKS = YES; - GCC_OPTIMIZATION_LEVEL = 0; - GCC_PREPROCESSOR_DEFINITIONS = ( - "DEBUG=1", - "$(inherited)", - ); - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 12.0; - MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE; - MTL_FAST_MATH = YES; - ONLY_ACTIVE_ARCH = YES; - SDKROOT = iphoneos; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - }; - name = Debug; - }; - 2EBF4B402122AA34008E4117 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_ENABLE_OBJC_WEAK = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - CODE_SIGN_IDENTITY = "iPhone Developer"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - ENABLE_NS_ASSERTIONS = NO; - ENABLE_STRICT_OBJC_MSGSEND = YES; - GCC_C_LANGUAGE_STANDARD = gnu11; - GCC_NO_COMMON_BLOCKS = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 12.0; - MTL_ENABLE_DEBUG_INFO = NO; - MTL_FAST_MATH = YES; - SDKROOT = iphoneos; - SWIFT_COMPILATION_MODE = wholemodule; - SWIFT_OPTIMIZATION_LEVEL = "-O"; - VALIDATE_PRODUCT = YES; - }; - name = Release; - }; - 2EBF4B422122AA34008E4117 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_MODULES = YES; - CODE_SIGN_STYLE = Automatic; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - "@loader_path/Frameworks", - ); - OTHER_LDFLAGS = "-ObjC"; - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = YES; - SWIFT_OBJC_BRIDGING_HEADER = "Logger/Logger-Bridging-Header.h"; - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - SWIFT_VERSION = 5.0; - TARGETED_DEVICE_FAMILY = "1,2"; - }; - name = Debug; - }; - 2EBF4B432122AA34008E4117 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_MODULES = YES; - CODE_SIGN_STYLE = Automatic; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - "@loader_path/Frameworks", - ); - OTHER_LDFLAGS = "-ObjC"; - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = YES; - SWIFT_OBJC_BRIDGING_HEADER = "Logger/Logger-Bridging-Header.h"; - SWIFT_VERSION = 5.0; - TARGETED_DEVICE_FAMILY = "1,2"; - }; - name = Release; - }; -/* End XCBuildConfiguration section */ - -/* Begin XCConfigurationList section */ - 2E58D36221316C3500BEF81A /* Build configuration list for PBXNativeTarget "UnitTests" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 2E58D36321316C3500BEF81A /* Debug */, - 2E58D36421316C3500BEF81A /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - 2EBF4B352122AA34008E4117 /* Build configuration list for PBXProject "Logger" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 2EBF4B3F2122AA34008E4117 /* Debug */, - 2EBF4B402122AA34008E4117 /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - 2EBF4B412122AA34008E4117 /* Build configuration list for PBXNativeTarget "Logger" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 2EBF4B422122AA34008E4117 /* Debug */, - 2EBF4B432122AA34008E4117 /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; -/* End XCConfigurationList section */ - }; - rootObject = 2EBF4B322122AA34008E4117 /* Project object */; -} diff --git a/Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 0ca1195..0000000 --- a/Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist deleted file mode 100644 index 18d9810..0000000 --- a/Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +++ /dev/null @@ -1,8 +0,0 @@ - - - - - IDEDidComputeMac32BitWarning - - - diff --git a/Logger/Logger-Bridging-Header.h b/Logger/Logger-Bridging-Header.h deleted file mode 100644 index 6a5bec0..0000000 --- a/Logger/Logger-Bridging-Header.h +++ /dev/null @@ -1,5 +0,0 @@ -// -// Use this file to import your target's public headers that you would like to expose to Swift. -// - -#import "Loggers/DiskLogger/NSFileHandle+Swift.h" diff --git a/Logger/Loggers/DiskLogger/NSFileHandle+Swift.h b/Logger/Loggers/DiskLogger/NSFileHandle+Swift.h deleted file mode 100644 index 23f3d4e..0000000 --- a/Logger/Loggers/DiskLogger/NSFileHandle+Swift.h +++ /dev/null @@ -1,35 +0,0 @@ -// -// MIT License -// -// Copyright (c) 2018 Wojciech Nagrodzki -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. -// - -#import - -NS_ASSUME_NONNULL_BEGIN - -@interface NSFileHandle (Swift) - -- (BOOL)swift_writeData:(NSData *)data error:(NSError **)error; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Logger/Loggers/DiskLogger/NSFileHandle+Swift.m b/Logger/Loggers/DiskLogger/NSFileHandle+Swift.m deleted file mode 100644 index 994e667..0000000 --- a/Logger/Loggers/DiskLogger/NSFileHandle+Swift.m +++ /dev/null @@ -1,44 +0,0 @@ -// -// MIT License -// -// Copyright (c) 2018 Wojciech Nagrodzki -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. -// - -#import "NSFileHandle+Swift.h" - -@implementation NSFileHandle (Swift) - -- (BOOL)swift_writeData:(NSData *)data error:(NSError **)error { - @try { - [self writeData:data]; - return YES; - } - @catch (NSException *exception) { - if (error == nil) { - return NO; - } - NSDictionary * userInfo = @{NSLocalizedFailureReasonErrorKey: exception.reason}; - *error = [NSError errorWithDomain:@"NSFileHandleException" code:1 userInfo:userInfo]; - return NO; - } -} - -@end diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..44673a3 --- /dev/null +++ b/Package.swift @@ -0,0 +1,24 @@ +// swift-tools-version:5.1 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let package = Package( + name: "SwiftLogger", + products: [ + // Products define the executables and libraries produced by a package, and make them visible to other packages. + .library( + name: "SwiftLogger", + targets: ["SwiftLogger"]), + ], + targets: [ + // Targets are the basic building blocks of a package. A target can define a module or a test suite. + // Targets can depend on other targets in this package, and on products in packages which this package depends on. + .target( + name: "SwiftLogger", + dependencies: []), + .testTarget( + name: "SwiftLoggerTests", + dependencies: ["SwiftLogger"]), + ] +) diff --git a/Logger/LogStringConvertible.swift b/Sources/SwiftLogger/LogStringConvertible.swift similarity index 100% rename from Logger/LogStringConvertible.swift rename to Sources/SwiftLogger/LogStringConvertible.swift diff --git a/Logger/Logger.swift b/Sources/SwiftLogger/Logger.swift similarity index 100% rename from Logger/Logger.swift rename to Sources/SwiftLogger/Logger.swift diff --git a/Logger/Loggers/AgregateLogger.swift b/Sources/SwiftLogger/Loggers/AgregateLogger.swift similarity index 100% rename from Logger/Loggers/AgregateLogger.swift rename to Sources/SwiftLogger/Loggers/AgregateLogger.swift diff --git a/Logger/Loggers/ConsoleLogger.swift b/Sources/SwiftLogger/Loggers/ConsoleLogger.swift similarity index 100% rename from Logger/Loggers/ConsoleLogger.swift rename to Sources/SwiftLogger/Loggers/ConsoleLogger.swift diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Sources/SwiftLogger/Loggers/DiskLogger/DiskLogger.swift similarity index 71% rename from Logger/Loggers/DiskLogger/DiskLogger.swift rename to Sources/SwiftLogger/Loggers/DiskLogger/DiskLogger.swift index c2a44d0..69e5320 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Sources/SwiftLogger/Loggers/DiskLogger/DiskLogger.swift @@ -24,23 +24,6 @@ import Foundation -/// Write failed as allowed size limit would be exceeded. -public struct SizeLimitedFileQuotaReached: Error {} - -/// Allows writing to a file while respecting allowed size limit. -protocol SizeLimitedFile { - - /// Synchronously writes `data` at the end of the file. - /// - /// - Parameter data: The data to be written. - /// - Throws: Throws an error if no free space is left on the file system, or if any other writing error occurs. - /// Throws `SizeLimitedFileQuotaReached` if allowed size limit would be exceeded. - func write(_ data: Data) throws - - /// Writes all in-memory data to permanent storage and closes the file. - func synchronizeAndCloseFile() -} - protocol SizeLimitedFileFactory { /// Returns newly initialized SizeLimitedFile instance. @@ -52,20 +35,6 @@ protocol SizeLimitedFileFactory { func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile } -/// Allows log files rotation. -protocol Logrotate { - - /// Rotates log files `rotations` number of times. - /// - /// First deletes file at `.`. - /// Next moves files located at: - /// - /// `, .1, .2 ... .` - /// - /// to `.1, .2 ... .` - func rotate() throws -} - protocol LogrotateFactory { /// Returns newly initialized Logrotate instance. @@ -77,12 +46,13 @@ protocol LogrotateFactory { } /// Logger that writes messages into the file at specified URL with log rotation support. +@available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) public final class DiskLogger: Logger { private let fileURL: URL private let fileSizeLimit: UInt64 private let rotations: Int - private let fileSystem: FileSystem + private let fileManager: OSFileManager private let sizeLimitedFileFactory: SizeLimitedFileFactory private let logrotateFactory: LogrotateFactory private let formatter: DateFormatter @@ -97,14 +67,14 @@ public final class DiskLogger: Logger { /// - fileSizeLimit: Maximum size log file can reach in bytes. Attempt to exceeding that limit triggers log files rotation. /// - rotations: Number of times log files are rotated before being removed. public convenience init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int) { - self.init(fileURL: fileURL, fileSizeLimit: fileSizeLimit, rotations: rotations, fileSystem: FileManager.default, sizeLimitedFileFactory: FileWriterFactory(), logrotateFactory: FileRotateFactory()) + self.init(fileURL: fileURL, fileSizeLimit: fileSizeLimit, rotations: rotations, fileManager: FileManager.default, sizeLimitedFileFactory: SizeLimitedFileFactoryImpl(), logrotateFactory: LogrotateFactoryImpl()) } - init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem, sizeLimitedFileFactory: SizeLimitedFileFactory, logrotateFactory: LogrotateFactory) { + init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileManager: OSFileManager, sizeLimitedFileFactory: SizeLimitedFileFactory, logrotateFactory: LogrotateFactory) { self.fileURL = fileURL self.fileSizeLimit = fileSizeLimit self.rotations = rotations - self.fileSystem = fileSystem + self.fileManager = fileManager self.sizeLimitedFileFactory = sizeLimitedFileFactory self.logrotateFactory = logrotateFactory formatter = DateFormatter() @@ -128,7 +98,7 @@ public final class DiskLogger: Logger { try self.writeBuffer() } catch is SizeLimitedFileQuotaReached { - self.closeSizeLimitedFile() + try self.closeSizeLimitedFile() try self.rotateLogFiles() try self.openSizeLimitedFile() try self.writeBuffer() @@ -144,8 +114,8 @@ public final class DiskLogger: Logger { private func openSizeLimitedFile() throws { guard sizeLimitedFile == nil else { return } - if fileSystem.itemExists(at: fileURL) == false { - _ = fileSystem.createFile(at: fileURL) + if fileManager.itemExists(at: fileURL) == false { + _ = fileManager.createFile(at: fileURL) } sizeLimitedFile = try sizeLimitedFileFactory.makeInstance(fileURL: fileURL, fileSizeLimit: fileSizeLimit) } @@ -155,8 +125,8 @@ public final class DiskLogger: Logger { buffer.removeAll() } - private func closeSizeLimitedFile() { - self.sizeLimitedFile.synchronizeAndCloseFile() + private func closeSizeLimitedFile() throws { + try self.sizeLimitedFile.synchronizeAndCloseFile() self.sizeLimitedFile = nil } @@ -166,24 +136,20 @@ public final class DiskLogger: Logger { } } -private class FileRotateFactory: LogrotateFactory { +private class LogrotateFactoryImpl: LogrotateFactory { func makeInstance(fileURL: URL, rotations: Int) -> Logrotate { - return FileRotate(fileURL: fileURL, rotations: rotations, fileSystem: FileManager.default) + return LogrotateImpl(fileURL: fileURL, rotations: rotations, fileManager: FileManager.default) } } -private class FileWriterFactory: SizeLimitedFileFactory { +private class SizeLimitedFileFactoryImpl: SizeLimitedFileFactory { func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { - return try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit, fileFactory: FileHandleFactory()) + return try SizeLimitedFileImpl(fileURL: fileURL, fileSizeLimit: fileSizeLimit, fileFactory: FileHandleFactoryImpl()) } } -private class FileHandleFactory: FileFactory { - func makeInstance(forWritingTo: URL) throws -> File { +private class FileHandleFactoryImpl: FileHandleFactory { + func makeInstance(forWritingTo: URL) throws -> OSFileHandle { return try FileHandle(forWritingTo: forWritingTo) } } - -extension FileHandle: File { - -} diff --git a/Logger/Loggers/DiskLogger/Filerotate.swift b/Sources/SwiftLogger/Loggers/DiskLogger/Logrotate.swift similarity index 70% rename from Logger/Loggers/DiskLogger/Filerotate.swift rename to Sources/SwiftLogger/Loggers/DiskLogger/Logrotate.swift index 0963cfa..4d640c7 100644 --- a/Logger/Loggers/DiskLogger/Filerotate.swift +++ b/Sources/SwiftLogger/Loggers/DiskLogger/Logrotate.swift @@ -24,26 +24,40 @@ import Foundation -final class FileRotate { +/// Allows log files rotation. +protocol Logrotate { + + /// Rotates log files `rotations` number of times. + /// + /// First deletes file at `.`. + /// Next moves files located at: + /// + /// `, .1, .2 ... .` + /// + /// to `.1, .2 ... .` + func rotate() throws +} + +final class LogrotateImpl { private let fileURL: URL private let rotations: Int - private let fileSystem: FileSystem + private let fileManager: OSFileManager /// Initializes new Logrotate instance. /// /// - Parameters: /// - fileURL: URL of the log file. /// - rotations: Number of times log files are rotated before being removed. - init(fileURL: URL, rotations: Int, fileSystem: FileSystem) { + init(fileURL: URL, rotations: Int, fileManager: OSFileManager) { precondition(rotations > 0) self.fileURL = fileURL self.rotations = rotations - self.fileSystem = fileSystem + self.fileManager = fileManager } } -extension FileRotate: Logrotate { +extension LogrotateImpl: Logrotate { func rotate() throws { let range = 1...rotations @@ -54,12 +68,12 @@ extension FileRotate: Logrotate { let toDelete = rotatedURLs.last! let toMove = zip(allURLs, rotatedURLs).reversed() - if fileSystem.itemExists(at: toDelete) { - try fileSystem.removeItem(at: toDelete) + if fileManager.itemExists(at: toDelete) { + try fileManager.removeItem(at: toDelete) } for (oldURL, newURL) in toMove { - guard fileSystem.itemExists(at: oldURL) else { continue } - try fileSystem.moveItem(at: oldURL, to: newURL) + guard fileManager.itemExists(at: oldURL) else { continue } + try fileManager.moveItem(at: oldURL, to: newURL) } } } diff --git a/Sources/SwiftLogger/Loggers/DiskLogger/OSFileHandle.swift b/Sources/SwiftLogger/Loggers/DiskLogger/OSFileHandle.swift new file mode 100644 index 0000000..34965bb --- /dev/null +++ b/Sources/SwiftLogger/Loggers/DiskLogger/OSFileHandle.swift @@ -0,0 +1,53 @@ +// +// OSFileHandle.swift +// Logger +// +// Created by Wojciech Nagrodzki on 30/10/2019. +// Copyright © 2019 Wojciech Nagrodzki. All rights reserved. +// + +import Foundation + +protocol OSFileHandle { + func osSeekToEndOfFile() throws -> UInt64 + func osWrite(_ data: Data) throws + func osSynchronizeFile() throws + func osCloseFile() throws +} + +extension FileHandle: OSFileHandle { + + func osSeekToEndOfFile() throws -> UInt64 { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + var offsetInFile: UInt64 = 0 + try __seek(toEndReturningOffset:&offsetInFile) + return offsetInFile + } else { + fatalError() + } + } + + func osWrite(_ data: Data) throws { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + try __write(data, error: ()) + } else { + fatalError() + } + } + + func osSynchronizeFile() throws { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + try synchronize() + } else { + fatalError() + } + } + + func osCloseFile() throws { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + try close() + } else { + fatalError() + } + } +} diff --git a/Logger/Loggers/DiskLogger/FileSystem.swift b/Sources/SwiftLogger/Loggers/DiskLogger/OSFileManager.swift similarity index 95% rename from Logger/Loggers/DiskLogger/FileSystem.swift rename to Sources/SwiftLogger/Loggers/DiskLogger/OSFileManager.swift index b47b316..02ae5be 100644 --- a/Logger/Loggers/DiskLogger/FileSystem.swift +++ b/Sources/SwiftLogger/Loggers/DiskLogger/OSFileManager.swift @@ -24,14 +24,14 @@ import Foundation -public protocol FileSystem { +public protocol OSFileManager { func itemExists(at URL: URL) -> Bool func removeItem(at URL: URL) throws func moveItem(at srcURL: URL, to dstURL: URL) throws func createFile(at URL: URL) -> Bool } -extension FileManager: FileSystem { +extension FileManager: OSFileManager { public func itemExists(at URL: URL) -> Bool { return fileExists(atPath: URL.path) diff --git a/Logger/Loggers/DiskLogger/FileWriter.swift b/Sources/SwiftLogger/Loggers/DiskLogger/SizeLimitedFile.swift similarity index 60% rename from Logger/Loggers/DiskLogger/FileWriter.swift rename to Sources/SwiftLogger/Loggers/DiskLogger/SizeLimitedFile.swift index be1ff30..e7b89cb 100644 --- a/Logger/Loggers/DiskLogger/FileWriter.swift +++ b/Sources/SwiftLogger/Loggers/DiskLogger/SizeLimitedFile.swift @@ -24,50 +24,60 @@ import Foundation -protocol File { - func seekToEndOfFile() -> UInt64 - func swift_write(_ data: Data) throws - func synchronizeFile() - func closeFile() +protocol FileHandleFactory { + func makeInstance(forWritingTo: URL) throws -> OSFileHandle } -protocol FileFactory { - func makeInstance(forWritingTo: URL) throws -> File +/// Write failed as allowed size limit would be exceeded. +public struct SizeLimitedFileQuotaReached: Error {} + +/// Allows writing to a file while respecting allowed size limit. +protocol SizeLimitedFile { + + /// Synchronously writes `data` at the end of the file. + /// + /// - Parameter data: The data to be written. + /// - Throws: Throws an error if no free space is left on the file system, or if any other writing error occurs. + /// Throws `SizeLimitedFileQuotaReached` if allowed size limit would be exceeded. + func write(_ data: Data) throws + + /// Writes all in-memory data to permanent storage and closes the file. + func synchronizeAndCloseFile() throws } /// Allows writing to a file while respecting allowed size limit. -final class FileWriter { +final class SizeLimitedFileImpl { - private let file: File + private let file: OSFileHandle private let sizeLimit: UInt64 private var currentSize: UInt64 - /// Initializes new FileWriter instance. + /// Initializes new SizeLimitedFileImpl instance. /// /// - Parameters: /// - fileURL: URL of the file. /// - fileSizeLimit: Maximum size the file can reach in bytes. /// - Throws: An error that may occur while the file is being opened for writing. - init(fileURL: URL, fileSizeLimit: UInt64, fileFactory: FileFactory) throws { + init(fileURL: URL, fileSizeLimit: UInt64, fileFactory: FileHandleFactory) throws { file = try fileFactory.makeInstance(forWritingTo: fileURL) self.sizeLimit = fileSizeLimit - currentSize = file.seekToEndOfFile() + currentSize = try file.osSeekToEndOfFile() } } -extension FileWriter: SizeLimitedFile { +extension SizeLimitedFileImpl: SizeLimitedFile { func write(_ data: Data) throws { let dataSize = UInt64(data.count) guard currentSize + dataSize <= sizeLimit else { throw SizeLimitedFileQuotaReached() } - try file.swift_write(data) + try file.osWrite(data) currentSize += dataSize } - func synchronizeAndCloseFile() { - file.synchronizeFile() - file.closeFile() + func synchronizeAndCloseFile() throws { + try file.osSynchronizeFile() + try file.osCloseFile() } } diff --git a/Logger/Loggers/NullLogger.swift b/Sources/SwiftLogger/Loggers/NullLogger.swift similarity index 100% rename from Logger/Loggers/NullLogger.swift rename to Sources/SwiftLogger/Loggers/NullLogger.swift diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift new file mode 100644 index 0000000..5e88a5e --- /dev/null +++ b/Tests/LinuxMain.swift @@ -0,0 +1,7 @@ +import XCTest + +import SwiftLoggerTests + +var tests = [XCTestCaseEntry]() +tests += SwiftLoggerTests.allTests() +XCTMain(tests) diff --git a/UnitTests/AgregateLoggerTests.swift b/Tests/SwiftLoggerTests/AgregateLoggerTests.swift similarity index 98% rename from UnitTests/AgregateLoggerTests.swift rename to Tests/SwiftLoggerTests/AgregateLoggerTests.swift index c3c2704..87cb73e 100644 --- a/UnitTests/AgregateLoggerTests.swift +++ b/Tests/SwiftLoggerTests/AgregateLoggerTests.swift @@ -23,7 +23,7 @@ // import XCTest -@testable import Logger +@testable import SwiftLogger class AgregateLoggerTests: XCTestCase { diff --git a/Tests/SwiftLoggerTests/DiskLoggerTests.swift b/Tests/SwiftLoggerTests/DiskLoggerTests.swift new file mode 100644 index 0000000..a86ad26 --- /dev/null +++ b/Tests/SwiftLoggerTests/DiskLoggerTests.swift @@ -0,0 +1,247 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import SwiftLogger + +class DiskLoggerTests: XCTestCase { + + let logURL = URL(fileURLWithPath: "/var/log/application.log") + + func testLoggingMessageToFile() { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") + expectation.expectedFulfillmentCount = 1 + + let fimeManager = FileManagerStub() + let sizeLimitedFileFactory = SizeLimitedFileMockFactory(writeCall: expectation) + let logrotateFactory = LogrotateMockFactory() + let logger = DiskLogger(fileURL: logURL, + fileSizeLimit: 1024, + rotations: 1, + fileManager: fimeManager, + sizeLimitedFileFactory: sizeLimitedFileFactory, + logrotateFactory: logrotateFactory) + + logger.log("message", level: .critical) + + let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) + XCTAssertEqual(result, .completed) + + XCTAssertEqual(sizeLimitedFileFactory.files.count, 1) + + // "2018-08-30 17:23:11.514 DiskLoggerTests:46 testWritingMessageToFile() a message\n" + let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self) + let expectedSuffix = " DiskLoggerTests:47 testLoggingMessageToFile() message\n" + + XCTAssertTrue(loggedMessage.hasSuffix(expectedSuffix)) + } + } + + func testExceedingFileSizeLimit() { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") + expectation.expectedFulfillmentCount = 2 + + let fimeManager = FileManagerStub() + let sizeLimitedFileFactory = SizeLimitedFileMockFactory(writeCall: expectation) + let logrotateFactory = LogrotateMockFactory() + let logger = DiskLogger(fileURL: logURL, + fileSizeLimit: 91, + rotations: 1, + fileManager: fimeManager, + sizeLimitedFileFactory: sizeLimitedFileFactory, + logrotateFactory: logrotateFactory) + + logger.log("1st message", level: .critical) + logger.log("2st message", level: .critical) + + let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) + XCTAssertEqual(result, .completed) + + XCTAssertEqual(sizeLimitedFileFactory.files.count, 2) + + // "2018-08-31 18:29:34.748 DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" + let loggedMessage = String(decoding: sizeLimitedFileFactory.files[1].data, as: UTF8.self) + let expectedSuffix = " DiskLoggerTests:78 testExceedingFileSizeLimit() 2st message\n" + + XCTAssertTrue(loggedMessage.hasSuffix(expectedSuffix)) + } + } + + func testErrorDuringLogProcess() { + if #available(OSX 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) { + let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") + expectation.expectedFulfillmentCount = 2 + + let fimeManager = FileManagerStub() + let sizeLimitedFileFactory = UnwritableFileStubFactory(writeCall: expectation) + let logrotateFactory = LogrotateMockFactory() + let logger = DiskLogger(fileURL: logURL, + fileSizeLimit: 91, + rotations: 1, + fileManager: fimeManager, + sizeLimitedFileFactory: sizeLimitedFileFactory, + logrotateFactory: logrotateFactory) + + logger.log("1st message", level: .critical) + logger.log("2st message", level: .critical) + + let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) + XCTAssertEqual(result, .completed) + + XCTAssertEqual(sizeLimitedFileFactory.files.count, 1) + + // "2018-08-31 18:29:34.748 DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" + let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self) + let expectedOccurence = " WriteFailed()" + + XCTAssertTrue(loggedMessage.contains(expectedOccurence)) + } + } +} + +private class FileManagerStub: OSFileManager { + func itemExists(at URL: URL) -> Bool { + return false + } + + func removeItem(at URL: URL) throws { + + } + + func moveItem(at srcURL: URL, to dstURL: URL) throws { + + } + + func createFile(at URL: URL) -> Bool { + return true + } +} + +private class SizeLimitedFileMockFactory: SizeLimitedFileFactory { + + private(set) var files = [SizeLimitedFileMock]() + private let writeCall: XCTestExpectation + + init(writeCall: XCTestExpectation) { + self.writeCall = writeCall + } + + func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { + let mock = SizeLimitedFileMock(writeCall: writeCall, fileSizeLimit: fileSizeLimit) + files.append(mock) + return mock + } +} + +private class SizeLimitedFileMock: SizeLimitedFile { + + private(set) var data = Data() + private(set) var synchronizeAndCloseFileCallCount = 0 + private let writeCall: XCTestExpectation + private let fileSizeLimit: UInt64 + + init(writeCall: XCTestExpectation, fileSizeLimit: UInt64) { + self.writeCall = writeCall + self.fileSizeLimit = fileSizeLimit + } + + func write(_ data: Data) throws { + guard data.count + self.data.count <= fileSizeLimit else { + throw SizeLimitedFileQuotaReached() + } + self.data.append(data) + writeCall.fulfill() + } + + func synchronizeAndCloseFile() { + synchronizeAndCloseFileCallCount += 1 + } +} + +private class UnwritableFileStubFactory: SizeLimitedFileFactory { + + private(set) var files = [UnwritableFileStub]() + private let writeCall: XCTestExpectation + + init(writeCall: XCTestExpectation) { + self.writeCall = writeCall + } + + func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { + let file = UnwritableFileStub(writeCall: writeCall, fileSizeLimit: fileSizeLimit) + files.append(file) + return file + } +} + +private class UnwritableFileStub: SizeLimitedFile { + + struct WriteFailed: Error {} + + private(set) var data = Data() + private let writeCall: XCTestExpectation + private var didThrowError = false + + init(writeCall: XCTestExpectation, fileSizeLimit: UInt64) { + self.writeCall = writeCall + } + + func write(_ data: Data) throws { + if didThrowError { + self.data.append(data) + writeCall.fulfill() + } + else { + didThrowError = true + writeCall.fulfill() + throw WriteFailed() + } + } + + func synchronizeAndCloseFile() { + + } +} + +private class LogrotateMockFactory: LogrotateFactory { + + private(set) var logrotates = [LogrotateMock]() + + func makeInstance(fileURL: URL, rotations: Int) -> Logrotate { + let mock = LogrotateMock() + logrotates.append(mock) + return mock + } +} + +private class LogrotateMock: Logrotate { + + private(set) var rotateCallCount = 0 + + func rotate() throws { + rotateCallCount += 1 + } +} diff --git a/UnitTests/LogStringConvertibleTests.swift b/Tests/SwiftLoggerTests/LogStringConvertibleTests.swift similarity index 98% rename from UnitTests/LogStringConvertibleTests.swift rename to Tests/SwiftLoggerTests/LogStringConvertibleTests.swift index 58bc9b2..4397405 100644 --- a/UnitTests/LogStringConvertibleTests.swift +++ b/Tests/SwiftLoggerTests/LogStringConvertibleTests.swift @@ -23,7 +23,7 @@ // import XCTest -@testable import Logger +@testable import SwiftLogger class LogStringConvertibleTests: XCTestCase { diff --git a/UnitTests/LoggetTests.swift b/Tests/SwiftLoggerTests/LoggetTests.swift similarity index 98% rename from UnitTests/LoggetTests.swift rename to Tests/SwiftLoggerTests/LoggetTests.swift index a753ca7..2d63a4b 100644 --- a/UnitTests/LoggetTests.swift +++ b/Tests/SwiftLoggerTests/LoggetTests.swift @@ -23,7 +23,7 @@ // import XCTest -@testable import Logger +@testable import SwiftLogger class LoggetTests: XCTestCase { diff --git a/UnitTests/FileRotateTests.swift b/Tests/SwiftLoggerTests/LogrotateTests.swift similarity index 66% rename from UnitTests/FileRotateTests.swift rename to Tests/SwiftLoggerTests/LogrotateTests.swift index 13ca7c0..ae00f22 100644 --- a/UnitTests/FileRotateTests.swift +++ b/Tests/SwiftLoggerTests/LogrotateTests.swift @@ -23,9 +23,9 @@ // import XCTest -@testable import Logger +@testable import SwiftLogger -class FileRotateTests: XCTestCase { +class LogrotateTests: XCTestCase { let logURL = URL(fileURLWithPath: "/var/log/application.log") let log1URL = URL(fileURLWithPath: "/var/log/application.log.1") @@ -33,98 +33,98 @@ class FileRotateTests: XCTestCase { let log3URL = URL(fileURLWithPath: "/var/log/application.log.3") func test_1rotation_0files() { - let fileSystem = FileSystemMock(files: []) - let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: []) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 1, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set() XCTAssertEqual(actual, expected) } func test_1rotation_1file() { - let fileSystem = FileSystemMock(files: [logURL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 1, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL]) XCTAssertEqual(actual, expected) } func test_1rotation_2files() { - let fileSystem = FileSystemMock(files: [logURL, log1URL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL, log1URL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 1, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL]) XCTAssertEqual(actual, expected) } func test_1rotation_3files() { - let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL, log1URL, log2URL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 1, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL, log2URL]) XCTAssertEqual(actual, expected) } func test_2rotations_0files() { - let fileSystem = FileSystemMock(files: []) - let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: []) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 2, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set() XCTAssertEqual(actual, expected) } func test_2rotations_1file() { - let fileSystem = FileSystemMock(files: [logURL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 2, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL]) XCTAssertEqual(actual, expected) } func test_2rotations_2files() { - let fileSystem = FileSystemMock(files: [logURL, log1URL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL, log1URL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 2, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL, log2URL]) XCTAssertEqual(actual, expected) } func test_2rotations_3files() { - let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL, log1URL, log2URL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 2, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL, log2URL]) XCTAssertEqual(actual, expected) } func test_2rotations_4files() { - let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL, log3URL]) - let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + let fimeManager = FileManagerMock(files: [logURL, log1URL, log2URL, log3URL]) + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 2, fileManager: fimeManager) try? logrotate.rotate() - let actual = fileSystem.files + let actual = fimeManager.files let expected = Set([log1URL, log2URL, log3URL]) XCTAssertEqual(actual, expected) } func testErrorPropagation() { - let fileSystem = BrokenFileSystem() - let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + let fimeManager = BrokenFileSystem() + let logrotate = LogrotateImpl(fileURL: logURL, rotations: 1, fileManager: fimeManager) XCTAssertThrowsError(try logrotate.rotate(), "An error when removing or moving an item") { (error) in XCTAssertTrue(error is BrokenFileSystem.IOError) @@ -132,7 +132,7 @@ class FileRotateTests: XCTestCase { } } -private class FileSystemMock: FileSystem { +private class FileManagerMock: OSFileManager { private(set) var files = Set() @@ -159,7 +159,7 @@ private class FileSystemMock: FileSystem { } } -private class BrokenFileSystem: FileSystem { +private class BrokenFileSystem: OSFileManager { struct IOError: Error { } diff --git a/UnitTests/FileWriterTests.swift b/Tests/SwiftLoggerTests/SizeLimitedFileTests.swift similarity index 72% rename from UnitTests/FileWriterTests.swift rename to Tests/SwiftLoggerTests/SizeLimitedFileTests.swift index 222991c..93d82bd 100644 --- a/UnitTests/FileWriterTests.swift +++ b/Tests/SwiftLoggerTests/SizeLimitedFileTests.swift @@ -23,22 +23,22 @@ // import XCTest -@testable import Logger +@testable import SwiftLogger -class FileWriterTests: XCTestCase { +class SizeLimitedFileTests: XCTestCase { let logURL = URL(fileURLWithPath: "/var/log/application.log") func testFileOpeningFailure() { let factory = UnopenableFileFactory() - XCTAssertThrowsError(try FileWriter(fileURL: logURL, fileSizeLimit: 0, fileFactory: factory), "file open failure") { (error) in + XCTAssertThrowsError(try SizeLimitedFileImpl(fileURL: logURL, fileSizeLimit: 0, fileFactory: factory), "file open failure") { (error) in XCTAssertTrue(error is UnopenableFileFactory.OpenFileError) } } func testKeepingFileSizeLimit() throws { let factory = FileMockFactory() - let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) + let writer = try SizeLimitedFileImpl(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) let data = Data([0]) try writer.write(data) @@ -47,7 +47,7 @@ class FileWriterTests: XCTestCase { func testExceedingFileSizeLimit() throws { let factory = FileMockFactory() - let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) + let writer = try SizeLimitedFileImpl(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) let data = Data([0, 0]) XCTAssertThrowsError(try writer.write(data), "file size limit exceeded") { (error) in @@ -59,49 +59,49 @@ class FileWriterTests: XCTestCase { func testSynchronizingAndClosingFile() throws { let factory = FileMockFactory() - let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) - writer.synchronizeAndCloseFile() + let writer = try SizeLimitedFileImpl(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) + try writer.synchronizeAndCloseFile() XCTAssertTrue(factory.mock.synchronizeFileCallCount == 1 && factory.mock.closeFileCallCount == 1) } } -private class UnopenableFileFactory: FileFactory { +private class UnopenableFileFactory: FileHandleFactory { struct OpenFileError: Error {} - func makeInstance(forWritingTo: URL) throws -> File { + func makeInstance(forWritingTo: URL) throws -> OSFileHandle { throw OpenFileError() } } -private class FileMockFactory: FileFactory { +private class FileMockFactory: FileHandleFactory { let mock = FileMock() - func makeInstance(forWritingTo: URL) throws -> File { + func makeInstance(forWritingTo: URL) throws -> OSFileHandle { return mock } } -private class FileMock: File { +private class FileMock: OSFileHandle { private(set) var writtenData = Data() private(set) var synchronizeFileCallCount = 0 private(set) var closeFileCallCount = 0 - func seekToEndOfFile() -> UInt64 { + func osSeekToEndOfFile() throws -> UInt64 { return 0 } - func swift_write(_ data: Data) throws { + func osWrite(_ data: Data) throws { self.writtenData.append(data) } - func synchronizeFile() { + func osSynchronizeFile() throws { synchronizeFileCallCount += 1 } - func closeFile() { + func osCloseFile() throws { closeFileCallCount += 1 } } diff --git a/Tests/SwiftLoggerTests/XCTestManifests.swift b/Tests/SwiftLoggerTests/XCTestManifests.swift new file mode 100644 index 0000000..52deb45 --- /dev/null +++ b/Tests/SwiftLoggerTests/XCTestManifests.swift @@ -0,0 +1,9 @@ +import XCTest + +#if !canImport(ObjectiveC) +public func allTests() -> [XCTestCaseEntry] { + return [ + testCase(SwiftLoggerTests.allTests), + ] +} +#endif diff --git a/UnitTests/DiskLoggerTests.swift b/UnitTests/DiskLoggerTests.swift deleted file mode 100644 index aaededc..0000000 --- a/UnitTests/DiskLoggerTests.swift +++ /dev/null @@ -1,241 +0,0 @@ -// -// MIT License -// -// Copyright (c) 2018 Wojciech Nagrodzki -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. -// - -import XCTest -@testable import Logger - -class DiskLoggerTests: XCTestCase { - - let logURL = URL(fileURLWithPath: "/var/log/application.log") - - func testLoggingMessageToFile() { - let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") - expectation.expectedFulfillmentCount = 1 - - let filesystem = FileSystemStub() - let sizeLimitedFileFactory = SizeLimitedFileMockFactory(writeCall: expectation) - let logrotateFactory = LogrotateMockFactory() - let logger = DiskLogger(fileURL: logURL, - fileSizeLimit: 1024, - rotations: 1, - fileSystem: filesystem, - sizeLimitedFileFactory: sizeLimitedFileFactory, - logrotateFactory: logrotateFactory) - - logger.log("message", level: .critical) - - let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) - XCTAssertEqual(result, .completed) - - XCTAssertEqual(sizeLimitedFileFactory.files.count, 1) - - // "2018-08-30 17:23:11.514 DiskLoggerTests:46 testWritingMessageToFile() a message\n" - let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self) - let expectedSuffix = " DiskLoggerTests:46 testLoggingMessageToFile() message\n" - - XCTAssertTrue(loggedMessage.hasSuffix(expectedSuffix)) - } - - func testExceedingFileSizeLimit() { - let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") - expectation.expectedFulfillmentCount = 2 - - let filesystem = FileSystemStub() - let sizeLimitedFileFactory = SizeLimitedFileMockFactory(writeCall: expectation) - let logrotateFactory = LogrotateMockFactory() - let logger = DiskLogger(fileURL: logURL, - fileSizeLimit: 91, - rotations: 1, - fileSystem: filesystem, - sizeLimitedFileFactory: sizeLimitedFileFactory, - logrotateFactory: logrotateFactory) - - logger.log("1st message", level: .critical) - logger.log("2st message", level: .critical) - - let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) - XCTAssertEqual(result, .completed) - - XCTAssertEqual(sizeLimitedFileFactory.files.count, 2) - - // "2018-08-31 18:29:34.748 DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" - let loggedMessage = String(decoding: sizeLimitedFileFactory.files[1].data, as: UTF8.self) - let expectedSuffix = " DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" - - XCTAssertTrue(loggedMessage.hasSuffix(expectedSuffix)) - } - - func testErrorDuringLogProcess() { - let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") - expectation.expectedFulfillmentCount = 2 - - let filesystem = FileSystemStub() - let sizeLimitedFileFactory = UnwritableFileStubFactory(writeCall: expectation) - let logrotateFactory = LogrotateMockFactory() - let logger = DiskLogger(fileURL: logURL, - fileSizeLimit: 91, - rotations: 1, - fileSystem: filesystem, - sizeLimitedFileFactory: sizeLimitedFileFactory, - logrotateFactory: logrotateFactory) - - logger.log("1st message", level: .critical) - logger.log("2st message", level: .critical) - - let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) - XCTAssertEqual(result, .completed) - - XCTAssertEqual(sizeLimitedFileFactory.files.count, 1) - - // "2018-08-31 18:29:34.748 DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" - let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self) - let expectedOccurence = " WriteFailed()" - - XCTAssertTrue(loggedMessage.contains(expectedOccurence)) - } -} - -private class FileSystemStub: FileSystem { - func itemExists(at URL: URL) -> Bool { - return false - } - - func removeItem(at URL: URL) throws { - - } - - func moveItem(at srcURL: URL, to dstURL: URL) throws { - - } - - func createFile(at URL: URL) -> Bool { - return true - } -} - -private class SizeLimitedFileMockFactory: SizeLimitedFileFactory { - - private(set) var files = [SizeLimitedFileMock]() - private let writeCall: XCTestExpectation - - init(writeCall: XCTestExpectation) { - self.writeCall = writeCall - } - - func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { - let mock = SizeLimitedFileMock(writeCall: writeCall, fileSizeLimit: fileSizeLimit) - files.append(mock) - return mock - } -} - -private class SizeLimitedFileMock: SizeLimitedFile { - - private(set) var data = Data() - private(set) var synchronizeAndCloseFileCallCount = 0 - private let writeCall: XCTestExpectation - private let fileSizeLimit: UInt64 - - init(writeCall: XCTestExpectation, fileSizeLimit: UInt64) { - self.writeCall = writeCall - self.fileSizeLimit = fileSizeLimit - } - - func write(_ data: Data) throws { - guard data.count + self.data.count <= fileSizeLimit else { - throw SizeLimitedFileQuotaReached() - } - self.data.append(data) - writeCall.fulfill() - } - - func synchronizeAndCloseFile() { - synchronizeAndCloseFileCallCount += 1 - } -} - -private class UnwritableFileStubFactory: SizeLimitedFileFactory { - - private(set) var files = [UnwritableFileStub]() - private let writeCall: XCTestExpectation - - init(writeCall: XCTestExpectation) { - self.writeCall = writeCall - } - - func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { - let file = UnwritableFileStub(writeCall: writeCall, fileSizeLimit: fileSizeLimit) - files.append(file) - return file - } -} - -private class UnwritableFileStub: SizeLimitedFile { - - struct WriteFailed: Error {} - - private(set) var data = Data() - private let writeCall: XCTestExpectation - private var didThrowError = false - - init(writeCall: XCTestExpectation, fileSizeLimit: UInt64) { - self.writeCall = writeCall - } - - func write(_ data: Data) throws { - if didThrowError { - self.data.append(data) - writeCall.fulfill() - } - else { - didThrowError = true - writeCall.fulfill() - throw WriteFailed() - } - } - - func synchronizeAndCloseFile() { - - } -} - -private class LogrotateMockFactory: LogrotateFactory { - - private(set) var logrotates = [LogrotateMock]() - - func makeInstance(fileURL: URL, rotations: Int) -> Logrotate { - let mock = LogrotateMock() - logrotates.append(mock) - return mock - } -} - -private class LogrotateMock: Logrotate { - - private(set) var rotateCallCount = 0 - - func rotate() throws { - rotateCallCount += 1 - } -} diff --git a/UnitTests/Info.plist b/UnitTests/Info.plist deleted file mode 100644 index 6c40a6c..0000000 --- a/UnitTests/Info.plist +++ /dev/null @@ -1,22 +0,0 @@ - - - - - CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - BNDL - CFBundleShortVersionString - 1.0 - CFBundleVersion - 1 - -