[cli] refactor: move some E2E to integration stanza

Author: paolino

cli/anti.cabal

@@ -295,55 +295,33 @@ executable anti-agent
 
 test-suite anti-E2E-test
   -- Import common warning flags.
-  import:             warnings
+  import:           warnings
 
   -- Base language which the package is written in.
-  default-language:   Haskell2010
+  default-language: Haskell2010
 
   -- Modules included in this executable, other than Main.
-  other-modules:
-    E2ESpec
-    Lib.Github.OracleValidationSpec
-    MPFS.APISpec
+  other-modules:    E2ESpec
 
   -- LANGUAGE extensions used by modules in this package.
   -- other-extensions:
 
   -- The interface type and version of the test suite.
-  type:               exitcode-stdio-1.0
+  type:             exitcode-stdio-1.0
 
   -- Directories containing source files.
-  hs-source-dirs:     test-E2E
+  hs-source-dirs:   test-E2E
 
   -- The entrypoint to the test suite.
-  main-is:            Main.hs
+  main-is:          Main.hs
 
   -- Test dependencies.
   build-depends:
-    , aeson
-    , anti
     , base
-    , base16-bytestring
     , bytestring
-    , canonical-json
-    , cardano-ledger-alonzo
-    , cardano-ledger-api
-    , cardano-ledger-babbage
-    , cardano-ledger-binary
-    , cardano-ledger-core
-    , cardano-strict-containers
-    , exceptions
     , github
     , hspec
-    , http-client
-    , http-client-tls
-    , lens
-    , plutus-tx
     , process
-    , servant-client
-    , text
-
-  build-tool-depends: hspec-discover:hspec-discover
 
 test-suite anti-unit-test
   -- Import common warning flags.
@@ -452,36 +430,52 @@ library test-lib
 
 test-suite anti-integration-test
   -- Import common warning flags.
-  import:             warnings
+  import:           warnings
 
   -- Base language which the package is written in.
-  default-language:   Haskell2010
+  default-language: Haskell2010
 
   -- Modules included in this executable, other than Main.
   other-modules:
+    Lib.Github.OracleValidationSpec
     Lib.GitHubSpec
+    MPFS.APISpec
 
   -- LANGUAGE extensions used by modules in this package.
   -- other-extensions:
 
   -- The interface type and version of the test suite.
-  type:               exitcode-stdio-1.0
+  type:             exitcode-stdio-1.0
 
   -- Directories containing source files.
-  hs-source-dirs:     test-integration
+  hs-source-dirs:   test-integration
 
   -- The entrypoint to the test suite.
-  main-is:            Main.hs
+  main-is:          Main.hs
 
   -- Test dependencies.
   build-depends:
+    , aeson
     , anti
     , base
+    , base16-bytestring
     , bytestring
+    , canonical-json
+    , cardano-ledger-alonzo
+    , cardano-ledger-api
+    , cardano-ledger-babbage
+    , cardano-ledger-binary
+    , cardano-ledger-core
+    , cardano-strict-containers
     , directory
-    , hspec
+    , exceptions
     , github
+    , hspec
+    , http-client
+    , http-client-tls
+    , lens
     , path
+    , plutus-tx
+    , servant-client
     , temporary
-
-  build-tool-depends: hspec-discover:hspec-discover
+    , text

cli/src/Lib/GitHub.hs

@@ -52,16 +52,17 @@ import Path
     , File
     , Path
     , Rel
-
+    , parent
+    , parseRelDir
     , parseRelFile
     , toFilePath
-    , (</>), parseRelDir, parent
+    , (</>)
     )
 import Streaming
 import Streaming.Prelude (yield)
 import Streaming.Prelude qualified as S
-import Text.JSON.Canonical
 import System.Directory (createDirectoryIfMissing)
+import Text.JSON.Canonical
 
 data GithubResponseError
     = GithubResponseErrorRepositoryNotFound

cli/test-E2E/Main.hs

@@ -1,24 +1,13 @@
 import Data.ByteString.Char8 qualified as BC
 import E2ESpec (e2eSpec)
 import GitHub (Auth (..))
-import Lib.Github.OracleValidationSpec
-    ( existenceSpec
-    , roleSpecs
-    , userSpec
-    )
-import MPFS.APISpec (mpfsAPISpec)
 import System.Environment (lookupEnv)
 import Test.Hspec (beforeAll, hspec)
 
 main :: IO ()
 main = hspec $ do
-    beforeAll getPAT $ do
-        existenceSpec
-        roleSpecs
     beforeAll getPAT $ do
         e2eSpec
-        mpfsAPISpec
-    userSpec
 
 tryGetPAT :: IO (Maybe Auth)
 tryGetPAT = fmap (OAuth . BC.pack) <$> lookupEnv "ANTI_GITHUB_PAT"

cli/test-integration/Lib/GitHubSpec.hs

