Argonix.hs 14.6 KB
Newer Older
Valentin Reis's avatar
Valentin Reis committed
1 2
{-# language RecordWildCards #-}
{-# language ApplicativeDo #-}
Valentin Reis's avatar
Valentin Reis committed
3
{-# language LambdaCase #-}
Valentin Reis's avatar
Valentin Reis committed
4 5
{-# language OverloadedStrings #-}

Valentin Reis's avatar
Valentin Reis committed
6 7 8 9 10 11 12
{-|
Module      : Main
Description : argonix
Copyright   : (c) Valentin Reis, 2018
License     : MIT
Maintainer  : fre@freux.fr -}

Valentin Reis's avatar
Valentin Reis committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26
module Main where

import           Data.Default
import           Turtle                  hiding ( header
                                                , text
                                                , arguments
                                                )
import           Options.Applicative
import           Data.Maybe
import           Prelude                 hiding ( FilePath )

import           Data.Text                      ( pack
                                                , unpack
                                                )
Valentin Reis's avatar
Valentin Reis committed
27 28 29 30
import           System.Console.ANSI
import           System.Console.ANSI.Types      ( Color )
import           Turtle.Shell
import           Control.Foldl
Valentin Reis's avatar
Valentin Reis committed
31
import           System.Posix.Process
Valentin Reis's avatar
Valentin Reis committed
32
import           System.IO               hiding ( FilePath )
Valentin Reis's avatar
Valentin Reis committed
33

Valentin Reis's avatar
Valentin Reis committed
34 35 36 37
-- | Miscellaneous printing utilities
colorShell :: Color -> Shell () -> Shell ()
colorShell color she = setC color *> she *> setC White
  where setC c = liftIO $ setSGR [SetColor Foreground Dull c]
Valentin Reis's avatar
Valentin Reis committed
38 39
verboseShell :: Bool -> Text -> Shell Line -> Shell ExitCode
verboseShell v c i = when v (printCommand c) >> shell c i
Valentin Reis's avatar
Valentin Reis committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
printInfo :: Text -> Shell ()
printCommand :: Text -> Shell ()
printError :: Text -> Shell ()
printWarning :: Text -> Shell ()
printSuccess :: Text -> Shell ()
printTest :: Text -> Shell ()
dieRed :: Text -> Shell ()

printInfo = printf ("Info: " % s % "\n")
printCommand = printf ("Running: " % s % "\n")
printWarning = colorShell Yellow . printf ("Warning: " % s % "\n")
printError = colorShell Red . printf ("Error: " % s % "\n")
printSuccess = colorShell Green . printf ("Success: " % s % "\n")
printTest = colorShell Green . printf ("RUNNING TEST: " % s % "\n")
dieRed strw =
  colorShell Red (printf ("Failure: " % s) strw) >> exit (ExitFailure 1)
Valentin Reis's avatar
Valentin Reis committed
56

57 58 59 60 61 62
checkFsAttributes :: FilePath -> Shell ()
checkFsAttributes workingDirectory = do
  let dir = case toText workingDirectory of
        Left  di -> di
        Right di -> di
  let findmnt = inproc "findmnt" ["-T", dir, "-o", "OPTIONS"] empty
Valentin Reis's avatar
Valentin Reis committed
63 64
  b <- liftIO
    $ Turtle.Shell.fold (grep (has "nosuid") findmnt) Control.Foldl.length
65 66 67 68 69
  when (b > 0) $ die $ format
    ("The output directory, " % fp % ", must not mounted with \"nosuid\"")
    workingDirectory

main :: IO ()
Valentin Reis's avatar
Valentin Reis committed
70 71 72
main = do
  hSetBuffering System.IO.stdout NoBuffering
  join $ execParser (info (opts <**> helper) idm)
73 74 75 76 77
 where
  opts :: Parser (IO ())
  opts = hsubparser
    (  command
        "build"
Valentin Reis's avatar
Valentin Reis committed
78
        (info (wrap NixBuild <$> targetParser <*> commonParser)
79 80 81
              (progDesc "Run an argo-compatible nix-build.")
        )
    <> command
Valentin Reis's avatar
Valentin Reis committed
82
         "shell"
Valentin Reis's avatar
Valentin Reis committed
83
         (info (wrap NixShell <$> targetParser <*> commonParser)
Valentin Reis's avatar
Valentin Reis committed
84
               (progDesc "Enter an argo-compatible nix-shell")
85
         )
Valentin Reis's avatar
Valentin Reis committed
86 87 88 89 90 91 92 93
    <> command
         "remote-shell"
         (info
           (remotely <$> targetParser <*> commonParser <*> remoteParser)
           (progDesc
             "Enter an argo-compatible nix-shell on a remote machine with nix enabled"
           )
         )
94 95 96
    <> help "Type of operation to run."
    )

Valentin Reis's avatar
Valentin Reis committed
97
data ArgsCommon = ArgsCommon
Valentin Reis's avatar
Valentin Reis committed
98 99 100 101 102
  { argopkgs   :: Text
   , verbosity :: Verbosity
   , run       :: Maybe Text
   , overrides :: [(String, String)]
   , grafting  :: Grafting
Valentin Reis's avatar
Valentin Reis committed
103
   , sandboxing :: Sandboxing
Valentin Reis's avatar
Valentin Reis committed
104
  } deriving (Show)
Valentin Reis's avatar
Valentin Reis committed
105
data Verbosity = Verbose | Normal deriving (Show, Eq)
Valentin Reis's avatar
Valentin Reis committed
106
data Sandboxing = Sandbox | NoSandbox deriving (Show, Eq)
Valentin Reis's avatar
Valentin Reis committed
107
data Grafting = Libnrm | NoGraft deriving (Show, Eq)
Valentin Reis's avatar
Valentin Reis committed
108

Valentin Reis's avatar
Valentin Reis committed
109
data ArgsRemote = ArgsRemote
Valentin Reis's avatar
style  
Valentin Reis committed
110 111
  {  targetMachine
   , retreive
Valentin Reis's avatar
Valentin Reis committed
112 113 114 115 116
   , retreiveAs    :: Maybe Text
  } deriving (Show)

instance Default ArgsCommon where
  def = ArgsCommon
Valentin Reis's avatar
Valentin Reis committed
117 118 119 120 121 122
    { verbosity  = Normal,
      argopkgs   = "<argopkgs>",
      run        = Nothing,
      overrides  = [],
      grafting   = NoGraft,
      sandboxing = NoSandbox
Valentin Reis's avatar
Valentin Reis committed
123 124
    }

Valentin Reis's avatar
Valentin Reis committed
125 126 127
instance Default ArgsRemote where
  def = ArgsRemote
    { targetMachine = Nothing,
Valentin Reis's avatar
Valentin Reis committed
128 129
      retreive      = Nothing,
      retreiveAs    = Nothing
Valentin Reis's avatar
Valentin Reis committed
130 131
    }

132 133 134 135
targetParser :: Parser String
targetParser =
  strArgument (metavar "TARGET" <> showDefault <> help "The build target.")

Valentin Reis's avatar
Valentin Reis committed
136 137
remoteParser :: Parser ArgsRemote
remoteParser = do
Valentin Reis's avatar
Valentin Reis committed
138 139 140 141 142 143 144 145 146 147 148 149
  retreive <- optional $ strOption
    (long "retreive" <> metavar "RELATIVE_PATH" <> help
      "File/Folder to retreive from the remote machine."
    )
  retreiveAs <- optional $ strOption
    (long "retreiveAs" <> metavar "LOCAL_PATH" <> help
      "File/Folder to save retreived data as (locally)."
    )
  targetMachine <- optional $ strOption
    (long "target_machine" <> metavar "USER@HOST" <> help
      "Target machine. defaults to localhost via forking."
    )
Valentin Reis's avatar
Valentin Reis committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
  pure ArgsRemote {..}

commonParser :: Parser ArgsCommon
commonParser = do
  argopkgs <- strOption
    (  long "argopkgs"
    <> metavar "ARGOPKGS"
    <> showDefault
    <> value (argopkgs def)
    <> help "Nix expression that produces the argopkgs source path."
    )
  verbosity <- flag
    Normal
    Verbose
    (long "verbose" <> short 'v' <> help "Enable verbose mode")
Valentin Reis's avatar
Valentin Reis committed
165 166 167 168
  sandboxing <- flag
    NoSandbox
    Sandbox
    (long "sandboxing" <> short 's' <> help "Enable nix sandboxing.")
Valentin Reis's avatar
Valentin Reis committed
169 170 171 172 173 174
  grafting <- flag
    NoGraft
    Libnrm
    (long "grafting" <> short 'g' <> help
      "Enable libnrm grafting to avoid rebuilding applications."
    )
Valentin Reis's avatar
Valentin Reis committed
175
  overrides <- catMaybes <$> targets
Valentin Reis's avatar
Valentin Reis committed
176 177 178 179
  run       <- optional $ strOption
    (long "run" <> metavar "COMMAND" <> help
      "Command to run the environment instead of an interactive shell"
    )
Valentin Reis's avatar
Valentin Reis committed
180
  pure ArgsCommon {..}
Valentin Reis's avatar
Valentin Reis committed
181
 where
Valentin Reis's avatar
Valentin Reis committed
182 183
  targets :: Parser [Maybe (String, String)]
  targets = traverse
Valentin Reis's avatar
Valentin Reis committed
184
    optSrc
Valentin Reis's avatar
Valentin Reis committed
185 186
    [ "aml"
    , "libnrm"
Valentin Reis's avatar
Valentin Reis committed
187 188
    , "nrm"
    , "containers"
Valentin Reis's avatar
Valentin Reis committed
189
    , "argotk"
Valentin Reis's avatar
Valentin Reis committed
190 191 192 193
    , "amg"
    , "lammps"
    , "qmcpack"
    , "stream"
Valentin Reis's avatar
Valentin Reis committed
194
    , "openmc"
Valentin Reis's avatar
Valentin Reis committed
195
    , "experiments"
Valentin Reis's avatar
Valentin Reis committed
196
    ]
Valentin Reis's avatar
Valentin Reis committed
197
  optSrc :: String -> Parser (Maybe (String, String))
Valentin Reis's avatar
Valentin Reis committed
198 199 200 201 202 203
  optSrc longform = do
    parsed <- optional $ strOption
      (long longform <> metavar "PATH" <> help
        (longform <> " source folder override.")
      )
    pure $ mapT longform parsed
Valentin Reis's avatar
Valentin Reis committed
204
  mapT :: String -> Maybe String -> Maybe (String, String)
Valentin Reis's avatar
Valentin Reis committed
205 206 207 208
  mapT longform thePath = case thePath of
    Nothing -> Nothing
    Just p  -> Just (longform, p)

Valentin Reis's avatar
Valentin Reis committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
sudoRemoveFile :: (Text -> Shell ()) -> Text -> FilePath -> Shell ()
sudoRemoveFile printer desc filePath = do
  foundSocket <- testfile filePath
  when foundSocket $ go False
  printInfo $ format ("OK: " % s % " " % fp) desc filePath
 where
  go useSudo = do
    printer $ format ("found file " % s % " at " % fp % ".. ") desc filePath
    shell
        (format ((if useSudo then "sudo " else "") % "rm -rf " % fp) filePath)
        Turtle.empty
      >>= \case
            ExitSuccess -> colorShell Green $ printf " Successfully removed.\n"
            ExitFailure _ -> if useSudo
              then printer $ format
                ("Failed to remove file " % s % ", even with sudo.")
                desc
              else do
                printer $ format
                  ("Failed to remove file " % s % ". Trying sudo..\n")
                  desc
                go True

cleanSocket :: FilePath -> Shell ()
cleanSocket = sudoRemoveFile printWarning "socket"
234

Valentin Reis's avatar
Valentin Reis committed
235
setupSystem :: ArgsCommon -> Shell ()
Valentin Reis's avatar
Valentin Reis committed
236
setupSystem sa = do
Valentin Reis's avatar
Valentin Reis committed
237 238
  doVerbose $ printInfo "Setting the nix-build environment up."
  doVerbose $ printInfo "Cleaning sockets."
Valentin Reis's avatar
Valentin Reis committed
239 240 241 242 243 244 245
  Prelude.mapM_
    cleanSocket
    [ "/tmp/nrm-downstream-in"
    , "/tmp/nrm-downstream-event"
    , "/tmp/nrm-upstream-in"
    , "/tmp/nrm-upstream-event"
    ]
Valentin Reis's avatar
Valentin Reis committed
246
  doVerbose $ printInfo "Setting up a cache directory:"
Valentin Reis's avatar
Valentin Reis committed
247 248
  cachedir <- single
    $ inproc "mktemp" ["-d", "/tmp/deletable-nix-cache-XXXX"] empty
249
  export "XDG_CACHE_HOME" $ lineToText cachedir
Valentin Reis's avatar
Valentin Reis committed
250
  doVerbose $ printInfo $ lineToText cachedir <> " exported to XDG_CACHE_HOME"
Valentin Reis's avatar
Valentin Reis committed
251 252 253 254
  vshell "sudo rm -rf result" empty >>= \case
    ExitSuccess -> printInfo "removed ./result"
    ExitFailure n ->
      die ("Failed to remove ./result " <> repr n)
Valentin Reis's avatar
Valentin Reis committed
255
  doVerbose $ printInfo "running nix-build for the containers attribute."
Valentin Reis's avatar
Valentin Reis committed
256 257
  doVerbose $ printCommand $ "nix-build " <> pack
    (unwords (nixArguments "containers" sa))
Valentin Reis's avatar
Valentin Reis committed
258
  nodeos_config <- single
Valentin Reis's avatar
Valentin Reis committed
259
    $ inproc "nix-build" (fmap pack (nixArguments "containers" sa)++["--no-out-link"]) empty
Valentin Reis's avatar
Valentin Reis committed
260
  doVerbose $ printInfo "Checking filesystem attributes on /tmp"
261
  checkFsAttributes "/tmp"
Valentin Reis's avatar
Valentin Reis committed
262 263
  vshell "sudo rm -rf /tmp/argo_nodeos_config" empty
  vshell
Valentin Reis's avatar
Valentin Reis committed
264 265 266 267
    (format ("cp " % s % "/bin/argo_nodeos_config /tmp/argo_nodeos_config")
            (lineToText nodeos_config)
    )
    empty
Valentin Reis's avatar
Valentin Reis committed
268
  vshell "sudo chown root:root /tmp/argo_nodeos_config" empty >>= \case
Valentin Reis's avatar
Valentin Reis committed
269 270 271
    ExitSuccess -> return ()
    ExitFailure n ->
      die ("Failed to set argo_nodeos_config permissions " <> repr n)
Valentin Reis's avatar
Valentin Reis committed
272
  vshell "sudo chmod u+sw /tmp/argo_nodeos_config" empty >>= \case
Valentin Reis's avatar
Valentin Reis committed
273 274
    ExitSuccess   -> return ()
    ExitFailure n -> die ("Setting suid bit failed with exit code " <> repr n)
Valentin Reis's avatar
Valentin Reis committed
275
  vshell "sudo /tmp/argo_nodeos_config --clean_config=kill_content:true" empty
Valentin Reis's avatar
Valentin Reis committed
276
  void $ printInfo "Done setting the environment for nix-build up."
Valentin Reis's avatar
Valentin Reis committed
277 278 279 280
 where
  vshell    = verboseShell verbose
  verbose   = verbosity sa == Verbose
  doVerbose = when verbose
281

Valentin Reis's avatar
Valentin Reis committed
282
nixArguments :: String -> ArgsCommon -> [String]
Valentin Reis's avatar
Valentin Reis committed
283 284 285
nixArguments target ArgsCommon {..} =
  [unpack argopkgs, "-A", target]
    ++ concat [ ["--arg", longform <> "-src", p] | (longform, p) <- overrides ]
Valentin Reis's avatar
Valentin Reis committed
286
    ++ (if grafting == Libnrm then ["--arg", "rebuildApps", "true"] else [])
Valentin Reis's avatar
Valentin Reis committed
287
    ++ [ "--show-trace" | verbosity == Verbose ]
288

Valentin Reis's avatar
Valentin Reis committed
289 290 291 292 293
data NixCommand = NixBuild | NixShell
toCommand :: IsString p => NixCommand -> p
toCommand NixBuild = "nix-build"
toCommand NixShell = "nix-shell"

Valentin Reis's avatar
Valentin Reis committed
294 295
wrap :: NixCommand -> String -> ArgsCommon -> IO ()
wrap nixCommand target sa@ArgsCommon {..} = sh $ do
Valentin Reis's avatar
Valentin Reis committed
296
  when (verbosity == Verbose) $ liftIO $ print sa
Valentin Reis's avatar
Valentin Reis committed
297
  _ <- setupSystem sa
Valentin Reis's avatar
Valentin Reis committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  printCommand $ pack nixc <> " " <> pack (unwords arglist)
  liftIO (executeFile nixc True arglist Nothing)
 where
  nixc = toCommand nixCommand
-- Sources of impurity for this build are: "/tmp/ /etc/argo/ /var/run/
-- /var/lock/. Moreover, sandboxing is disabled, in particular because of:
-- /tmp/nrm-* sockets, /etc/argo, /var/run/, /var/lock/ which all need read
-- access.  until these components are patched to allow for alternative paths,
-- no sandbox use is possible. If sandbox paths were read only we could add:
   {-, "--option"-}
   {-, "build-use-sandbox"-}
   {-, "--option"-}
   {-, "extra-sandbox-paths"-}
   {-, "/tmp/ /etc/argo/ /var/run/ /var/lock/"-}
  arglist =
    nixArguments target sa
      ++ [ "--pure"
         , "--allow-new-privileges"
         , "-K"
         , "--option"
         , "build-use-sandbox"
         ]
Valentin Reis's avatar
Valentin Reis committed
320 321
      ++ [if sandboxing == Sandbox then "true" else "false"]

322

Valentin Reis's avatar
Valentin Reis committed
323
remotely :: String -> ArgsCommon -> ArgsRemote -> IO ()
Valentin Reis's avatar
Valentin Reis committed
324
remotely _ _ _ = putStrLn "unsupported in this version"
Valentin Reis's avatar
Valentin Reis committed
325

Valentin Reis's avatar
Valentin Reis committed
326 327
{-nixshell :: IO ()-}
{-nixshell = undefined-}
Valentin Reis's avatar
Valentin Reis committed
328
  {-ArgsCommon {..} <- liftIO $ execParser opts-}
Valentin Reis's avatar
Valentin Reis committed
329

Valentin Reis's avatar
Valentin Reis committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
  {--- building nixArguments (pure stuff) and shellArguments (impure stuff)-}
  {-let nixArguments = ["-A", if enableApps then "expe" else "test"] ++ concat-}
        {-[ ["--arg", longform <> "-src", encodeString p]-}
        {-| (longform, p) <- overrides-}
        {-]-}
  {-sudo <- which "sudo" >>= \case-}
    {-(Just sudo) -> printf ("Found sudo at " % fp % "\n") sudo >> return sudo-}
    {-Nothing     -> die "sudo not in $PATH."-}
  {-export "SUDO" $ pack $ encodeString sudo-}
  {-let shellArguments =-}
        {-[unpack argopkgs]-}
          {-++ [ "--keep"-}
             {-, "SUDO"-}
             {-, "--pure"-}
             {-, "--allow-new-privileges"-}
             {-, "--option"-}
             {-, "build-extra-sandbox-paths"-}
             {-, encodeString (directory sudo)-}
             {-]-}
          {-++ nixArguments-}
          {-++ (case run of-}
               {-Just cmd -> ["--run", unpack ("\"exec " <> cmd <> "\"")]-}
               {-Nothing  -> []-}
             {-)-}
Valentin Reis's avatar
Valentin Reis committed
354

Valentin Reis's avatar
Valentin Reis committed
355 356 357 358 359 360 361 362 363 364 365 366 367
  {-cachedir <- single $ inproc-}
    {-"mktemp"-}
    {-["-d", "--suffix=nixcache", "/tmp/deletable-nix-cache-XXXX"]-}
    {-empty-}
  {-export "XDG_CACHE_HOME" $ lineToText cachedir-}
  {-case targetMachine of-}
    {-Nothing -> do-}
      {-printf s "Running nix-shell with the following arguments: \n"-}
      {-liftIO $ print shellArguments-}
      {-liftIO $ executeFile "nix-shell" True shellArguments Nothing-}
    {-Just host -> do-}
      {-export "NIX_SSHOPTS" "source .profile; source .bash_profile;"-}
      {-printf s "argonix: creating a derivation in the local store:\n"-}
Valentin Reis's avatar
Valentin Reis committed
368

Valentin Reis's avatar
Valentin Reis committed
369 370 371 372
      {-drv <- single $ inproc-}
        {-"nix-instantiate"-}
        {-(["--quiet", argopkgs, "-A", "test"] ++ fmap pack nixArguments)-}
        {-empty-}
Valentin Reis's avatar
Valentin Reis committed
373

Valentin Reis's avatar
Valentin Reis committed
374
      {-printf (s % "\n") $ lineToText drv-}
Valentin Reis's avatar
Valentin Reis committed
375

Valentin Reis's avatar
Valentin Reis committed
376 377 378 379 380 381 382 383 384
      {-if remoteBuild-}
        {-then do-}
          {-printf-}
            {-s-}
            {-"argonix: copying the derivation's closure (without build output).\n"-}
          {-proc "nix-copy-closure" ["--to", host, lineToText drv] empty-}
        {-else do-}
          {-printf s "argonix: building the derivation's output:\n"-}
          {-proc "nix-store" ["--realize", lineToText drv, "--quiet"] empty-}
Valentin Reis's avatar
Valentin Reis committed
385

Valentin Reis's avatar
Valentin Reis committed
386 387 388 389 390 391
          {-printf-}
            {-s-}
            {-"argonix: copying the derivation's closure (with build output).\n"-}
          {-proc "nix-copy-closure"-}
               {-["--include-outputs", "--to", host, lineToText drv]-}
               {-empty-}
Valentin Reis's avatar
Valentin Reis committed
392

Valentin Reis's avatar
Valentin Reis committed
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
      {-case run of-}
        {-Just cmd -> do-}
          {-_ <- proc-}
            {-"ssh"-}
            {-[ "-t"-}
            {-, host-}
            {-, "source .profile; source .bash_profile; SUDO=$(which sudo) exec nix-shell --keep SUDO --pure --allow-new-privileges --option build-extra-sandbox-paths $(which sudo | xargs dirname) "-}
            {-<> lineToText drv-}
            {-<> " --run "-}
            {-<> "\""-}
            {-<> cmd-}
            {-<> "\""-}
            {-]-}
            {-empty-}
          {-Prelude.mapM_-}
            {-(\r -> proc "scp"-}
                        {-["-r", host <> ":" <> r, fromMaybe "." retreiveAs]-}
                        {-empty-}
            {-)-}
            {-retreive-}
        {-Nothing -> liftIO $ executeFile-}
          {-"ssh"-}
          {-True-}
          {-[ "-t"-}
          {-, unpack host-}
          {-, unpack-}
            {-("source .profile; source .bash_profile; SUDO=$(which sudo) exec nix-shell --keep SUDO --pure --allow-new-privileges --option build-extra-sandbox-paths $(which sudo | xargs dirname) "-}
            {-<> lineToText drv-}
            {-)-}
          {-]-}
          {-Nothing-}
 {-where-}
  {-opts = info-}
Valentin Reis's avatar
Valentin Reis committed
426
    {-(commonParser <**> helper)-}
Valentin Reis's avatar
Valentin Reis committed
427 428 429 430
    {-(  fullDesc-}
    {-<> progDesc "Argo environment provisioning/deployment/execution."-}
    {-<> header "argonix"-}
    {-)-}