wnagrodzki/SwiftLogger
1
0
Fork 0
mirror of https://github.com/wnagrodzki/SwiftLogger.git synced 2025-04-05 20:11:53 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'release/1.0.0'

Browse source
This commit is contained in:
Wojciech Nagrodzki 2018-09-19 20:51:01 +02:00
commit 6e8d96f8b9
Signed by: wnagrodzki
GPG key ID: E9D0EB0302264569
25 changed files with 2145 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.travis.yml Normal file
View file

@ -0,0 +1,5 @@
language: swift
osx_image: xcode10
xcode_project: Logger.xcodeproj
script: xcodebuild test -project Logger.xcodeproj -scheme Logger -destination 'platform=iOS Simulator,name=iPhone XS,OS=12.0'
after_success: bash <(curl -s https://codecov.io/bash)

512
Logger.xcodeproj/project.pbxproj Normal file
View file

@ -0,0 +1,512 @@
// !$*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 = "<group>"; };
2E58D35E21316C3500BEF81A /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
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 = "<group>"; };
2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LogStringConvertible.swift; sourceTree = "<group>"; };
2EBF4B472122AF53008E4117 /* AgregateLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AgregateLogger.swift; sourceTree = "<group>"; };
2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConsoleLogger.swift; sourceTree = "<group>"; };
2EBF4B492122AF53008E4117 /* NullLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NullLogger.swift; sourceTree = "<group>"; };
2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSFileHandle+Swift.h"; sourceTree = "<group>"; };
2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSFileHandle+Swift.m"; sourceTree = "<group>"; };
2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Logger-Bridging-Header.h"; sourceTree = "<group>"; };
2EBF4B542122B598008E4117 /* DiskLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DiskLogger.swift; sourceTree = "<group>"; };
2EBF4B552122B598008E4117 /* FileWriter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileWriter.swift; sourceTree = "<group>"; };
2EBF4B562122B598008E4117 /* FileRotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileRotate.swift; sourceTree = "<group>"; };
2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = "<group>"; };
2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = "<group>"; };
2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = "<group>"; };
2ED103E02135C61100EB3683 /* FileRotateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileRotateTests.swift; sourceTree = "<group>"; };
2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileWriterTests.swift; sourceTree = "<group>"; };
2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DiskLoggerTests.swift; sourceTree = "<group>"; };
2EDA8AE8213ACCFF00FE5840 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
/* 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 = "<group>";
};
2EBF4B312122AA34008E4117 = {
isa = PBXGroup;
children = (
2EDA8AE8213ACCFF00FE5840 /* README.md */,
2EBF4B3C2122AA34008E4117 /* Logger */,
2E58D35B21316C3500BEF81A /* UnitTests */,
2EBF4B3B2122AA34008E4117 /* Products */,
);
sourceTree = "<group>";
};
2EBF4B3B2122AA34008E4117 /* Products */ = {
isa = PBXGroup;
children = (
2EBF4B3A2122AA34008E4117 /* libLogger.a */,
2E58D35A21316C3500BEF81A /* UnitTests.xctest */,
);
name = Products;
sourceTree = "<group>";
};
2EBF4B3C2122AA34008E4117 /* Logger */ = {
isa = PBXGroup;
children = (
2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */,
2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */,
2EBF4B3D2122AA34008E4117 /* Logger.swift */,
2EBF4B462122AF53008E4117 /* Loggers */,
);
path = Logger;
sourceTree = "<group>";
};
2EBF4B462122AF53008E4117 /* Loggers */ = {
isa = PBXGroup;
children = (
2EBF4B472122AF53008E4117 /* AgregateLogger.swift */,
2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */,
2EBF4B492122AF53008E4117 /* NullLogger.swift */,
2EBF4B4D2122B034008E4117 /* DiskLogger */,
);
path = Loggers;
sourceTree = "<group>";
};
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 = "<group>";
};
/* 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;
};
2EBF4B392122AA34008E4117 = {
CreatedOnToolsVersion = 10.0;
LastSwiftMigration = 1000;
};
};
};
buildConfigurationList = 2EBF4B352122AA34008E4117 /* Build configuration list for PBXProject "Logger" */;
compatibilityVersion = "Xcode 9.3";
developmentRegion = en;
hasScannedForEncodings = 0;
knownRegions = (
en,
);
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 = 4.2;
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 = 4.2;
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 = 4.2;
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 = 4.2;
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 */;
}