@@ -1,37 +1,30 @@
 {-# LANGUAGE TemplateHaskell #-}
 
-module Lib.GitHubSpec (spec) where
+module Lib.GitHubSpec (githubSpec) where
 
-import Control.Monad (void)
 import Core.Types.Basic (Commit (..), Repository (..))
-import Data.ByteString.Char8 qualified as BC
-import GitHub (Auth (OAuth))
+import GitHub (Auth)
 import Lib.GitHub (copyGithubDirectory)
 import Path
-    ( Dir,
-      Path,
-      parseAbsDir,
-      toFilePath,
-      (</>),
-      mkRelDir,
-      mkRelFile,
-      parseRelFile,
-      File,
-      Rel )
+    ( Dir
+    , File
+    , Path
+    , Rel
+    , mkRelDir
+    , mkRelFile
+    , parseAbsDir
+    , toFilePath
+    , (</>)
+    )
 import System.Directory (doesFileExist)
-import System.Environment (getEnv)
 import System.IO.Temp (withSystemTempDirectory)
 import Test.Hspec
-    ( Spec
-    , beforeAll
+    ( SpecWith
     , describe
     , it
     , shouldReturn
     )
 
-boot :: IO Auth
-boot = OAuth . BC.pack <$> getEnv "ANTI_GITHUB_PAT"
-
 repo :: Repository
 repo =
     Repository
@@ -54,26 +47,20 @@ dockerComposePath = $(mkRelFile "docker-compose.yaml")
 testnetPath :: Path Rel File
 testnetPath = $(mkRelFile "testnet.yaml")
 
-spec :: Spec
-spec = do
-    describe "Path lib" $ do
-        it "parses relative directory" $ do
-            void $ parseRelFile @IO "antithesis-test/somefile.txt"
-    beforeAll boot $ do
-        describe "Lib.GitHub" $ do
-            it "downloads a directory" $ \pat ->
-                withSystemTempDirectory "github-test" $ \targetPath -> do
-                    targetDir <- parseAbsDir targetPath
-                    copyGithubDirectory pat repo commit srcPath targetDir
-                        `shouldReturn` Right ()
-                    let readmeAbsPath = targetDir </> srcPath </> readmePath
-                    print $ "Checking for file: " ++ toFilePath readmeAbsPath
-                    doesFileExist (toFilePath readmeAbsPath) `shouldReturn` True
-                    let dockerComposeAbsPath =
-                            targetDir
-                                </> srcPath
-                                </> dockerComposePath
-                    doesFileExist (toFilePath dockerComposeAbsPath)
-                        `shouldReturn` True
-                    let testnetAbsPath = targetDir </> srcPath </> testnetPath
-                    doesFileExist (toFilePath testnetAbsPath) `shouldReturn` True
+githubSpec :: SpecWith Auth
+githubSpec = describe "Lib.GitHub" $ do
+    it "downloads a directory" $ \pat ->
+        withSystemTempDirectory "github-test" $ \targetPath -> do
+            targetDir <- parseAbsDir targetPath
+            copyGithubDirectory pat repo commit srcPath targetDir
+                `shouldReturn` Right ()
+            let readmeAbsPath = targetDir </> srcPath </> readmePath
+            doesFileExist (toFilePath readmeAbsPath) `shouldReturn` True
+            let dockerComposeAbsPath =
+                    targetDir
+                        </> srcPath
+                        </> dockerComposePath
+            doesFileExist (toFilePath dockerComposeAbsPath)
+                `shouldReturn` True
+            let testnetAbsPath = targetDir </> srcPath </> testnetPath
+            doesFileExist (toFilePath testnetAbsPath) `shouldReturn` True

cli/test-E2E/Lib/Github/OracleValidationSpec.hs renamed to cli/test-integration/Lib/Github/OracleValidationSpec.hs

@@ -1 +1,34 @@
- {-# OPTIONS_GHC -F -pgmF hspec-discover #-}
+import Data.ByteString.Char8 qualified as BC
+import GitHub (Auth (..))
+import Lib.GitHubSpec (githubSpec)
+import Lib.Github.OracleValidationSpec
+    ( existenceSpec
+    , roleSpecs
+    , userSpec
+    )
+import MPFS.APISpec (mpfsAPISpec)
+import System.Environment (lookupEnv)
+import Test.Hspec (beforeAll, hspec)
+
+main :: IO ()
+main = hspec $ do
+    beforeAll getPAT $ do
+        githubSpec
+        existenceSpec
+        roleSpecs
+        mpfsAPISpec
+    userSpec
+
+tryGetPAT :: IO (Maybe Auth)
+tryGetPAT = fmap (OAuth . BC.pack) <$> lookupEnv "ANTI_GITHUB_PAT"
+
+getPAT :: IO Auth
+getPAT = do
+    mpat <- tryGetPAT
+    case mpat of
+        Just pat -> return pat
+        Nothing ->
+            error
+                "Environment variable ANTI_GITHUB_PAT is not set. \
+                \ Please set it to some valid GitHub Personal Access Token with \
+                \ read access to public repositories."