Windows test failures

[harpocrates]

I'm in the process of setting up Appveyor CI for Haddock. I'm disappointed to say that we have some failures on windows in hypsrc-test:

Log snippet

Test suite hypsrc-test: RUNNING...
Running 1 test suites...
Haddock version 2.23.0, (c) Simon Marlow 2006
Ported to use the GHC API by David Waern 2006-2008
8.8.1
Generating documentation...
Testing output files...
Checking "src\Types.html"... PASS
Checking "src\Records.html"... PASS
Checking "src\PositionPragmas.html"... FAIL
Checking "src\Polymorphism.html"... PASS
Checking "src\Operators.html"... PASS
Checking "src\Literals.html"... PASS
Checking "src\LinkingIdentifiers.html"... PASS
Checking "src\Identifiers.html"... PASS
Checking "src\CPP.html"... FAIL
Checking "src\Constructors.html"... PASS
Checking "src\Classes.html"... PASS
Diffing failed cases...
Diff for file "src\PositionPragmas.html":
41,42c41,46
<       ><span class="hs-identifier"
<       >foo</span
---
>       ><span class="annot"
>       ><a href="PositionPragmas.html#foo"
> 	><span class="hs-identifier hs-type"
> 	  >foo</span
> 	  ></a
> 	></span
49,50c53,56
<       ><span class="hs-identifier"
<       >String</span
---
>       ><span class="annot"
>       ><span class="hs-identifier hs-type"
> 	>String</span
> 	></span
56,57c62,72
<       ><span class="hs-identifier"
<       >foo</span
---
>       ><span id="foo"
>       ><span class="annot"
> 	><span class="annottext"
> 	  >foo :: String
> </span
> 	  ><a href="PositionPragmas.html#foo"
> 	  ><span class="hs-identifier hs-var hs-var"
> 	    >foo</span
> 	    ></a
> 	  ></span
> 	></span
64,65c79,87
<       ><span class="hs-identifier"
<       >bar</span
---
>       ><span class="annot"
>       ><span class="annottext"
> 	>String
> </span
> 	><a href="PositionPragmas.html#bar"
> 	><span class="hs-identifier hs-var"
> 	  >bar</span
> 	  ></a
> 	></span
88,89c110,115
<       ><span class="hs-identifier"
<       >bar</span
---
>       ><span class="annot"
>       ><a href="PositionPragmas.html#bar"
> 	><span class="hs-identifier hs-type"
> 	  >bar</span
> 	  ></a
> 	></span
96,97c122,125
<       ><span class="hs-identifier"
<       >String</span
---
>       ><span class="annot"
>       ><span class="hs-identifier hs-type"
> 	>String</span
> 	></span
103,104c131,141
<       ><span class="hs-identifier"
<       >bar</span
---
>       ><span id="bar"
>       ><span class="annot"
> 	><span class="annottext"
> 	  >bar :: String
> </span
> 	  ><a href="PositionPragmas.html#bar"
> 	  ><span class="hs-identifier hs-var hs-var"
> 	    >bar</span
> 	    ></a
> 	  ></span
> 	></span
111,112c148,156
<       ><span class="hs-identifier"
<       >foo</span
---
>       ><span class="annot"
>       ><span class="annottext"
> 	>String
> </span
> 	><a href="PositionPragmas.html#foo"
> 	><span class="hs-identifier hs-var"
> 	  >foo</span
> 	  ></a
> 	></span
Diff for file "src\CPP.html":
36,37c36,41
<       ><span class="hs-identifier"
<       >foo</span
---
>       ><span class="annot"
>       ><a href="CPP.html#foo"
> 	><span class="hs-identifier hs-type"
> 	  >foo</span
> 	  ></a
> 	></span
44,45c48,51
<       ><span class="hs-identifier"
<       >String</span
---
>       ><span class="annot"
>       ><span class="hs-identifier hs-type"
> 	>String</span
> 	></span
51,52c57,67
<       ><span class="hs-identifier"
<       >foo</span
---
>       ><span id="foo"
>       ><span class="annot"
> 	><span class="annottext"
> 	  >foo :: String
> </span
> 	  ><a href="CPP.html#foo"
> 	  ><span class="hs-identifier hs-var hs-var"
> 	    >foo</span
> 	    ></a
> 	  ></span
> 	></span
64a80
>       ><span class="annot"
66c82,83
<       >"foo"</span
---
> 	>"foo"</span
> 	></span
77,78c94,99
<       ><span class="hs-identifier"
<       >bar</span
---
>       ><span class="annot"
>       ><a href="CPP.html#bar"
> 	><span class="hs-identifier hs-type"
> 	  >bar</span
> 	  ></a
> 	></span
85,86c106,109
<       ><span class="hs-identifier"
<       >String</span
---
>       ><span class="annot"
>       ><span class="hs-identifier hs-type"
> 	>String</span
> 	></span
92,93c115,125
<       ><span class="hs-identifier"
<       >bar</span
---
>       ><span id="bar"
>       ><span class="annot"
> 	><span class="annottext"
> 	  >bar :: String
> </span
> 	  ><a href="CPP.html#bar"
> 	  ><span class="hs-identifier hs-var hs-var"
> 	    >bar</span
> 	    ></a
> 	  ></span
> 	></span
99a132
>       ><span class="annot"
101c134,135
<       >"block comment in a string is not a comment {- "</span
---
> 	>"block comment in a string is not a comment {- "</span
> 	></span
143,144c177,182
<       ><span class="hs-identifier"
<       >baz</span
---
>       ><span class="annot"
>       ><a href="CPP.html#baz"
> 	><span class="hs-identifier hs-type"
> 	  >baz</span
> 	  ></a
> 	></span
151,152c189,192
<       ><span class="hs-identifier"
<       >String</span
---
>       ><span class="annot"
>       ><span class="hs-identifier hs-type"
> 	>String</span
> 	></span
158,159c198,208
<       ><span class="hs-identifier"
<       >baz</span
---
>       ><span id="baz"
>       ><span class="annot"
> 	><span class="annottext"
> 	  >baz :: String
> </span
> 	  ><a href="CPP.html#baz"
> 	  ><span class="hs-identifier hs-var hs-var"
> 	    >baz</span
> 	    ></a
> 	  ></span
> 	></span
165a215
>       ><span class="annot"
167c217,218
<       >"line comment in a string is not a comment --"</span
---
> 	>"line comment in a string is not a comment --"</span
> 	></span
Test suite hypsrc-test: FAIL
Test suite logged to:
C:\projects\haddock\dist-newstyle\build\x86_64-windows\ghc-8.8.1\haddock-2.23.0\t\hypsrc-test\test\haddock-2.23.0-hypsrc-test.log
0 of 1 test suites (0 of 1 test cases) passed.
cabal.exe: Tests failed for test:hypsrc-test from haddock-2.23.0.

Inspecting the output, it looks like what we are missing is annotations for identifiers. This looks suspiciously like another instance of hyperlinker not properly binding the AST to the tokens.

[harpocrates]

I did some debugging and the failures are probably not as serious as I thought:

• PositionPragmas passes a unix-style position pragma. This is fine, but it means that when run on windows, the HIE information we get from GHC will have two files in it (one for the unix-style path and one for the windows-style path). Hyperlinker uses only the one for the windows style path.

  This failure isn't too bad, since LINE pragmas are usually only in generated sources, which tend to be generated on the platform they are also built on, so the paths in pragmas will match the file path.

• CPP - not yet debugged yet.