summaryrefslogtreecommitdiffstats
path: root/b2g/components/test/unit/test_logshake.js
blob: cfb81b8933c8b479d7a1b580b323467626320df1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/**
 * Test the log capturing capabilities of LogShake.jsm
 */

/* jshint moz: true */
/* global Components, LogCapture, LogShake, ok, add_test, run_next_test, dump */
/* exported run_test */

/* disable use strict warning */
/* jshint -W097 */
"use strict";

var Cu = Components.utils;

Cu.import("resource://gre/modules/LogCapture.jsm");
Cu.import("resource://gre/modules/LogShake.jsm");

const EVENTS_PER_SECOND = 6.25;
const GRAVITY = 9.8;

/**
 * Force logshake to handle a device motion event with given components.
 * Does not use SystemAppProxy because event needs special
 * accelerationIncludingGravity property.
 */
function sendDeviceMotionEvent(x, y, z) {
  let event = {
    type: "devicemotion",
    accelerationIncludingGravity: {
      x: x,
      y: y,
      z: z
    }
  };
  LogShake.handleEvent(event);
}

/**
 * Send a screen change event directly, does not use SystemAppProxy due to race
 * conditions.
 */
function sendScreenChangeEvent(screenEnabled) {
  let event = {
    type: "screenchange",
    detail: {
      screenEnabled: screenEnabled
    }
  };
  LogShake.handleEvent(event);
}

/**
 * Mock the readLogFile function of LogCapture.
 * Used to detect whether LogShake activates.
 * @return {Array<String>} Locations that LogShake tries to read
 */
function mockReadLogFile() {
  let readLocations = [];

  LogCapture.readLogFile = function(loc) {
    readLocations.push(loc);
    return null; // we don't want to provide invalid data to a parser
  };

  // Allow inspection of readLocations by caller
  return readLocations;
}

/**
 * Send a series of events that corresponds to a shake
 */
function sendSustainedShake() {
  // Fire a series of devicemotion events that are of shake magnitude
  for (let i = 0; i < 2 * EVENTS_PER_SECOND; i++) {
    sendDeviceMotionEvent(0, 2 * GRAVITY, 2 * GRAVITY);
  }

}

add_test(function test_do_log_capture_after_shaking() {
  // Enable LogShake
  LogShake.init();

  let readLocations = mockReadLogFile();

  sendSustainedShake();

  ok(readLocations.length > 0,
      "LogShake should attempt to read at least one log");

  LogShake.uninit();
  run_next_test();
});

add_test(function test_do_nothing_when_resting() {
  // Enable LogShake
  LogShake.init();

  let readLocations = mockReadLogFile();

  // Fire several devicemotion events that are relatively tiny
  for (let i = 0; i < 2 * EVENTS_PER_SECOND; i++) {
    sendDeviceMotionEvent(0, GRAVITY, GRAVITY);
  }

  ok(readLocations.length === 0,
      "LogShake should not read any logs");

  LogShake.uninit();
  run_next_test();
});

add_test(function test_do_nothing_when_disabled() {
  // Disable LogShake
  LogShake.uninit();

  let readLocations = mockReadLogFile();

  // Fire a series of events that would normally be a shake
  sendSustainedShake();

  ok(readLocations.length === 0,
      "LogShake should not read any logs");

  run_next_test();
});

add_test(function test_do_nothing_when_screen_off() {
  // Enable LogShake
  LogShake.init();

  // Send an event as if the screen has been turned off
  sendScreenChangeEvent(false);

  let readLocations = mockReadLogFile();

  // Fire a series of events that would normally be a shake
  sendSustainedShake();

  ok(readLocations.length === 0,
      "LogShake should not read any logs");

  // Restore the screen
  sendScreenChangeEvent(true);

  LogShake.uninit();
  run_next_test();
});

add_test(function test_do_log_capture_resilient_readLogFile() {
  // Enable LogShake
  LogShake.init();

  let readLocations = [];
  LogCapture.readLogFile = function(loc) {
    readLocations.push(loc);
    throw new Error("Exception during readLogFile for: " + loc);
  };

  // Fire a series of events that would normally be a shake
  sendSustainedShake();

  ok(readLocations.length > 0,
      "LogShake should attempt to read at least one log");

  LogShake.uninit();
  run_next_test();
});

add_test(function test_do_log_capture_resilient_parseLog() {
  // Enable LogShake
  LogShake.init();

  let readLocations = [];
  LogCapture.readLogFile = function(loc) {
    readLocations.push(loc);
    LogShake.LOGS_WITH_PARSERS[loc] = function() {
      throw new Error("Exception during LogParser for: " + loc);
    };
    return null;
  };

  // Fire a series of events that would normally be a shake
  sendSustainedShake();

  ok(readLocations.length > 0,
      "LogShake should attempt to read at least one log");

  LogShake.uninit();
  run_next_test();
});

add_test(function test_do_nothing_when_dropped() {
  // Enable LogShake
  LogShake.init();

  let readLocations = mockReadLogFile();

  // We want a series of spikes to be ignored by LogShake. This roughly
  // corresponds to the compare_stairs_sock graph on bug #1101994

  for (let i = 0; i < 10 * EVENTS_PER_SECOND; i++) {
    // Fire a devicemotion event that is at rest
    sendDeviceMotionEvent(0, 0, GRAVITY);
    // Fire a spike of motion
    sendDeviceMotionEvent(0, 2 * GRAVITY, 2 * GRAVITY);
  }

  ok(readLocations.length === 0,
      "LogShake should not read any logs");

  LogShake.uninit();
  run_next_test();
});

function run_test() {
  run_next_test();
}