Could not obtain flags for test files with cabal-helper cradle using stack

[fduxiao]

Everything was working well until I recompiled HIE with commit hash 22c69c620b2707119194bb33c4ae15427e46f0a2. When I try editing a test file, vscode keeps complaining the following:

Fail on initialisation for "/Users/xiao/haskell/mal2/test/NumberSpec.hs".
Could not obtain flags for: "test/NumberSpec.hs".

This module was not part of any component we are aware of.

Component: ChLibName ChMainLibName with source directory: ["src"]
Component: ChExeName "mal-exe" with source directory: ["app"]


To expose a module, refer to:
https://docs.haskellstack.org/en/stable/GUIDE/
If you are using `package.yaml` then you don't have to manually expose modules.
Maybe you didn't set the source directories for your project correctly.

Previously (at least in November 2019) I never met this, but now vscode warns me that Fail on initialisation for "/Users/xiao/haskell/mal2/test/NumberSpec.hs". Could not obtain flags for: "test/NumberSpec.hs". repeatedly. (The alert flashes so quickly that I narrowly copied this line).

stack test works correctly and the test source dir is specified in the tests section of package.yaml(The same problem occurs even if I initialize a new project with stack). It seems that HIE doesn't consider test sources as a component to be aware of.

[fendor]

What is the content of the generated cabal file?

[fduxiao]

It looks like this:

cabal-version: 1.12

-- This file has been generated from package.yaml by hpack version 0.31.2.
--
-- see: https://github.com/sol/hpack
--
-- hash: 0237d3eaa901762b9786046b053689250944bf6f8f5cd71ad3894e00fc5f5a72

name:           mal
version:        0.1.0.0
description:    Please see the README on GitHub at <https://github.com/githubuser/mal2#readme>
homepage:       https://github.com/githubuser/mal2#readme
bug-reports:    https://github.com/githubuser/mal2/issues
author:         Author name here
maintainer:     example@example.com
copyright:      2019 Author name here
license:        BSD3
license-file:   LICENSE
build-type:     Simple
extra-source-files:
    README.md
    ChangeLog.md

source-repository head
  type: git
  location: https://github.com/githubuser/mal2

library
  exposed-modules:
      Eval
      Lexer
      Mal
      Reader
      Repl
      Runtime
  other-modules:
      Paths_mal
  hs-source-dirs:
      src
  build-depends:
      base >=4.7 && <5
    , haskeline
    , hspec
    , parsec
  default-language: Haskell2010

executable mal-exe
  main-is: Main.hs
  other-modules:
      Paths_mal
  hs-source-dirs:
      app
  ghc-options: -threaded -rtsopts -with-rtsopts=-N
  build-depends:
      base >=4.7 && <5
    , haskeline
    , hspec
    , mal
    , parsec
  default-language: Haskell2010

test-suite mal-test
  type: exitcode-stdio-1.0
  main-is: Spec.hs
  other-modules:
      Helper
      NumberSpec
      Paths_mal
  hs-source-dirs:
      test
  ghc-options: -threaded -rtsopts -with-rtsopts=-N
  build-depends:
      base >=4.7 && <5
    , haskeline
    , hspec
    , mal
    , parsec
  default-language: Haskell2010

[fendor]

Can you maybe share the project so I can try, too?

[fduxiao]

Sure, the repo is here. I am following this guide writing a lisp.

[srahmi]

I had the same error today with a simple servant project. When I ran the stack test command the error seem to be disappeared

[vaclavsvejcar]

Same problem here, I'm able to reproduce this error with this project that contains test files.

[prophet1906]

I am also facing same issue.

[fendor]

Problem is related to stack. By default test-components are not in the global project definition, and executing stack test enables test components. That is why stack test does solve that problem.
Another possible work-around is to use an explicit hie.yaml

cradle:
  stack:
    - path: ./test
      component: "project:test:test-name"
    - path: ./src
      component: "project:lib"
    ...

All available targets can be shown with stack ide targets.

[prophet1906]

Problem is related to stack. By default test-components are not in the global project definition, and executing stack test enables test components. That is why stack test does solve that problem.
Another possible work-around is to use an explicit hie.yaml

cradle:
  stack:
    - path: ./test
      component: "project:test:test-name"
    - path: ./src
      component: "project:lib"
    ...

All available targets can be shown with stack ide targets.

My project is not using stack. I am facing this issue when running cabal test.

[fendor]

@prophet1906 You are running into the described problem and after running cabal test, the problem is solved? Do you have any special changes in your cabal project?
On my test project using cabal, I can load test-files.

[alanz]

Problem is related to stack. By default test-components are not in the global project definition, and executing stack test enables test components. That is why stack test does solve that problem.
Another possible work-around is to use an explicit hie.yaml

cradle:
  stack:
    - path: ./test
      component: "project:test:test-name"
    - path: ./src
      component: "project:lib"
    ...

All available targets can be shown with stack ide targets.

I wonder if we should not automatically construct this cradle, or its effect anyway. It seems it should be a straightforward generalisation, perhaps for when there is no hie.yaml.

[fendor]

I would argue that cabal-helper does exactly that, in a sophisticated way and true to the original build plan. In the original build plan, some components are not active or hidden by flags in the *.cabal file.