/*
2013 Measuring Broadband America Program
Mobile Measurement Android Application
Copyright (C) 2012 SamKnows Ltd.
The FCC Measuring Broadband America (MBA) Program's Mobile Measurement Effort developed in cooperation with SamKnows Ltd. and diverse stakeholders employs an client-server based anonymized data collection approach to gather broadband performance data in an open and transparent manner with the highest commitment to protecting participants privacy. All data collected is thoroughly analyzed and processed prior to public release to ensure that subscribers’ privacy interests are protected.
Data related to the radio characteristics of the handset, information about the handset type and operating system (OS) version, the GPS coordinates available from the handset at the time each test is run, the date and time of the observation, and the results of active test results are recorded on the handset in JSON(JavaScript Object Notation) nested data elements within flat files. These JSON files are then transmitted to storage servers at periodic intervals after the completion of active test measurements.
This Android application source code is made available under the GNU GPL2 for testing purposes only and intended for participants in the SamKnows/FCC Measuring Broadband American program. It is not intended for general release and this repository may be disabled at any time.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package com.samknows.measurement;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
import org.json.JSONException;
import org.json.JSONObject;
import com.samknows.measurement.net.SubmitTestResultsAction;
import com.samknows.measurement.net.SubmitTestResultsAnonymousAction;
import com.samknows.measurement.schedule.ScheduleConfig;
import com.samknows.measurement.schedule.TestDescription;
import com.samknows.measurement.schedule.datacollection.BaseDataCollector;
import com.samknows.measurement.storage.DBHelper;
import com.samknows.measurement.storage.PassiveMetric;
import com.samknows.measurement.storage.TestBatch;
import com.samknows.measurement.storage.TestResult;
import com.samknows.measurement.test.TestContext;
import com.samknows.measurement.test.TestExecutor;
import com.samknows.measurement.util.OtherUtils;
import com.samknows.tests.TestFactory;
import android.content.Context;
import android.os.Handler;
import android.os.Message;
/*
* This class is used to run the the tests when they are executed manually
* implements a runnable interface and and uses an Handler in order to publish
* the tests results to the interface
*/
public class ManualTest implements Runnable {
public static final String JSON_MANUAL_TEST = "manual_test";
private Handler mHandler;
private List<TestDescription> mTestDescription;
private Context ctx;
private AtomicBoolean run = new AtomicBoolean(true);
public static boolean isExecuting = false;
ManualTest(Context ctx, Handler handler, List<TestDescription> td) {
mHandler = handler;
mTestDescription = td;
this.ctx = ctx;
}
/*
* Returns a ManualTest object that runs only the test with id test_id
*/
public static ManualTest create(Context ctx, Handler handler, int test_id) {
ManualTest ret = create(ctx, handler);
if (ret == null) {
return ret;
}
for (TestDescription td : ret.mTestDescription) {
if (td.testId == test_id) {
ret.mTestDescription = new ArrayList<TestDescription>();
ret.mTestDescription.add(td);
return ret;
}
}
Logger.e(ManualTest.class,
"ManualTest cannot be initialized because there is no manual test with id: "
+ test_id);
return null;
}
/*
* Returns a ManualTest object if the manual_tests list of the schedule
* config is not empty and the MainService is not executing
*/
public static ManualTest create(Context ctx, Handler handler) {
ManualTest ret = null;
Storage storage = CachingStorage.getInstance();
ScheduleConfig config = storage.loadScheduleConfig();
if (config == null) {
Logger.e(
ManualTest.class,
"ManualTest cannot be initialized because storage does not contain the ScheduleConfig");
} else if (config.manual_tests.size() == 0) {
Logger.e(
ManualTest.class,
"ManualTest cannot be initialized because manual test section in the config file is empty");
} else if (MainService.isExecuting()) {
Logger.e(ManualTest.class,
"ManualTest cannot be initialized because MainService is executing");
} else {
ret = new ManualTest(ctx, handler, config.manual_tests);
}
return ret;
}
// returns the maximum amount of bytes used by the manual test
public long getNetUsage() {
long ret = 0;
for (TestDescription td : mTestDescription) {
ret += td.maxUsageBytes;
}
return ret;
}
/*
* Runs all the test in manual tests
*/
@Override
public void run() {
isExecuting = true;
// Start collectors for the passive metrics
// Start tests
long startTime = System.currentTimeMillis();
JSONObject batch = new JSONObject();
TestContext tc = TestContext.create(ctx);
TestExecutor te = new TestExecutor(tc);
List<JSONObject> testsResults = new ArrayList<JSONObject>();
List<JSONObject> passiveMetrics = new ArrayList<JSONObject>();
te.startInBackGround();
Message msg;
long testsBytes = 0;
for (TestDescription td : mTestDescription) {
// check if a stop command has been received
if (!run.get()) {
Logger.d(this, "Manual test interrupted by the user.");
break;
}
com.samknows.measurement.test.TestResult tr = new com.samknows.measurement.test.TestResult();
ObservableExecutor oe = new ObservableExecutor(te, td, tr);
Thread t = new Thread(oe);
t.start();
while (true) {
try {
t.join(100);
if (!t.isAlive())
break;
} catch (InterruptedException ie) {
Logger.e(this, ie.getMessage());
}
for (JSONObject pm : progressMessage(td, te)) {
msg = new Message();
msg.obj = pm;
mHandler.sendMessage(msg);
}
}
testsBytes += te.getLastTestByte();
List<JSONObject> currResults = new ArrayList<JSONObject>();
for (String out : tr.results) {
currResults.addAll(TestResult.testOutput(out));
}
for (JSONObject cr : currResults) {
// publish results
msg = new Message();
msg.obj = cr;
mHandler.sendMessage(msg);
}
testsResults.addAll(currResults);
}
Logger.d(this, "bytes used by the tests: " + testsBytes);
AppSettings.getInstance().appendUsedBytes(testsBytes);
// stops collectors
te.stop();
te.save(JSON_MANUAL_TEST);
// Gather data from collectors
for (BaseDataCollector collector : tc.config.dataCollectors) {
if (collector.isEnabled) {
for (JSONObject o : collector.getPassiveMetric()) {
// update interface
msg = new Message();
msg.obj = PassiveMetric.passiveMetricToCurrentTest(o);
mHandler.sendMessage(msg);
// save metric
passiveMetrics.add(o);
}
}
}
// insert batch in the database
try {
batch.put(TestBatch.JSON_DTIME, startTime);
batch.put(TestBatch.JSON_RUNMANUALLY, "1");
} catch (JSONException je) {
Logger.e(this,
"Error in creating test batch object: " + je.getMessage());
}
// insert the results in the database only if we didn't receive a stop
// command
if (run.get()) {
DBHelper db = new DBHelper(ctx);
db.insertTestBatch(batch, testsResults, passiveMetrics);
}
// Send completed message to the interface
msg = new Message();
JSONObject jtc = new JSONObject();
try {
Thread.sleep(1000);
jtc.put(TestResult.JSON_TYPE_ID, "completed");
msg.obj = jtc;
} catch (JSONException je) {
Logger.e(this, "Error in creating json object: " + je.getMessage());
} catch (InterruptedException e) {
Logger.e(
this,
"Sleep interrupted in the manual test view: "
+ e.getMessage());
}
mHandler.sendMessage(msg);
try {
// Submitting test results
if (AppSettings.getInstance().anonymous) {
new SubmitTestResultsAnonymousAction(ctx).execute();
} else {
new SubmitTestResultsAction(ctx).execute();
}
} catch (Throwable t) {
Logger.e(this, "Submit result. ", t);
}
Logger.d(this, "Exiting manual test");
isExecuting = false;
}
private class ObservableExecutor implements Runnable {
public TestExecutor te;
TestDescription td;
com.samknows.measurement.test.TestResult tr;
public ObservableExecutor(TestExecutor te, TestDescription td,
com.samknows.measurement.test.TestResult tr) {
this.te = te;
this.td = td;
this.tr = tr;
}
@Override
public void run() {
te.executeTest(td, tr);
}
}
static private List<JSONObject> progressMessage(TestDescription td,
TestExecutor te) {
List<JSONObject> ret = new ArrayList<JSONObject>();
List<String> tests = new ArrayList<String>();
if (td.type.equals(TestFactory.DOWNSTREAMTHROUGHPUT)) {
tests.add("" + TestResult.DOWNLOAD_TEST_ID);
} else if (td.type.equals(TestFactory.UPSTREAMTHROUGHPUT)) {
tests.add("" + TestResult.UPLOAD_TEST_ID);
} else if (td.type.equals(TestFactory.LATENCY)) {
tests.add("" + TestResult.LATENCY_TEST_ID);
tests.add("" + TestResult.PACKETLOSS_TEST_ID);
tests.add("" + TestResult.JITTER_TEST_ID);
}
try {
for (String t : tests) {
JSONObject c = new JSONObject();
c.put(TestResult.JSON_TYPE_ID, "test");
c.put(TestResult.JSON_TESTNUMBER, t);
c.put(TestResult.JSON_STATUS_COMPLETE, te.getProgress());
c.put(TestResult.JSON_HRRESULT, "");
ret.add(c);
}
} catch (JSONException je) {
Logger.e(
ManualTest.class,
"Error in creating JSON progress object: "
+ je.getMessage());
}
return ret;
}
// It stops the test from being executed
public void stop() {
run.set(false);
}
}