Add Bot Configuration tests

cojoj · cojoj · commit 827fe42080b2 · 2015-06-24T21:41:16.000+02:00
diff --git a/XcodeServerSDK.xcodeproj/project.pbxproj b/XcodeServerSDK.xcodeproj/project.pbxproj
@@ -78,6 +78,7 @@
 		707D089E1B2C6A1F003900F3 /* TriggerConditions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 707D089D1B2C6A1F003900F3 /* TriggerConditions.swift */; };
 		709ED67C1B35FD3F00A06038 /* XcodeServerEntityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 709ED67B1B35FD3F00A06038 /* XcodeServerEntityTests.swift */; };
 		709ED6801B3608FC00A06038 /* XcodeServerConfigTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 709ED67F1B3608FC00A06038 /* XcodeServerConfigTests.swift */; };
+		70B21FF81B3AFB1D00EAD4EB /* BotConfigurationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 70B21FF71B3AFB1D00EAD4EB /* BotConfigurationTests.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -141,6 +142,7 @@
 		707D089D1B2C6A1F003900F3 /* TriggerConditions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TriggerConditions.swift; sourceTree = "<group>"; };
 		709ED67B1B35FD3F00A06038 /* XcodeServerEntityTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = XcodeServerEntityTests.swift; sourceTree = "<group>"; };
 		709ED67F1B3608FC00A06038 /* XcodeServerConfigTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = XcodeServerConfigTests.swift; sourceTree = "<group>"; };
+		70B21FF71B3AFB1D00EAD4EB /* BotConfigurationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BotConfigurationTests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -247,8 +249,9 @@
 				709ED67B1B35FD3F00A06038 /* XcodeServerEntityTests.swift */,
 				3A058A8D1B31595A0077FD47 /* BotParsingTests.swift */,
 				3A058A921B315BB50077FD47 /* TestUtils.swift */,
-				3A7B48CA1B2A5AC40077ABEA /* Supporting Files */,
 				705D59A01B3AE502002521BA /* HTTPUtilsTests.swift */,
+				70B21FF71B3AFB1D00EAD4EB /* BotConfigurationTests.swift */,
+				3A7B48CA1B2A5AC40077ABEA /* Supporting Files */,
 			);
 			path = XcodeServerSDKTests;
 			sourceTree = "<group>";
@@ -568,6 +571,7 @@
 				3A058A931B315BB50077FD47 /* TestUtils.swift in Sources */,
 				3A7B48CD1B2A5AC40077ABEA /* XcodeServerTests.swift in Sources */,
 				709ED6801B3608FC00A06038 /* XcodeServerConfigTests.swift in Sources */,
+				70B21FF81B3AFB1D00EAD4EB /* BotConfigurationTests.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
diff --git a/XcodeServerSDK/Server Entities/BotConfiguration.swift b/XcodeServerSDK/Server Entities/BotConfiguration.swift
@@ -10,71 +10,103 @@ import Foundation
 
 public class BotConfiguration : XcodeServerEntity {
     
+    /**
+    Enum with values describing when Bots history
+    should be cleaned.
+    
+    - Never:       Never clean
+    - Always:      Clean always project is opened
+    - Once_a_Day:  Clean once a day on first build
+    - Once_a_Week: Clean once a week on first build
+    */
     public enum CleaningPolicy : Int {
         case Never = 0
         case Always
         case Once_a_Day
         case Once_a_Week
         
+        /**
+        Method for preinting in human readable Bots
+        cleaning policy
+        
+        - returns: String with cleaning policy description
+        */
         public func toString() -> String {
             switch self {
-            case .Never:
-                return "Never"
-            case .Always:
-                return "Always"
-            case .Once_a_Day:
-                return "Once a day (first build)"
-            case .Once_a_Week:
-                return "Once a week (first build)"
+                case .Never:
+                    return "Never"
+                case .Always:
+                    return "Always"
+                case .Once_a_Day:
+                    return "Once a day (first build)"
+                case .Once_a_Week:
+                    return "Once a week (first build)"
             }
         }
     }
     
