Merge pull request #2 from applidium/feature/display_application_logs

Feature/display application logs

Author: Jurollet

XCTestHTMLReport/XCTestHTMLReport/Classes/HTMLTemplates.swift

@@ -193,11 +193,17 @@ struct HTMLTemplates
       flex-direction: column;
     }
 
-    #logs-iframe {
+    #test-logs-iframe {
       border: 0;
       flex: 1;
     }
 
+    #app-logs-iframe {
+        display: none;
+        border: 0;
+        flex: 1;
+    }
+
     #design-review {
         display: none;
         background-color: #F2F2F2;
@@ -908,6 +914,18 @@ struct HTMLTemplates
         setDisplayToElementsWithSelector('#right-sidebar', 'none');
     }
 
+    function showTestLogs(el) {
+        selectedElement(el);
+        showElementsWithSelector('#test-logs-iframe');
+        hideElementsWithSelector('#app-logs-iframe');
+    }
+
+    function showApplicationLogs(el) {
+        selectedElement(el);
+        showElementsWithSelector('#app-logs-iframe');
+        hideElementsWithSelector('#test-logs-iframe');
+    }
+
     document.querySelectorAll('.device-info')[0].classList.add(\"selected\");
     document.querySelectorAll('.run')[0].classList.add(\"active\");
 
@@ -944,10 +962,12 @@ struct HTMLTemplates
     <div id=\"logs\">
       <div id=\"logs-header\">
         <ul class=\"toolbar toggle-toolbar\">
-          <li class=\"selected\">All Messages</li>
+          <li onclick=\"showTestLogs(this);\" class=\"selected\">Test Logs</li>
+          <li onclick=\"showApplicationLogs(this);\">App Logs</li>
         </ul>
       </div>
-      <iframe id=\"logs-iframe\" src=\"logs-[[DEVICE_IDENTIFIER]].txt\"></iframe>
+      <iframe id=\"test-logs-iframe\" src=\"test-logs-[[DEVICE_IDENTIFIER]].txt\"></iframe>
+      <iframe id=\"app-logs-iframe\" src=\"app-logs-[[DEVICE_IDENTIFIER]].txt\"></iframe>
     </div>
     <div id=\"design-review\">
         [[TEST_DESIGN_REVIEW]]

XCTestHTMLReport/XCTestHTMLReport/Classes/Models/Run.swift

@@ -126,12 +126,14 @@ struct Run: HTML
             let activityLogs = logs[start..<end]
 
             do {
-                let file = "\(result.values.first!)/logs-\(runDestination.targetDevice.uniqueIdentifier).txt"
+                let file = "\(result.values.first!)/test-logs-\(runDestination.targetDevice.uniqueIdentifier).txt"
                 try activityLogs.write(toFile: file, atomically: false, encoding: .utf8)
             }
             catch let e {
                 Logger.error("An error has occured while create the activity log file for \(root). Error: \(e)")
             }
+
+            generateApplicationLog(from: parentDirectory)
         }
     }
 
@@ -153,4 +155,42 @@ struct Run: HTML
         ]
     }
 
+    // MARK: - Private
+
+    private func generateApplicationLog(from parentDirectory: String) {
+        // The app log file we are looking for is at :
+        // ./Diagnostics/<targetName>-X/<targetName>-X/StandardOutputAndStandardError-<bundleId>
+        // where X is a random identifier
+        let path = parentDirectory + "/Diagnostics"
+
+        guard let appLogsPath = getPath(
+            from: path,
+            startingWith: "StandardOutputAndStandardError-"
+        ) else {
+            return
+        }
+
+        let appLogFile = "\(result.values.first!)/app-logs-\(runDestination.targetDevice.uniqueIdentifier).txt"
+        do {
+            let appLogs = try String(contentsOfFile: appLogsPath)
+            try appLogs.write(toFile: appLogFile, atomically: false, encoding: .utf8)
+        } catch let e {
+            Logger.error("An error has occured while create the application log file for \(path). Error: \(e)")
+        }
+    }
+
+    private func getPath(from parentPath: String, startingWith prefix: String) -> String? {
+        guard
+            let enumerator = FileManager.default.enumerator(atPath: parentPath),
+            var paths = enumerator.allObjects as? [String] else {
+                return nil
+        }
+        paths = paths.filter { $0.contains(prefix) }
+
+        guard paths.count == 1, let path = paths.first else {
+            Logger.error("Should corresponds to a single path")
+            return nil
+        }
+        return parentPath + "/" + path
+    }
 }

XCTestHTMLReport/XCTestHTMLReport/HTML/index.html

@@ -187,11 +187,17 @@
       flex-direction: column;
     }
 
-    #logs-iframe {
+    #test-logs-iframe {
       border: 0;
       flex: 1;
     }
 
+    #app-logs-iframe {
+        display: none;
+        border: 0;
+        flex: 1;
+    }
+
     #design-review {
         display: none;
         background-color: #F2F2F2;
@@ -902,6 +908,18 @@ <h2>No Selected Attachment</h2>
         setDisplayToElementsWithSelector('#right-sidebar', 'none');
     }
 
+    function showTestLogs(el) {
+        selectedElement(el);
+        showElementsWithSelector('#test-logs-iframe');
+        hideElementsWithSelector('#app-logs-iframe');
+    }
+
+    function showApplicationLogs(el) {
+        selectedElement(el);
+        showElementsWithSelector('#app-logs-iframe');
+        hideElementsWithSelector('#test-logs-iframe');
+    }
+
     document.querySelectorAll('.device-info')[0].classList.add("selected");
     document.querySelectorAll('.run')[0].classList.add("active");
 

XCTestHTMLReport/XCTestHTMLReport/HTML/run.html

@@ -16,10 +16,12 @@
     <div id="logs">
       <div id="logs-header">
         <ul class="toolbar toggle-toolbar">
-          <li class="selected">All Messages</li>
+          <li onclick="showTestLogs(this);" class="selected">Test Logs</li>
+          <li onclick="showApplicationLogs(this);">App Logs</li>
         </ul>
       </div>
-      <iframe id="logs-iframe" src="logs-[[DEVICE_IDENTIFIER]].txt"></iframe>
+      <iframe id="test-logs-iframe" src="test-logs-[[DEVICE_IDENTIFIER]].txt"></iframe>
+      <iframe id="app-logs-iframe" src="app-logs-[[DEVICE_IDENTIFIER]].txt"></iframe>
     </div>
     <div id="design-review">
         [[TEST_DESIGN_REVIEW]]