Copy .hie test fails with ghc-9.8.1

[philderbeast]

While testing #9717, I found a test that fails locally with ghc-9.8.1 but passes with ghc-9.4.8. Here's the failure;

$ cabal run cabal-testsuite:cabal-tests -- --with-cabal=./dist-newstyle/build/x86_64-linux/ghc-9.8.1/cabal-install-3.11.0.0/x/cabal/build/cabal/cabal cabal-testsuite/PackageTests/CopyHie/setup.test.hs
...
- setup.test.hs: /home/<USERNAME>/.../cabal/cabal-testsuite/PackageTests/CopyHie/setup.dist/usr/lib/x86_64-linux-ghc-9.8.1/hie-local-0.1.0.0/extra-compilation-artifacts/hie/HieLocal.hie should exist
+ setup.test.hs: /tmp/cabal-testsuite-156428/setup.dist/usr/lib/x86_64-linux-ghc-9.8.1/hie-local-0.1.0.0/extra-compilation-artifacts/hie/HieLocal.hie should exist

Putting the tests into a temporary directory is definitely an improvement, if only because it puts the tests into a clean room away from whatever junk may be lying around in my working directory.

Originally posted by @philderbeast in #9717 (comment)

[philderbeast]

I have hls-2.6.0.0 installed and this supports ghc-9.8.1 according to its release.

[philderbeast]

The failing test was added in #9019.

[mpickering]

It seems to pass on 9.6.2 and 9.8.1 for me locally.

[philderbeast]

More carefully this time, first with ghc-9.6.2;

$ tree -P 'HieLocal.hie' --prune
.

0 directories, 0 files

$ cabal run cabal-testsuite:cabal-tests -- \
  --with-cabal=./dist-newstyle/build/x86_64-linux/ghc-9.6.2/cabal-install-3.11.0.0/x/cabal/build/cabal/cabal \
  cabal-testsuite/PackageTests/CopyHie/setup.test.hs
...
OK

$tree -P 'HieLocal.hie' --prune
.
└── cabal-testsuite
    └── PackageTests
        └── CopyHie
            ├── setup.cabal.dist
            │   ├── usr
            │   │   └── lib
            │   │       └── x86_64-linux-ghc-9.6.2
            │   │           └── hie-local-0.1.0.0
            │   │               └── extra-compilation-artifacts
            │   │                   └── hie
            │   │                       └── HieLocal.hie
            │   └── work
            │       └── dist
            │           └── build
            │               └── extra-compilation-artifacts
            │                   └── hie
            │                       └── HieLocal.hie
            └── setup.dist
                ├── usr
                │   └── lib
                │       └── x86_64-linux-ghc-9.6.2
                │           └── hie-local-0.1.0.0
                │               └── extra-compilation-artifacts
                │                   └── hie
                │                       └── HieLocal.hie
                └── work
                    └── dist
                        └── build
                            └── extra-compilation-artifacts
                                └── hie
                                    └── HieLocal.hie

28 directories, 4 files

Then again with ghc-9.8.1;

$ tree -P 'HieLocal.hie' --prune
.

0 directories, 0 files

$ cabal run cabal-testsuite:cabal-tests -- \
  --with-cabal=./dist-newstyle/build/x86_64-linux/ghc-9.8.1/cabal-install-3.11.0.0/x/cabal/build/cabal/cabal \
  cabal-testsuite/PackageTests/CopyHie/setup.test.hs
...
setup.test.hs: /home/.../cabal/cabal-testsuite/PackageTests/CopyHie/setup.dist/usr/lib/x86_64-linux-ghc-9.8.1/hie-local-0.1.0.0/extra-compilation-artifacts/hie/HieLocal.hie should exist
CallStack (from HasCallStack)
...
(exit 1): failed

$ tree -P 'HieLocal.hie' --prune
.
└── cabal-testsuite
    └── PackageTests
        └── CopyHie
            └── setup.dist
                ├── usr
                │   └── lib
                │       └── x86_64-linux-ghc-9.8.1-eb95
                │           └── hie-local-0.1.0.0
                │               └── extra-compilation-artifacts
                │                   └── hie
                │                       └── HieLocal.hie
                └── work
                    └── dist
                        └── build
                            └── extra-compilation-artifacts
                                └── hie
                                    └── HieLocal.hie

16 directories, 2 files

[philderbeast]

The test is looking in the wrong place;

- setup.dist/usr/lib/x86_64-linux-ghc-9.8.1/hie-local-0.1.0.0/extra-compilation-artifacts/hie/HieLocal.hie
+ setup.dist/usr/lib/x86_64-linux-ghc-9.8.1-eb95/hie-local-0.1.0.0/extra-compilation-artifacts/hie/HieLocal.hie

[philderbeast]

@alt-romes could this be from the change in #9618 to use showCompilerIdWithAbi? I'm testing with master at fe82d9b.

[philderbeast]

/home/<USERNAME>/.cache/hie-bios/dist-cabal-6d85a4e3f3d8c061527ba56a3e684653/build/x86_64-linux/ghc-9.8.1/cabal-testsuite-3/build/global-autogen/Test/Cabal/ScriptEnv0.hs has¹;

lbiCompiler :: Compiler
lbiCompiler = Compiler {compilerId = CompilerId GHC (mkVersion [9,8,1]), compilerAbiTag = NoAbiTag, ...

Same lbiCompiler Compiler.compilerAbiTag for;

dist-newstyle/build/x86_64-linux/ghc-9.8.1/cabal-testsuite-3/build/global-autogen/Test/Cabal/ScriptEnv0.hs

$ ghc --info
...
 ,("Project version","9.8.1")
 ,("Project Git commit id","443e870d977b1ab6fc05f47a9a17bc49296adbd6")
...
 ,("Project Unit Id","ghc-9.8.1-eb95")
...

Footnotes

1. HLS go to definiton for Test.Cabal.ScriptEnv0.lbiCompiler. ↩

[mpickering]

A patch which fixes this immediate issue: https://github.com/mpickering/cabal/tree/wip/test-compiler-fix

I am still not happy with the overall approach (see #9730) so I will leave it here for when progress is forced on this issue.