summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/news/test/unit/test_filter.js
blob: 9e450499e75c36fbd3d5d151c088dcf859980340 (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
// Tests for the filtering code of NNTP. The same tests are run for each of the
// different NNTP setups, to test code in a variety of cases.
//
// Different suites:
// * Perfect 3977 compliance (not tested)
// * Perfect 2980 compliance (XOVER and XHDR work)
// * Giganews compliance (XHDR doesn't work for practical purposes)
// * Only 977 compliance (no XOVER support)
// Basic operations:
// * Test that the following headers trigger:
//   - Subject
//   - From
//   - Date
//   - Size
//   - Message-ID (header retrievable by XOVER)
//   - User-Agent (header not retrievable by XHDR)
// * Test all actions

/* import-globals-from ../../../test/resources/filterTestUtils.js */
load("../../../resources/filterTestUtils.js");

// These are the expected results for testing filter triggers
var attribResults = {
  "1@regular.invalid": ["isRead", false],
  "2@regular.invalid": ["isRead", true],
  "3@regular.invalid": ["isRead", true],
  "4@regular.invalid": ["isRead", true],
  "5@regular.invalid": ["isRead", true],
  "6.odd@regular.invalid": ["isRead", true],
  "7@regular.invalid": ["isRead", true],
  "8.unread@regular.invalid": ["isRead", true],
};
function testAttrib(handler, daemon, localserver) {
  var server = makeServer(handler, daemon);
  server.setDebugLevel(fsDebugAll);
  server.start();
  localserver.port = server.port;

  // Get the folder and force filters to run
  var folder = localserver.rootFolder.getChildNamed("test.filter");
  folder.getNewMessages(null, {
    OnStopRunningUrl() {
      localserver.closeCachedConnections();
    },
  });
  server.performTest();

  var headers = [...folder.messages];

  try {
    Assert.equal(headers.length, 8);
    for (var header of headers) {
      var id = header.messageId;
      dump("Testing message " + id + "\n");
      Assert.equal(header[attribResults[id][0]], attribResults[id][1]);
    }
  } catch (e) {
    print(server.playTransaction().them);
    throw e;
  } finally {
    server.stop();
  }

  resetFolder(folder);
}

// These are the results for testing actual actions
var actionResults = {
  "1@regular.invalid": ["priority", 6],
  // "2@regular.invalid" should not be in database
  "3@regular.invalid": function (header, folder) {
    var flags = folder.msgDatabase.getThreadContainingMsgHdr(header).flags;
    var ignored = Ci.nsMsgMessageFlags.Ignored;
    // This is checking the thread's kill flag
    return (flags & ignored) == ignored;
  },
  "4@regular.invalid": function (header, folder) {
    var flags = folder.msgDatabase.getThreadContainingMsgHdr(header).flags;
    var watched = Ci.nsMsgMessageFlags.Watched;
    // This is checking the thread's watch flag
    return (flags & watched) == watched;
  },
  "5@regular.invalid": ["isFlagged", true],
  "6.odd@regular.invalid": ["isRead", false],
  "7@regular.invalid": function (header, folder) {
    return header.getStringProperty("keywords") == "tag";
  },
  "8.unread@regular.invalid": ["isRead", false],
};
function testAction(handler, daemon, localserver) {
  var server = makeServer(handler, daemon);
  server.start();
  localserver.port = server.port;

  // Get the folder and force filters to run
  var folder = localserver.rootFolder.getChildNamed("test.filter");
  folder.getNewMessages(null, {
    OnStopRunningUrl() {
      localserver.closeCachedConnections();
    },
  });
  server.performTest();

  let headers = [...folder.messages];

  try {
    Assert.equal(headers.length, 7);
    for (var header of headers) {
      var id = header.messageId;
      dump("Testing message " + id + "\n");
      if (actionResults[id] instanceof Array) {
        Assert.equal(header[actionResults[id][0]], actionResults[id][1]);
      } else {
        Assert.ok(actionResults[id](header, folder));
      }
    }
  } catch (e) {
    print(server.playTransaction().them);
    throw e;
  } finally {
    server.stop();
  }

  resetFolder(folder);
}

// These are the various server handlers
var handlers = [
  NNTP_RFC977_handler,
  NNTP_Giganews_handler,
  NNTP_RFC2980_handler,
];
function run_test() {
  // Set up the server and add in filters
  var daemon = setupNNTPDaemon();
  var localserver = setupLocalServer(NNTP_PORT);
  var serverFilters = localserver.getFilterList(null);

  createFilter(serverFilters, "subject", "Odd", "read");
  createFilter(serverFilters, "from", "Odd Person", "read");
  // A PRTime is the time in μs, but a JS date is time in ms.
  createFilter(serverFilters, "date", new Date(2000, 0, 1) * 1000, "read");
  createFilter(serverFilters, "size", 2, "read");
  createFilter(serverFilters, "message-id", "odd", "read");
  createFilter(serverFilters, "user-agent", "Odd/1.0", "read");
  createFilter(serverFilters, "message-id", "8.unread", "read");
  localserver.setFilterList(serverFilters);

  handlers.forEach(function (handler) {
    testAttrib(handler, daemon, localserver);
  });

  // Now we test folder-filters... and actions
  // Clear out the server filters
  while (serverFilters.filterCount > 0) {
    serverFilters.removeFilterAt(0);
  }
  localserver.setFilterList(serverFilters);

  var folder = localserver.rootFolder.getChildNamed("test.filter");
  var folderFilters = folder.getFilterList(null);
  createFilter(folderFilters, "subject", "First", "priority");
  createFilter(folderFilters, "subject", "Odd", "delete");
  createFilter(folderFilters, "from", "Odd Person", "kill");
  createFilter(folderFilters, "date", new Date(2000, 0, 1) * 1000, "watch");
  createFilter(folderFilters, "size", 2, "flag");
  createFilter(folderFilters, "message-id", "odd", "stop");
  // This shouldn't be hit, because of the previous filter
  createFilter(folderFilters, "message-id", "6.odd", "read");
  createFilter(folderFilters, "user-agent", "Odd/1.0", "tag");
  createFilter(folderFilters, "message-id", "8.unread", "read");
  createFilter(folderFilters, "message-id", "8.unread", "unread");
  folderFilters.loggingEnabled = true;
  folder.setFilterList(folderFilters);

  handlers.forEach(function (handler) {
    testAction(handler, daemon, localserver);
  });
}