Improve live tests (#9)

* Improve live testing and fix transaction consume * Remove unused @testable
omgnetwork · Feb 27, 2018 · d9156fb · d9156fb
1 parent 3a292ef
commit d9156fb
Show file tree

Hide file tree

Showing 19 changed files with 244 additions and 85 deletions.
diff --git a/OmiseGO.xcodeproj/project.pbxproj b/OmiseGO.xcodeproj/project.pbxproj
@@ -62,6 +62,8 @@
 		037032B61FBBE6B100DBCDDD /* OmiseGOError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 037032A11FBBE6B100DBCDDD /* OmiseGOError.swift */; };
 		037032B81FBBE6B100DBCDDD /* OMGRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 037032A31FBBE6B100DBCDDD /* OMGRequest.swift */; };
 		037032BC1FBBE7A300DBCDDD /* Tool.swift in Sources */ = {isa = PBXBuildFile; fileRef = 037032BB1FBBE7A300DBCDDD /* Tool.swift */; };
+		0370519E2040756F009FD899 /* secret.plist in Resources */ = {isa = PBXBuildFile; fileRef = 0370519D2040756F009FD899 /* secret.plist */; };
+		037051A020407D4A009FD899 /* TransactionRequestLiveTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0370519F20407D4A009FD899 /* TransactionRequestLiveTests.swift */; };
 		038A42561F8DE786001A00E0 /* UserFixtureTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 038A42551F8DE786001A00E0 /* UserFixtureTests.swift */; };
 		038CB3E5202AE93900E40715 /* QRTestHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 038CB3E4202AE93900E40715 /* QRTestHelper.swift */; };
 		038CB3E7202AF81900E40715 /* TransactionConsumeParams.swift in Sources */ = {isa = PBXBuildFile; fileRef = 038CB3E6202AF81900E40715 /* TransactionConsumeParams.swift */; };
@@ -155,6 +157,8 @@
 		037032A31FBBE6B100DBCDDD /* OMGRequest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = OMGRequest.swift; sourceTree = "<group>"; };
 		037032A41FBBE6B100DBCDDD /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		037032BB1FBBE7A300DBCDDD /* Tool.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Tool.swift; sourceTree = "<group>"; };
+		0370519D2040756F009FD899 /* secret.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = secret.plist; sourceTree = "<group>"; };
+		0370519F20407D4A009FD899 /* TransactionRequestLiveTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TransactionRequestLiveTests.swift; sourceTree = "<group>"; };
 		038A42551F8DE786001A00E0 /* UserFixtureTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserFixtureTests.swift; sourceTree = "<group>"; };
 		038CB3E4202AE93900E40715 /* QRTestHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QRTestHelper.swift; sourceTree = "<group>"; };
 		038CB3E6202AF81900E40715 /* TransactionConsumeParams.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TransactionConsumeParams.swift; sourceTree = "<group>"; };
@@ -279,6 +283,7 @@
 				03CEF4C01FB01CB5009B8CEB /* AuthenticationLiveTest.swift */,
 				033522311FB5A7D800BCBD11 /* SettingLiveTests.swift */,
 				03966281204005E8004E5640 /* TransactionLiveTests.swift */,
+				0370519F20407D4A009FD899 /* TransactionRequestLiveTests.swift */,
 			);
 			path = LiveTests;
 			sourceTree = "<group>";
@@ -397,6 +402,7 @@
 				030F573520341A2600F54296 /* APIEndpointTest.swift */,
 				03BCCCB91F8B311600F604DB /* Info.plist */,
 				031443001F8CAA68003DD5BE /* Models */,
+				0370519D2040756F009FD899 /* secret.plist */,
 			);
 			path = OmiseGOTests;
 			sourceTree = "<group>";
@@ -523,6 +529,7 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				0370519E2040756F009FD899 /* secret.plist in Resources */,
 				03F5C0111F8CB1F80079E073 /* Fixtures in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -631,6 +638,7 @@
 				0396628420400CE8004E5640 /* TransactionTest.swift in Sources */,
 				03FE644E2032AA7400345281 /* TransactionConsumeFixtureTests.swift in Sources */,
 				0334869E2036C7EC0013B37A /* StubGenerator.swift in Sources */,
