Add haddock --keep-temp-files test

[9999years]

Split off of #10292

Thanks to @mpickering for helping with this test case.

• Patches conform to the coding conventions.
• Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Depends-on: #10388

[mpickering]

This seems to depend on #10388

[geekosaur]

Yes, that's why there's a Depends-on: in the header.

[9999years]

@mpickering This seems to be failing on Windows, would you mind taking a look at it?

[mpickering]

It appears on windows the response file is called had5244.txt rather than haddock-response.txt, I will look into modifying the test.

[mpickering]

@9999years It seems that in the original patch I provided it worked on windows. Could you restore that approach to the test? I

+{-# LANGUAGE LambdaCase #-}
+import Test.Cabal.Prelude
+import Data.List (sort)
+import Distribution.Verbosity
+import Distribution.Simple.Glob
+import Distribution.Simple.Glob.Internal
+import Distribution.Simple.Utils
+
+-- Test that "cabal haddock" preserves temporary files
+-- We use haddock-keep-temp-file: True in the cabal.project.
+main = cabalTest $ recordMode DoNotRecord $ withProjectFile "cabal.project" $ do
+    cabal "haddock" []
+
+    cwd <- fmap testCurrentDir getTestEnv
+
+    -- Windows has multiple response files, and only the last one (alphabetically) is the important one.
+    (safeLast . sort . globMatches <$> liftIO (runDirFileGlob silent Nothing cwd (GlobDirRecursive [WildCard, Literal "txt"]))) >>= \case
+      Nothing -> error "Expecting a response file to exist"
+      Just m -> do
+        -- Assert the matched response file is not empty, and indeed a haddock rsp
+        assertFileDoesContain (cwd </> m) "--package-name"

I tried to push a commit which restored the test to this form but I don't have permission to push to your branch.

[9999years]

Ah:

File name template. If the template is "foo.ext" then the created file will be "fooXXX.ext" where XXX is some random number. Note that this should not contain any path separator characters. On Windows, the template prefix may be truncated to 3 chars, e.g. "foobar.ext" will be "fooXXX.ext".

https://hackage.haskell.org/package/base-4.20.0.1/docs/System-IO.html#v:openTempFile

[9999years]

@mpickering I've updated the test. I think it's a bit more readable this way, and the error messages for failures will be more informative. Let me know what you think.

[mpickering]

Looks fine.

[geekosaur]

@mergify refresh

[mergify]

refresh

✅ Pull request refreshed