summaryrefslogtreecommitdiffstats
path: root/browser/modules/test/unit/test_FirefoxBridgeExtensionUtilsNativeManifest.js
blob: cef550d705ba805c17e80f7fa743194c5b83056b (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
219
220
221
222
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

const { AppConstants } = ChromeUtils.importESModule(
  "resource://gre/modules/AppConstants.sys.mjs"
);
const { FileUtils } = ChromeUtils.importESModule(
  "resource://gre/modules/FileUtils.sys.mjs"
);
const { FirefoxBridgeExtensionUtils } = ChromeUtils.importESModule(
  "resource:///modules/FirefoxBridgeExtensionUtils.sys.mjs"
);

const DUAL_BROWSER_EXTENSION_ORIGIN = ["chrome-extension://fake-origin/"];
const NATIVE_MESSAGING_HOST_ID = "org.mozilla.firefox_bridge_test";

let dir = FileUtils.getDir("TmpD", ["NativeMessagingHostsTest"]);
dir.createUnique(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);

let userDir = dir.clone();
userDir.append("user");
userDir.create(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);

let appDir = dir.clone();
appDir.append("app");
appDir.create(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);

let dirProvider = {
  getFile(property) {
    if (property == "Home") {
      return userDir.clone();
    } else if (property == "AppData") {
      return appDir.clone();
    }
    return null;
  },
};

try {
  Services.dirsvc.undefine("Home");
} catch (e) {}
try {
  Services.dirsvc.undefine("AppData");
} catch (e) {}
Services.dirsvc.registerProvider(dirProvider);

registerCleanupFunction(() => {
  Services.dirsvc.unregisterProvider(dirProvider);
  dir.remove(true);
});

const USER_TEST_PATH = PathUtils.join(userDir.path, "manifestDir");

let binFile = null;
add_setup(async function () {
  binFile = Services.dirsvc.get("XREExeF", Ci.nsIFile).parent.clone();
  if (AppConstants.platform == "win") {
    binFile.append("nmhproxy.exe");
  } else if (AppConstants.platform == "macosx") {
    binFile.append("nmhproxy");
  } else {
    throw new Error("Unsupported platform");
  }
});

function getExpectedOutput() {
  return {
    name: NATIVE_MESSAGING_HOST_ID,
    description: "Firefox Native Messaging Host",
    path: binFile.path,
    type: "stdio",
    allowed_origins: DUAL_BROWSER_EXTENSION_ORIGIN,
  };
}

add_task(async function test_maybeWriteManifestFiles() {
  await FirefoxBridgeExtensionUtils.maybeWriteManifestFiles(
    USER_TEST_PATH,
    NATIVE_MESSAGING_HOST_ID,
    DUAL_BROWSER_EXTENSION_ORIGIN
  );
  let expectedOutput = JSON.stringify(getExpectedOutput());
  let nmhManifestFilePath = PathUtils.join(
    USER_TEST_PATH,
    `${NATIVE_MESSAGING_HOST_ID}.json`
  );
  let nmhManifestFileContent = await IOUtils.readUTF8(nmhManifestFilePath);
  await IOUtils.remove(nmhManifestFilePath);
  Assert.equal(nmhManifestFileContent, expectedOutput);
});

add_task(async function test_maybeWriteManifestFilesIncorrect() {
  let nmhManifestFile = await IOUtils.getFile(
    USER_TEST_PATH,
    `${NATIVE_MESSAGING_HOST_ID}.json`
  );

  let incorrectInput = {
    name: NATIVE_MESSAGING_HOST_ID,
    description: "Manifest with unexpected description",
    path: binFile.path,
    type: "stdio",
    allowed_origins: DUAL_BROWSER_EXTENSION_ORIGIN,
  };
  await IOUtils.writeJSON(nmhManifestFile.path, incorrectInput);

  // Write correct JSON to the file and check to make sure it matches
  // the expected output
  await FirefoxBridgeExtensionUtils.maybeWriteManifestFiles(
    USER_TEST_PATH,
    NATIVE_MESSAGING_HOST_ID,
    DUAL_BROWSER_EXTENSION_ORIGIN
  );
  let expectedOutput = JSON.stringify(getExpectedOutput());

  let nmhManifestFilePath = PathUtils.join(
    USER_TEST_PATH,
    `${NATIVE_MESSAGING_HOST_ID}.json`
  );
  let nmhManifestFileContent = await IOUtils.readUTF8(nmhManifestFilePath);
  await IOUtils.remove(nmhManifestFilePath);
  Assert.equal(nmhManifestFileContent, expectedOutput);
});

add_task(async function test_maybeWriteManifestFilesAlreadyExists() {
  // Write file and confirm it exists
  await FirefoxBridgeExtensionUtils.maybeWriteManifestFiles(
    USER_TEST_PATH,
    NATIVE_MESSAGING_HOST_ID,
    DUAL_BROWSER_EXTENSION_ORIGIN
  );
  let nmhManifestFile = await IOUtils.getFile(
    USER_TEST_PATH,
    `${NATIVE_MESSAGING_HOST_ID}.json`
  );

  // Modify file modificatiomn time to be older than the write time
  let oldModificationTime = Date.now() - 1000000;
  let setModificationTime = await IOUtils.setModificationTime(
    nmhManifestFile.path,
    oldModificationTime
  );
  Assert.equal(oldModificationTime, setModificationTime);

  // Call function which writes correct JSON to the file and make sure
  // the modification time is the same, meaning we haven't written anything
  await FirefoxBridgeExtensionUtils.maybeWriteManifestFiles(
    USER_TEST_PATH,
    NATIVE_MESSAGING_HOST_ID,
    DUAL_BROWSER_EXTENSION_ORIGIN
  );
  let stat = await IOUtils.stat(nmhManifestFile.path);
  await IOUtils.remove(nmhManifestFile.path);
  Assert.equal(stat.lastModified, oldModificationTime);
});

add_task(async function test_maybeWriteManifestFilesDirDoesNotExist() {
  let testDir = dir.clone();
  // This folder does not exist, so we want to make sure it's created
  testDir.append("dirDoesNotExist");
  await FirefoxBridgeExtensionUtils.maybeWriteManifestFiles(
    testDir.path,
    NATIVE_MESSAGING_HOST_ID,
    DUAL_BROWSER_EXTENSION_ORIGIN
  );

  ok(await IOUtils.exists(testDir.path));
  ok(
    await IOUtils.exists(
      PathUtils.join(testDir.path, `${NATIVE_MESSAGING_HOST_ID}.json`)
    )
  );
  await IOUtils.remove(testDir.path, { recursive: true });
});

add_task(async function test_ensureRegistered() {
  let expectedJSONDirPath = null;
  let nativeHostId = "org.mozilla.firefox_bridge_nmh";
  if (AppConstants.NIGHTLY_BUILD) {
    nativeHostId = "org.mozilla.firefox_bridge_nmh_nightly";
  } else if (AppConstants.MOZ_DEV_EDITION) {
    nativeHostId = "org.mozilla.firefox_bridge_nmh_dev";
  } else if (AppConstants.IS_ESR) {
    nativeHostId = "org.mozilla.firefox_bridge_nmh_esr";
  }

  if (AppConstants.platform == "macosx") {
    expectedJSONDirPath = PathUtils.joinRelative(
      userDir.path,
      "Library/Application Support/Google/Chrome/NativeMessagingHosts/"
    );
  } else if (AppConstants.platform == "win") {
    expectedJSONDirPath = PathUtils.joinRelative(
      appDir.path,
      "Mozilla\\Firefox"
    );
  } else {
    throw new Error("Unsupported platform");
  }

  ok(!(await IOUtils.exists(expectedJSONDirPath)));
  let expectedJSONPath = PathUtils.join(
    expectedJSONDirPath,
    `${nativeHostId}.json`
  );

  await FirefoxBridgeExtensionUtils.ensureRegistered();
  let realOutput = {
    name: nativeHostId,
    description: "Firefox Native Messaging Host",
    path: binFile.path,
    type: "stdio",
    allowed_origins: FirefoxBridgeExtensionUtils.getExtensionOrigins(),
  };

  let expectedOutput = JSON.stringify(realOutput);
  let JSONContent = await IOUtils.readUTF8(expectedJSONPath);
  await IOUtils.remove(expectedJSONPath);
  Assert.equal(JSONContent, expectedOutput);
});