+				037051A020407D4A009FD899 /* TransactionRequestLiveTests.swift in Sources */,
 				03F84C6A1FC28D5E00F21C7B /* UserTests.swift in Sources */,
 				031863FD1F8F678300D13862 /* SettingFixtureTests.swift in Sources */,
 				03F84C681FC2886700F21C7B /* BalanceTests.swift in Sources */,

diff --git a/OmiseGO.xcodeproj/xcshareddata/xcschemes/OmiseGO.xcscheme b/OmiseGO.xcodeproj/xcshareddata/xcschemes/OmiseGO.xcscheme
@@ -55,6 +55,11 @@
             value = "$(OMG_BASE_URL)"
             isEnabled = "YES">
          </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "OMG_MINTED_TOKEN_ID"
+            value = "$(OMG_MINTED_TOKEN_ID)"
+            isEnabled = "YES">
+         </EnvironmentVariable>
          <EnvironmentVariable
             key = "OMG_API_KEY"
             value = "$(OMG_API_KEY)"

diff --git a/OmiseGOTests/DecodeTests.swift b/OmiseGOTests/DecodeTests.swift
@@ -239,7 +239,7 @@ class DecodeTests: XCTestCase {
             let jsonData = try self.jsonData(withFileName: "transaction_request")
             let decodedData = try self.jsonDecoder.decode(TransactionRequest.self, from: jsonData)
             XCTAssertEqual(decodedData.id, "8eb0160e-1c96-481a-88e1-899399cc84dc")
-            XCTAssertEqual(decodedData.mintedTokenId, "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95")
+            XCTAssertEqual(decodedData.mintedToken.id, "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95")
             XCTAssertEqual(decodedData.amount, 1337)
             XCTAssertEqual(decodedData.address, "3b7f1c68-e3bd-4f8f-9916-4af19be95d00")
             XCTAssertEqual(decodedData.correlationId, "31009545-db10-4287-82f4-afb46d9741d8")

diff --git a/OmiseGOTests/EncodeTests.swift b/OmiseGOTests/EncodeTests.swift
@@ -124,42 +124,19 @@ class EncodeTests: XCTestCase {
         }
     }
 
