Merge pull request #227 from pennlabs/development

Update 5.1.1

Author: joshdoman

AutomatedScreenshotUITests/AutomatedScreenshotUITests.swift

@@ -0,0 +1,93 @@
+//
+//  AutomatedScreenshotUITests.swift
+//  AutomatedScreenshotUITests
+//
+//  Created by Dominic Holmes on 2/23/19.
+//  Copyright © 2019 PennLabs. All rights reserved.
+//
+
+import XCTest
+import SimulatorStatusMagic
+
+class AutomatedScreenshotUITests: XCTestCase {
+    
+    let waitTime: Double = 5
+
+    override func setUp() {
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+
+        // In UI tests it is usually best to stop immediately when a failure occurs.
+        continueAfterFailure = false
+
+        // UI tests must launch the application that they test. Doing this in setup will make sure it happens for each test method.
+        //XCUIApplication().launch()
+
+        // In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this.
+        
+        // Fastlane Setup
+        let app = XCUIApplication()
+        app.launchArguments = ["FASTLANE"]
+        setupSnapshot(app)
+        app.launch()
+        
+        SDStatusBarManager.sharedInstance().carrierName = "AirPennNet"
+        SDStatusBarManager.sharedInstance().timeString = "9:41"
+        SDStatusBarManager.sharedInstance().bluetoothState = .hidden
+        SDStatusBarManager.sharedInstance().batteryDetailEnabled = false
+        SDStatusBarManager.sharedInstance().enableOverrides()
+    }
+
+    override func tearDown() {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+        SDStatusBarManager.sharedInstance().disableOverrides()
+    }
+
+    func testExample() {
+        // Use recording to get started writing UI tests.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+        
+        // Home
+        let app = XCUIApplication()
+        app.buttons["CONTINUE AS GUEST"].tap()
+        wait(for: 10.0)
+        snapshot("01Home", timeWaitingForIdle: waitTime)
+        
+        // Dining
+        let tabBarsQuery = app.tabBars
+        tabBarsQuery.children(matching: .other).element(boundBy: 1).tap()
+        snapshot("02Dining", waitForLoadingIndicator: true)
+        
+        // GSR
+        tabBarsQuery.otherElements["GSR - tab - 3 of 5"].tap()
+        // GSR takes a while, run with fast wifi to avoid loading indicators on the screenshots
+        wait(for: 10.0)
+        snapshot("03GSR", timeWaitingForIdle: waitTime)
+        
+        // Laundry
+        tabBarsQuery.otherElements["Laundry - tab - 4 of 5"].tap()
+        // Laundry takes a while, run with fast wifi to avoid loading indicators on the screenshots
+        
+        wait(for: 10.0)
+        snapshot("04Laundry", timeWaitingForIdle: waitTime)
+        
+        // More
+        tabBarsQuery.otherElements["More - tab - 5 of 5"].tap()
+        snapshot("05More", waitForLoadingIndicator: true)
+    }
+
+}
+
+extension XCTestCase {
+    
+    func wait(for duration: TimeInterval) {
+        let waitExpectation = expectation(description: "Waiting")
+        
+        let when = DispatchTime.now() + duration
+        DispatchQueue.main.asyncAfter(deadline: when) {
+            waitExpectation.fulfill()
+        }
+        
+        // We use a buffer here to avoid flakiness with Timer on CI
+        waitForExpectations(timeout: duration + 0.5)
+    }
+}

FastlaneUIAutomation/Info.plist AutomatedScreenshotUITests/Info.plistFastlaneUIAutomation/Info.plist renamed to AutomatedScreenshotUITests/Info.plist

@@ -18,8 +18,8 @@ import XCTest
 var deviceLanguage = ""
 var locale = ""
 
