From 520c51817a16cd100d96e785cba0f6d07e29044d Mon Sep 17 00:00:00 2001
From: slotThe <soliditsallgood@mailbox.org>
Date: Mon, 29 Nov 2021 17:48:03 +0100
Subject: [PATCH] X.U.EZConfig: Add simple unit tests

Add very basic unit tests for EZConfig to see if it can parse all of the
keys (and key combinations) that it promises to parse.

The long-term goal here should be to write a pretty-printer for EZConfig
and to check whether that's a proper inverse (either in the normal sense
or in the inverse semigroup sense), as the tests for X.P.OrgMode do.
---
 XMonad/Util/EZConfig.hs |  7 ++++++-
 tests/EZConfig.hs       | 39 +++++++++++++++++++++++++++++++++++++++
 tests/Main.hs           |  2 ++
 xmonad-contrib.cabal    |  4 ++++
 4 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 tests/EZConfig.hs

diff --git a/XMonad/Util/EZConfig.hs b/XMonad/Util/EZConfig.hs
index 65398402..847b0dd7 100644
--- a/XMonad/Util/EZConfig.hs
+++ b/XMonad/Util/EZConfig.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE CPP #-}
 --------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.EZConfig
@@ -34,7 +35,11 @@ module XMonad.Util.EZConfig (
 
                              parseKey, -- used by XMonad.Util.Paste
                              parseKeyCombo,
-                             parseKeySequence, readKeySequence
+                             parseKeySequence, readKeySequence,
+#ifdef TESTING
+                             functionKeys, specialKeys, multimediaKeys,
+                             parseModifier,
+#endif
                             ) where
 
 import XMonad
diff --git a/tests/EZConfig.hs b/tests/EZConfig.hs
new file mode 100644
index 00000000..c7e3408a
--- /dev/null
+++ b/tests/EZConfig.hs
@@ -0,0 +1,39 @@
+module EZConfig (spec) where
+
+import Control.Arrow (first)
+import Test.Hspec
+import XMonad
+import XMonad.Prelude
+import XMonad.Util.EZConfig
+import XMonad.Util.Parser
+
+spec :: Spec
+spec = do
+  context "parseKey" $ do
+    let prepare = unzip . map (first surround)
+        testParseKey (ns, ks) = traverse (runParser parseKey) ns `shouldBe` Just ks
+    it "parses all regular keys"    $ testParseKey          regularKeys
+    it "parses all function keys"   $ testParseKey (prepare functionKeys  )
+    it "parses all special keys"    $ testParseKey (prepare specialKeys   )
+    it "parses all multimedia keys" $ testParseKey (prepare multimediaKeys)
+  context "parseModifier" $ do
+    it "parses all combinations of modifiers" $
+      nub . map sort <$> traverse (runParser (many $ parseModifier def))
+                                     modifiers
+        `shouldBe` Just [[ shiftMask, controlMask
+                         , mod1Mask, mod1Mask      -- def M and M1
+                         , mod2Mask, mod3Mask, mod4Mask, mod5Mask
+                         ]]
+
+regularKeys :: ([String], [KeySym])
+regularKeys = unzip . map (first (: ""))
+            $ zip ['!'    .. '~'   ] [xK_exclam       .. xK_asciitilde]
+           ++ zip ['\xa0' .. '\xff'] [xK_nobreakspace .. xK_ydiaeresis]
+
+-- | QuickCheck can handle the 8! combinations just fine.
+modifiers :: [String]
+modifiers = map concat $
+  permutations ["M-", "C-", "S-", "M1-", "M2-", "M3-", "M4-", "M5-"]
+
+surround :: String -> String
+surround s = "<" <> s <> ">"
diff --git a/tests/Main.hs b/tests/Main.hs
index 7712f953..813ba921 100644
--- a/tests/Main.hs
+++ b/tests/Main.hs
@@ -13,6 +13,7 @@ import qualified XPrompt
 import qualified CycleRecentWS
 import qualified OrgMode
 import qualified GridSelect
+import qualified EZConfig
 
 main :: IO ()
 main = hspec $ do
@@ -51,3 +52,4 @@ main = hspec $ do
     context "CycleRecentWS"  CycleRecentWS.spec
     context "OrgMode"        OrgMode.spec
     context "GridSelect"     GridSelect.spec
+    context "EZConfig"       EZConfig.spec
diff --git a/xmonad-contrib.cabal b/xmonad-contrib.cabal
index 931224f3..57d34887 100644
--- a/xmonad-contrib.cabal
+++ b/xmonad-contrib.cabal
@@ -388,6 +388,7 @@ test-suite tests
   type:           exitcode-stdio-1.0
   main-is:        Main.hs
   other-modules:  CycleRecentWS
+                  EZConfig
                   ExtensibleConf
                   GridSelect
                   Instances
@@ -404,6 +405,7 @@ test-suite tests
                   XMonad.Actions.GridSelect
                   XMonad.Actions.PhysicalScreens
                   XMonad.Actions.RotateSome
+                  XMonad.Actions.Submap
                   XMonad.Actions.SwapWorkspaces
                   XMonad.Actions.TagWindows
                   XMonad.Actions.WindowBringer
@@ -422,11 +424,13 @@ test-suite tests
                   XMonad.Prompt.Shell
                   XMonad.Util.Dmenu
                   XMonad.Util.Dzen
+                  XMonad.Util.EZConfig
                   XMonad.Util.ExtensibleConf
                   XMonad.Util.ExtensibleState
                   XMonad.Util.Font
                   XMonad.Util.Image
                   XMonad.Util.Invisible
+                  XMonad.Util.NamedActions
                   XMonad.Util.NamedWindows
                   XMonad.Util.Parser
                   XMonad.Util.PureX