Failing test with whitespace mismatches for hls-splice-plugin

[maralorn]

Your environment

Trying to build hls-splice-plugin-1.0.0.1.

Which OS do you use: Nixos

Steps to reproduce

I ran the tests.

Expected behaviour

Tests pass.

Actual behaviour

  TSimpleDecl.hs (golden):      FAIL (111.47s)
    test/Main.hs:87:
    expected: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\r\nfoo = 42\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"
     but got: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\nfoo = 42\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"
  TQQDecl.hs (golden):          FAIL (133.83s)
    test/Main.hs:87:
    expected: "{-# LANGUAGE QuasiQuotes #-}\r\nmodule TQQDecl where\r\nimport QQ (str)\r\n\r\nfoo :: String\r\nfoo = \"foo\"\r\n"
     but got: "{-# LANGUAGE QuasiQuotes #-}\r\nmodule TQQDecl where\r\nimport QQ (str)\r\n\r\nfoo :: String\nfoo = \"foo\"\r\n"
  TTypeKindError.hs (golden):   OK (125.31s)
  TDeclKindError.hs (golden):   FAIL (118.40s)
    test/Main.hs:120:
    expected: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\r\nfoo = 42\r\nbar :: Int\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"
     but got: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\nfoo = 42\nbar :: Int\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"

3 out of 31 tests failed (138.46s)

This looks like some issue with unix vs. windows line endings?

[felixonmars]

I am getting the same errors when building for Arch:

  TSimpleDecl.hs (golden):      FAIL (88.82s)
    test/Main.hs:87:
    expected: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\r\nfoo = 42\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"
     but got: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\nfoo = 42\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"
  TQQDecl.hs (golden):          FAIL (102.13s)
    test/Main.hs:87:
    expected: "{-# LANGUAGE QuasiQuotes #-}\r\nmodule TQQDecl where\r\nimport QQ (str)\r\n\r\nfoo :: String\r\nfoo = \"foo\"\r\n"
     but got: "{-# LANGUAGE QuasiQuotes #-}\r\nmodule TQQDecl where\r\nimport QQ (str)\r\n\r\nfoo :: String\nfoo = \"foo\"\r\n"
  TTypeKindError.hs (golden):   OK (99.71s)
  TDeclKindError.hs (golden):   FAIL (93.87s)
    test/Main.hs:120:
    expected: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\r\nfoo = 42\r\nbar :: Int\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"
     but got: "{-# LANGUAGE TemplateHaskell #-}\r\n{-# LANGUAGE QuasiQuotes #-}\r\nmodule TSimpleDecl where\r\nimport Language.Haskell.TH ( mkName, clause, normalB, funD, sigD )\r\n\r\n-- Foo\r\n--  Bar\r\nfoo :: Int\nfoo = 42\nbar :: Int\r\n-- Bar\r\n-- ee\r\n-- dddd\r\n"

[jneira]

Usually tests fail in windows cause the same issue 🙂 , editing the source test cases should fix it, i suppose

[Ailrun]

It's partially because splice plugin does not use any golden test util, and implement its own pseudo-golden test by itself... (If we use git diff, we can ignore \r differences)

[berberman]

Yeah, eval plugin and tactics plugin have the same problem as well.

And it turns out that files in uploaded tarballs are different from those in our git source tree:

$ diff ~/Downloads/hls-splice-plugin-1.0.0.1/test/testdata/TErrorExp.hs.expected ~/haskell-language-server/plugins/hls-splice-plugin/test/testdata/TErrorExp.hs.expected   
1,6c1,6
< {-# LANGUAGE TemplateHaskell #-}
< module TErrorExp where
< import Language.Haskell.TH ( tupE, litE, integerL )
< 
< main :: IO ()
< main = return (42, ())
---
> {-# LANGUAGE TemplateHaskell #-}
> module TErrorExp where
> import Language.Haskell.TH ( tupE, litE, integerL )
> 
> main :: IO ()
> main = return (42, ())

@jneira Did you create this sdist on Windows?

[jneira]

yeah, it seems it could be my fault, maybe cause i have auto.crlf enabled (not at my laptop rigt now).
I will take a look asap