-    func testTransactionRequestEncoding() {
-        do {
-            let transactionRequest = TransactionRequest(id: "0a8a4a98-794b-419e-b92d-514e83657e75",
-                                                        type: .receive,
-                                                        mintedTokenId: "BTC:5ee328ec-b9e2-46a5-88bb-c8b15ea6b3c1",
-                                                        amount: 1337,
-                                                        address: "3bfe0ff7-f43e-4ac6-bdf9-c4a290c40d0d",
-                                                        correlationId: "31009545-db10-4287-82f4-afb46d9741d8",
-                                                        status: .valid)
-            let encodedData = try JSONEncoder().encode(transactionRequest)
-            XCTAssertEqual(String(data: encodedData, encoding: .utf8)!, """
-                {
-                    "amount":1337,
-                    "id":"0a8a4a98-794b-419e-b92d-514e83657e75",
-                    "status":"valid",
-                    "token_id":"BTC:5ee328ec-b9e2-46a5-88bb-c8b15ea6b3c1",
-                    "type":"receive",
-                    "address":"3bfe0ff7-f43e-4ac6-bdf9-c4a290c40d0d"
-                }
-            """.uglifiedEncodedString())
-        } catch let thrownError {
-            XCTFail(thrownError.localizedDescription)
-        }
-    }
-
     func testTransactionConsumeParamsEncoding() {
         do {
-            let transactionRequest = TransactionRequest(id: "0a8a4a98-794b-419e-b92d-514e83657e75",
-                                                        type: .receive,
-                                                        mintedTokenId: "BTC:5ee328ec-b9e2-46a5-88bb-c8b15ea6b3c1",
-                                                        amount: 1337,
-                                                        address: "3bfe0ff7-f43e-4ac6-bdf9-c4a290c40d0d",
-                                                        correlationId: "31009545-db10-4287-82f4-afb46d9741d8",
-                                                        status: .valid)
+            let transactionRequest = TransactionRequest(
+                id: "0a8a4a98-794b-419e-b92d-514e83657e75",
+                type: .receive,
+                mintedToken: StubGenerator.mintedToken(id: "BTC:5ee328ec-b9e2-46a5-88bb-c8b15ea6b3c1"),
+                amount: 1337,
+                address: "3bfe0ff7-f43e-4ac6-bdf9-c4a290c40d0d",
+                correlationId: "31009545-db10-4287-82f4-afb46d9741d8",
+                status: .valid)
             let transactionConsumeParams = TransactionConsumeParams(transactionRequest: transactionRequest,
                                                                     address: "456",
+                                                                    mintedTokenId: "BTC:123",
                                                                     idempotencyToken: "123",
                                                                     correlationId: "321",
                                                                     metadata: [:])
@@ -169,6 +146,7 @@ class EncodeTests: XCTestCase {
                     "amount":1337,
                     "transaction_request_id":"0a8a4a98-794b-419e-b92d-514e83657e75",
                     "metadata":{},
+                    "token_id":"BTC:123",
                     "correlation_id":"321",
                     "address":"456"
                 }

diff --git a/OmiseGOTests/FixtureTests/Fixtures/fixture/me.create_transaction_request.json b/OmiseGOTests/FixtureTests/Fixtures/fixture/me.create_transaction_request.json
@@ -5,7 +5,13 @@
     "object": "transaction_request",
     "type": "receive",
     "id": "8eb0160e-1c96-481a-88e1-899399cc84dc",
-    "token_id": "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
+    "minted_token": {
+      "object": "minted_token",
+      "id": "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
+      "symbol": "BTC",
+      "name": "Bitcoin",
+      "subunit_to_unit": 100000
+    },
     "amount": 1337,
     "address": "3b7f1c68-e3bd-4f8f-9916-4af19be95d00",
     "correlation_id": "31009545-db10-4287-82f4-afb46d9741d8",

diff --git a/OmiseGOTests/FixtureTests/Fixtures/fixture/me.get_transaction_request.json b/OmiseGOTests/FixtureTests/Fixtures/fixture/me.get_transaction_request.json
@@ -5,7 +5,13 @@
     "object": "transaction_request",
     "type": "receive",
     "id": "8eb0160e-1c96-481a-88e1-899399cc84dc",
-    "token_id": "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
+    "minted_token": {
+      "object": "minted_token",
+      "id": "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
+      "symbol": "BTC",
+      "name": "Bitcoin",
+      "subunit_to_unit": 100000
+    },
     "amount": 1337,
     "address": "3b7f1c68-e3bd-4f8f-9916-4af19be95d00",
     "correlation_id": "31009545-db10-4287-82f4-afb46d9741d8",

diff --git a/OmiseGOTests/FixtureTests/Fixtures/objects/transaction_request.json b/OmiseGOTests/FixtureTests/Fixtures/objects/transaction_request.json
@@ -2,7 +2,13 @@
   "object": "transaction_request",
   "type": "receive",
   "id": "8eb0160e-1c96-481a-88e1-899399cc84dc",
-  "token_id": "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
+  "minted_token": {
+    "object": "minted_token",
+    "id": "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
+    "symbol": "BTC",
+    "name": "Bitcoin",
+    "subunit_to_unit": 100000
+  },
   "amount": 1337,
   "address": "3b7f1c68-e3bd-4f8f-9916-4af19be95d00",
   "correlation_id": "31009545-db10-4287-82f4-afb46d9741d8",

diff --git a/OmiseGOTests/FixtureTests/TransactionConsumeFixtureTests.swift b/OmiseGOTests/FixtureTests/TransactionConsumeFixtureTests.swift
@@ -17,14 +17,15 @@ class TransactionConsumeFixtureTests: FixtureTestCase {
         let transactionRequest = StubGenerator.transactionRequest(
                 id: "0a8a4a98-794b-419e-b92d-514e83657e75",
                 type: .receive,
-                mintedTokenId: "BTC:5ee328ec-b9e2-46a5-88bb-c8b15ea6b3c1",
+                mintedToken: StubGenerator.mintedToken(id: "BTC:5ee328ec-b9e2-46a5-88bb-c8b15ea6b3c1"),
                 amount: 1337,
                 address: "3bfe0ff7-f43e-4ac6-bdf9-c4a290c40d0d",
                 correlationId: "31009545-db10-4287-82f4-afb46d9741d8",
                 status: .valid)
         let params = TransactionConsumeParams(
                 transactionRequest: transactionRequest,
                 address: nil,
+                mintedTokenId: nil,
                 idempotencyToken: "123",
                 correlationId: nil,
                 metadata: [:])!

diff --git a/OmiseGOTests/FixtureTests/TransactionRequestFixtureTests.swift b/OmiseGOTests/FixtureTests/TransactionRequestFixtureTests.swift
@@ -26,7 +26,7 @@ class TransactionRequestFixtureTests: FixtureTestCase {
                 switch result {
                 case .success(data: let transactionRequest):
                     XCTAssertEqual(transactionRequest.id, "8eb0160e-1c96-481a-88e1-899399cc84dc")
-                    XCTAssertEqual(transactionRequest.mintedTokenId, "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95")
+                    XCTAssertEqual(transactionRequest.mintedToken.id, "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95")
                     XCTAssertEqual(transactionRequest.amount, 1337)
                     XCTAssertEqual(transactionRequest.address, "3b7f1c68-e3bd-4f8f-9916-4af19be95d00")
                     XCTAssertEqual(transactionRequest.correlationId, "31009545-db10-4287-82f4-afb46d9741d8")
@@ -49,7 +49,7 @@ class TransactionRequestFixtureTests: FixtureTestCase {
                     switch result {
                     case .success(data: let transactionRequest):
                         XCTAssertEqual(transactionRequest.id, "8eb0160e-1c96-481a-88e1-899399cc84dc")
-                        XCTAssertEqual(transactionRequest.mintedTokenId, "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95")
+                        XCTAssertEqual(transactionRequest.mintedToken.id, "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95")
                         XCTAssertEqual(transactionRequest.amount, 1337)
                         XCTAssertEqual(transactionRequest.address, "3b7f1c68-e3bd-4f8f-9916-4af19be95d00")
                         XCTAssertEqual(transactionRequest.correlationId, "31009545-db10-4287-82f4-afb46d9741d8")

diff --git a/OmiseGOTests/Helpers/StubGenerator.swift b/OmiseGOTests/Helpers/StubGenerator.swift
@@ -96,7 +96,7 @@ class StubGenerator {
     class func transactionRequest(
         id: String? = nil,
         type: TransactionRequestType? = nil,
-        mintedTokenId: String? = nil,
+        mintedToken: MintedToken? = nil,
         amount: Double? = nil,
         address: String? = nil,
         correlationId: String? = nil,
@@ -106,7 +106,7 @@ class StubGenerator {
             return TransactionRequest(
                 id: id ?? v.id,
                 type: type ?? v.type,
-                mintedTokenId: mintedTokenId ?? v.mintedTokenId,
+                mintedToken: mintedToken ?? v.mintedToken,
                 amount: amount ?? v.amount,
                 address: address ?? v.address,
                 correlationId: correlationId ?? v.correlationId,
@@ -174,13 +174,15 @@ class StubGenerator {
     class func transactionConsumeParams(
         transactionRequest: TransactionRequest? = StubGenerator.stub(forResource: "transaction_request"),
         address: String? = "3b7f1c68-e3bd-4f8f-9916-4af19be95d00",
+        mintedTokenId: String? = "BTC:861020af-17b6-49ee-a0cb-661a4d2d1f95",
         amount: Double? = 1337,
         idempotencyToken: String? = "7a0ad55f-2084-4457-b871-1413142cde84",
         correlationId: String? = "45a5bce3-4e9d-4244-b3a9-64b7a4c5bdc4",
         metadata: [String: Any]? = [:]) -> TransactionConsumeParams {
             return TransactionConsumeParams(
                 transactionRequest: transactionRequest!,
                 address: address!,
+                mintedTokenId: mintedTokenId!,
                 amount: amount!,
                 idempotencyToken: idempotencyToken!,
                 correlationId: correlationId!,

diff --git a/OmiseGOTests/LiveTestCase.swift b/OmiseGOTests/LiveTestCase.swift
@@ -5,19 +5,23 @@
 //  Created by Mederic Petit on 18/10/2017 BE.
 //  Copyright © 2017 OmiseGO. All rights reserved.
 //
+// swiftlint:disable identifier_name
 
 import Foundation
 import XCTest
 import OmiseGO
 
 class LiveTestCase: XCTestCase {
 
-    /// Replace with yours!
-    var validBaseURL = ""
-    /// Replace with yours!
-    var validAPIKey = ""
-    /// Replace with yours!
-    var validAuthenticationToken = ""
+    private static let BASE_URL = "OMG_BASE_URL"
+    private static let OMG_API_KEY = "OMG_API_KEY"
+    private static let OMG_AUTHENTICATION_TOKEN = "OMG_AUTHENTICATION_TOKEN"
+    private static let OMG_MINTED_TOKEN_ID = "OMG_MINTED_TOKEN_ID"
+
+    var validBaseURL: String = ""
+    var validAPIKey: String = ""
+    var validAuthenticationToken: String = ""
+    var validMintedTokenId: String = ""
 
     let invalidBaseURL = "an invalid base url"
     let invalidAPIKey = "an invalid api key"
@@ -28,7 +32,10 @@ class LiveTestCase: XCTestCase {
         self.continueAfterFailure = false
         self.loadEnvKeys()
         if !self.areKeysValid() {
-            XCTFail("Replace base url, authentication token and API Key at the top of this file!")
+            XCTFail("""
+                Missing values for required constants.
+                Replace the in secret.plist or pass them as environment variables.
+            """)
         }
         self.testClient = OMGClient(config: self.validConfig())
     }
@@ -42,7 +49,11 @@ class LiveTestCase: XCTestCase {
     }
 
     func areKeysValid() -> Bool {
-        return !(self.validBaseURL == "" || self.validAPIKey == "" || self.validAuthenticationToken == "")
+        return
+            self.validBaseURL != ""
+            && self.validAPIKey != ""
+            && self.validAuthenticationToken != ""
+            && self.validMintedTokenId != ""
     }
 
     /// This function loads the keys from the environment variables,
@@ -54,14 +65,35 @@ class LiveTestCase: XCTestCase {
     /// OMG_BASE_URL="https://some.base.url" \
     /// OMG_API_KEY="someKey" \
     /// OMG_AUTHENTICATION_TOKEN="someToken" \
+    /// OMG_MINTED_TOKEN_ID="someMintedTokenId" \
     /// test
     private func loadEnvKeys() {
-        self.validBaseURL = self.validBaseURL != "" ? self.validBaseURL :
-            ProcessInfo.processInfo.environment["OMG_BASE_URL"]!
-        self.validAPIKey = self.validAPIKey != "" ? self.validAPIKey :
-            ProcessInfo.processInfo.environment["OMG_API_KEY"]!
-        self.validAuthenticationToken = self.validAuthenticationToken != "" ? self.validAuthenticationToken :
-            ProcessInfo.processInfo.environment["OMG_AUTHENTICATION_TOKEN"]!
+        let plistSecrets = self.loadSecretPlistFile()
+        self.validBaseURL =
+            plistSecrets?[LiveTestCase.BASE_URL] != nil &&
+            plistSecrets![LiveTestCase.BASE_URL] != "" ?
+            plistSecrets![LiveTestCase.BASE_URL]! :
+            ProcessInfo.processInfo.environment[LiveTestCase.BASE_URL]!
+        self.validAPIKey =
+            plistSecrets?[LiveTestCase.OMG_API_KEY] != nil &&
+            plistSecrets![LiveTestCase.OMG_API_KEY] != "" ?
+            plistSecrets![LiveTestCase.OMG_API_KEY]! :
+            ProcessInfo.processInfo.environment[LiveTestCase.OMG_API_KEY]!
+        self.validAuthenticationToken =
+            plistSecrets?[LiveTestCase.OMG_AUTHENTICATION_TOKEN] != nil &&
+            plistSecrets![LiveTestCase.OMG_AUTHENTICATION_TOKEN] != "" ?
+            plistSecrets![LiveTestCase.OMG_AUTHENTICATION_TOKEN]! :
+            ProcessInfo.processInfo.environment[LiveTestCase.OMG_AUTHENTICATION_TOKEN]!
+        self.validMintedTokenId =
+            plistSecrets?[LiveTestCase.OMG_MINTED_TOKEN_ID] != nil &&
+            plistSecrets![LiveTestCase.OMG_MINTED_TOKEN_ID] != "" ?
+            plistSecrets![LiveTestCase.OMG_MINTED_TOKEN_ID]! :
+            ProcessInfo.processInfo.environment[LiveTestCase.OMG_MINTED_TOKEN_ID]!
+    }
+
+    private func loadSecretPlistFile() -> [String: String]? {
+        guard let path = Bundle(for: LiveTestCase.self).path(forResource: "secret", ofType: "plist") else { return nil }
+        return NSDictionary(contentsOfFile: path) as? [String: String]
     }
 
 }