+    /**
+    Enum which describes type of available devices.
+    
+    - Simulator: iOS simulator (can be any device running iOS)
+    - Mac:       Mac with installed OS X
+    - iPhone:    iOS device (includes iPhone, iPad and iPod Touch)
+    */
     public enum DeviceType : String {
         case Simulator = "com.apple.iphone-simulator"
         case Mac = "com.apple.mac"
-        case iPhone = "com.apple.iphone" //also includes iPad and iPod Touch
+        case iPhone = "com.apple.iphone"
     }
     
+    /**
+    Enum which describes identifiers of devices on which test should be run.
+    
+    - iOS_AllDevicesAndSimulators:      iOS default - for build only
+    - iOS_AllDevices:                   All iOS devices
+    - iOS_AllSimulators:                All iOS simulators
+    - iOS_SelectedDevicesAndSimulators: Manually selected devices/simulators
+    - Mac:                              Mac default (probably, crashes when saving in Xcode) - for build only
+    - AllCompatible:                    All Compatible (default) - for build only
+    */
     public enum TestingDestinationIdentifier : Int {
-        case iOS_AllDevicesAndSimulators = 0 //iOS default - for build only
+        case iOS_AllDevicesAndSimulators = 0
         case iOS_AllDevices = 1
         case iOS_AllSimulators = 2
         case iOS_SelectedDevicesAndSimulators = 3
-        case Mac = 7 //Mac default (probably, crashes when saving in Xcode) - for build only
-        case AllCompatible = 8 //All Compatible default - for build only
+        case Mac = 7
+        case AllCompatible = 8
         
         public func toString() -> String {
             switch self {
-            case .iOS_AllDevicesAndSimulators:
-                return "iOS: All Devices and Simulators"
-            case .iOS_AllDevices:
-                return "iOS: All Devices"
-            case .iOS_AllSimulators:
-                return "iOS: All Simulators"
-            case .iOS_SelectedDevicesAndSimulators:
-                return "iOS: Selected Devices and Simulators"
-            case .Mac:
-                return "Mac"
-            case .AllCompatible:
-                return "All Compatible (Mac + iOS)"
+                case .iOS_AllDevicesAndSimulators:
+                    return "iOS: All Devices and Simulators"
+                case .iOS_AllDevices:
+                    return "iOS: All Devices"
+                case .iOS_AllSimulators:
+                    return "iOS: All Simulators"
+                case .iOS_SelectedDevicesAndSimulators:
+                    return "iOS: Selected Devices and Simulators"
+                case .Mac:
+                    return "Mac"
+                case .AllCompatible:
+                    return "All Compatible (Mac + iOS)"
             }
         }
         
         public func allowedDeviceTypes() -> [DeviceType] {
             switch self {
-            case .iOS_AllDevicesAndSimulators:
-                return [.iPhone, .Simulator]
-            case .iOS_AllDevices:
-                return [.iPhone]
-            case .iOS_AllSimulators:
-                return [.Simulator]
-            case .iOS_SelectedDevicesAndSimulators:
-                return [.iPhone, .Simulator]
-            case .Mac:
-                return [.Mac]
-            case .AllCompatible:
-                return [.iPhone, .Simulator, .Mac]
+                case .iOS_AllDevicesAndSimulators:
+                    return [.iPhone, .Simulator]
+                case .iOS_AllDevices:
+                    return [.iPhone]
+                case .iOS_AllSimulators:
+                    return [.Simulator]
+                case .iOS_SelectedDevicesAndSimulators:
+                    return [.iPhone, .Simulator]
+                case .Mac:
+                    return [.Mac]
+                case .AllCompatible:
+                    return [.iPhone, .Simulator, .Mac]
             }
         }
     }