7
Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata generated Normal file
View file

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<Workspace
version = "1.0">
<FileRef
location = "self:Logger.xcodeproj">
</FileRef>
</Workspace>

8
Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>IDEDidComputeMac32BitWarning</key>
<true/>
</dict>
</plist>

100
Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme Normal file
View file

@ -0,0 +1,100 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "1000"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
buildImplicitDependencies = "YES">
<BuildActionEntries>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "YES"
buildForProfiling = "YES"
buildForArchiving = "YES"
buildForAnalyzing = "YES">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "2EBF4B392122AA34008E4117"
BuildableName = "libLogger.a"
BlueprintName = "Logger"
ReferencedContainer = "container:Logger.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
</BuildAction>
<TestAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
codeCoverageEnabled = "YES"
shouldUseLaunchSchemeArgsEnv = "YES">
<Testables>
<TestableReference
skipped = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "2E58D35921316C3500BEF81A"
BuildableName = "UnitTests.xctest"
BlueprintName = "UnitTests"
ReferencedContainer = "container:Logger.xcodeproj">
</BuildableReference>
</TestableReference>
</Testables>
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "2EBF4B392122AA34008E4117"
BuildableName = "libLogger.a"
BlueprintName = "Logger"
ReferencedContainer = "container:Logger.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</TestAction>
<LaunchAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
launchStyle = "0"
useCustomWorkingDirectory = "NO"
ignoresPersistentStateOnLaunch = "NO"
debugDocumentVersioning = "YES"
debugServiceExtension = "internal"
allowLocationSimulation = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "2EBF4B392122AA34008E4117"
BuildableName = "libLogger.a"
BlueprintName = "Logger"
ReferencedContainer = "container:Logger.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</LaunchAction>
<ProfileAction
buildConfiguration = "Release"
shouldUseLaunchSchemeArgsEnv = "YES"
savedToolIdentifier = ""
useCustomWorkingDirectory = "NO"
debugDocumentVersioning = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "2EBF4B392122AA34008E4117"
BuildableName = "libLogger.a"
BlueprintName = "Logger"
ReferencedContainer = "container:Logger.xcodeproj">
</BuildableReference>
</MacroExpansion>
</ProfileAction>
<AnalyzeAction
buildConfiguration = "Debug">
</AnalyzeAction>
<ArchiveAction
buildConfiguration = "Release"
revealArchiveInOrganizer = "YES">
</ArchiveAction>
</Scheme>

41
Logger/LogStringConvertible.swift Normal file
View file

@ -0,0 +1,41 @@
//
// 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 Foundation
/// A type with a customized textual representation suitable for logging purposes.
public protocol LogStringConvertible {
/// A textual representation of this instance, suitable for logging.
var logDescription: String { get }
}
extension Array: LogStringConvertible where Element: LogStringConvertible {
public var logDescription: String {
let descriptions = map { $0.logDescription }
let joinedDescriptions = descriptions.joined(separator: ", ")
return "[" + joinedDescriptions + "]"
}
}

5
Logger/Logger-Bridging-Header.h Normal file
View file

@ -0,0 +1,5 @@
//
// Use this file to import your target's public headers that you would like to expose to Swift.
//
#import "Loggers/DiskLogger/NSFileHandle+Swift.h"

121
Logger/Logger.swift Normal file
View file

