seihou-cli-0.5.0.0: test/Seihou/CLI/UpdateE2ESpec.hs
module Seihou.CLI.UpdateE2ESpec (tests) where
import Data.ByteString.Lazy qualified as LBS
import Data.Text qualified as T
import Data.Text.IO qualified as TIO
import Seihou.CLI.UpdateSpec (UpdateFixture (..), prepareUpdateFixture)
import System.Directory (doesFileExist)
import System.Environment (getEnvironment, getExecutablePath)
import System.Exit (ExitCode (..))
import System.FilePath (takeDirectory, (</>))
import System.IO.Temp (withSystemTempDirectory)
import System.Process (CreateProcess (..), callProcess, proc, readCreateProcessWithExitCode, readProcess)
import Test.Hspec
import Test.Tasty
import Test.Tasty.Hspec (testSpec)
tests :: IO TestTree
tests = testSpec "Update end-to-end" spec
spec :: Spec
spec = do
it "updates through the executable and preserves a non-overlapping user edit" $
withSystemTempDirectory "seihou-update-executable" $ \root -> do
fixture <- prepareUpdateFixture root
binary <- seihouBinary
TIO.writeFile fixture.projectFile "hello accepted by-user\nkeep\nv1\n"
(exitCode, stdoutText, stderrText) <- runSeihou binary fixture ["update", "demo", "--json"]
case exitCode of
ExitSuccess -> pure ()
ExitFailure code -> expectationFailure ("update exited " <> show code <> "\nstdout:\n" <> T.unpack stdoutText <> "\nstderr:\n" <> T.unpack stderrText)
stdoutText `shouldSatisfy` T.isInfixOf "\"outcome\":\"applied\""
stdoutText `shouldSatisfy` T.isInfixOf "\"skippedUnchanged\":1"
stdoutText `shouldNotSatisfy` T.isInfixOf "Apply?"
stderrText `shouldNotSatisfy` T.isInfixOf "Apply?"
TIO.readFile fixture.projectFile `shouldReturn` "hello accepted by-user\nkeep\nv2\n"
TIO.readFile (fixture.installedModule <> "/module.dhall")
`shouldReturnSatisfy` T.isInfixOf "Some \"2.0.0\""
doesFileExist (fixture.projectRoot <> "/command.log") `shouldReturn` False
(statusExit, statusOut, _) <- runSeihou binary fixture ["status"]
statusExit `shouldBe` ExitSuccess
statusOut `shouldNotSatisfy` T.isInfixOf "seihou update demo"
afterApply <- LBS.readFile fixture.manifestPath
(noOpExit, noOpOut, noOpErr) <- runSeihou binary fixture ["update", "demo", "--json"]
noOpExit `shouldBe` ExitSuccess
noOpOut `shouldSatisfy` T.isInfixOf "\"alreadyUpToDate\":true"
noOpOut `shouldSatisfy` T.isInfixOf "\"outcome\":\"plan\""
noOpErr `shouldNotSatisfy` T.isInfixOf "Apply?"
LBS.readFile fixture.manifestPath `shouldReturn` afterApply
it "keeps project, manifest, and installed cache byte-identical for JSON dry-run" $
withSystemTempDirectory "seihou-update-executable-dry" $ \root -> do
fixture <- prepareUpdateFixture root
binary <- seihouBinary
beforeProject <- TIO.readFile fixture.projectFile
beforeManifest <- LBS.readFile fixture.manifestPath
beforeInstalled <- TIO.readFile (fixture.installedModule <> "/module.dhall")
(exitCode, stdoutText, _) <- runSeihou binary fixture ["update", "--dry-run", "--json"]
exitCode `shouldBe` ExitSuccess
stdoutText `shouldSatisfy` T.isInfixOf "\"outcome\":\"plan\""
TIO.readFile fixture.projectFile `shouldReturn` beforeProject
LBS.readFile fixture.manifestPath `shouldReturn` beforeManifest
TIO.readFile (fixture.installedModule <> "/module.dhall") `shouldReturn` beforeInstalled
it "commits exactly the managed update paths with a requested Conventional Commit message" $
withSystemTempDirectory "seihou-update-executable-commit" $ \root -> do
fixture <- prepareUpdateFixture root
binary <- seihouBinary
callProcess "git" ["-C", fixture.projectRoot, "init", "-q"]
callProcess "git" ["-C", fixture.projectRoot, "config", "user.name", "Seihou Test"]
callProcess "git" ["-C", fixture.projectRoot, "config", "user.email", "test@example.com"]
callProcess "git" ["-C", fixture.projectRoot, "add", "."]
callProcess "git" ["-C", fixture.projectRoot, "commit", "-qm", "test: record v1 fixture"]
(exitCode, stdoutText, stderrText) <-
runSeihou
binary
fixture
["update", "demo", "--json", "--commit-message", "chore(seihou): update demo"]
case exitCode of
ExitSuccess -> pure ()
ExitFailure code -> expectationFailure ("update exited " <> show code <> "\nstdout:\n" <> T.unpack stdoutText <> "\nstderr:\n" <> T.unpack stderrText)
subject <- T.strip . T.pack <$> readProcess "git" ["-C", fixture.projectRoot, "log", "-1", "--pretty=%s"] ""
subject `shouldBe` "chore(seihou): update demo"
worktree <- T.strip . T.pack <$> readProcess "git" ["-C", fixture.projectRoot, "status", "--porcelain"] ""
worktree `shouldBe` ""
it "retains an edited orphan under --force" $
withSystemTempDirectory "seihou-update-executable-orphan" $ \root -> do
fixture <- prepareUpdateFixture root
binary <- seihouBinary
let modulePath = fixture.remote <> "/module.dhall"
moduleBody <- TIO.readFile modulePath
TIO.writeFile
modulePath
( T.replace
", steps = [{ strategy = \"template\", src = \"README.tmpl\", dest = \"README.md\", when = None Text, patch = None Text }]"
", steps = [] : List { strategy : Text, src : Text, dest : Text, when : Optional Text, patch : Optional Text }"
moduleBody
)
callProcess "git" ["-C", fixture.remote, "add", "module.dhall"]
callProcess "git" ["-C", fixture.remote, "-c", "user.name=Seihou Test", "-c", "user.email=test@example.com", "commit", "-qm", "remove generated file"]
TIO.writeFile fixture.projectFile "user-owned orphan\n"
(exitCode, stdoutText, stderrText) <- runSeihou binary fixture ["update", "demo", "--force", "--json"]
case exitCode of
ExitSuccess -> pure ()
ExitFailure code -> expectationFailure ("update exited " <> show code <> "\nstdout:\n" <> T.unpack stdoutText <> "\nstderr:\n" <> T.unpack stderrText)
stdoutText `shouldSatisfy` T.isInfixOf "\"editedOrphans\":1"
TIO.readFile fixture.projectFile `shouldReturn` "user-owned orphan\n"
TIO.readFile fixture.manifestPath `shouldReturnSatisfy` T.isInfixOf "README.md"
it "reports an unresolved overlap before publishing project, manifest, or cache state" $
withSystemTempDirectory "seihou-update-executable-conflict" $ \root -> do
fixture <- prepareUpdateFixture root
binary <- seihouBinary
TIO.writeFile (fixture.remote <> "/files/README.tmpl") "candidate {{project.name}}\nkeep\nv2\n"
callProcess "git" ["-C", fixture.remote, "add", "files/README.tmpl"]
callProcess "git" ["-C", fixture.remote, "-c", "user.name=Seihou Test", "-c", "user.email=test@example.com", "commit", "-qm", "overlap"]
TIO.writeFile fixture.projectFile "user accepted\nkeep\nv1\n"
beforeManifest <- LBS.readFile fixture.manifestPath
beforeInstalled <- LBS.readFile (fixture.installedModule <> "/module.dhall")
(exitCode, stdoutText, _) <- runSeihou binary fixture ["update", "demo", "--json"]
exitCode `shouldSatisfy` (/= ExitSuccess)
stdoutText `shouldSatisfy` T.isInfixOf "\"code\":\"unresolved_conflicts\""
TIO.readFile fixture.projectFile `shouldReturn` "user accepted\nkeep\nv1\n"
LBS.readFile fixture.manifestPath `shouldReturn` beforeManifest
LBS.readFile (fixture.installedModule <> "/module.dhall") `shouldReturn` beforeInstalled
(forceExit, forceOut, forceErr) <- runSeihou binary fixture ["update", "demo", "--force", "--json"]
case forceExit of
ExitSuccess -> pure ()
ExitFailure code -> expectationFailure ("forced update exited " <> show code <> "\nstdout:\n" <> T.unpack forceOut <> "\nstderr:\n" <> T.unpack forceErr)
forceOut `shouldSatisfy` T.isInfixOf "\"outcome\":\"applied\""
TIO.readFile fixture.projectFile `shouldReturn` "candidate accepted\nkeep\nv2\n"
it "exposes update and its options through the shared Bash, Zsh, and Fish completion protocol" $ do
binary <- seihouBinary
(topExit, topOutput, _) <- runProcessText binary ["--bash-completion-enriched", "--bash-completion-index", "0"] Nothing Nothing
topExit `shouldBe` ExitSuccess
topOutput `shouldSatisfy` T.isInfixOf "update\tUpdate recorded project applications"
(optionExit, optionOutput, _) <-
runProcessText
binary
[ "--bash-completion-enriched",
"--bash-completion-index",
"2",
"--bash-completion-word",
"seihou",
"--bash-completion-word",
"update"
]
Nothing
Nothing
optionExit `shouldBe` ExitSuccess
optionOutput `shouldSatisfy` T.isInfixOf "--force\tUse generated content"
(exclusiveExit, _, exclusiveErr) <-
runProcessText binary ["update", "--run-all-commands", "--no-commands"] Nothing Nothing
exclusiveExit `shouldSatisfy` (/= ExitSuccess)
exclusiveErr `shouldSatisfy` T.isInfixOf "Invalid option"
mapM_
( \shell -> do
(shellExit, script, _) <- runProcessText binary ["completions", shell] Nothing Nothing
shellExit `shouldBe` ExitSuccess
script `shouldSatisfy` T.isInfixOf "bash-completion"
)
["bash", "zsh", "fish"]
seihouBinary :: IO FilePath
seihouBinary = do
testBinary <- getExecutablePath
pure (takeDirectory (takeDirectory testBinary) </> "seihou" </> "seihou")
runSeihou :: FilePath -> UpdateFixture -> [String] -> IO (ExitCode, T.Text, T.Text)
runSeihou binary fixture args = do
inherited <- getEnvironment
let environment = ("XDG_CONFIG_HOME", fixture.xdgHome) : filter ((/= "XDG_CONFIG_HOME") . fst) inherited
runProcessText binary args (Just fixture.projectRoot) (Just environment)
runProcessText binary args workingDirectory environment = do
let command = (proc binary args) {cwd = workingDirectory, env = environment}
(exitCode, stdoutText, stderrText) <- readCreateProcessWithExitCode command ""
pure (exitCode, T.pack stdoutText, T.pack stderrText)
shouldReturnSatisfy :: IO T.Text -> (T.Text -> Bool) -> Expectation
shouldReturnSatisfy action predicate = action >>= (`shouldSatisfy` predicate)