Argonix.hs 14.1 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
  } deriving (Show)
Valentin Reis's avatar
Valentin Reis committed
104
data Verbosity = Verbose | Normal deriving (Show, Eq)
Valentin Reis's avatar
Valentin Reis committed
105
data Grafting = Libnrm | NoGraft deriving (Show, Eq)
Valentin Reis's avatar
Valentin Reis committed
106

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

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

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


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

Valentin Reis's avatar
Valentin Reis committed
134 135
remoteParser :: Parser ArgsRemote
remoteParser = do
Valentin Reis's avatar
Valentin Reis committed
136 137 138 139 140 141 142 143 144 145 146 147
  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
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
  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
163 164 165 166 167 168
  grafting <- flag
    NoGraft
    Libnrm
    (long "grafting" <> short 'g' <> help
      "Enable libnrm grafting to avoid rebuilding applications."
    )
Valentin Reis's avatar
Valentin Reis committed
169
  overrides <- catMaybes <$> targets
Valentin Reis's avatar
Valentin Reis committed
170 171 172 173
  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
174
  pure ArgsCommon {..}
Valentin Reis's avatar
Valentin Reis committed
175
 where
Valentin Reis's avatar
Valentin Reis committed
176 177
  targets :: Parser [Maybe (String, String)]
  targets = traverse
Valentin Reis's avatar
Valentin Reis committed
178
    optSrc
Valentin Reis's avatar
Valentin Reis committed
179 180
    [ "aml"
    , "libnrm"
Valentin Reis's avatar
Valentin Reis committed
181 182
    , "nrm"
    , "containers"
Valentin Reis's avatar
Valentin Reis committed
183
    , "argotk"
Valentin Reis's avatar
Valentin Reis committed
184 185 186 187
    , "amg"
    , "lammps"
    , "qmcpack"
    , "stream"
Valentin Reis's avatar
Valentin Reis committed
188
    , "openmc"
Valentin Reis's avatar
Valentin Reis committed
189
    ]
Valentin Reis's avatar
Valentin Reis committed
190
  optSrc :: String -> Parser (Maybe (String, String))
Valentin Reis's avatar
Valentin Reis committed
191 192 193 194 195 196
  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
197
  mapT :: String -> Maybe String -> Maybe (String, String)
Valentin Reis's avatar
Valentin Reis committed
198 199 200 201
  mapT longform thePath = case thePath of
    Nothing -> Nothing
    Just p  -> Just (longform, p)

Valentin Reis's avatar
Valentin Reis committed
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
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"
227

Valentin Reis's avatar
Valentin Reis committed
228
setupSystem :: ArgsCommon -> Shell ()
Valentin Reis's avatar
Valentin Reis committed
229
setupSystem sa = do
Valentin Reis's avatar
Valentin Reis committed
230 231
  doVerbose $ printInfo "Setting the nix-build environment up."
  doVerbose $ printInfo "Cleaning sockets."
Valentin Reis's avatar
Valentin Reis committed
232 233 234 235 236 237 238
  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
239
  doVerbose $ printInfo "Setting up a cache directory:"
Valentin Reis's avatar
Valentin Reis committed
240 241
  cachedir <- single
    $ inproc "mktemp" ["-d", "/tmp/deletable-nix-cache-XXXX"] empty
242
  export "XDG_CACHE_HOME" $ lineToText cachedir
Valentin Reis's avatar
Valentin Reis committed
243 244 245
  doVerbose $ printInfo $ lineToText cachedir <> " exported to XDG_CACHE_HOME"
  doVerbose $ printInfo "running nix-build for the containers attribute."
  doVerbose $ printCommand $ "nix-build " <> pack (unwords (nixArguments "containers" sa))
Valentin Reis's avatar
Valentin Reis committed
246 247
  nodeos_config <- single
    $ inproc "nix-build" (fmap pack (nixArguments "containers" sa)) empty
Valentin Reis's avatar
Valentin Reis committed
248
  doVerbose $ printInfo "Checking filesystem attributes on /tmp"
249
  checkFsAttributes "/tmp"
Valentin Reis's avatar
Valentin Reis committed
250 251
  vshell "sudo rm -rf /tmp/argo_nodeos_config" empty
  vshell