@ -0,0 +1,121 @@
//
// 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 Foundation
/// A type able to build custom log message and send it to a logging system.
public protocol Logger {
/// Builds log a message from passed parameters and sends it to the logging system.
///
/// Do not call this method directly.
///
/// - Parameters:
/// - time: The date log method was called.
/// - level: The log level.
/// - location: Part of the log message provided by `description(for file: String, line: Int, function: String)` method.
/// - message: The message to be logged.
func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String)
/// Transforms passed parameters into location textual representation which will be a part of the log message.
///
/// Customization point. Default implementation returns location in format `"<file name>:<line> <function>"`,
///
/// - Parameters:
/// - file: The path to the file log method was called from.
/// - line: The line number log method was called at.
/// - function: The name of the declaration log method was called within.
func description(for file: String, line: Int, function: String) -> String
}
/// Log level controls the conditions under which a message should be logged.
/// - note: [RFC5424](https://www.rfc-editor.org/info/rfc5424)
public enum LogLevel: Int {
/// System is unusable.
case emergency = 0
/// Action must be taken immediately.
case alert = 1
/// Critical conditions.
case critical = 2
/// Error conditions.
case error = 3
/// Warning conditions.
case warning = 4
/// Normal but significant conditions.
case notice = 5
/// Informational messages.
case informational = 6
/// Debug-level messages.
case debug = 7
}
extension LogLevel: LogStringConvertible {
public var logDescription: String {
switch self {
case .emergency: return "emerg"
case .alert: return "alert"
case .critical: return "crit"
case .error: return "err"
case .warning: return "warning"
case .notice: return "notice"
case .informational: return "info"
case .debug: return "debug"
}
}
}
extension Logger {
/// Sends object to the logging system, optionally specifying a custom log level.
///
/// - Parameters:
/// - message: The message to be logged.
/// - level: The log level.
/// - file: **Do not provide a custom value.** The path to the file log method is called from.
/// - line: **Do not provide a custom value.** The line number log method is called at.
/// - function: **Do not provide a custom value.** The name of the declaration log method is called within.
public func log(_ message: @autoclosure () -> String, level: LogLevel, file: String = #file, line: Int = #line, function: String = #function) {
let now = Date()
let location = description(for: file, line: line, function: function)
log(time: now, level: level, location: location, message: message)
}
/// Returns location in format `"<file name>:<line> <function>"`.
public func description(for file: String, line: Int, function: String) -> String {
return filename(fromFilePath: file) + ":\(line) \(function)"
}
private func filename(fromFilePath path: String) -> String {
return URL(fileURLWithPath: path).deletingPathExtension().lastPathComponent
}
}

44
Logger/Loggers/AgregateLogger.swift Normal file
View file

@ -0,0 +1,44 @@
//
// 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 Foundation
/// Logger that forwards messages to all the loggers it is intialized with.
public final class AgregateLogger: Logger {
private let loggers: [Logger]
/// Initializes new AgregateLogger instance.
///
/// - Parameter loggers: Array of loggers all messages will be forwarded to.
public init(loggers: [Logger]) {
self.loggers = loggers
}
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
for logger in self.loggers {
logger.log(time: time, level: level, location: location, message: message)
}
}
}

41
Logger/Loggers/ConsoleLogger.swift Normal file
View file

@ -0,0 +1,41 @@
//
// 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 Foundation
/// Logger that writes messages into the standard output.
public final class ConsoleLogger: Logger {
private let formatter: DateFormatter
public init() {
formatter = DateFormatter()
formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS"
formatter.timeZone = TimeZone(secondsFromGMT: 0)
}
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
print(formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + message())
}
}

189
Logger/Loggers/DiskLogger/DiskLogger.swift Normal file
View file

