Add support for environment variables

spec/environment.yaml

@@ -0,0 +1,8 @@
+tests:
+  - name: shell
+    environment:
+      TEST_ENV: "test-value"
+    command: |
+      echo $TEST_ENV
+    stdout: |
+      test-value

src/lib/Test/Smoke/Assert.hs

@@ -23,7 +23,7 @@ assertResult location testPlan@TestPlan {planTest = test} (ExecutionSucceeded ac
   either (TestErrored test . AssertionError) (TestFinished testPlan) <$> runExceptT (processOutputs location testPlan actualOutputs)
 
 processOutputs :: Path Resolved Dir -> TestPlan -> ActualOutputs -> Asserting FinishedTest
-processOutputs location (TestPlan _ _ fallbackShell _ _ _ expectedStatus expectedStdOuts expectedStdErrs expectedFiles _) (ActualOutputs actualStatus actualStdOut actualStdErr actualFiles) = do
+processOutputs location (TestPlan _ _ fallbackShell _ _ _ _ expectedStatus expectedStdOuts expectedStdErrs expectedFiles _) (ActualOutputs actualStatus actualStdOut actualStdErr actualFiles) = do
   let statusResult = assertEqual expectedStatus actualStatus
   stdOutResult <- assertAll (defaultIfEmpty expectedStdOuts) actualStdOut
   stdErrResult <- assertAll (defaultIfEmpty expectedStdErrs) actualStdErr

src/lib/Test/Smoke/Executable.hs

@@ -1,6 +1,7 @@
 module Test.Smoke.Executable where
 
 import Control.Monad.Trans.Except (ExceptT)
+import Data.Map.Strict qualified as Map
 import Data.Text (Text)
 import Data.Text.IO qualified as Text.IO
 import Data.Vector qualified as Vector
@@ -17,19 +18,21 @@ runExecutable ::
   Executable ->
   Args ->
   StdIn ->
+  Maybe EnvVars ->
   Maybe WorkingDirectory ->
   IO (ExitCode, Text, Text)
-runExecutable (ExecutableProgram executablePath executableArgs) args (StdIn stdIn) workingDirectory =
+runExecutable (ExecutableProgram executablePath executableArgs) args (StdIn stdIn) env workingDirectory =
   readCreateProcessWithExitCode
     ( ( proc
           (toFilePath executablePath)
           (Vector.toList (unArgs (executableArgs <> args)))
       )
-        { cwd = toFilePath . unWorkingDirectory <$> workingDirectory
+        { cwd = toFilePath . unWorkingDirectory <$> workingDirectory,
+          env = fmap Map.toList (unEnvVars <$> env)
         }
     )
     stdIn
-runExecutable (ExecutableScript (Shell shellPath shellArgs) (Script script)) args stdIn workingDirectory =
+runExecutable (ExecutableScript (Shell shellPath shellArgs) (Script script)) args stdIn env workingDirectory =
   withSystemTempFile defaultShellScriptName $ \scriptPath scriptHandle -> do
     Text.IO.hPutStr scriptHandle script
     hClose scriptHandle
@@ -38,6 +41,7 @@ runExecutable (ExecutableScript (Shell shellPath shellArgs) (Script script)) arg
       (ExecutableProgram shellPath executableArgs)
       args
       stdIn
+      env
       workingDirectory
 
 convertCommandToExecutable ::

src/lib/Test/Smoke/Execution.hs

@@ -31,7 +31,7 @@ runTest location testPlan =
     else either ExecutionFailed ExecutionSucceeded <$> runExceptT (executeTest location testPlan)
 
 executeTest :: Path Resolved Dir -> TestPlan -> Execution ActualOutputs
-executeTest location (TestPlan _ workingDirectory _ executable args processStdIn _ _ _ files revert) = do
+executeTest location (TestPlan _ workingDirectory _ executable args env processStdIn _ _ _ files revert) = do
   let workingDirectoryFilePath =
         toFilePath $ unWorkingDirectory workingDirectory
   workingDirectoryExists <- liftIO $ doesDirectoryExist workingDirectoryFilePath
@@ -41,7 +41,7 @@ executeTest location (TestPlan _ workingDirectory _ executable args processStdIn
   revertingDirectories revert $ do
     (exitCode, processStdOut, processStdErr) <-
       tryIO (CouldNotExecuteCommand executable) $
-        runExecutable executable args processStdIn (Just workingDirectory)
+        runExecutable executable args processStdIn env (Just workingDirectory)
     actualFiles <- Map.fromList <$> mapM (liftIO . readTestFile) (Map.keys files)
     pure $ ActualOutputs (convertExitCode exitCode) (StdOut processStdOut) (StdErr processStdErr) actualFiles
   where

src/lib/Test/Smoke/Filters.hs

@@ -17,7 +17,7 @@ applyFilters fallbackShell (Filter command) value = do
     withExceptT (CouldNotExecuteFilter executable) $
       ExceptT $
         tryIOError $
-          runExecutable executable mempty (StdIn (serializeFixture value)) Nothing
+          runExecutable executable mempty (StdIn (serializeFixture value)) Nothing Nothing
   case exitCode of
     ExitSuccess -> pure $ deserializeFixture processStdOut
     ExitFailure code ->

src/lib/Test/Smoke/Plan.hs

@@ -85,6 +85,7 @@ readTest location fallbackWorkingDirectory fallbackShell fallbackCommand test =
         planShell = fallbackShell,
         planExecutable = executable,
         planArgs = args,
+        planEnvironment = testEnvironment test,
         planStdIn = stdIn,
         planStatus = status,
         planStdOut = stdOut,

src/lib/Test/Smoke/Types/Base.hs

@@ -8,6 +8,7 @@ import Control.Monad (when)
 import Data.Aeson
 import Data.Aeson.Types (Parser, typeMismatch)
 import Data.Default
+import Data.Map.Strict (Map)
 import Data.String (IsString)
 import Data.Text (Text)
 import Data.Text qualified as Text
@@ -55,6 +56,11 @@ instance FromFixture Args where
   fixtureName = "args"
   serializeFixture = Text.unlines . Vector.toList . Vector.map Text.pack . unArgs
 
+newtype EnvVars = EnvVars
+  { unEnvVars :: Map String String
+  }
+  deriving (FromJSON)
+
 newtype Script = Script
   { unScript :: Text
   }

src/lib/Test/Smoke/Types/Plans.hs

@@ -26,6 +26,7 @@ data TestPlan = TestPlan
     planShell :: Maybe Shell,
     planExecutable :: Executable,
     planArgs :: Args,
+    planEnvironment :: Maybe EnvVars,
     planStdIn :: StdIn,
     planStatus :: Status,
     planStdOut :: Vector (Assert StdOut),

src/lib/Test/Smoke/Types/Tests.hs

@@ -45,6 +45,7 @@ data Test = Test
     testWorkingDirectory :: Maybe (Path Relative Dir),
     testCommand :: Maybe Command,
     testArgs :: Maybe Args,
+    testEnvironment :: Maybe EnvVars,
     testStdIn :: Maybe (TestInput StdIn),
     testStatus :: Status,
     testStdOut :: Vector (TestOutput StdOut),
@@ -62,6 +63,7 @@ instance FromJSON Test where
         <*> (v .:? "working-directory")
         <*> (v .:? "command")
         <*> (v .:? "args")
+        <*> (v .:? "environment")
         <*> (v .:? "stdin")
         <*> (v .:? "exit-status" .!= def)
         <*> (manyMaybe <$> (v .:? "stdout"))