fourmolu-0.17.0.0: tests/Ormolu/ConfigSpec.hs
{-# LANGUAGE OverloadedStrings #-}
-- | Tests for Fourmolu file configuration.
module Ormolu.ConfigSpec (spec) where
import Data.ByteString.Char8 qualified as Char8
import Data.List (isInfixOf)
import Data.List.NonEmpty qualified as NonEmpty
import Data.Map qualified as Map
import Data.Yaml qualified as Yaml
import Ormolu.Config (FourmoluConfig (..), ImportGroup (..), ImportGroupRule (..), ImportGrouping (..), ImportModuleMatcher (..), ImportRulePriority (ImportRulePriority), PrinterOpts (..), QualifiedImportMatcher (MatchBothQualifiedAndUnqualified, MatchQualifiedOnly, MatchUnqualifiedOnly), defaultImportRulePriority, matchAllRulePriority, resolvePrinterOpts)
import Ormolu.Fixity (ModuleReexports (..))
import Ormolu.Utils.Glob (mkGlob)
import Test.Hspec
spec :: Spec
spec = do
describe "FourmoluConfig" $ do
it "parses multiple reexports from same module" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "reexports:",
"- module Foo exports Bar1",
"- module Foo exports Bar2"
]
let expected =
Map.fromList
[ ("Foo", NonEmpty.fromList [(Nothing, "Bar2"), (Nothing, "Bar1")])
]
cfgFileReexports config `shouldBe` ModuleReexports expected
it "applies configurations in correct order" $ do
let opts1 = mempty {poIndentation = Just 2}
opts2 = mempty {poIndentation = Just 4}
configs = [opts1, opts2]
poIndentation (resolvePrinterOpts configs) `shouldBe` 4
context "when using an import grouping configuration" $ do
it "parses 'legacy' as the 'ImportGroupLegacy' import grouping strategy" $ do
config <- Yaml.decodeThrow "import-grouping: legacy"
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
actualStrategy `shouldBe` Just ImportGroupLegacy
it "parses 'preserve' as the 'ImportGroupPreserve' import grouping strategy" $ do
config <- Yaml.decodeThrow "import-grouping: preserve"
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
actualStrategy `shouldBe` Just ImportGroupPreserve
it "parses 'single' as the 'ImportGroupSingle' import grouping strategy" $ do
config <- Yaml.decodeThrow "import-grouping: single"
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
actualStrategy `shouldBe` Just ImportGroupSingle
it "parses 'by-qualified' as the 'ImportGroupByQualified' import grouping strategy" $ do
config <- Yaml.decodeThrow "import-grouping: by-qualified"
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
actualStrategy `shouldBe` Just ImportGroupByQualified
it "parses 'by-scope' as the 'ImportGroupByScope' import grouping strategy" $ do
config <- Yaml.decodeThrow "import-grouping: by-scope"
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
actualStrategy `shouldBe` Just ImportGroupByScope
it "parses 'by-scope-then-qualified' as the 'ImportGroupByScopeThenQualified' import grouping strategy" $ do
config <- Yaml.decodeThrow "import-grouping: by-scope-then-qualified"
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
actualStrategy `shouldBe` Just ImportGroupByScopeThenQualified
it "fails when an unknown strategy is requested" $ do
let decodeResult = Yaml.decodeEither' @FourmoluConfig "import-grouping: fake-strategy"
isAnUnknownStrategyValue e = case e of
Left (Yaml.AesonException msg) -> "unknown strategy value" `isInfixOf` msg
_ -> False
decodeResult `shouldSatisfy` isAnUnknownStrategyValue
it "parses a grouping rule's name" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - name: Some name",
" rules:",
" - match: all"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Just "Some name",
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchAllModules,
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = matchAllRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "enables the 'qualified' rule option" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - glob: \"**\"",
" qualified: yes"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Nothing,
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "**"),
igrQualifiedMatcher = MatchQualifiedOnly,
igrPriority = defaultImportRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "disables the 'qualified' rule option" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - glob: \"**\"",
" qualified: no"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Nothing,
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "**"),
igrQualifiedMatcher = MatchUnqualifiedOnly,
igrPriority = defaultImportRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "decodes the 'priority' rule option" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - match: all",
" priority: 55"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Nothing,
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchAllModules,
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = ImportRulePriority 55
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "parses a 'glob' rule" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - glob: Data.Text.**"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Nothing,
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "Data.Text.**"),
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = defaultImportRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "parses a 'match' rule for local modules" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - match: local-modules"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Nothing,
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchLocalModules,
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = defaultImportRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "parses a 'match' rule for all modules" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - match: all"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Nothing,
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchAllModules,
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = matchAllRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "parses multiple group configurations and rules in their order of appearance in the configuration" $ do
config <-
Yaml.decodeThrow . Char8.pack . unlines $
[ "import-grouping:",
" - name: Text modules",
" rules:",
" - glob: Data.Text",
" - name: The rest",
" rules:",
" - match: all",
" priority: 100",
" - name: My internals and monads unqualified",
" rules:",
" - match: local-modules",
" qualified: no",
" - glob: Control.Monad",
" qualified: no",
" - name: My internals and monads qualified",
" rules:",
" - match: local-modules",
" qualified: yes",
" - glob: Control.Monad",
" qualified: yes",
" - name: Specific monads",
" rules:",
" - glob: Control.Monad.**"
]
let actualStrategy = poImportGrouping (cfgFilePrinterOpts config)
expectedRules =
NonEmpty.fromList
[ ImportGroup
{ igName = Just "Text modules",
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "Data.Text"),
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = defaultImportRulePriority
}
]
},
ImportGroup
{ igName = Just "The rest",
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchAllModules,
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = ImportRulePriority 100
}
]
},
ImportGroup
{ igName = Just "My internals and monads unqualified",
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchLocalModules,
igrQualifiedMatcher = MatchUnqualifiedOnly,
igrPriority = defaultImportRulePriority
},
ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "Control.Monad"),
igrQualifiedMatcher = MatchUnqualifiedOnly,
igrPriority = defaultImportRulePriority
}
]
},
ImportGroup
{ igName = Just "My internals and monads qualified",
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchLocalModules,
igrQualifiedMatcher = MatchQualifiedOnly,
igrPriority = defaultImportRulePriority
},
ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "Control.Monad"),
igrQualifiedMatcher = MatchQualifiedOnly,
igrPriority = defaultImportRulePriority
}
]
},
ImportGroup
{ igName = Just "Specific monads",
igRules =
NonEmpty.fromList
[ ImportGroupRule
{ igrModuleMatcher = MatchGlob (mkGlob "Control.Monad.**"),
igrQualifiedMatcher = MatchBothQualifiedAndUnqualified,
igrPriority = defaultImportRulePriority
}
]
}
]
actualStrategy `shouldBe` Just (ImportGroupCustom expectedRules)
it "fails when a rule cannot be identified" $ do
let decodeResult =
Yaml.decodeEither' @FourmoluConfig . Char8.pack . unlines $
[ "import-grouping:",
" - rules:",
" - some-unknown-rule-type: whatever"
]
isAnUnknownModuleMatcher e = case e of
Left (Yaml.AesonException msg) -> "Unknown or invalid module matcher" `isInfixOf` msg
_ -> False
decodeResult `shouldSatisfy` isAnUnknownModuleMatcher