@ -0,0 +1,189 @@
//
// 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 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.
///
/// - 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.
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 `<fileURL>.<rotations>`.
/// Next moves files located at:
///
/// `<fileURL>, <fileURL>.1, <fileURL>.2 ... <fileURL>.<rotations - 1>`
///
/// to `<fileURL>.1, <fileURL>.2 ... <fileURL>.<rotations>`
func rotate() throws
}
protocol LogrotateFactory {
/// Returns newly initialized Logrotate instance.
///
/// - Parameters:
/// - fileURL: URL of the log file.
/// - rotations: Number of times log files are rotated before being removed.
func makeInstance(fileURL: URL, rotations: Int) -> Logrotate
}
/// Logger that writes messages into the file at specified URL with log rotation support.
public final class DiskLogger: Logger {
private let fileURL: URL
private let fileSizeLimit: UInt64
private let rotations: Int
private let fileSystem: FileSystem
private let sizeLimitedFileFactory: SizeLimitedFileFactory
private let logrotateFactory: LogrotateFactory
private let formatter: DateFormatter
private let queue = DispatchQueue(label: "com.wnagrodzki.DiskLogger", qos: .background, attributes: [], autoreleaseFrequency: .workItem, target: nil)
private var buffer = Data()
private var sizeLimitedFile: SizeLimitedFile!
/// Initializes new DiskLogger instance.
///
/// - Parameters:
/// - fileURL: URL of the log file.
/// - 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())
}
init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem, sizeLimitedFileFactory: SizeLimitedFileFactory, logrotateFactory: LogrotateFactory) {
self.fileURL = fileURL
self.fileSizeLimit = fileSizeLimit
self.rotations = rotations
self.fileSystem = fileSystem
self.sizeLimitedFileFactory = sizeLimitedFileFactory
self.logrotateFactory = logrotateFactory
formatter = DateFormatter()
formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS"
formatter.timeZone = TimeZone(secondsFromGMT: 0)
}
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
let message = formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + message() + "\n"
log(message)
}
private func log(_ message: String) {
let data = Data(message.utf8)
queue.async {
self.buffer.append(data)
do {
try self.openSizeLimitedFile()
do {
try self.writeBuffer()
}
catch is SizeLimitedFileQuotaReached {
self.closeSizeLimitedFile()
try self.rotateLogFiles()
try self.openSizeLimitedFile()
try self.writeBuffer()
}
}
catch {
let message = self.formatter.string(from: Date()) + " <" + LogLevel.warning.logDescription + "> " + String(describing: error) + "\n"
let data = Data(message.utf8)
self.buffer.append(data)
}
}
}
private func openSizeLimitedFile() throws {
guard sizeLimitedFile == nil else { return }
if fileSystem.itemExists(at: fileURL) == false {
_ = fileSystem.createFile(at: fileURL)
}
sizeLimitedFile = try sizeLimitedFileFactory.makeInstance(fileURL: fileURL, fileSizeLimit: fileSizeLimit)
}
private func writeBuffer() throws {
try sizeLimitedFile.write(buffer)
buffer.removeAll()
}
private func closeSizeLimitedFile() {
self.sizeLimitedFile.synchronizeAndCloseFile()
self.sizeLimitedFile = nil
}
private func rotateLogFiles() throws {
let logrotate = logrotateFactory.makeInstance(fileURL: fileURL, rotations: rotations)
try logrotate.rotate()
}
}
private class FileRotateFactory: LogrotateFactory {
func makeInstance(fileURL: URL, rotations: Int) -> Logrotate {
return FileRotate(fileURL: fileURL, rotations: rotations, fileSystem: FileManager.default)
}
}
private class FileWriterFactory: SizeLimitedFileFactory {
func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile {
return try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit, fileFactory: FileHandleFactory())
}
}
private class FileHandleFactory: FileFactory {
func makeInstance(forWritingTo: URL) throws -> File {
return try FileHandle(forWritingTo: forWritingTo)
}
}
extension FileHandle: File {
}

43
Logger/Loggers/DiskLogger/FileSystem.swift Normal file
View file

@ -0,0 +1,43 @@
//
// 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 Foundation
public protocol FileSystem {
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 {
public func itemExists(at URL: URL) -> Bool {
return fileExists(atPath: URL.path)
}
public func createFile(at URL: URL) -> Bool {
return createFile(atPath: URL.path, contents: nil, attributes: nil)
}
}

73
Logger/Loggers/DiskLogger/FileWriter.swift Normal file
View file

@ -0,0 +1,73 @@
//
// 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 Foundation
protocol File {
func seekToEndOfFile() -> UInt64
func swift_write(_ data: Data) throws
func synchronizeFile()
func closeFile()
}
protocol FileFactory {
func makeInstance(forWritingTo: URL) throws -> File
}
/// Allows writing to a file while respecting allowed size limit.
final class FileWriter {
private let file: File
private let sizeLimit: UInt64
private var currentSize: UInt64
/// Initializes new FileWriter 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 {
file = try fileFactory.makeInstance(forWritingTo: fileURL)
self.sizeLimit = fileSizeLimit
currentSize = file.seekToEndOfFile()
}
}
extension FileWriter: SizeLimitedFile {
func write(_ data: Data) throws {
let dataSize = UInt64(data.count)
guard currentSize + dataSize <= sizeLimit else {
throw SizeLimitedFileQuotaReached()
}
try file.swift_write(data)
currentSize += dataSize
}
func synchronizeAndCloseFile() {
file.synchronizeFile()
file.closeFile()
}
}

