Merge pull request #30 from homebysix/tests

Add test for findExistingLabel, update pre-commit hooks

Author: homebysix

.pre-commit-config.yaml

@@ -1,24 +1,25 @@
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.2.0
-  hooks:
-  - id: check-added-large-files
-    args: [--maxkb=100]
-  - id: check-ast
-  - id: check-byte-order-marker
-  - id: check-case-conflict
-  - id: check-docstring-first
-  - id: check-merge-conflict
-  - id: mixed-line-ending
-  - id: no-commit-to-branch
-  - id: trailing-whitespace
-    args: [--markdown-linebreak-ext=md]
-- repo: https://github.com/ambv/black
-  rev: 20.8b1
-  hooks:
-  - id: black
-- repo: https://github.com/asottile/blacken-docs
-  rev: v1.8.0
-  hooks:
-  - id: blacken-docs
-    additional_dependencies: [black==20.8b1]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: check-added-large-files
+        args: [--maxkb=100]
+      - id: check-ast
+      - id: check-byte-order-marker
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+      - id: no-commit-to-branch
+        args: [--branch, main]
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/ambv/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+  - repo: https://github.com/asottile/blacken-docs
+    rev: v1.9.2
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==20.8b1]

tests/unit.py

@@ -1,4 +1,10 @@
-"""Unit tests for docklib."""
+"""unit.py
+
+Unit tests for docklib. NOTE: These tests are designed to mutate the logged in
+user's dock. If all tests pass, the end state should be the same as the
+beginning state, but be aware that there is some possibility of undesired
+modifications remaining if the tests fail.
+"""
 
 import os
 import types
@@ -9,27 +15,28 @@
 
 
 class TestDocklib(unittest.TestCase):
-    """Unit test class."""
+    """Unit test class. Functions are numbered in order to ensure a specific
+    execution order."""
 
     def setUp(self):
         self.dock = docklib.Dock()
 
-    def test_import(self):
+    def test_00_import(self):
         """Ensure docklib imports successfully as a module."""
         self.assertIs(type(docklib), types.ModuleType)
 
-    def test_init(self):
+    def test_05_init(self):
         """Ensure docklib successfully reads the macOS dock."""
         self.assertIsInstance(self.dock, docklib.Dock)
 
-    def test_sections(self):
+    def test_10_sections(self):
         """Ensure docklib retrieves the expected dock sections."""
         actual_sections = list(self.dock.items.keys())
         # pylint: disable=W0212
         self.assertEqual(sorted(actual_sections), sorted(docklib.Dock._SECTIONS))
         # pylint: enable=W0212
 
-    def test_item_keys(self):
+    def test_15_item_keys(self):
         """Ensure docklib does not encounter unexpected dock item keys."""
         sections = ["persistent-apps", "persistent-others"]
         actual_keys = []
@@ -40,7 +47,7 @@ def test_item_keys(self):
         actual_keys = list(set(actual_keys))
         self.assertEqual(sorted(actual_keys), sorted(expected_keys))
 
