Regression

.gitignore

@@ -7,3 +7,7 @@
 /build
 /captures
 .externalNativeBuild
+.idea
+modified-key-92e6.json
+config.py
+__pycache__/

README.md

@@ -1,8 +1,21 @@
+
 # TrivialTrivia
 Remake of "trivial trivia" with native Android code and a truer implementation of Model-View-Presenter paradigm.
 
-## Installation
-Import into Android Studio, build and run. Alternatively, install the last stable version from the [Play Store](https://play.google.com/store/apps/details?id=com.avinashdavid.trivialtrivia)
+## Setup Instructions 
+
+   *  Install Android Studio 3.6 or later 
+
+   *  Clone the repository. In terminal or command prompt: git clone https://github.com/Carrie0302/TrivialTrivia.git 
+   *  In Android Studio, click “Open an existing Android Studio project” 
+   *  Navigate to the root of the cloned git repository 
+   *  Wait for Gradle Sync to sync the project and download dependencies 
+
+## Running the Unit Tests 
+
+  *  Navigate to the test class to be run (ex. OverallStatisticsCalculatorTest) 
+
+   * Click the green play button next to the test class or individual test method and select “Run with Coverage” to get code coverage metrics 
 
 ## Description
 This is a remake of my first published app, which was called "Trivial Trivia". On the Play Store, this version of the app can be found under the name "Trivial Trivia 2". 

RunTestSuite.py

@@ -0,0 +1,139 @@
+#!/usr/bin/env python3
+
+import subprocess, smtplib, ssl, sys, time
+from email.message import EmailMessage
+import re, config
+import random, datetime
+
+
+"""
+ RunTestSuite runs the unit tests in android studio a certain 
+ number of times and emails the results using gradle commands. 
+
+ Example of running this script:
+ $ python RunTestSuite.py 2 [email protected]
+"""
+
+def generateSummary(testResults, timeStart, timeEnd, i ):
+    elapsedTime = timeEnd - timeStart
+    outcome = "\nLoop " + str(i) + ": " + testResults +" Elapsed Time: " + str(round(elapsedTime, 2)) + "s\n"
+    return outcome
+
+
+def getTestResults(output):
+    if "BUILD SUCCESSFUL" not in str(output):
+        testResults = "\033[1;31;40m FAILED \x1b[0m"
+        result = "Some Tests Failed "
+    else:
+        testResults = "\033[1;32;40m PASSED \x1b[0m"
+        result = "All Tests Pass "
+    return result
+
+
+def runAndroidTest():
+    subprocess.call("gradlew build -x lint", shell=True)
+    cmdExe = "gradlew test"
+    process = subprocess.Popen(cmdExe, stdout=subprocess.PIPE, shell=True)
+    output = process.communicate()[0]
+    output = str(output)
+    return output
+
+def createEmail(testResults, resultFormat, fails, total ):
+    #version = random.randint(0, 500)
+    today = datetime.datetime.now()
+    email = "Subject: Trivial Trivia Test Summary - " + testResults  + today.strftime("%x") + " \n"
+    email += total + resultFormat + fails
+    return email
+
+
+def formatLoopOutput(loopNum, outputOrig, verbose):
+    countPass = 0
+    countFail = 0
+    output = outputOrig.replace('\\n', '\n')
+
+    allP = re.findall("PASSED", output)
+    for p in allP:
+        countPass+=1
+    allFails = re.findall("com.avinashdavid.trivialtrivia.*FAILED", output)
+    fails = set(allFails)
+    for f in allFails:
+        countFail+=1
+
+    totalUnitTests = countPass + countFail
+    result = "  UNIT TESTS: Passed = " + str(countPass) + " Failed = " + str(countFail) + " - Loop " + str(loopNum) + "\n"
+    if verbose:
+        print(output)
+        summary = ""
+        allS = re.findall("RUNNING.*result: SUCCESS", output)
+        for s in allS:
+            summary += s + "\n"
+        return summary +  result
+    return (result, fails, countPass, totalUnitTests)
+
+
+def runTestMultipleTimes( numLoop ):
+    overallResult = ""
+    avgTimeAndRuns = ""
+    totalTime = 0
+    for i in range(numLoop):
+        timeStart = time.time()
+        output = runAndroidTest()
+        resultFormat, fails, countPass, totalUnitTests = formatLoopOutput( i, output , False )
+        timeEnd = time.time()
+        testResults = getTestResults( output )
+        overallResult += "\n" + generateSummary(testResults, timeStart, timeEnd, i)
+        overallResult += resultFormat
+        avgTimeAndRuns = "\nIn Test Suite - Unit Tests (Passed {0} of {1})".format(countPass, totalUnitTests)
+        totalTime += (timeEnd - timeStart)
+    avgTime = totalTime / (i + 1)
+    avgTimeAndRuns += "\nThe Entire Suite was Run {0} times - Avg Time {1:.2f}".format( str(i+1), avgTime )
+    return [testResults, overallResult, fails, avgTimeAndRuns] 
+
+
+def formatFailure( fails ):
+    results = "\nFailures: \n"
+    uniqueFail = set()
+    for f in fails:
+        if f not in uniqueFail:
+            uniqueFail.add( f )
+            results += "   "  + f + "\n"
+    return results
+
+
+if __name__ == "__main__":
+    """
+    Can take up to 2 Command Line Arguments,  the number of times to run the entire
+    suite of tests from android and the email the report should be sent to.
+    """
+
+    if(len(sys.argv) == 3):
+        numLoop = int(sys.argv[1])
+        receiver_email = sys.argv[2]
+        sendEmail = True
+    elif(len(sys.argv) == 2):
+        numLoop = int(sys.argv[1])
+        sendEmail = False
+    else:
+        numLoop = 1
+        sendEmail = False
+
+    print( "\nTEST SUMMARY:\n")
+    testResults, overallResult, fails, avgTimeAndRuns = runTestMultipleTimes(numLoop)
+    uniqueFail = formatFailure( fails )
+    print( avgTimeAndRuns )
+    print( overallResult )
+    print( uniqueFail )
+
+    if sendEmail:
+        port = 465  # For SSL
+        smtp_server = "smtp.gmail.com"
+        sender_email =  config.sender
+        password = config.password
+
+        email = createEmail(testResults, overallResult, uniqueFail, avgTimeAndRuns)
+        context = ssl.create_default_context()
+
+        with smtplib.SMTP_SSL(smtp_server, port, context=context) as server:
+            server.login(sender_email, password)
+            server.sendmail(sender_email, receiver_email, email)
+            server.quit()

StressTestApp.sh

@@ -0,0 +1,43 @@
+#!/bin/zsh
+trap "exit" INT TERM
+trap "kill 0" EXIT
+
+if [ "$#" -ne 2 ]; then
+    echo "Usage: StressTestApp.sh <number of iterations> <number of background processes>"
+    exit -1
+fi
+
+NUM_ITERATIONS=$1
+NUM_BACKGROUND_PROCESSES=$2
+
+# Run once before to do any necessary compilation once
+echo "Pre-compiling tests"
+./RunTestSuite.py 1 > /dev/null 2>&1
+START_TIME=$(date)
+START_SECONDS=$SECONDS
+
+PID_ARRAY=()
+for ((i=0;i<$NUM_BACKGROUND_PROCESSES;i++))
+do
+    ./RunTestSuite.py $NUM_ITERATIONS > /dev/null 2>&1 &
+    PID_ARRAY+=($!)
+    echo "Started background process $((i+1)) with PID $!"
+done
+
+echo "Created ${#PID_ARRAY[@]} background processes"
+for PID in "${PID_ARRAY[@]}"
+do
+    echo "Waiting for background process with ID $PID"
+    wait $PID
+done
+
+COMPLETED_TIME=$(date)
+ELAPSED_SECONDS=$(($SECONDS - $START_SECONDS))
+
+echo "
+Finished executing stress test with parameters:
+Number of background processes: $NUM_BACKGROUND_PROCESSES
+Number of iterations: $NUM_ITERATIONS
+Start time: $START_TIME
+End time: $COMPLETED_TIME
+Elapsed seconds: $ELAPSED_SECONDS"