65
Logger/Loggers/DiskLogger/Filerotate.swift Normal file
View file

@ -0,0 +1,65 @@
//
// 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 Foundation
final class FileRotate {
private let fileURL: URL
private let rotations: Int
private let fileSystem: FileSystem
/// 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) {
precondition(rotations > 0)
self.fileURL = fileURL
self.rotations = rotations
self.fileSystem = fileSystem
}
}
extension FileRotate: Logrotate {
func rotate() throws {
let range = 1...rotations
let pathExtensions = range.map { "\($0)" }
let rotatedURLs = pathExtensions.map { fileURL.appendingPathExtension($0) }
let allURLs = [fileURL] + rotatedURLs
let toDelete = rotatedURLs.last!
let toMove = zip(allURLs, rotatedURLs).reversed()
if fileSystem.itemExists(at: toDelete) {
try fileSystem.removeItem(at: toDelete)
}
for (oldURL, newURL) in toMove {
guard fileSystem.itemExists(at: oldURL) else { continue }
try fileSystem.moveItem(at: oldURL, to: newURL)
}
}
}

35
Logger/Loggers/DiskLogger/NSFileHandle+Swift.h Normal file
View file

@ -0,0 +1,35 @@
//
// 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 <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@interface NSFileHandle (Swift)
- (BOOL)swift_writeData:(NSData *)data error:(NSError **)error;
@end
NS_ASSUME_NONNULL_END

44
Logger/Loggers/DiskLogger/NSFileHandle+Swift.m Normal file
View file

@ -0,0 +1,44 @@
//
// 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

40
Logger/Loggers/NullLogger.swift Normal file
View file

@ -0,0 +1,40 @@
//
// 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 Foundation
/// Logger that ignores all messages with the intention to minimize observer effect.
public class NullLogger: Logger {
public init() {
}
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
// noop
}
/// Returns empty string to minimize observer effect.
public func description(for file: String, line: Int, function: String) -> String {
return ""
}
}

48
README.md
View file