diff --git a/XcodeServerSDKTests/BotConfigurationTests.swift b/XcodeServerSDKTests/BotConfigurationTests.swift
@@ -0,0 +1,87 @@
+//
+//  BotConfigurationTests.swift
+//  XcodeServerSDK
+//
+//  Created by Mateusz Zając on 24.06.2015.
+//  Copyright © 2015 Honza Dvorsky. All rights reserved.
+//
+
+import XCTest
+import XcodeServerSDK
+
+class BotConfigurationTests: XCTestCase {
+
+    override func setUp() {
+        super.setUp()
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+    }
+    
+    override func tearDown() {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+        super.tearDown()
+    }
+
+    // MARK: Cleaning policy tests
+    func testCleaningPolicyToString() {
+        var policy: BotConfiguration.CleaningPolicy
+        
+        policy = .Never
+        XCTAssertEqual(policy.toString(), "Never")
+        
+        policy = .Always
+        XCTAssertEqual(policy.toString(), "Always")
+        
+        policy = .Once_a_Day
+        XCTAssertEqual(policy.toString(), "Once a day (first build)")
+        
+        policy = .Once_a_Week
+        XCTAssertEqual(policy.toString(), "Once a week (first build)")
+    }
+    
+    // MARK: Testing destination tests
+    func testTestingDestinationToString() {
+        var destination: BotConfiguration.TestingDestinationIdentifier
+        
+        destination = .iOS_AllDevicesAndSimulators
+        XCTAssertEqual(destination.toString(), "iOS: All Devices and Simulators")
+        
+        destination = .iOS_AllDevices
+        XCTAssertEqual(destination.toString(), "iOS: All Devices")
+        
+        destination = .iOS_AllSimulators
+        XCTAssertEqual(destination.toString(), "iOS: All Simulators")
+        
+        destination = .iOS_SelectedDevicesAndSimulators
+        XCTAssertEqual(destination.toString(), "iOS: Selected Devices and Simulators")
+        
+        destination = .Mac
+        XCTAssertEqual(destination.toString(), "Mac")
+        
+        destination = .AllCompatible
+        XCTAssertEqual(destination.toString(), "All Compatible (Mac + iOS)")
+    }
+    
+    func testAllowedDevicesTypes() {
+        let allCompatible = BotConfiguration.TestingDestinationIdentifier.AllCompatible
+        let selected = BotConfiguration.TestingDestinationIdentifier.iOS_SelectedDevicesAndSimulators
+        let allDevicesAndSimulators = BotConfiguration.TestingDestinationIdentifier.iOS_AllDevicesAndSimulators
+        let allDevices = BotConfiguration.TestingDestinationIdentifier.iOS_AllDevices
+        let allSimulators = BotConfiguration.TestingDestinationIdentifier.iOS_AllSimulators
+        let mac = BotConfiguration.TestingDestinationIdentifier.Mac
+        
+        let allCompatibleExpected: [BotConfiguration.DeviceType] = [.iPhone, .Simulator, .Mac]
+        let selectedExpected: [BotConfiguration.DeviceType] = [.iPhone, .Simulator]
+        let allDevicesAndSimulatorsExpected: [BotConfiguration.DeviceType] = [.iPhone, .Simulator]
+        let allDevicesExpected: [BotConfiguration.DeviceType] = [.iPhone]
+        let allSimulatorsExpected: [BotConfiguration.DeviceType] = [.Simulator]
+        let macExpected: [BotConfiguration.DeviceType] = [.Mac]
+        
+        XCTAssertEqual(allCompatible.allowedDeviceTypes(), allCompatibleExpected)
+        XCTAssertEqual(selected.allowedDeviceTypes(), selectedExpected)
+        XCTAssertEqual(allDevices.allowedDeviceTypes(), allDevicesExpected)
+        XCTAssertEqual(allSimulators.allowedDeviceTypes(), allSimulatorsExpected)
+        XCTAssertEqual(allDevicesAndSimulators.allowedDeviceTypes(), allDevicesAndSimulatorsExpected)
+        XCTAssertEqual(mac.allowedDeviceTypes(), macExpected)
+    }
+
+}