Valentin Reis's avatar
Valentin Reis committed
252 253 254 255
    (format ("cp " % s % "/bin/argo_nodeos_config /tmp/argo_nodeos_config")
            (lineToText nodeos_config)
    )
    empty
Valentin Reis's avatar
Valentin Reis committed
256
  vshell "sudo chown root:root /tmp/argo_nodeos_config" empty >>= \case
Valentin Reis's avatar
Valentin Reis committed
257 258 259
    ExitSuccess -> return ()
    ExitFailure n ->
      die ("Failed to set argo_nodeos_config permissions " <> repr n)
Valentin Reis's avatar
Valentin Reis committed
260
  vshell "sudo chmod u+sw /tmp/argo_nodeos_config" empty >>= \case
Valentin Reis's avatar
Valentin Reis committed
261 262
    ExitSuccess   -> return ()
    ExitFailure n -> die ("Setting suid bit failed with exit code " <> repr n)
Valentin Reis's avatar
Valentin Reis committed
263
  vshell "sudo /tmp/argo_nodeos_config --clean_config=kill_content:true" empty
Valentin Reis's avatar
Valentin Reis committed
264
  void $ printInfo "Done setting the environment for nix-build up."
Valentin Reis's avatar
Valentin Reis committed
265 266 267
  where vshell = verboseShell verbose
        verbose = verbosity sa == Verbose
        doVerbose = when verbose
268

Valentin Reis's avatar
Valentin Reis committed
269
nixArguments :: String -> ArgsCommon -> [String]
Valentin Reis's avatar
Valentin Reis committed
270 271 272
nixArguments target ArgsCommon {..} =
  [unpack argopkgs, "-A", target]
    ++ concat [ ["--arg", longform <> "-src", p] | (longform, p) <- overrides ]
273
    ++ (if grafting == Libnrm then ["--arg", "rebuildApps", "false"] else [])
Valentin Reis's avatar
Valentin Reis committed
274
    ++ [ "--show-trace" | verbosity == Verbose ]
275

Valentin Reis's avatar
Valentin Reis committed
276 277 278 279 280
data NixCommand = NixBuild | NixShell
toCommand :: IsString p => NixCommand -> p
toCommand NixBuild = "nix-build"
toCommand NixShell = "nix-shell"

Valentin Reis's avatar
Valentin Reis committed
281 282
wrap :: NixCommand -> String -> ArgsCommon -> IO ()
wrap nixCommand target sa@ArgsCommon {..} = sh $ do
Valentin Reis's avatar
Valentin Reis committed
283
  when (verbosity == Verbose) $ liftIO $ print sa
Valentin Reis's avatar
Valentin Reis committed
284
  _ <- setupSystem sa
Valentin Reis's avatar
Valentin Reis committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
  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"
         , "false"
         ]
308

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

Valentin Reis's avatar
Valentin Reis committed
312 313
{-nixshell :: IO ()-}
{-nixshell = undefined-}
Valentin Reis's avatar
Valentin Reis committed
314
  {-ArgsCommon {..} <- liftIO $ execParser opts-}
Valentin Reis's avatar
Valentin Reis committed
315

Valentin Reis's avatar
Valentin Reis committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
  {--- 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
340

Valentin Reis's avatar
Valentin Reis committed
341 342 343 344 345 346 347 348 349 350 351 352 353
  {-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
354

Valentin Reis's avatar
Valentin Reis committed
355 356 357 358
      {-drv <- single $ inproc-}
        {-"nix-instantiate"-}
        {-(["--quiet", argopkgs, "-A", "test"] ++ fmap pack nixArguments)-}
        {-empty-}
Valentin Reis's avatar
Valentin Reis committed
359

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

Valentin Reis's avatar
Valentin Reis committed
362 363 364 365 366 367 368 369 370
      {-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
371

Valentin Reis's avatar
Valentin Reis committed
372 373 374 375 376 377
          {-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
378

Valentin Reis's avatar
Valentin Reis committed
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
      {-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
412
    {-(commonParser <**> helper)-}
Valentin Reis's avatar
Valentin Reis committed
413 414 415 416
    {-(  fullDesc-}
    {-<> progDesc "Argo environment provisioning/deployment/execution."-}
    {-<> header "argonix"-}
    {-)-}