@ -1,2 +1,50 @@
# SwiftLogger
[![Build Status](https://travis-ci.org/wnagrodzki/SwiftLogger.svg?branch=master)](https://travis-ci.org/wnagrodzki/SwiftLogger)
[![codecov](https://codecov.io/gh/wnagrodzki/SwiftLogger/branch/master/graph/badge.svg)](https://codecov.io/gh/wnagrodzki/SwiftLogger)
Dependency free Logger API for Swift.
## Motivation
Beside obvious benefit for unit testing (see `NullLogger`), having loose coupling to a logging framework makes it easy to log messages into multiple logging systems at once (see `AgregateLogger`).
## Usage
`Logger` protocol provides simple interface utilizing log levels defined by [The Syslog Protocol - RFC5424](https://www.rfc-editor.org/info/rfc5424).
```swift
logger.log("message", level: .emergency)
logger.log("message", level: .alert)
logger.log("message", level: .critical)
logger.log("message", level: .error)
logger.log("message", level: .warning)
logger.log("message", level: .notice)
logger.log("message", level: .informational)
logger.log("message", level: .debug)
```
Log calls capture time, file name, method name and line number automatically. This way it is possible to compose log messages similar to the one presented below.
```
2018-08-31 18:29:34.748 <crit> SwiftFile:75 method() message
```
## Integration with logger frameworks
You need to provide implementation for one method.
```swift
final class CustomLogger: Logger {
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
/// compose message and forward it to a logging framework
}
}
```
## Provided loggers
`ConsoleLogger` writes messages into the standard output.
`NullLogger` ignores all messages with the intention to minimize observer effect. Useful for unit testing.
`DiskLogger` writes messages into the file at specified URL with log rotation support.
`AgregateLogger` forwards messages to all the loggers it is initialized with.

68
UnitTests/AgregateLoggerTests.swift Normal file
View file

@ -0,0 +1,68 @@
//
// 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 AgregateLoggerTests: XCTestCase {
func testCallForwarding() {
let loggerA = LoggerMock()
let loggerB = LoggerMock()
let agregateLogger = AgregateLogger(loggers: [loggerA, loggerB])
agregateLogger.log("0", level: .emergency)
agregateLogger.log("1", level: .alert)
agregateLogger.log("2", level: .critical)
agregateLogger.log("3", level: .error)
agregateLogger.log("4", level: .warning)
agregateLogger.log("5", level: .notice)
agregateLogger.log("6", level: .informational)
agregateLogger.log("7", level: .debug)
XCTAssertEqual(loggerA, loggerB)
}
}
private class LoggerMock: Logger {
struct Log: Equatable {
let time: Date
let level: LogLevel
let location: String
let message: String
}
private var logs = [Log]()
func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
let log = Log(time: time, level: level, location: location, message: message())
logs.append(log)
}
}
extension LoggerMock: Equatable {
static func == (lhs: LoggerMock, rhs: LoggerMock) -> Bool {
return lhs.logs == rhs.logs
}
}

241
UnitTests/DiskLoggerTests.swift Normal file
View file

@ -0,0 +1,241 @@
//
// 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 <crit> DiskLoggerTests:46 testWritingMessageToFile() a message\n"
let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self)
let expectedSuffix = " <crit> 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 <crit> DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n"
let loggedMessage = String(decoding: sizeLimitedFileFactory.files[1].data, as: UTF8.self)
let expectedSuffix = " <crit> 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 <crit> DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n"
let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self)
let expectedOccurence = " <warning> 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
}
}

181
UnitTests/FileRotateTests.swift Normal file
View file

@ -0,0 +1,181 @@
//
// 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 FileRotateTests: XCTestCase {
let logURL = URL(fileURLWithPath: "/var/log/application.log")
let log1URL = URL(fileURLWithPath: "/var/log/application.log.1")
let log2URL = URL(fileURLWithPath: "/var/log/application.log.2")
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)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>()
XCTAssertEqual(actual, expected)
}
func test_1rotation_1file() {
let fileSystem = FileSystemMock(files: [logURL])
let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([log1URL])
XCTAssertEqual(actual, expected)
}
func test_1rotation_2files() {
let fileSystem = FileSystemMock(files: [logURL, log1URL])
let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([log1URL])
XCTAssertEqual(actual, expected)
}
func test_1rotation_3files() {
let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL])
let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([log1URL, log2URL])
XCTAssertEqual(actual, expected)
}
func test_2rotations_0files() {
let fileSystem = FileSystemMock(files: [])
let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>()
XCTAssertEqual(actual, expected)
}
func test_2rotations_1file() {
let fileSystem = FileSystemMock(files: [logURL])
let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([log1URL])
XCTAssertEqual(actual, expected)
}
func test_2rotations_2files() {
let fileSystem = FileSystemMock(files: [logURL, log1URL])
let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([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)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([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)
try? logrotate.rotate()
let actual = fileSystem.files
let expected = Set<URL>([log1URL, log2URL, log3URL])
XCTAssertEqual(actual, expected)
}
func testErrorPropagation() {
let fileSystem = BrokenFileSystem()
let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem)
XCTAssertThrowsError(try logrotate.rotate(), "An error when removing or moving an item") { (error) in
XCTAssertTrue(error is BrokenFileSystem.IOError)
}
}
}
private class FileSystemMock: FileSystem {
private(set) var files = Set<URL>()
init(files: Set<URL>) {
self.files = files
}
func itemExists(at URL: URL) -> Bool {
return files.contains(URL)
}
func removeItem(at URL: URL) throws {
files.remove(URL)
}
func moveItem(at srcURL: URL, to dstURL: URL) throws {
files.remove(srcURL)
files.insert(dstURL)
}
func createFile(at URL: URL) -> Bool {
files.insert(URL)
return true
}
}
private class BrokenFileSystem: FileSystem {
struct IOError: Error { }
func itemExists(at URL: URL) -> Bool {
return true
}
func removeItem(at URL: URL) throws {
throw IOError()
}
func moveItem(at srcURL: URL, to dstURL: URL) throws {
throw IOError()
}
func createFile(at URL: URL) -> Bool {
return false
}
}

