Xlsx.hs

{-# LANGUAGE OverloadedStrings #-}
{- |
   Module      : Tests.Readers.Xlsx
   Copyright   : © 2025 Anton Antic
   License     : GNU GPL, version 2 or above

   Maintainer  : Anton Antic <anton@everworker.ai>
   Stability   : alpha
   Portability : portable

Tests for the XLSX reader.
-}
module Tests.Readers.Xlsx (tests) where

import qualified Data.ByteString as BS
import qualified Data.ByteString.Lazy as B
import Test.Tasty
import Test.Tasty.Golden.Advanced
import Tests.Helpers
import Text.Pandoc
import Text.Pandoc.UTF8 as UTF8

defopts :: ReaderOptions
defopts = def{ readerExtensions = getDefaultExtensions "xlsx" }

testCompare :: String -> FilePath -> FilePath -> TestTree
testCompare = testCompareWithOpts defopts

testCompareWithOpts :: ReaderOptions -> String -> FilePath -> FilePath -> TestTree
testCompareWithOpts opts testName xlsxFP nativeFP =
  goldenTest
  testName
  (do nf <- UTF8.toText <$> BS.readFile nativeFP
      runIOorExplode (readNative def nf))
  (do df <- B.readFile xlsxFP
      runIOorExplode (readXlsx opts df))
  (nativeDiff nativeFP)
  (\a -> runIOorExplode (writeNative def{ writerTemplate = Just mempty} a)
            >>= BS.writeFile nativeFP . UTF8.fromText)

tests :: [TestTree]
tests = [ testGroup "basic"
          [ testCompare
            "cell fonts"
            "xlsx-reader/cell-fonts.xlsx"
            "xlsx-reader/cell-fonts.native"
          , testCompare
            "inline and rich-text strings"
            "xlsx-reader/strings.xlsx"
            "xlsx-reader/strings.native"
          , testCompare
            "sheet extraction"
            "xlsx-reader/basic.xlsx"
            "xlsx-reader/basic.native"
          , testCompare
            "package-absolute relationship targets"
            "xlsx-reader/absolute-targets.xlsx"
            "xlsx-reader/absolute-targets.native"
          ]
        , testGroup "values"
          [ testCompare
            "numbers, booleans and errors"
            "xlsx-reader/numbers.xlsx"
            "xlsx-reader/numbers.native"
          ]
        , testGroup "dates"
          [ testCompare
            "date and time formats"
            "xlsx-reader/dates.xlsx"
            "xlsx-reader/dates.native"
          , testCompare
            "1904 date system"
            "xlsx-reader/dates-1904.xlsx"
            "xlsx-reader/dates-1904.native"
          ]
        , testGroup "merged cells"
          [ testCompare
            "merged ranges as spans"
            "xlsx-reader/merged.xlsx"
            "xlsx-reader/merged.native"
          ]
        , testGroup "charts"
          [ testCompare
            "charts on a sheet and on a chart sheet"
            "xlsx-reader/charts.xlsx"
            "xlsx-reader/charts.native"
          ]
        ]