The Tor Browser: toolkit/components/telemetry/tests/unit/test_TelemetryLateWrites.js@b8a032363ba2 (annotated)

toolkit/components/telemetry/tests/unit/test_TelemetryLateWrites.js@b8a032363ba2 (annotated)

toolkit/components/telemetry/tests/unit/test_TelemetryLateWrites.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* Any copyright is dedicated to the Public Domain.
    http://creativecommons.org/publicdomain/zero/1.0/
 */
 /* A testcase to make sure reading late writes stacks works.  */
 const Cc = Components.classes;
 const Ci = Components.interfaces;
 const Cu = Components.utils;
 const Cr = Components.results;
 Cu.import("resource://gre/modules/Services.jsm", this);
 const Telemetry = Cc["@mozilla.org/base/telemetry;1"].getService(Ci.nsITelemetry);
 // Constants from prio.h for nsIFileOutputStream.init
 const PR_WRONLY = 0x2;
 const PR_CREATE_FILE = 0x8;
 const PR_TRUNCATE = 0x20;
 const RW_OWNER = 0600;
 const STACK_SUFFIX1 = "stack1.txt";
 const STACK_SUFFIX2 = "stack2.txt";
 const STACK_BOGUS_SUFFIX = "bogus.txt";
 const LATE_WRITE_PREFIX = "Telemetry.LateWriteFinal-";
 // The names and IDs don't matter, but the format of the IDs does.
 const LOADED_MODULES = {
   '4759A7E6993548C89CAF716A67EC242D00': 'libtest.so',
   'F77AF15BB8D6419FA875954B4A3506CA00': 'libxul.so',
   '1E2F7FB590424E8F93D60BB88D66B8C500': 'libc.so'
 };
 const N_MODULES = Object.keys(LOADED_MODULES).length;
 // Format of individual items is [index, offset-in-library].
 const STACK1 = [
   [ 0, 0 ],
   [ 1, 1 ],
   [ 2, 2 ]
 ];
 const STACK2 = [
   [ 0, 0 ],
   [ 1, 5 ],
   [ 2, 10 ],
 ];
 // XXX The only error checking is for a zero-sized stack.
 const STACK_BOGUS = [];
 function write_string_to_file(file, contents) {
   let ostream = Cc["@mozilla.org/network/safe-file-output-stream;1"]
                 .createInstance(Ci.nsIFileOutputStream);
   ostream.init(file, PR_WRONLY | PR_CREATE_FILE | PR_TRUNCATE,
 	       RW_OWNER, ostream.DEFER_OPEN);
   ostream.write(contents, contents.length);
   ostream.QueryInterface(Ci.nsISafeOutputStream).finish();
   ostream.close();
 }
 function construct_file(suffix) {
   let profileDirectory = Services.dirsvc.get("ProfD", Ci.nsIFile);
   let file = profileDirectory.clone();
   file.append(LATE_WRITE_PREFIX + suffix);
   return file;
 }
 function write_late_writes_file(stack, suffix)
 {
   let file = construct_file(suffix);
   let contents = N_MODULES + "\n";
   for (let id in LOADED_MODULES) {
     contents += id + " " + LOADED_MODULES[id] + "\n";
   }
   contents += stack.length + "\n";
   for (let element of stack) {
     contents += element[0] + " " + element[1].toString(16) + "\n";
   }
   write_string_to_file(file, contents);
 }
 function run_test() {
   do_get_profile();
   write_late_writes_file(STACK1, STACK_SUFFIX1);
   write_late_writes_file(STACK2, STACK_SUFFIX2);
   write_late_writes_file(STACK_BOGUS, STACK_BOGUS_SUFFIX);
   let lateWrites = Telemetry.lateWrites;
   do_check_true("memoryMap" in lateWrites);
   do_check_eq(lateWrites.memoryMap.length, 0);
   do_check_true("stacks" in lateWrites);
   do_check_eq(lateWrites.stacks.length, 0);
   do_test_pending();
   Telemetry.asyncFetchTelemetryData(function () {
     actual_test();
   });
 }
 function actual_test() {
   do_check_false(construct_file(STACK_SUFFIX1).exists());
   do_check_false(construct_file(STACK_SUFFIX2).exists());
   do_check_false(construct_file(STACK_BOGUS_SUFFIX).exists());
   let lateWrites = Telemetry.lateWrites;
   do_check_true("memoryMap" in lateWrites);
   do_check_eq(lateWrites.memoryMap.length, N_MODULES);
   for (let id in LOADED_MODULES) {
     let matchingLibrary = lateWrites.memoryMap.filter(function(library, idx, array) {
                                                         return library[1] == id;
                                                       });
     do_check_eq(matchingLibrary.length, 1);
     let library = matchingLibrary[0]
     let name = library[0];
     do_check_eq(LOADED_MODULES[id], name);
   }
   do_check_true("stacks" in lateWrites);
   do_check_eq(lateWrites.stacks.length, 2);
   let uneval_STACKS = [uneval(STACK1), uneval(STACK2)];
   let first_stack = lateWrites.stacks[0];
   let second_stack = lateWrites.stacks[1];
   function stackChecker(canonicalStack) {
     let unevalCanonicalStack = uneval(canonicalStack);
     return function(obj, idx, array) {
       return unevalCanonicalStack == obj;
     }
   }
   do_check_eq(uneval_STACKS.filter(stackChecker(first_stack)).length, 1);
   do_check_eq(uneval_STACKS.filter(stackChecker(second_stack)).length, 1);
   do_test_finished();
 }