107
UnitTests/FileWriterTests.swift Normal file
View file

@ -0,0 +1,107 @@
//
// 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 FileWriterTests: 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
XCTAssertTrue(error is UnopenableFileFactory.OpenFileError)
}
}
func testKeepingFileSizeLimit() throws {
let factory = FileMockFactory()
let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory)
let data = Data(bytes: [0])
try writer.write(data)
XCTAssertEqual(factory.mock.writtenData, data)
}
func testExceedingFileSizeLimit() throws {
let factory = FileMockFactory()
let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory)
let data = Data(bytes: [0, 0])
XCTAssertThrowsError(try writer.write(data), "file size limit exceeded") { (error) in
XCTAssertTrue(error is SizeLimitedFileQuotaReached)
}
XCTAssertEqual(factory.mock.writtenData.count, 0)
}
func testSynchronizingAndClosingFile() throws {
let factory = FileMockFactory()
let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory)
writer.synchronizeAndCloseFile()
XCTAssertTrue(factory.mock.synchronizeFileCallCount == 1 && factory.mock.closeFileCallCount == 1)
}
}
private class UnopenableFileFactory: FileFactory {
struct OpenFileError: Error {}
func makeInstance(forWritingTo: URL) throws -> File {
throw OpenFileError()
}
}
private class FileMockFactory: FileFactory {
let mock = FileMock()
func makeInstance(forWritingTo: URL) throws -> File {
return mock
}
}
private class FileMock: File {
private(set) var writtenData = Data()
private(set) var synchronizeFileCallCount = 0
private(set) var closeFileCallCount = 0
func seekToEndOfFile() -> UInt64 {
return 0
}
func swift_write(_ data: Data) throws {
self.writtenData.append(data)
}
func synchronizeFile() {
synchronizeFileCallCount += 1
}
func closeFile() {
closeFileCallCount += 1
}
}

22
UnitTests/Info.plist Normal file
View file

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>$(DEVELOPMENT_LANGUAGE)</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>$(PRODUCT_NAME)</string>
<key>CFBundlePackageType</key>
<string>BNDL</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleVersion</key>
<string>1</string>
</dict>
</plist>

50
UnitTests/LogStringConvertibleTests.swift Normal file
View file

@ -0,0 +1,50 @@
//
// 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 LogStringConvertibleTests: XCTestCase {
func testZeroObjectsDescription() {
let objects = [Int]()
XCTAssertEqual(objects.logDescription, "[]")
}
func testOneObjectDescription() {
let objects = [1]
XCTAssertEqual(objects.logDescription, "[1]")
}
func testTwoObjectsDescription() {
let objects = [1, 2]
XCTAssertEqual(objects.logDescription, "[1, 2]")
}
}
extension Int: LogStringConvertible {
public var logDescription: String {
return String(describing: self)
}
}

55
UnitTests/LoggetTests.swift Normal file
View file

@ -0,0 +1,55 @@
//
// 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 LoggetTests: XCTestCase {
func testLocation() {
let mock = LoggerMock()
mock.log("", level: .critical)
XCTAssertEqual(mock.location, "LoggetTests:32 testLocation()")
}
func testLogLevelLogDescription() {
XCTAssertEqual(LogLevel.emergency.logDescription, "emerg")
XCTAssertEqual(LogLevel.alert.logDescription, "alert")
XCTAssertEqual(LogLevel.critical.logDescription, "crit")
XCTAssertEqual(LogLevel.error.logDescription, "err")
XCTAssertEqual(LogLevel.warning.logDescription, "warning")
XCTAssertEqual(LogLevel.notice.logDescription, "notice")
XCTAssertEqual(LogLevel.informational.logDescription, "info")
XCTAssertEqual(LogLevel.debug.logDescription, "debug")
}
}
private class LoggerMock: Logger {
var location: String?
func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
self.location = location
}
}