Skip to content

Commit

Permalink
Separate Check and Run phases of strace test to make sure output is a…
Browse files Browse the repository at this point in the history 
…ll there (#179)

Previously strace's output might not have been fully flushed, and the test
would intermittently fail
  • Loading branch information
@mzabani
mzabani authored Feb 29, 2024
1 parent 4ac1768 commit 7fe8da5
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 84 deletions.
6 changes: 4 additions & 2 deletions Runfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,9 @@ test-system-resources:

if [ -n "$NIX" ]; then
nix build ".#x86_64-unknown-linux-musl:codd:test:codd-test" -o local/codd-test
nix develop ".#testShells.x86_64-linux.pg16" -i -c run test-with-db-internal --strace --nix -- --match "/SystemResourcesSpecs/"
nix develop ".#testShells.x86_64-linux.pg16" -i -c run test-with-db-internal --strace --nix -- --match "/SystemResourcesSpecs/RUNNING"
nix develop ".#testShells.x86_64-linux.pg16" -i -c run test-with-db-internal --nix -- --match "/SystemResourcesSpecs/CHECKING"
else
nix develop ".#testShells.x86_64-linux.pg16" -c run test-with-db-internal --strace -- --match "/SystemResourcesSpecs/"
nix develop ".#testShells.x86_64-linux.pg16" -c run test-with-db-internal --strace -- --match "/SystemResourcesSpecs/RUNNING"
nix develop ".#testShells.x86_64-linux.pg16" -c run test-with-db-internal -- --match "/SystemResourcesSpecs/CHECKING"
fi
164 changes: 82 additions & 82 deletions test/SystemResourcesSpecs/OpenFilesSpec.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import Codd ( VerifySchemas(..)
)
import Codd.Environment ( CoddSettings(..) )
import Control.Applicative ( (<|>) )
import Control.Concurrent ( threadDelay )
import Control.Monad ( foldM
, forM_
, void
Expand All @@ -30,92 +29,93 @@ import UnliftIO ( SomeException
spec :: Spec
spec = do
describe "SystemResourcesSpecs" $ do
describe "Open files limit" $ aroundFreshDatabase $ do
it
"At most one .sql migration file and one on-disk representation file open at a time"
$ \emptyTestDbInfo -> do
void @IO $ runStdoutLoggingT $ applyMigrations
emptyTestDbInfo
{ sqlMigrations =
["test/migrations/open-files-limit/"]
, onDiskReps = Left "./expected-schema"
}
Nothing
testConnTimeout
LaxCheck -- This will output an error but will not throw. What matters is that on-disk reps are read
-- This test must run wrapped in a specific strace incantation as it'll read the output log of that
-- to assert that at most one migration file is opened at a time
-- It seems it's possible for the writes of strace to not have been flushed yet, so wait a second just in case.
threadDelay 1_000_000
contentsE <-
try $ Text.readFile
"/tmp/strace-codd-system-resources-test.log"
case contentsE of
Left (ex :: SomeException) -> do
putStrLn
"Error reading /tmp/strace-codd-system-resources-test.log. Are you running this with the runfile target or are you running this test directly? This test needs to run under a very specific `strace` command that you'll find in our Runfile test targets, or it doesn't work."
throwM ex
Right contents -> do
let
openAndCloseLines =
filter
(\l ->
-- We test both migrations and on-disk representations
"migrations/open-files-limit"
`Text.isInfixOf` l
|| "expected-schema/"
`Text.isInfixOf` l
|| "close("
`Text.isInfixOf` l
)
$ Text.lines contents
-- forM_ (Text.lines contents) Text.putStrLn
(openFilesAtEnd, atLeastOneMigrationWasOpened) <-
foldM
(\(openFiles, atLeastOneMig) line -> do
case P.parseOnly openParser line of
Right (fp, fd) ->
if Map.size openFiles > 0
then do
putStrLn
"More than one simultaneously open migration or on-disk representation! Here's the strace log:"
forM_
openAndCloseLines
Text.putStrLn
aroundFreshDatabase
$ it
"RUNNING - At most one .sql migration file and one on-disk representation file open at a time"
$ \emptyTestDbInfo -> do
void @IO $ runStdoutLoggingT $ applyMigrations
emptyTestDbInfo
{ sqlMigrations =
["test/migrations/open-files-limit/"]
, onDiskReps = Left "./expected-schema"
}
Nothing
testConnTimeout
LaxCheck -- This will output an error but will not throw. What matters is that on-disk reps are read
-- This test must run wrapped in a specific strace incantation as it'll read the output log of that
-- to assert that at most one migration file is opened at a time

it
"CHECKING - At most one .sql migration file and one on-disk representation file open at a time"
$ do
contentsE <-
try $ Text.readFile
"/tmp/strace-codd-system-resources-test.log"
case contentsE of
Left (ex :: SomeException) -> do
putStrLn
"Error reading /tmp/strace-codd-system-resources-test.log. Are you running this with the runfile target or are you running this test directly? This test needs to run after a very specific `strace` wrapped command that you'll find in our Runfile test targets, or it doesn't work."
throwM ex
Right contents -> do
let openAndCloseLines =
filter
(\l ->
-- We test both migrations and on-disk representations
"migrations/open-files-limit"
`Text.isInfixOf` l
|| "expected-schema/"
`Text.isInfixOf` l
|| "close("
`Text.isInfixOf` l
)
$ Text.lines contents
-- forM_ (Text.lines contents) Text.putStrLn
(openFilesAtEnd, atLeastOneMigrationWasOpened) <-
foldM
(\(openFiles, atLeastOneMig) line -> do
case P.parseOnly openParser line of
Right (fp, fd) ->
if Map.size openFiles > 0
then do
putStrLn
"More than one simultaneously open migration or on-disk representation! Here's the strace log:"
forM_
openAndCloseLines
Text.putStrLn
error
"More than one file open simultaneously. Test failed."
else do
pure
( Map.insert
fd
fp
openFiles
, True
)
Left _ -> do
case
P.parseOnly
closeParser
line
of
Left e ->
error
"More than one file open simultaneously. Test failed."
else do
$ "Found strace line that could not be parsed due to '"
++ show e
++ "': "
++ show line
Right fd ->
pure
( Map.insert
( Map.delete
fd
fp
openFiles
, True
, atLeastOneMig
)
Left _ -> do
case
P.parseOnly
closeParser
line
of
Left e ->
error
$ "Found strace line that could not be parsed due to '"
++ show e
++ "': "
++ show line
Right fd ->
pure
( Map.delete
fd
openFiles
, atLeastOneMig
)
)
(Map.empty :: Map.Map Int FilePath, False)
openAndCloseLines
openFilesAtEnd `shouldBe` Map.empty
atLeastOneMigrationWasOpened `shouldBe` True -- Otherwise we might be stracing different processes. This is a good sanity check.
)
(Map.empty :: Map.Map Int FilePath, False)
openAndCloseLines
openFilesAtEnd `shouldBe` Map.empty
atLeastOneMigrationWasOpened `shouldBe` True -- Otherwise we might be stracing different processes. This is a good sanity check.

-- | Parses both glibc's `openat` and musl's `open` syscalls from a `strace -f -o` output line and returns the opened file and file descriptor.
openParser :: P.Parser (FilePath, Int)
Expand Down

0 comments on commit 7fe8da5

Please sign in to comment.