├── .envrc ├── .gitignore ├── CHANGELOG.md ├── Foreign └── Nix │ ├── Shellout.hs │ └── Shellout │ ├── Helpers.hs │ ├── Prefetch.hs │ └── Types.hs ├── LICENSE ├── README.md ├── libnix.cabal ├── shell.nix └── tests ├── Main.hs └── TestShellout.hs /.envrc: -------------------------------------------------------------------------------- 1 | eval "$(lorri direnv)" 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /dist-newstyle/ 2 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # libnix 2 | 3 | ## 0.4.1.0 -- 2021-11-23 4 | 5 | * Add `executables` to the `RunOptions`. Backwards compatible if you use `defaultRunOptions`. 6 | 7 | ## 0.4.0.1 -- 2021-11-19 8 | 9 | * Fix `Prefetch.url`. The constructed command was missing flags for `urlUnpack = True`. 10 | 11 | ## 0.4.0.0 -- 2021-11-19 12 | 13 | * Allow setting a log function when running a nix action, which can log command invocations. 14 | * Add an `m` attribute to `NixAction` to make it into a proper `MonadTrans`. 15 | * Reexport `Types` from the other modules, so that explicit import is not required. 16 | 17 | ## 0.3.0.0 -- 2021-11-16 18 | 19 | * Remove `Eq` instance from `NixExpr` (not sensible) 20 | * Replace the `NixAction` tuple with a more semantic `NixActionError` 21 | * Update to 2021 and remove dependency on protolude 22 | 23 | ## 0.2.0.0 -- 2018-08-12 24 | 25 | * First released version. 26 | -------------------------------------------------------------------------------- /Foreign/Nix/Shellout.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE LambdaCase #-} 2 | {-# LANGUAGE OverloadedStrings #-} 3 | {-# LANGUAGE ViewPatterns #-} 4 | {-| 5 | Module : Foreign.Nix.Shellout 6 | Description : Interface to the nix package manager’s CLI 7 | Copyright : Profpatsch, 2016–2018 8 | License : GPL-3 9 | Stability : experimental 10 | Portability : nix 1.11.x, nix 2.0 11 | 12 | Calls to the nix command line to convert 13 | textual nix expressions to derivations & realized storepaths. 14 | -} 15 | module Foreign.Nix.Shellout 16 | ( -- * Calling nix 17 | -- ** Parse 18 | parseNixExpr, ParseError(..) 19 | -- ** Instantiate 20 | , instantiate, InstantiateError(..) 21 | , eval 22 | -- ** Realize 23 | , realize, RealizeError(..) 24 | -- ** Helpers 25 | , addToStore 26 | , parseInstRealize 27 | , NixError(..) 28 | -- * Types 29 | , NixExpr 30 | , module Foreign.Nix.Shellout.Types 31 | ) where 32 | 33 | import Control.Error ( throwE, tryLast ) 34 | import Data.Text (stripPrefix, lines, isPrefixOf, Text) 35 | 36 | import qualified Foreign.Nix.Shellout.Helpers as Helpers 37 | import Foreign.Nix.Shellout.Types 38 | import qualified Data.Text as Text 39 | import System.Exit (ExitCode(ExitFailure, ExitSuccess)) 40 | import Control.Monad ((>=>)) 41 | import qualified System.FilePath as FilePath 42 | import Data.Function ((&)) 43 | import qualified Data.List as List 44 | import Control.Monad.IO.Class (MonadIO) 45 | import Control.Monad.Except (throwError) 46 | 47 | ------------------------------------------------------------------------------ 48 | -- Parsing 49 | 50 | -- | A sucessfully parsed nix expression. 51 | newtype NixExpr = NixExpr Text deriving (Show) 52 | 53 | data ParseError 54 | = SyntaxError Text 55 | -- ^ the input string was not a syntactically valid nix expression 56 | | UnknownParseError 57 | -- ^ catch-all error 58 | deriving (Show, Eq) 59 | 60 | -- | Parse a nix expression and check for syntactic validity. 61 | 62 | -- Runs @nix-instantiate@. 63 | parseNixExpr :: MonadIO m => Text -> NixAction ParseError m NixExpr 64 | parseNixExpr e = do 65 | exec <- Helpers.getExecOr exeNixInstantiate "nix-instantiate" 66 | mapActionError parseParseError 67 | $ NixExpr 68 | <$> evalNixOutput exec [ "--parse", "-E", e ] 69 | 70 | 71 | parseParseError :: Text -> ParseError 72 | parseParseError 73 | (stripPrefix "error: syntax error, " 74 | -> Just mes) = SyntaxError mes 75 | parseParseError _ = UnknownParseError 76 | 77 | ------------------------------------------------------------------------------ 78 | -- Instantiating 79 | 80 | data InstantiateError 81 | = NotADerivation 82 | -- ^ the given expression does not evaluate to a derivaton 83 | | UnknownInstantiateError 84 | -- ^ catch-all error 85 | deriving (Show, Eq) 86 | 87 | -- | Instantiate a parsed expression into a derivation. 88 | -- 89 | -- Runs @nix-instantiate@. 90 | instantiate :: (MonadIO m) => NixExpr -> NixAction InstantiateError m (StorePath Derivation) 91 | instantiate (NixExpr e) = do 92 | exec <- Helpers.getExecOr exeNixInstantiate "nix-instantiate" 93 | mapActionError parseInstantiateError 94 | $ evalNixOutput exec [ "-E", e ] 95 | >>= toNixFilePath StorePath 96 | 97 | -- | Just tests if the expression can be evaluated. 98 | -- That doesn’t mean it has to instantiate however. 99 | -- 100 | -- Runs @nix-instantiate@. 101 | eval :: MonadIO m => NixExpr -> NixAction InstantiateError m () 102 | eval (NixExpr e) = do 103 | exec <- Helpers.getExecOr exeNixInstantiate "nix-instantiate" 104 | 105 | _instantiateOutput <- mapActionError parseInstantiateError 106 | $ evalNixOutput exec [ "--eval", "-E", e ] 107 | pure () 108 | 109 | parseInstantiateError :: Text -> InstantiateError 110 | parseInstantiateError 111 | (stripPrefix "error: expression does not evaluate to a derivation" 112 | -> Just _) = NotADerivation 113 | parseInstantiateError _ = UnknownInstantiateError 114 | 115 | 116 | ------------------------------------------------------------------------------ 117 | -- Realizing 118 | 119 | data RealizeError = UnknownRealizeError deriving (Show, Eq) 120 | 121 | -- | Finally derivations are realized into full store outputs. 122 | -- This will typically take a while so it should be executed asynchronously. 123 | -- 124 | -- Runs @nix-store@. 125 | realize :: MonadIO m => StorePath Derivation -> NixAction RealizeError m (StorePath Realized) 126 | realize (StorePath d) = 127 | storeOp [ "-r", Text.pack d ] 128 | 129 | -- | Copy the given file or folder to the nix store and return it’s path. 130 | -- 131 | -- Runs @nix-store@. 132 | addToStore :: MonadIO m => FilePath -> NixAction RealizeError m (StorePath Realized) 133 | addToStore fp = storeOp [ "--add", Text.pack fp ] 134 | 135 | storeOp :: (MonadIO m) => [Text] -> NixAction RealizeError m (StorePath Realized) 136 | storeOp op = do 137 | exec <- Helpers.getExecOr exeNixInstantiate "nix-store" 138 | mapActionError (const UnknownRealizeError) 139 | $ evalNixOutput exec op 140 | >>= toNixFilePath StorePath 141 | 142 | ------------------------------------------------------------------------------ 143 | -- Convenience 144 | 145 | -- | Combines all error types that could happen. 146 | data NixError 147 | = ParseError ParseError 148 | | InstantiateError InstantiateError 149 | | RealizeError RealizeError deriving (Show, Eq) 150 | 151 | -- | A convenience function to directly realize a nix expression. 152 | -- Any errors are put into a combined error type. 153 | parseInstRealize :: (MonadIO m) => Text -> NixAction NixError m (StorePath Realized) 154 | parseInstRealize = mapActionError ParseError . parseNixExpr 155 | >=> mapActionError InstantiateError . instantiate 156 | >=> mapActionError RealizeError . realize 157 | 158 | ------------------------------------------------------------------------------ 159 | -- Helpers 160 | 161 | -- | Take args and return either error message or output path 162 | evalNixOutput :: (MonadIO m) 163 | => Helpers.Executable 164 | -- ^ name of executable 165 | -> [Text] 166 | -- ^ arguments 167 | -> NixAction Text m Text 168 | -- ^ error: (stderr, errormsg), success: path 169 | evalNixOutput = Helpers.readProcess (\(out, err) -> \case 170 | ExitFailure _ -> throwE $ 171 | case 172 | err 173 | & Text.lines 174 | & dropWhile (not . isPrefixOf "error: ") 175 | & List.intersperse "\n" 176 | & mconcat of 177 | "" -> "nix didn’t output any error message" 178 | s -> s 179 | ExitSuccess -> tryLast 180 | "nix didn’t output a store path" (Data.Text.lines out)) 181 | 182 | 183 | -- | Apply filePath p to constructor a if it’s a valid filepath 184 | toNixFilePath :: Monad m => (String -> a) -> Text -> NixAction Text m a 185 | toNixFilePath a p = NixAction $ 186 | if FilePath.isValid (Text.unpack p) then pure $ a (Text.unpack p) 187 | else throwError $ NixActionError 188 | { actionStderr = nostderr 189 | , actionError = p <> " is not a filepath!" } 190 | where nostderr = mempty 191 | -------------------------------------------------------------------------------- /Foreign/Nix/Shellout/Helpers.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | {-# LANGUAGE LambdaCase #-} 3 | {-# LANGUAGE FlexibleContexts #-} 4 | module Foreign.Nix.Shellout.Helpers where 5 | 6 | import Foreign.Nix.Shellout.Types ( NixActionError(..), RunOptions (logFn, executables), LogFn (LogFn), NixAction, Executables ) 7 | import qualified System.Process as P 8 | import qualified Data.Text.IO as TIO 9 | import qualified Data.Text as T 10 | import qualified System.IO as SIO 11 | 12 | -- needed for ignoreSigPipe 13 | -- needed for ignoreSigPipe 14 | import GHC.IO.Exception (IOErrorType(..), IOException(..), ExitCode) 15 | import Foreign.C.Error (Errno(Errno), ePIPE) 16 | import Data.Text (Text) 17 | import Control.Error (ExceptT, runExceptT) 18 | import Control.Concurrent (MVar, newEmptyMVar, forkIO, takeMVar, putMVar, killThread) 19 | import Control.DeepSeq (rnf) 20 | 21 | import Control.Exception (SomeException, throwIO, onException, try, mask, handle, evaluate) 22 | 23 | import Control.Monad (unless) 24 | import Control.Monad.IO.Class (liftIO, MonadIO) 25 | import qualified Data.Text as Text 26 | import Control.Monad.Except (MonadError (throwError)) 27 | import Control.Monad.Reader (asks) 28 | import Control.Monad.Trans (lift) 29 | import Data.Function ((&)) 30 | 31 | -- | Something we can run 32 | data Executable = 33 | ExeFromPathEnv Text 34 | -- ^ name of the executable, to be looked up in PATH 35 | | ExeFromFilePath FilePath 36 | -- ^ a file path to the executable (can be relative or absolute) 37 | 38 | -- | Get an executable from the 'Executables' option (by its getter) 39 | -- or if not set use the given 'Text' as the name of the excutable 40 | -- to be looked up in @PATH@. 41 | getExecOr :: Monad m => (Executables -> Maybe FilePath) -> Text -> NixAction e m Executable 42 | getExecOr getter exeName = 43 | let f = \case 44 | Nothing -> ExeFromPathEnv exeName 45 | Just fp -> ExeFromFilePath fp 46 | in asks (f . getter . executables) 47 | 48 | -- | Read the output of a process into a NixAction. 49 | -- | Keeps stderr if process returns a failure exit code. 50 | -- | The text is decoded as @UTF-8@. 51 | readProcess :: (MonadIO m) 52 | => ((Text, Text) -> ExitCode -> ExceptT e m a) 53 | -- ^ handle (stdout, stderr) depending on the return value 54 | -> Executable 55 | -- ^ executable to run 56 | -> [Text] 57 | -- ^ arguments 58 | -> NixAction e m a 59 | readProcess with exec args = do 60 | let exec' = case exec of 61 | ExeFromPathEnv name -> name 62 | ExeFromFilePath fp -> fp & Text.pack 63 | -- log every call based on the LogFn the user passed 64 | (LogFn l) <- asks logFn 65 | lift $ l exec' args 66 | 67 | (exc, out, err) <- liftIO 68 | $ readCreateProcessWithExitCodeAndEncoding 69 | (P.proc (Text.unpack exec') (map Text.unpack args)) SIO.utf8 "" 70 | lift (runExceptT (with (out, err) exc)) >>= \case 71 | Left e -> 72 | throwError $ NixActionError 73 | { actionStderr = err 74 | , actionError = e } 75 | Right a -> pure a 76 | 77 | -- Copied & modified from System.Process (process-1.6.4.0) 78 | 79 | -- | like @readCreateProcessWithExitCodeAndEncoding, but uses 80 | -- | Text instead of [Char] and lets the user specify an encoding 81 | -- | for the handles. 82 | readCreateProcessWithExitCodeAndEncoding 83 | :: P.CreateProcess 84 | -> SIO.TextEncoding -- ^ encoding for handles 85 | -> Text -- ^ standard input 86 | -> IO (ExitCode, Text, Text) -- ^ exitcode, stdout, stderr 87 | readCreateProcessWithExitCodeAndEncoding cp encoding input = do 88 | let cp_opts = cp 89 | { P.std_in = P.CreatePipe 90 | , P.std_out = P.CreatePipe 91 | , P.std_err = P.CreatePipe } 92 | -- todo: this is not exposed by System.Process 93 | -- withCreateProcess_ "readCreateProcessWithExitCode" cp_opts $ 94 | P.withCreateProcess cp_opts $ 95 | \(Just inh) (Just outh) (Just errh) ph -> do 96 | 97 | SIO.hSetEncoding outh encoding 98 | SIO.hSetEncoding errh encoding 99 | SIO.hSetEncoding inh encoding 100 | 101 | out <- TIO.hGetContents outh 102 | err <- TIO.hGetContents errh 103 | 104 | -- fork off threads to start consuming stdout & stderr 105 | withForkWait (evaluate $ rnf out) $ \waitOut -> 106 | withForkWait (evaluate $ rnf err) $ \waitErr -> do 107 | 108 | -- now write any input 109 | unless (T.null input) $ 110 | ignoreSigPipe $ TIO.hPutStr inh input 111 | -- hClose performs implicit hFlush, and thus may trigger a SIGPIPE 112 | ignoreSigPipe $ SIO.hClose inh 113 | 114 | -- wait on the output 115 | waitOut 116 | waitErr 117 | 118 | -- TODO: isn’t this done by `withCreateProcess`? 119 | SIO.hClose outh 120 | SIO.hClose errh 121 | 122 | -- wait on the process 123 | ex <- P.waitForProcess ph 124 | 125 | return (ex, out, err) 126 | 127 | 128 | -- Copied from System.Process (process-1.6.4.0) 129 | 130 | -- | Fork a thread while doing something else, but kill it if there's an 131 | -- exception. 132 | -- 133 | -- This is important in the cases above because we want to kill the thread 134 | -- that is holding the Handle lock, because when we clean up the process we 135 | -- try to close that handle, which could otherwise deadlock. 136 | -- 137 | withForkWait :: IO () -> (IO () -> IO a) -> IO a 138 | withForkWait async body = do 139 | waitVar <- newEmptyMVar :: IO (MVar (Either SomeException ())) 140 | mask $ \restore -> do 141 | tid <- forkIO $ try (restore async) >>= putMVar waitVar 142 | let wait = takeMVar waitVar >>= either throwIO return 143 | restore (body wait) `onException` killThread tid 144 | 145 | ignoreSigPipe :: IO () -> IO () 146 | ignoreSigPipe = handle $ \e -> case e of 147 | IOError { ioe_type = ResourceVanished 148 | , ioe_errno = Just ioe } 149 | | Errno ioe == ePIPE -> return () 150 | _ -> throwIO e 151 | -------------------------------------------------------------------------------- /Foreign/Nix/Shellout/Prefetch.hs: -------------------------------------------------------------------------------- 1 | {-| 2 | Description : Wrapper for the @nix-prefetch@ CLI utilities 3 | Copyright : Profpatsch, 2018 4 | License : GPL-3 5 | Stability : experimental 6 | Portability : nix-prefetch-scripts 2018 (no version number) 7 | 8 | Calls to the @nix-prefetch-X@ utilities, to parse their output 9 | into nice reusable data types. 10 | -} 11 | {-# LANGUAGE RecordWildCards, GeneralizedNewtypeDeriving, ApplicativeDo #-} 12 | {-# LANGUAGE LambdaCase #-} 13 | {-# LANGUAGE OverloadedStrings #-} 14 | module Foreign.Nix.Shellout.Prefetch 15 | ( -- * nix-prefetch-url 16 | url, UrlOptions(..), defaultUrlOptions 17 | -- * nix-prefetch-git 18 | , git, GitOptions(..), defaultGitOptions, GitOutput(..) 19 | -- * Types 20 | , PrefetchError(..) 21 | , Url(..), Sha256(..) 22 | , module Foreign.Nix.Shellout.Types 23 | ) where 24 | 25 | import Control.Error hiding (bool, err) 26 | import qualified Data.Text as T 27 | 28 | import qualified Data.Aeson as Aeson 29 | import qualified Data.Aeson.Types as AesonT 30 | 31 | import Foreign.Nix.Shellout.Types 32 | import qualified Foreign.Nix.Shellout.Helpers as Helpers 33 | import Data.Text (Text) 34 | import Data.String (IsString) 35 | import GHC.IO.Exception (ExitCode(ExitFailure, ExitSuccess)) 36 | import qualified Data.Text as Text 37 | import Data.Bool (bool) 38 | import Data.Bifunctor (first) 39 | import qualified Data.Text.Lazy as Text.Lazy 40 | import qualified Data.Text.Lazy.Encoding as Text.Lazy.Encoding 41 | import qualified Data.List as List 42 | import Control.Monad.IO.Class (MonadIO) 43 | import Foreign.Nix.Shellout.Helpers (getExecOr) 44 | 45 | data PrefetchError 46 | = PrefetchOutputMalformed Text 47 | -- ^ the tool’s output could not be parsed as expected 48 | | ExpectedHashError 49 | -- ^ an expected hash was given and not valid 50 | | UnknownPrefetchError 51 | -- ^ catch-all error 52 | deriving (Eq, Show) 53 | 54 | -- | A descriptive type for URLs. 55 | newtype Url = Url { unUrl :: Text } deriving (Show, Eq, IsString) 56 | -- | A @sha-256@ hash. 57 | newtype Sha256 = Sha256 { unSha256 :: Text } deriving (Show, Eq, IsString) 58 | 59 | data UrlOptions = UrlOptions 60 | { urlUrl :: Url 61 | -- ^ the URL 62 | , urlUnpack :: Bool 63 | -- ^ whether to unpack before hashing (useful for prefetching @fetchTarball@) 64 | , urlName :: Maybe Text 65 | -- ^ name of the store path 66 | , urlExpectedHash :: Maybe Sha256 67 | -- ^ the hash we are expecting 68 | } 69 | 70 | -- | Takes the URL, doesn’t unpack and uses the default name. 71 | defaultUrlOptions :: Url -> UrlOptions 72 | defaultUrlOptions u = UrlOptions 73 | { urlUrl = u 74 | , urlUnpack = False 75 | , urlName = Nothing 76 | , urlExpectedHash = Nothing } 77 | 78 | -- | Runs @nix-prefetch-url@. 79 | url :: (MonadIO m) => UrlOptions -> NixAction PrefetchError m (Sha256, StorePath Realized) 80 | url UrlOptions{..} = do 81 | exec <- Helpers.getExecOr exeNixPrefetchUrl "nix-prefetch-url" 82 | Helpers.readProcess handler exec args 83 | where 84 | args = bool [] ["--unpack"] urlUnpack 85 | <> maybe [] (\n -> ["--name", n]) urlName 86 | <> [ "--type", "sha256" 87 | , "--print-path" 88 | , unUrl urlUrl ] 89 | <> maybe [] (pure.unSha256) urlExpectedHash 90 | 91 | handler (out, err) = \case 92 | ExitSuccess -> withExceptT PrefetchOutputMalformed $ do 93 | let ls = T.lines $ T.stripEnd out 94 | path <- tryLast "nix-prefetch-url didn’t output a store path" ls 95 | sha <- let errS = "nix-prefetch-url didn’t output a hash" 96 | in tryInit errS ls >>= tryLast errS 97 | pure (Sha256 sha, StorePath $ Text.unpack path) 98 | ExitFailure _ -> throwE $ 99 | if "error: hash mismatch" `T.isPrefixOf` err 100 | then ExpectedHashError 101 | else UnknownPrefetchError 102 | 103 | 104 | data GitOptions = GitOptions 105 | { gitUrl :: Url 106 | -- ^ the URL 107 | , gitRev :: Maybe Text 108 | -- ^ a git revision (hash, branch name, tag, ref, …) 109 | , gitExpectedHash :: Maybe Sha256 110 | -- ^ the hash we are expecting 111 | , gitDeepClone :: Bool 112 | -- ^ whether to do a deep instead of a shallow (@--depth=1@) git clone 113 | , gitLeaveDotGit :: Bool 114 | -- ^ whether to keep @.git@ directories 115 | , gitFetchSubmodules :: Bool 116 | -- ^ whether to fetch submodules 117 | } 118 | 119 | -- | Takes the url, mirrors the default `fetchgit` options in nixpkgs: 120 | -- no deep clone, no @.git@, fetches submodules by default. 121 | -- By default, the latest default @rev@ is used. 122 | defaultGitOptions :: Url -> GitOptions 123 | defaultGitOptions u = GitOptions 124 | { gitUrl = u 125 | , gitRev = Nothing 126 | , gitExpectedHash = Nothing 127 | , gitDeepClone = False 128 | , gitLeaveDotGit = False 129 | , gitFetchSubmodules = True } 130 | 131 | data GitOutput = GitOutput 132 | { gitOutputRev :: Text 133 | -- ^ The actual revision that is used (useful if no 'gitRev' was given) 134 | , gitOutputSha256 :: Sha256 135 | -- ^ the hash 136 | , gitOuputPath :: StorePath Realized 137 | -- ^ the store path of the result 138 | } deriving (Show, Eq) 139 | 140 | -- | Runs @nix-prefetch-git@. 141 | git :: (MonadIO m) => GitOptions -> NixAction PrefetchError m GitOutput 142 | git GitOptions{..} = do 143 | exec <- getExecOr exeNixPrefetchGit "nix-prefetch-git" 144 | Helpers.readProcess handler exec args 145 | where 146 | args = bool ["--no-deepClone"] ["--deepClone"] gitDeepClone 147 | <> bool [] ["--leave-dotGit"] gitLeaveDotGit 148 | <> bool [] ["--fetch-submodules"] gitFetchSubmodules 149 | <> [ "--hash", "sha256" -- --hash is the type, not the thing 150 | -- we need @url [rev [hash]]@, 151 | -- otherwise we can’t expect a hash 152 | , unUrl gitUrl 153 | , fromMaybe "" gitRev ] 154 | -- hash comes last 155 | <> maybe [] (\(Sha256 h) -> [h]) gitExpectedHash 156 | 157 | handler (out, err) = \case 158 | ExitSuccess -> withExceptT PrefetchOutputMalformed $ do 159 | let error' msg = "nix-prefetch-git " <> msg 160 | jsonError :: [Char] -> Text 161 | jsonError = \msg -> error' (T.intercalate "\n" 162 | [ "parsing json output failed:" 163 | , Text.pack msg 164 | , "The output was:" 165 | , out ]) 166 | 167 | (gitOutputRev, gitOutputSha256) 168 | <- ExceptT . pure . first jsonError $ do 169 | val <- Aeson.eitherDecode' (Text.Lazy.Encoding.encodeUtf8 $ Text.Lazy.fromStrict out) 170 | flip AesonT.parseEither val 171 | $ Aeson.withObject "GitPrefetchOutput" $ \obj -> do 172 | (,) <$> obj Aeson..: "rev" 173 | <*> fmap Sha256 (obj Aeson..: "sha256") 174 | 175 | -- The path isn’t output in the json, but on stderr. :( 176 | -- So this is a bit more hacky than necessary. 177 | gitOuputPath <- case 178 | List.find ("path is /nix/store" `T.isPrefixOf`) (T.lines err) 179 | >>= T.stripPrefix "path is " of 180 | Nothing -> throwE 181 | $ error "could not find nix store output path on stderr" 182 | Just path -> pure $ StorePath $ Text.unpack path 183 | 184 | pure GitOutput{..} 185 | 186 | ExitFailure _ -> throwE $ 187 | if "hash mismatch for URL" `T.isInfixOf` err 188 | then ExpectedHashError 189 | else UnknownPrefetchError 190 | -------------------------------------------------------------------------------- /Foreign/Nix/Shellout/Types.hs: -------------------------------------------------------------------------------- 1 | {-| 2 | Description : Common Types 3 | Copyright : Profpatsch, 2018–2021 4 | License : GPL-3 5 | Stability : experimental 6 | -} 7 | {-# LANGUAGE GeneralizedNewtypeDeriving, DeriveFunctor #-} 8 | module Foreign.Nix.Shellout.Types ( 9 | -- * Store paths 10 | StorePath(..), 11 | Derivation, 12 | Realized, 13 | -- * NixAction 14 | runNixAction, 15 | NixAction(..), 16 | RunOptions(..), 17 | defaultRunOptions, 18 | LogFn(..), 19 | Executables(..), 20 | defaultExecutables, 21 | NixActionError(..), 22 | mapActionError, 23 | 24 | ) where 25 | 26 | import Control.Error ( bimapExceptT, runExceptT, ExceptT ) 27 | import Control.Monad.IO.Class (MonadIO) 28 | import Control.Monad.Reader (ReaderT (runReaderT, ReaderT), MonadReader ) 29 | import Data.Text (Text) 30 | import Control.Monad.Trans ( lift, MonadTrans ) 31 | import Control.Monad.Except (MonadError) 32 | 33 | -- | Options that modify how a 'NixAction' executes. 34 | -- 35 | -- Might get more fields in the future, use 'defaultRunOptions' 36 | -- to be backwards-compatbile. 37 | data RunOptions m = RunOptions { 38 | logFn :: LogFn m, 39 | -- ^ The command line logging function. 40 | executables :: Executables 41 | -- ^ A record of all executables this library could need. 42 | } 43 | 44 | -- | Logging function to call before running a command. 45 | -- This can be used to provide debugging output. 46 | -- 47 | -- The first argument is the executable name, 48 | -- the second argument is the list of arguments. 49 | newtype LogFn m = LogFn (Text -> [Text] -> m ()) 50 | 51 | -- | All executables this library might need. 52 | -- 53 | -- If you set an executable to @Just filepath@, the internal code will use the given path instead of looking up the executable name in @PATH@. 54 | -- This is useful if you want to ensure that the executables always exist before calling into this library. 55 | -- 56 | -- 'NixAction' functions document the executables they use in their docstrings. 57 | -- 58 | -- If an executable can’t be found, an 'IOException' is thrown (by the process spawn function). 59 | data Executables = Executables { 60 | exeNixInstantiate :: Maybe FilePath, 61 | -- ^ @nix-instantiate@; usually you can expect nix to exist on the system (but we don’t check before running the commands) 62 | exeNixStore :: Maybe FilePath, 63 | -- ^ @nix-store@ 64 | exeNixPrefetchUrl :: Maybe FilePath, 65 | -- ^ @nix-prefetch-url@; as of nix @2.3@, this executable comes with the nix distribution, so if @nix-store@ is available, this should also be available 66 | exeNixPrefetchGit :: Maybe FilePath 67 | -- ^ @nix-prefetch-git@; This is usually provided by the @nix-prefetch-scripts@ package and /not/ installed with nix 68 | } 69 | 70 | -- | all executables are taken from @PATH@ 71 | defaultExecutables :: Executables 72 | defaultExecutables = Executables { 73 | exeNixInstantiate = Nothing, 74 | exeNixStore = Nothing, 75 | exeNixPrefetchUrl = Nothing, 76 | exeNixPrefetchGit = Nothing 77 | } 78 | 79 | -- | 80 | -- @ 81 | -- logFn = nothing is done/logged 82 | -- executable = all executables are taken from @PATH@ 83 | -- @ 84 | defaultRunOptions :: Monad m => RunOptions m 85 | defaultRunOptions = RunOptions { 86 | logFn = LogFn (\_prog _args -> pure ()), 87 | executables = defaultExecutables 88 | } 89 | 90 | -- | Calls a command that returns an error and the whole stderr on failure. 91 | newtype NixAction e m a = NixAction 92 | { unNixAction :: ReaderT (RunOptions m) (ExceptT (NixActionError e) m) a } 93 | deriving (Functor, Applicative, Monad, MonadIO, MonadError (NixActionError e), MonadReader (RunOptions m)) 94 | 95 | instance MonadTrans (NixAction e) where 96 | lift = NixAction . lift . lift 97 | 98 | -- | Combines the standard error of running a command with a more semantic 99 | -- error type one should match on first. 100 | data NixActionError e = NixActionError 101 | { actionStderr :: Text 102 | , actionError :: e } 103 | deriving (Show, Functor) 104 | 105 | -- | Run a 'NixAction', given runtime options. See 'defaultRunOptions'. 106 | runNixAction :: RunOptions m 107 | -> NixAction e m a 108 | -> m (Either (NixActionError e) a) 109 | runNixAction runOpts act = runExceptT $ runReaderT (unNixAction act) runOpts 110 | 111 | -- | Map over the @e@ in a 'NixActionError'. 112 | mapActionError :: Functor m => (a1 -> e) -> NixAction a1 m a2 -> NixAction e m a2 113 | mapActionError f (NixAction act) = NixAction $ ReaderT $ \runOpts -> bimapExceptT (fmap f) id $ runReaderT act runOpts 114 | 115 | -- | A path in the nix store. It carries a phantom @a@ to differentiate 116 | -- between 'Derivation' files and 'Realized' paths. 117 | newtype StorePath a = StorePath 118 | { unStorePath :: FilePath } 119 | deriving (Eq, Show) 120 | 121 | -- | A nix derivation is a complete build instruction that can be realized. 122 | data Derivation 123 | -- | Once a derivation is realized, the finished output can be used. 124 | data Realized 125 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # libnix 2 | 3 | Haskell bindings to the [nix package manager][nix] 4 | 5 | This project aims to provide an interface to call [nix][nix] functionality from 6 | the safe haven that is Haskell. As much type safety as possible should be 7 | guaranteed to the user. 8 | 9 | The project consists of two broad steps: 10 | 11 | 1. bindings to the command line tools 12 | 2. bindings to the nix libraries themselves 13 | 14 | At the moment, an beta version of 1. is implemented, together with a small 15 | number of tests to check for possible changes in the interface, 16 | which consists mainly of three functions: 17 | 18 | ```haskell 19 | parseNixExpr :: Text -> NixAction ParseError NixExpr 20 | instantiate :: NixExpr -> NixAction InstantiateError (StorePath Derivation) 21 | realize :: StorePath Derivation -> NixAction RealizeError (StorePath Realized) 22 | ``` 23 | 24 | which do what you’d expect; and two helper functions 25 | 26 | ```haskell 27 | eval :: NixExpr -> NixAction InstantiateError () 28 | parseInstRealize :: Text -> NixAction NixError (StorePath Realized) 29 | ``` 30 | 31 | where `parseInstRealize` performs all three steps at once. 32 | 33 | [nix]: https://github.com/NixOS/nix 34 | 35 | 36 | ## Nix Prefetch Wrappers 37 | 38 | We implement an additional module that creates nicely typed wrappers 39 | for `nix-prefetch-X` tools, please see the module documentation what 40 | is supported exactly. 41 | 42 | ```haskell 43 | url :: UrlOptions -> NixAction PrefetchError (Sha256, StorePath Realized) 44 | git :: GitOptions -> NixAction PrefetchError GitOutput 45 | ``` 46 | 47 | 48 | ## C++ bindings 49 | 50 | The second steps would be to directly bind into the C++ library. That could 51 | either mean writing a C wrapper and using Haskell’s native FFI, or generating 52 | bindings with [Hoppy][hoppy], which we’d prefer. Hoppy would need to be able to 53 | [handle C++ exceptions][exc] first, though. 54 | 55 | [hoppy]: http://khumba.net/projects/hoppy/ 56 | [exc]: https://gitlab.com/khumba/hoppy/issues/10 57 | 58 | ## Other nix libraries on hackage 59 | 60 | - [cabal2nix](https://hackage.haskell.org/package/cabal2nix): the executable at the base of nix haskell support 61 | - [language-nix](https://hackage.haskell.org/package/language-nix): library cabal2nix uses to generate its nix files 62 | - [hnix](https://hackage.haskell.org/package/hnix): a project to implement the nix expression language in haskell 63 | - [nix-eval](https://hackage.haskell.org/package/nix-eval): runtime eval of Haskell code using nix 64 | - [simple-nix](https://hackage.haskell.org/package/simple-nix): looks like a nix parser, but not entirely sure 65 | 66 | It doesn’t look like the scope of libnix collides with any of these packages. 67 | -------------------------------------------------------------------------------- /libnix.cabal: -------------------------------------------------------------------------------- 1 | name: libnix 2 | version: 0.4.1.0 3 | synopsis: Bindings to the nix package manager 4 | description: Use the nix package manager from Haskell. All modules are designed to be imported qualified. 5 | category: Foreign, Nix 6 | homepage: https://github.com/Profpatsch/libnix-haskell#readme 7 | bug-reports: https://github.com/Profpatsch/libnix-haskell/issues 8 | license: GPL-3 9 | license-file: LICENSE 10 | author: Profpatsch 11 | maintainer: mail@profpatsch.de 12 | build-type: Simple 13 | cabal-version: >=1.10 14 | 15 | extra-source-files: 16 | LICENSE 17 | CHANGELOG.md 18 | README.md 19 | shell.nix 20 | 21 | source-repository head 22 | type: git 23 | location: https://github.com/Profpatsch/libnix-haskell 24 | 25 | library 26 | exposed-modules: Foreign.Nix.Shellout 27 | , Foreign.Nix.Shellout.Prefetch 28 | , Foreign.Nix.Shellout.Types 29 | other-modules: Foreign.Nix.Shellout.Helpers 30 | build-depends: base >=4.9 && <5.0 31 | , aeson >=1.0.0.0 32 | , bytestring 33 | , deepseq 34 | , errors >=2.2.0 35 | , filepath 36 | , mtl 37 | , process 38 | , text 39 | -- hs-source-dirs: 40 | ghc-options: -Wall 41 | default-language: Haskell2010 42 | 43 | test-suite tests 44 | type: exitcode-stdio-1.0 45 | main-is: Main.hs 46 | hs-source-dirs: tests 47 | other-modules: TestShellout 48 | build-depends: base 49 | , directory 50 | , errors 51 | , text 52 | , libnix 53 | , tasty 54 | , tasty-hunit 55 | ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall 56 | default-language: Haskell2010 57 | -------------------------------------------------------------------------------- /shell.nix: -------------------------------------------------------------------------------- 1 | { pkgs ? import {}}: 2 | 3 | pkgs.haskellPackages.shellFor { 4 | packages = hps: [ 5 | (hps.callCabal2nix "libnix" (pkgs.nix-gitignore.gitignoreSource [".git"] ./.) {}) 6 | ]; 7 | buildInputs = [ 8 | pkgs.cabal-install 9 | pkgs.haskell-language-server 10 | ]; 11 | } 12 | -------------------------------------------------------------------------------- /tests/Main.hs: -------------------------------------------------------------------------------- 1 | module Main where 2 | 3 | import Prelude 4 | import TestShellout 5 | import Test.Tasty 6 | 7 | main :: IO () 8 | main = defaultMain shelloutTests 9 | -------------------------------------------------------------------------------- /tests/TestShellout.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE RecordWildCards #-} 2 | {-# LANGUAGE OverloadedStrings #-} 3 | {-# LANGUAGE NamedFieldPuns #-} 4 | {-# LANGUAGE TypeApplications #-} 5 | {-# LANGUAGE LambdaCase #-} 6 | module TestShellout where 7 | 8 | import qualified Data.Text as T 9 | import System.IO (openTempFile, hClose) 10 | import System.Directory (getTemporaryDirectory) 11 | 12 | import Test.Tasty 13 | import Test.Tasty.HUnit 14 | 15 | import Foreign.Nix.Shellout 16 | import Data.Text (Text) 17 | import Control.Monad.IO.Class (liftIO) 18 | import Control.Monad ((>=>)) 19 | import Control.Exception (SomeException, try, Exception (displayException)) 20 | import Data.Function ((&)) 21 | import qualified Data.List as List 22 | 23 | 24 | shelloutTests :: TestTree 25 | shelloutTests = testGroup "shellout tests" 26 | [ testGroup "parsing" 27 | [ syntaxError ] 28 | , testGroup "evaluating" 29 | [ infiniteRecursion 30 | , notADerivation 31 | , someDerivation ] 32 | , testGroup "realizing" 33 | [ nixpkgsExists 34 | , multilineErrors 35 | , helloWorld 36 | , copyTempfileToStore ] 37 | , testGroup "executable paths" 38 | [ badInstantiateFilePath ] 39 | ] 40 | 41 | 42 | syntaxError :: TestTree 43 | syntaxError = testCase "syntax error" 44 | $ parseNixExpr ";" `isENoFail` 45 | Left ("", SyntaxError "unexpected ';', at (string):1:1") 46 | 47 | infiniteRecursion :: TestTree 48 | infiniteRecursion = testCase "infinite recursion" 49 | $ parseInst "let a = a; in a" 50 | `isE` Left ( "error: infinite recursion encountered, at (string):1:10" 51 | , UnknownInstantiateError) 52 | 53 | notADerivation :: TestTree 54 | notADerivation = testCase "not a derivation" 55 | $ parseInst "42" 56 | `isE` Left ("", NotADerivation) 57 | 58 | someDerivation :: TestTree 59 | someDerivation = testCase "a basic derivation" 60 | $ assertNoFailure $ parseInst 61 | "derivation { name = \"foo\"; builder = \" \"; system = \" \"; }" 62 | 63 | nixpkgsExists :: TestTree 64 | nixpkgsExists = testCase "nixpkgs is accessible" 65 | $ assertNoFailure $ parseEval "import {}" 66 | 67 | multilineErrors :: TestTree 68 | multilineErrors = testCase "nixpkgs multiline stderr it parsed" 69 | $ parseEval "builtins.abort ''wow\nsuch error''" 70 | `isE` Left 71 | ( "error: evaluation aborted with the following error \ 72 | \message: 'wow\nsuch error'" 73 | , UnknownInstantiateError) 74 | 75 | helloWorld :: TestTree 76 | helloWorld = testCase "build the GNU hello package" 77 | $ assertNoFailure $ parseInstRealize "with import {}; hello" 78 | 79 | copyTempfileToStore :: TestTree 80 | copyTempfileToStore = testCase "copy a temporary file to store" 81 | $ assertNoFailure $ do 82 | (fp, h) <- liftIO $ 83 | getTemporaryDirectory >>= flip openTempFile "store-test" 84 | liftIO $ hClose h 85 | addToStore fp 86 | 87 | badInstantiateFilePath :: TestTree 88 | badInstantiateFilePath = testCase "not a derivation" 89 | $ isExcBad "No such file or directory" (parseInst "42") 90 | where 91 | isExcBad = isException (defaultRunOptions { 92 | executables = defaultExecutables { 93 | exeNixInstantiate = Just "/path/does/not/exist" 94 | } 95 | }) 96 | 97 | -------------------------------------------------------------------- 98 | -- Helpers 99 | 100 | parseInst :: Text -> NixAction InstantiateError IO (StorePath Derivation) 101 | parseInst = parseInstLike instantiate 102 | 103 | parseEval :: Text -> NixAction InstantiateError IO () 104 | parseEval = parseInstLike eval 105 | 106 | parseInstLike :: (NixExpr -> NixAction InstantiateError IO a) 107 | -> Text 108 | -> NixAction InstantiateError IO a 109 | parseInstLike like = 110 | mapActionError (\_ -> UnknownInstantiateError) 111 | . parseNixExpr >=> like 112 | 113 | isE :: (Eq a, Eq e, Show a, Show e) 114 | => NixAction e IO a 115 | -> Either (Text, e) a 116 | -- ^ Left (subset of stdout, error) 117 | -> Assertion 118 | isE = isE' defaultRunOptions 119 | 120 | isE' :: (Eq a, Eq e, Show a, Show e) 121 | => RunOptions IO 122 | -> NixAction e IO a 123 | -> Either (Text, e) a 124 | -- ^ Left (subset of stdout, error) 125 | -> Assertion 126 | isE' runOptions na match = runNixAction runOptions na >>= \res -> 127 | case (match, res) of 128 | (Right a, Right b) -> a @=? b 129 | (match', res') -> check match' res' 130 | 131 | isException :: RunOptions IO -> [Char] -> NixAction e IO a -> IO () 132 | isException runOptions matchText na = try @SomeException (runNixAction runOptions na) >>= \case 133 | Left exc -> do 134 | let text = exc & displayException 135 | assertBool ("threw exception, but did not match the given substring\nshould have contained: " <> matchText <> "\nbut was: " <> text) 136 | $ matchText `List.isInfixOf` text 137 | Right _a -> assertFailure "runNixAction should have thrown an exception" 138 | 139 | isENoFail :: (Eq e, Show a, Show e) 140 | => NixAction e IO a 141 | -> Either (Text, e) a 142 | -- ^ Left (subset of stdout, error) 143 | -> Assertion 144 | isENoFail na match = runNixAction defaultRunOptions na >>= check match 145 | 146 | check :: (Eq a, Show a) 147 | => Either (Text, a) _x 148 | -> Either (NixActionError a) _x 149 | -> Assertion 150 | check (Left (outMatch, err)) 151 | (Left NixActionError 152 | { actionStderr = out 153 | , actionError = err' }) = do 154 | assertBool "stderr not matched" (outMatch `T.isInfixOf` out) 155 | err @=? err' 156 | check (Right _) (Left _) = 157 | assertFailure "output should have succeeded, but it failed" 158 | check (Left _) (Right _) = 159 | assertFailure "output should have failed, but it succeeded" 160 | check _ _ = error "handled by isE" 161 | 162 | assertNoFailure :: Show e => NixAction e IO a -> Assertion 163 | assertNoFailure na = do 164 | ei <- runNixAction defaultRunOptions na 165 | case ei of 166 | (Left naErr) -> assertFailure $ show $ actionError naErr 167 | (Right _) -> pure () 168 | --------------------------------------------------------------------------------