more tests

haskell · Nov 25, 2015 · e9cea16 · e9cea16
1 parent eb32bf6
commit e9cea16
Show file tree

Hide file tree

Showing 4 changed files with 152 additions and 2 deletions.
diff --git a/haskell-ide-engine.cabal b/haskell-ide-engine.cabal
@@ -97,6 +97,7 @@ test-suite haskell-ide-test
                        HaRePluginSpec
                        JsonStdioSpec
                        JsonSpec
+                       PluginUtilsSpec
   build-depends:       base
                      , aeson
                      , containers

diff --git a/hie-plugin-api/Haskell/Ide/Engine/PluginUtils.hs b/hie-plugin-api/Haskell/Ide/Engine/PluginUtils.hs
@@ -11,6 +11,7 @@ module Haskell.Ide.Engine.PluginUtils
   , incorrectParameter
   , validatePlugins
   , PluginDescriptionError(..)
+  , ParamNameCollision
   ) where
 
 import           Data.Aeson
@@ -93,7 +94,7 @@ data PluginDescriptionError =
   PluginDescriptionError {
     paramNameCollisions :: [ParamNameCollision]
   , paramNameCollisionErrorMsg :: String
-  } deriving Eq
+  } deriving (Eq, Show)
 
 validatePlugins :: Plugins -> Maybe PluginDescriptionError
 validatePlugins plugins =

diff --git a/test/DispatcherSpec.hs b/test/DispatcherSpec.hs
@@ -40,7 +40,7 @@ dispatcherSpec :: Spec
 dispatcherSpec = do
   describe "checking plugins on startup" $ do
 
-    it "exits on parameter name collisions" $ do
+    it "exits with an error if any command has a parameter name collision" $ do
       runIdeM (IdeState testPluginWithParamNameCollison) undefined `shouldThrow` anyErrorCall
 
     -- ---------------------------------

diff --git a/test/PluginUtilsSpec.hs b/test/PluginUtilsSpec.hs
@@ -23,6 +23,154 @@ pluginUtilsSpec = do
     it "accepts plugins without parameter name collisions" $ do
       validatePlugins pluginsWithoutCollisions `shouldBe` Nothing
 
+    it "reports collisions for plugins with parameter name collisions" $ do
+      fmap paramNameCollisions (validatePlugins pluginsWithCollisions) `shouldBe` Just
+            [
+              ("plugin1",
+                  [
+                    ("cmd1", ["file"])
+                  , ("cmd2", ["end_pos"])
+                  , ("cmd3", ["a", "a", "b"])
+                  ]
+              )
+            , ("plugin2",
+                  [
+                    ("cmd1", ["file"])
+                  ]
+              )
+            ]
+
+
+    it "pretty prints the error message" $ do
+      fmap paramNameCollisionErrorMsg (validatePlugins pluginsWithCollisions) `shouldBe` Just (
+            "In plugin \"plugin1\" the command \"cmd1\" has multiple parameters named \"file\"" ++
+            "\nIn plugin \"plugin1\" the command \"cmd2\" has multiple parameters named \"end_pos\"" ++
+            "\nIn plugin \"plugin1\" the command \"cmd3\" has multiple parameters named \"a\", \"b\"" ++
+            "\nIn plugin \"plugin2\" the command \"cmd1\" has multiple parameters named \"file\""
+          )
+
+
+pluginsWithCollisions :: Plugins
+pluginsWithCollisions = Map.fromList [("plugin1", PluginDescriptor
+    {
+      pdCommands =
+        [
+          Command
+            { cmdDesc = CommandDesc
+                          { cmdName = "cmd1"
+                          , cmdUiDescription = ""
+                          , cmdFileExtensions = []
+                          , cmdContexts = [CtxRegion, CtxPoint] -- ["file", "start_pos", "file", "start_pos", "end_pos"]
+                          , cmdAdditionalParams =
+                            [
+                              RP
+                                { pName = "file"
+                                , pHelp = "shoud collide"
+                                , pType = PtText
+                                }
+                            , RP
+                                { pName = "uniqueParamName1"
+                                , pHelp = "shoud not collide"
+                                , pType = PtText
+                                }
+                            ]
+                          }
+            , cmdFunc = CmdSync $ \_ _ -> return (IdeResponseOk ("" :: T.Text))
+            }
+        , Command
+            { cmdDesc = CommandDesc
+                          { cmdName = "cmd2"
+                          , cmdUiDescription = ""
+                          , cmdFileExtensions = []
+                          , cmdContexts = [CtxRegion]
+                          , cmdAdditionalParams =
+                            [
+                              RP
+                                { pName = "end_pos"
+                                , pHelp = "shoud collide"
+                                , pType = PtText
+                                }
+                            , OP
+                                { pName = "uniqueParamName1"
+                                , pHelp = "shoud not collide"
+                                , pType = PtText
+                                }
+                            ]
+                          }
+            , cmdFunc = CmdSync $ \_ _ -> return (IdeResponseOk ("" :: T.Text))
+            }
+            , Command
+                { cmdDesc = CommandDesc
+                              { cmdName = "cmd3"
+                              , cmdUiDescription = ""
+                              , cmdFileExtensions = []
+                              , cmdContexts = [] -- ["file", "start_pos", "file", "start_pos", "end_pos"]
+                              , cmdAdditionalParams =
+                                [
+                                  RP
+                                    { pName = "a"
+                                    , pHelp = "shoud collide"
+                                    , pType = PtText
+                                    }
+                                , OP
+                                    { pName = "a"
+                                    , pHelp = "shoud collide"
+                                    , pType = PtText
+                                    }
+                                , OP
+                                    { pName = "a"
+                                    , pHelp = "shoud collide"
+                                    , pType = PtText
+                                    }
+                                , RP
+                                  { pName = "b"
+                                  , pHelp = "shoud collide"
+                                  , pType = PtText
+                                  }
+                                , RP
+                                  { pName = "b"
+                                  , pHelp = "shoud collide"
+                                  , pType = PtText
+                                  }
+                                ]
+                              }
+                , cmdFunc = CmdSync $ \_ _ -> return (IdeResponseOk ("" :: T.Text))
+                }
+        ]
+      , pdExposedServices = []
+      , pdUsedServices    = []
+    })
+    , ("plugin2", PluginDescriptor
+        {
+          pdCommands =
+            [
+              Command
+                { cmdDesc = CommandDesc
+                              { cmdName = "cmd1"
+                              , cmdUiDescription = ""
+                              , cmdFileExtensions = []
+                              , cmdContexts = [CtxRegion, CtxPoint] -- ["file", "start_pos", "file", "start_pos", "end_pos"]
+                              , cmdAdditionalParams =
+                                [
+                                  RP
+                                    { pName = "file"
+                                    , pHelp = "shoud collide"
+                                    , pType = PtText
+                                    }
+                                , RP
+                                    { pName = "uniqueParamName1"
+                                    , pHelp = "shoud not collide"
+                                    , pType = PtText
+                                    }
+                                ]
+                              }
+                , cmdFunc = CmdSync $ \_ _ -> return (IdeResponseOk ("" :: T.Text))
+                }
+            ]
+          , pdExposedServices = []
+          , pdUsedServices    = []
+        })
+    ]
 
 
 pluginsWithoutCollisions :: Plugins