Revision control
Copy as Markdown
Other Tools
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
import json
import os.path
from marionette_harness import MarionetteTestCase
here = os.path.dirname(__file__)
class TestToolbarMigration(MarionetteTestCase):
"""
Tests that a hidden="false" value for the status bar is removed from the XUL store since the
presence of *any* value for that attribute now hides the status bar.
"""
get_hidden_attribute = """
return document.getElementById("status-bar").getAttribute("hidden");
"""
get_xulstore_value = """
return Services.xulStore.getValue(
"status-bar",
"hidden"
);
"""
get_pref_value = """
return Services.prefs.getIntPref("mail.ui-rdf.version", -1);
"""
def test_no_xulstore(self):
"""
A completely new profile. The status bar should be visible, because that's the default.
"""
self.subtest(None, None, None, "")
def test_no_xulstore_no_update(self):
"""
The XUL store has no value and migration doesn't happen. The status bar should be visible,
because that's the default.
"""
self.subtest(53, None, None, "")
def test_no_xulstore_update(self):
"""
The XUL store has no value when migration happens. The status bar should be visible, because
that's the default.
"""
self.subtest(52, None, None, "")
def test_xulstore_false_no_update(self):
"""
The XUL store value is false and migration doesn't happen. The status bar should be hidden,
because it has a value for the hidden attribute, even though that value is "false".
Fortunately, we should never be in this situation.
"""
self.subtest(53, "false", "false", "false")
def test_xulstore_false_update(self):
"""
The XUL store value is false when migration happens. The value should be removed and the
status bar should be visible.
"""
self.subtest(52, "false", None, "")
def test_xulstore_true_no_update(self):
"""
The XUL store value is true and migration doesn't happen. The status bar should be hidden.
"""
self.subtest(53, "true", "true", "true")
def test_xulstore_true_update(self):
"""
The XUL store value is true when migration happens. The status bar should be hidden.
"""
self.subtest(52, "true", "true", "true")
def subtest(
self, migration_version, xulstore_value, expected_attribute_value, expected_xulstore_value
):
self.marionette.set_context(self.marionette.CONTEXT_CHROME)
self.marionette.quit(in_app=True)
# Set the migration pref to a number higher than the migration we're testing
prefs_path = os.path.join(self.marionette.profile_path, "prefs.js")
if migration_version is None:
os.unlink(prefs_path)
else:
with open(prefs_path, "w") as prefs_file:
prefs_file.write(f"""user_pref("mail.ui-rdf.version", {migration_version});\n""")
# Write a xulstore.json file that has the attribute set to true.
xulstore_path = os.path.join(self.marionette.profile_path, "xulstore.json")
if migration_version is None:
os.unlink(xulstore_path)
else:
if xulstore_value is None:
else:
xulstore_data = {
"status-bar": {"hidden": xulstore_value}
}
}
with open(xulstore_path, "w") as xulstore_file:
json.dump(xulstore_data, xulstore_file)
# Start the application, check the state.
self.marionette.start_session()
self.marionette.set_context(self.marionette.CONTEXT_CHROME)
self.assertEqual(
expected_attribute_value, self.marionette.execute_script(self.get_hidden_attribute)
)
self.assertEqual(
expected_xulstore_value, self.marionette.execute_script(self.get_xulstore_value)
)
self.assertTrue(self.marionette.execute_script(self.get_pref_value) >= 53)