diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog for `tasty-process` + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to the +[Haskell Package Versioning Policy](https://pvp.haskell.org/). + +## 0.1.0.0 - 2024-03-14 + +- First version. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# tasty-process + +`tasty-process` is a library for running integration tests with the [Tasty](https://github.com/UnkindPartition/tasty) testing framework. + +Features: + +- Run an external process as a test case +- Supply input to `stdin` +- Test the process' `exitcode`, `stdout` and `stderr` +- Set timeout for the running process using Tasty's `Timeout` option +- Automatic clean up the process after the test + +## Example + +Here is an example Echo program that reads from `stdin` and echos back to `stdout`. + +```hs +module Main (main) where + +main :: IO () +main = getLine >>= putStr +``` + +And here is a test case for the Echo program using `tasty-process`. + +```hs +import System.Exit (ExitCode (..)) +import Test.Tasty (TestTree) +import Test.Tasty.Process + +echoTest :: TestTree +echoTest = + setTimeout (1000000) $ -- set timeout to 1 second + processTest + "Echo test" -- test name + TestProcess + { process = + (proc "echo-test" []) -- process to launch with a list of arguments + , input = "Echo!" -- input to stdin + , exitCodeCheck = equals ExitSuccess -- check exit code + , stdoutCheck = equals "Echo!" -- check stdout + , stderrCheck = equals "" -- check stderr + } + +``` + +## Documentation + +See the [Hackage page](https://hackage.haskell.org/package/tasty-process) for detailed API documentation. + +## GHC Compatibility + +`tasty-process` is tested with GHC version >= 8.6 diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,3 @@ +import Distribution.Simple + +main = defaultMain diff --git a/src/Test/Tasty/Process.hs b/src/Test/Tasty/Process.hs new file mode 100644 --- /dev/null +++ b/src/Test/Tasty/Process.hs @@ -0,0 +1,232 @@ +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE UndecidableInstances #-} + +module Test.Tasty.Process + ( processTest + , TestProcess (..) + , proc + , shell + , defaultProcess + , ExitCodeCheck + , OutputCheck + , equals + , ignored + , setTimeout + ) +where + +import Control.DeepSeq (deepseq) +import Data.Foldable (for_) +import Data.Maybe (fromMaybe) +import GHC.IO.Handle (Handle, hClose, hFlush, hPutStr) +import System.Exit (ExitCode) +import System.IO (hGetContents) +import System.Process + ( CmdSpec (..) + , CreateProcess (..) + , ProcessHandle + , StdStream (..) + , cleanupProcess + , createProcess + , waitForProcess + ) +import qualified System.Process as P (proc, shell) +import Test.Tasty (TestName, TestTree, localOption, mkTimeout, withResource) +import Test.Tasty.Providers + ( IsTest (..) + , Result + , singleTest + , testFailed + , testPassed + ) + +{- | Create a 'TestTree' from a 'TestProcess'. Here is an example of how to use +the function to create a test. + +@ +exampleTest :: TestTree +exampleTest = + setTimeout (1000000) $ + processTest + "Simple test" + TestProcess + { process = + (proc "test-executable-simple" []) + , input = Nothing + , exitCodeCheck = equals ExitSuccess + , stdoutCheck = equals "Hello, world!\n" + , stderrCheck = equals "" + } +@ +-} +processTest + :: TestName + -> TestProcess + -> TestTree +processTest + testName + tp@TestProcess {process} = + withResource + (createProcess process) + cleanupProcess + (\io -> singleTest testName (tp, io)) + +{- | 'ExitCodeCheck' represents a function that given the 'ExitCode' of a process, +returns '()' if the exit code is expected, or a reason otherwise. +-} +type ExitCodeCheck = ExitCode -> Either String () + +{- | 'OutputCheck' represents a function that given the output of a process, +returns '()' if the output is expected, or a reason otherwise. +-} +type OutputCheck = String -> Either String () + +-- | 'TestProcess' is a data type that represents a process to be tested. +data TestProcess = TestProcess + { process :: CreateProcess + -- ^ The process to be tested. + , input :: Maybe String + -- ^ The input to be sent to the process. If 'Nothing', no input will be sent. + , exitCodeCheck :: ExitCodeCheck + -- ^ The check to be performed on the exit code of the process. + , stdoutCheck :: OutputCheck + -- ^ The check to be performed on the @stdout@ of the process. + , stderrCheck :: OutputCheck + -- ^ The check to be performed on the @stderr@ of the process. + } + +-- | The template process configuration. +defaultProcess :: TestProcess +defaultProcess = + TestProcess + { process = undefined + , input = Nothing + , exitCodeCheck = ignored + , stdoutCheck = ignored + , stderrCheck = ignored + } + +instance + IsTest + (TestProcess, IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)) + where + run _ (tp, io) _ = runTestProcess tp io + + testOptions = return [] + +runTestProcess + :: TestProcess + -> IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle) + -> IO Result +runTestProcess + TestProcess + { process + , input + , exitCodeCheck + , stdoutCheck + , stderrCheck + } + io = do + (mbStdinH, mbStdoutH, mbStderrH, ph) <- io + -- Send input to the process. + for_ input $ \i -> do + mapM_ (`hPutStr` i) mbStdinH + mapM_ hFlush mbStdinH + mapM_ hClose mbStdinH + -- Wait for the process to finish and get the exit code, stdout and stderr. + stdout :: String <- fromMaybe "" <$> mapM hGetContents mbStdoutH + stderr :: String <- fromMaybe "" <$> mapM hGetContents mbStderrH + exitCode :: ExitCode <- stderr `deepseq` stdout `deepseq` waitForProcess ph + -- Check the exit code, stdout and stderr. + let exitFailure' = exitFailure process exitCode stderr stdout + let exitCodeCheckResult = exitCodeCheck exitCode + let stderrCheckResult = stderrCheck stderr + let stdoutCheckResult = stdoutCheck stdout + let handleNotes = + printHandleNote mbStdinH "stdin" + ++ printHandleNote mbStdoutH "stdout" + ++ printHandleNote mbStderrH "stderr" + let res + | Left reason <- exitCodeCheckResult = + exitFailure' ("ExitCode check failed.\n" ++ reason ++ handleNotes) + | Left reason <- stdoutCheckResult = + exitFailure' ("Stdout check failed.\n" ++ reason ++ handleNotes) + | Left reason <- stderrCheckResult = + exitFailure' ("Stderr check failed.\n" ++ reason ++ handleNotes) + | otherwise = testPassed "" + return res + +printHandleNote :: Maybe a -> String -> String +printHandleNote (Just _) _ = "" +printHandleNote Nothing hName = + hName + ++ " was not captured because it is not set to `CreatePipe` in `CreateProcess`.\n" + +exitFailure + :: CreateProcess -> ExitCode -> String -> String -> String -> Result +exitFailure CreateProcess {cmdspec} code stderr stdout reason = + testFailed $ + unlines + [ printCmdSpec cmdspec ++ " exited with code " ++ show code + , "" + , if null stdout + then "Nothing was printed to stdout." + else "stdout contained:\n" ++ stdout + , "" + , if null stderr + then "Nothing was printed to stderr." + else "stderr contained:\n" ++ stderr + , "" + , reason + ] + +printCmdSpec :: CmdSpec -> String +printCmdSpec (ShellCommand x) = x +printCmdSpec (RawCommand x y) = unwords (x : y) + +-- | Set the timeout (in microseconds) for a 'TestTree'. +setTimeout :: Integer -> TestTree -> TestTree +setTimeout = localOption . mkTimeout + +{- | A helper function for creating equality checks. + +>>> equals "str" "str" +Right () + +>>> equals ExitSuccess ExitSuccess +Right () + +>>> equals "expected value" "actual value" +Left "expected : \"expected value\"\nactual : \"actual value\"\n" +-} +equals :: (Show a, Eq a) => a -> a -> Either String () +equals expected actual + | expected == actual = Right () + | otherwise = + Left $ "expected : " ++ show expected ++ "\nactual : " ++ show actual ++ "\n" + +{- | A helper function to ignore checks. + +>>> ignored "any value" +Right () +-} +ignored :: a -> Either String () +ignored _ = Right () + +{- | Re-export of 'proc' from "System.Process" with correct default values. + +Construct a `CreateProcess` record for passing to `createProcess`, representing a command to be passed to the shell. +-} +proc :: FilePath -> [String] -> CreateProcess +proc x y = + (P.proc x y) {std_out = CreatePipe, std_err = CreatePipe, std_in = CreatePipe} + +{- | Re-export of 'shell' from "System.Process" with correct default values. + +Construct a `CreateProcess` record for passing to `createProcess`, representing a raw command with arguments. +See `RawCommand` for precise semantics of the specified `FilePath`. +-} +shell :: String -> CreateProcess +shell x = (P.shell x) {std_out = CreatePipe, std_err = CreatePipe, std_in = CreatePipe} diff --git a/tasty-process.cabal b/tasty-process.cabal new file mode 100644 --- /dev/null +++ b/tasty-process.cabal @@ -0,0 +1,125 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.36.0. +-- +-- see: https://github.com/sol/hpack + +name: tasty-process +version: 0.1.0.0 +synopsis: Test execution of external processes with Tasty +description: Please see the README on GitHub at +category: Testing +homepage: https://github.com/HEIGE-PCloud/tasty-process#readme +bug-reports: https://github.com/HEIGE-PCloud/tasty-process/issues +author: PCloud +maintainer: heige.pcloud@outlook.com +copyright: (c) 2024 PCloud +license: GPL-2 +license-file: LICENSE +build-type: Simple +extra-source-files: + README.md + CHANGELOG.md + +source-repository head + type: git + location: https://github.com/HEIGE-PCloud/tasty-process + +library + exposed-modules: + Test.Tasty.Process + other-modules: + Paths_tasty_process + hs-source-dirs: + src + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints + build-depends: + async >=2.2.5 && <2.3 + , base >=4.7 && <5 + , deepseq >=1.4.8 && <1.5 + , process >=1.6.18 && <1.7 + , tasty >=1.4 && <1.6 + default-language: Haskell2010 + +executable test-executable-echo + main-is: Main.hs + other-modules: + Paths_tasty_process + hs-source-dirs: + test/executables/echo + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + async >=2.2.5 && <2.3 + , base >=4.7 && <5 + , deepseq >=1.4.8 && <1.5 + , process >=1.6.18 && <1.7 + , tasty >=1.4 && <1.6 + , tasty-process + default-language: Haskell2010 + +executable test-executable-exitcode + main-is: Main.hs + other-modules: + Paths_tasty_process + hs-source-dirs: + test/executables/exitcode + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + async >=2.2.5 && <2.3 + , base >=4.7 && <5 + , deepseq >=1.4.8 && <1.5 + , process >=1.6.18 && <1.7 + , tasty >=1.4 && <1.6 + , tasty-process + default-language: Haskell2010 + +executable test-executable-simple + main-is: Main.hs + other-modules: + Paths_tasty_process + hs-source-dirs: + test/executables/simple + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + async >=2.2.5 && <2.3 + , base >=4.7 && <5 + , deepseq >=1.4.8 && <1.5 + , process >=1.6.18 && <1.7 + , tasty >=1.4 && <1.6 + , tasty-process + default-language: Haskell2010 + +executable test-executable-sleep + main-is: Main.hs + other-modules: + Paths_tasty_process + hs-source-dirs: + test/executables/sleep + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + async >=2.2.5 && <2.3 + , base >=4.7 && <5 + , deepseq >=1.4.8 && <1.5 + , process >=1.6.18 && <1.7 + , tasty >=1.4 && <1.6 + , tasty-process + default-language: Haskell2010 + +test-suite tasty-process-test + type: exitcode-stdio-1.0 + main-is: Main.hs + other-modules: + Test + Paths_tasty_process + hs-source-dirs: + test + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + async >=2.2.5 && <2.3 + , base >=4.7 && <5 + , deepseq >=1.4.8 && <1.5 + , process >=1.6.18 && <1.7 + , tasty >=1.4 && <1.6 + , tasty-expected-failure + , tasty-process + default-language: Haskell2010 diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,5 @@ +import Test (allTests) +import Test.Tasty (defaultMain) + +main :: IO () +main = defaultMain allTests diff --git a/test/Test.hs b/test/Test.hs new file mode 100644 --- /dev/null +++ b/test/Test.hs @@ -0,0 +1,82 @@ +module Test (allTests) where + +import System.Exit (ExitCode (ExitFailure)) +import Test.Tasty (TestTree, testGroup) +import Test.Tasty.ExpectedFailure (expectFailBecause) +import Test.Tasty.Process + +second :: Integer +second = 1000000 + +simpleTest :: TestTree +simpleTest = + setTimeout (1 * second) $ + processTest + "Simple test" + defaultProcess + { process = proc "test-executable-simple" [] + , stdoutCheck = equals "Hello, world!\n" + } + +echoTest :: TestTree +echoTest = + setTimeout (1 * second) $ + processTest + "Echo test" + defaultProcess + { process = proc "test-executable-echo" [] + , input = Just "Echo!" + , stdoutCheck = equals "Echo!" + } + +failedEchoTest :: TestTree +failedEchoTest = + expectFailBecause "Expected '!ochE', but get 'Echo!'" $ + processTest + "Failed echo test" + defaultProcess + { process = proc "test-executable-echo" [] + , input = Just "Echo!" + , stdoutCheck = equals "!ochE" + } + +exitCodeTest :: TestTree +exitCodeTest = + processTest + "Exit code test" + defaultProcess + { process = proc "test-executable-exitcode" [] + , exitCodeCheck = equals (ExitFailure 123) + } + +failedExitCodeTest :: TestTree +failedExitCodeTest = + expectFailBecause "Expected exit code 321, but get 123" $ + processTest + "Failed exit code test" + defaultProcess + { process = proc "test-executable-exitcode" [] + , exitCodeCheck = equals (ExitFailure 321) + } + +timeoutTest :: TestTree +timeoutTest = + expectFailBecause "Should timeout after 1s" $ + setTimeout (1 * second) $ + processTest + "Timeout test" + defaultProcess + { process = proc "test-executable-sleep" [] + } + +allTests :: TestTree +allTests = + testGroup + "Test" + [ simpleTest + , echoTest + , failedEchoTest + , exitCodeTest + , failedExitCodeTest + , timeoutTest + ] diff --git a/test/executables/echo/Main.hs b/test/executables/echo/Main.hs new file mode 100644 --- /dev/null +++ b/test/executables/echo/Main.hs @@ -0,0 +1,4 @@ +module Main (main) where + +main :: IO () +main = getLine >>= putStr diff --git a/test/executables/exitcode/Main.hs b/test/executables/exitcode/Main.hs new file mode 100644 --- /dev/null +++ b/test/executables/exitcode/Main.hs @@ -0,0 +1,6 @@ +module Main (main) where + +import System.Exit (ExitCode (ExitFailure), exitWith) + +main :: IO () +main = exitWith (ExitFailure 123) diff --git a/test/executables/simple/Main.hs b/test/executables/simple/Main.hs new file mode 100644 --- /dev/null +++ b/test/executables/simple/Main.hs @@ -0,0 +1,4 @@ +module Main (main) where + +main :: IO () +main = putStrLn "Hello, world!" diff --git a/test/executables/sleep/Main.hs b/test/executables/sleep/Main.hs new file mode 100644 --- /dev/null +++ b/test/executables/sleep/Main.hs @@ -0,0 +1,7 @@ +module Main (main) where + +import Control.Concurrent (threadDelay) + +-- | sleep for 10 seconds +main :: IO () +main = threadDelay $ 10 * 1000000