-    def test_tile_data_keys(self):
+    def test_20_tile_data_keys(self):
         """Ensure docklib does not encounter unexpected tile-data keys."""
         sections = ["persistent-apps", "persistent-others"]
         expected_keys = [
@@ -64,7 +71,7 @@ def test_tile_data_keys(self):
                 for key in item["tile-data"].keys():
                     self.assertIn(key, expected_keys)
 
-    def test_tile_types(self):
+    def test_25_tile_types(self):
         """Ensure docklib does not encounter unexpected tile-types."""
         sections = ["persistent-apps", "persistent-others"]
         expected_types = [
@@ -78,7 +85,7 @@ def test_tile_types(self):
             for item in self.dock.items[section]:
                 self.assertIn(item["tile-type"], expected_types)
 
-    def test_add_app(self):
+    def test_30_add_app(self):
         """Ensure docklib can add apps to the dock."""
         item = self.dock.makeDockAppEntry("/System/Applications/Chess.app")
         old_len = len(self.dock.items["persistent-apps"])
@@ -88,15 +95,15 @@ def test_add_app(self):
         new_len = len(self.dock.items["persistent-apps"])
         self.assertEqual(new_len, old_len + 1)
 
-    def test_find_app(self):
+    def test_35_find_app(self):
         """Ensure docklib can find apps in the dock."""
         app_idx = self.dock.findExistingLabel("Chess", section="persistent-apps")
         self.assertGreaterEqual(app_idx, 0)
 
         app_idx = self.dock.findExistingLabel("FooBarApp", section="persistent-apps")
         self.assertEqual(app_idx, -1)
 
-    def test_remove_app(self):
+    def test_40_remove_app(self):
         """Ensure docklib can remove apps from the dock."""
         old_len = len(self.dock.items["persistent-apps"])
         self.dock.removeDockEntry("Chess")
@@ -105,7 +112,7 @@ def test_remove_app(self):
         new_len = len(self.dock.items["persistent-apps"])
         self.assertEqual(new_len, old_len - 1)
 
-    def test_add_other(self):
+    def test_45_add_other(self):
         """Ensure docklib can add other items to the dock."""
         item = self.dock.makeDockOtherEntry(
             os.path.expanduser("~/Library/Application Support")
@@ -117,7 +124,7 @@ def test_add_other(self):
         new_len = len(self.dock.items["persistent-others"])
         self.assertEqual(new_len, old_len + 1)
 
-    def test_find_other(self):
+    def test_50_find_other(self):
         """Ensure docklib can find other items in the dock."""
         other_idx = self.dock.findExistingLabel(
             "Application Support", section="persistent-others"
@@ -129,7 +136,7 @@ def test_find_other(self):
         )
         self.assertEqual(other_idx, -1)
 
-    def test_remove_other(self):
+    def test_55_remove_other(self):
         """Ensure docklib can remove other items from the dock."""
         old_len = len(self.dock.items["persistent-others"])
         self.dock.removeDockEntry("Application Support")
@@ -138,7 +145,7 @@ def test_remove_other(self):
         new_len = len(self.dock.items["persistent-others"])
         self.assertEqual(new_len, old_len - 1)
 
-    def test_add_url(self):
+    def test_60_add_url(self):
         """Ensure docklib can add url items to the dock."""
         item = self.dock.makeDockOtherURLEntry("https://www.apple.com", "Apple Inc")
         old_len = len(self.dock.items["persistent-others"])
@@ -148,7 +155,14 @@ def test_add_url(self):
         new_len = len(self.dock.items["persistent-others"])
         self.assertEqual(new_len, old_len + 1)
 
-    def test_remove_url(self):
+    def test_65_find_url(self):
+        """Ensure docklib can find url items in the dock."""
+        other_idx = self.dock.findExistingLabel(
+            "Apple Inc", section="persistent-others"
+        )
+        self.assertGreaterEqual(other_idx, 0)
+
+    def test_70_remove_url(self):
         """Ensure docklib can remove url items from the dock."""
         old_len = len(self.dock.items["persistent-others"])
         self.dock.removeDockURLEntry("https://www.apple.com")
@@ -157,7 +171,7 @@ def test_remove_url(self):
         new_len = len(self.dock.items["persistent-others"])
         self.assertEqual(new_len, old_len - 1)
 
-    def test_add_spacer(self):
+    def test_75_add_spacer(self):
         """Ensure docklib can add a spacer item to the dock."""
         item = self.dock.makeDockAppSpacer()
         old_len = len(self.dock.items["persistent-apps"])
@@ -167,7 +181,7 @@ def test_add_spacer(self):
         new_len = len(self.dock.items["persistent-apps"])
         self.assertEqual(new_len, old_len + 1)
 
-    def test_remove_spacer(self):
+    def test_80_remove_spacer(self):
         """Ensure docklib can remove a spacer item from the dock."""
         old_len = len(self.dock.items["persistent-apps"])
         del self.dock.items["persistent-apps"][0]