-func setupSnapshot(_ app: XCUIApplication) {
-    Snapshot.setupSnapshot(app)
+func setupSnapshot(_ app: XCUIApplication, waitForAnimations: Bool = true) {
+    Snapshot.setupSnapshot(app, waitForAnimations: waitForAnimations)
 }
 
 func snapshot(_ name: String, waitForLoadingIndicator: Bool) {
@@ -63,14 +63,16 @@ enum SnapshotError: Error, CustomDebugStringConvertible {
 @objcMembers
 open class Snapshot: NSObject {
     static var app: XCUIApplication?
+    static var waitForAnimations = true
     static var cacheDirectory: URL?
     static var screenshotsDirectory: URL? {
         return cacheDirectory?.appendingPathComponent("screenshots", isDirectory: true)
     }
 
-    open class func setupSnapshot(_ app: XCUIApplication) {
+    open class func setupSnapshot(_ app: XCUIApplication, waitForAnimations: Bool = true) {
 
         Snapshot.app = app
+        Snapshot.waitForAnimations = waitForAnimations
 
         do {
             let cacheDir = try pathPrefix()
@@ -153,7 +155,9 @@ open class Snapshot: NSObject {
 
         print("snapshot: \(name)") // more information about this, check out https://docs.fastlane.tools/actions/snapshot/#how-does-it-work
 
-        sleep(1) // Waiting for the animation to be finished (kind of)
+        if Snapshot.waitForAnimations {
+            sleep(1) // Waiting for the animation to be finished (kind of)
+        }
 
         #if os(OSX)
             guard let app = self.app else {
@@ -291,4 +295,4 @@ private extension CGFloat {
 
 // Please don't remove the lines below
 // They are used to detect outdated configuration files
-// SnapshotHelperVersion [1.14]
+// SnapshotHelperVersion [1.15]

FastlaneUIAutomation/SnapshotHelper.swift …edScreenshotUITests/SnapshotHelper.swiftFastlaneUIAutomation/SnapshotHelper.swift renamed to AutomatedScreenshotUITests/SnapshotHelper.swift FastlaneUIAutomation/SnapshotHelper.swift renamed to AutomatedScreenshotUITests/SnapshotHelper.swift

@@ -18,7 +18,7 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.7.2)
     emoji_regex (1.0.1)
-    excon (0.62.0)
+    excon (0.64.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday-cookie_jar (0.0.6)
@@ -27,7 +27,7 @@ GEM
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
     fastimage (2.1.5)
-    fastlane (2.119.0)
+    fastlane (2.121.1)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.3, < 3.0.0)
       babosa (>= 1.0.2, < 2.0.0)
@@ -105,7 +105,7 @@ GEM
     multipart-post (2.0.0)
     nanaimo (0.2.6)
     naturally (2.2.0)
-    os (1.0.0)
+    os (1.0.1)
     plist (3.5.0)
     public_suffix (2.0.5)
     representable (3.0.4)
@@ -135,7 +135,7 @@ GEM
     uber (0.1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
     unicode-display_width (1.5.0)
     word_wrap (1.0.0)
     xcodeproj (1.8.2)

FastlaneUIAutomation/FastlaneUIAutomation.swift

@@ -0,0 +1,65 @@
+# Using Fastlane
+Docs: [Setup - fastlane docs](https://docs.fastlane.tools/getting-started/ios/setup/)
+Contact **Dominic Holmes** with questions. Email:
+	* hello [at] dominic [dot] land
+
+### Lanes
+I made 3 lanes (specified in `fastlane/Fastfile`)
+1. **screenshots**
+	* this generates screenshots for all of the devices listed in `Snapfile`, by using the UITest target `AutomatedScreenshotUITests`
+2. **frame**
+	* this lane frames all screenshots in the`fastlane/screenshots/en-US/` folder with the configuration listed under **Framing Screenshots**
+3. **capture_and_frame**
+	* this lane is basically just lane 1 + lane 2. It captures all new screenshots and frames them — takes about 9 minutes on a fast Mac.
+
+### Getting started
+1. Make sure you’re on the `fastlane` branch and you have pulled all changes
+2. Run `pod install` and make sure the app launches normally
+3. Install fastlane by running `sudo gem install fastlane -NV`
+4. Run `sudo bundle update` & put in your password to make sure everything’s good
+5. We’re ready! Run fastlane with `bundle exec fastlane [lane]` or `bundle exec fastlane` to have all lanes shown
+6. You’ll need to follow the instructions under **Framing Screenshots** to get that lane to work.
+
+### Framing Screenshots
+The framing step will fail if you don’t have this set up.
+Complete instructions here: [Screenshots - fastlane docs](https://docs.fastlane.tools/getting-started/ios/screenshots/#put-your-screenshots-into-device-frames)
+
+1. Install imagemagick through homebrew: `brew install libpng jpeg imagemagick`
+2. I have framing installed in the lane already, but you may need to update the screenshot tags.
+	* For every screenshot that fastlane takes in, it gives it a tag like “01Dining”.  Change these in `AutomaticScreenshotUITests.swift`.
+	* That tag is then used in `Framefile.json` to set parameters for each frame (such as color).
+	* It is also used in `/screenshots/en-US/keyword.strings` and `/screenshots/en-US/title.strings` to define the titles and subtitles to go on the frame.
+	* Additionally, the frame uses `background.png`, although this can be customized and set individually in `Framefile.json`
+	* You can specify the devices in `Snapfile`
+    
+### Conditional Code
+I added a way for us to check if Fastlane is currently taking screenshots. This is needed for things like Laundry preferences -- we want to return real preferences when testing the app and in production -- but NOT when running the Fastlane UI automation. Otherwise, we would have to start up each simulator and select the same user preferences.
+
+You can check for conditional code anytime by calling `UIApplication.isRunningFastlaneTest`. This just checkings for a launch argument ("FASTLANE") I pass in at the beginning of the test.
+
+### Perfect Status Bar
+Last thing — I also installed PerfectStatusBar. It sets the time to be 9:41 and the battery to be full. The pod is only installed on the UITests target, so it doesn’t affect normal testing.
+
+### Errors
+1. Make sure fastlane is up to date (especially if there have been new iOS versions or Xcode versions) with `[sudo] bundle update fastlane`
+2. If you encounter:  _[!] Could not determine installed iOS SDK version. Try running the _xcodebuild_ command manually to ensure it works._
+	* Try running the following: `sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer`
+    3. If some of the screenshots have loading indicators, then you need to give each screen more time :( This makes the test take longer. Just increase the `waitTime` variable at the top of `AutomatedScreenshotUITests.swift`. This variable is in seconds.
+
+Generally — just follow whatever instructions Fastlane gives you, or google them if you’re unclear (they have great docs).
+
+### Running Time
+The following is the running time of screenshot capture + framing, in seconds, on a MBP 2018.
+
+```
++------+---------------------+-------------+
+|             fastlane summary             |
++------+---------------------+-------------+
+| Step | Action              | Time (in s) |
++------+---------------------+-------------+
+| 1    | update_fastlane     | 6           |
+| 2    | default_platform    | 0           |
+| 3    | capture_screenshots | 224         |
+| 4    | frameit             | 282         |
++------+---------------------+-------------+
+```