summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/tests/use-chromeutils-import.js
blob: f9aea6566a43324f3b6176710ae6e1835a48bafc (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
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------

var rule = require("../lib/rules/use-chromeutils-import");
var RuleTester = require("eslint").RuleTester;

const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: "latest" } });

// ------------------------------------------------------------------------------
// Tests
// ------------------------------------------------------------------------------

function callError(message) {
  return [{ message, type: "CallExpression" }];
}

const MESSAGE_IMPORT = "Please use ChromeUtils.import instead of Cu.import";
const MESSAGE_DEFINE =
  "Please use ChromeUtils.defineModuleGetter instead of " +
  "XPCOMUtils.defineLazyModuleGetter";

ruleTester.run("use-chromeutils-import", rule, {
  valid: [
    `ChromeUtils.import("resource://gre/modules/AppConstants.jsm");`,
    `ChromeUtils.import("resource://gre/modules/AppConstants.jsm", this);`,
    `ChromeUtils.defineModuleGetter(this, "AppConstants",
                                    "resource://gre/modules/AppConstants.jsm");`,
    `XPCOMUtils.defineLazyModuleGetter(this, "AppConstants",
                                       "resource://gre/modules/AppConstants.jsm",
                                       "Foo");`,
    `XPCOMUtils.defineLazyModuleGetter(this, "AppConstants",
                                       "resource://gre/modules/AppConstants.jsm",
                                       undefined, preAppConstantsLambda);`,
  ],
  invalid: [
    {
      code: `Cu.import("resource://gre/modules/AppConstants.jsm");`,
      output: `ChromeUtils.import("resource://gre/modules/AppConstants.jsm");`,
      errors: callError(MESSAGE_IMPORT),
    },
    {
      code: `Cu.import("resource://gre/modules/AppConstants.jsm", this);`,
      output: `ChromeUtils.import("resource://gre/modules/AppConstants.jsm", this);`,
      errors: callError(MESSAGE_IMPORT),
    },
    {
      code: `Components.utils.import("resource://gre/modules/AppConstants.jsm");`,
      output: `ChromeUtils.import("resource://gre/modules/AppConstants.jsm");`,
      errors: callError(MESSAGE_IMPORT),
    },
    {
      code: `XPCOMUtils.defineLazyModuleGetter(this, "AppConstants",
                                               "resource://gre/modules/AppConstants.jsm");`,
      output: `ChromeUtils.defineModuleGetter(this, "AppConstants",
                                               "resource://gre/modules/AppConstants.jsm");`,
      errors: callError(MESSAGE_DEFINE),
    },
  ],
});