Argonix.hs 13.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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
-- | Miscellaneous printing utilities
colorShell :: Color -> Shell () -> Shell ()
colorShell color she = setC color *> she *> setC White
  where setC c = liftIO $ setSGR [SetColor Foreground Dull c]
verboseShell :: Text -> Shell Line -> Shell ExitCode
verboseShell c i = printCommand c >> shell c i
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 98
data ArgsCommon = ArgsCommon
  { argopkgs      :: Text
Valentin Reis's avatar
Valentin Reis committed
99
   , verbosity     :: Verbosity
Valentin Reis's avatar
Valentin Reis committed
100
   , run           :: Maybe Text
Valentin Reis's avatar
Valentin Reis committed
101
   , overrides     :: [(String, String)]
Valentin Reis's avatar
Valentin Reis committed
102
  } deriving (Show)
Valentin Reis's avatar
Valentin Reis committed
103
data Verbosity = Verbose | Normal deriving (Show, Eq)
Valentin Reis's avatar
Valentin Reis committed
104

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

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

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


127 128 129 130
targetParser :: Parser String
targetParser =
  strArgument (metavar "TARGET" <> showDefault <> help "The build target.")

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

Valentin Reis's avatar
Valentin Reis committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
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"
218

Valentin Reis's avatar
Valentin Reis committed
219
setupSystem :: ArgsCommon -> Shell ()
Valentin Reis's avatar
Valentin Reis committed
220
setupSystem sa = do
Valentin Reis's avatar
Valentin Reis committed
221 222 223 224 225 226 227 228 229 230 231 232
  printInfo "Setting the nix-build environment up."
  printInfo "Cleaning sockets."
  Prelude.mapM_
    cleanSocket
    [ "/tmp/nrm-downstream-in"
    , "/tmp/nrm-downstream-event"
    , "/tmp/nrm-upstream-in"
    , "/tmp/nrm-upstream-event"
    ]
  printInfo "Setting up a cache directory:"
  cachedir <- single
    $ inproc "mktemp" ["-d", "/tmp/deletable-nix-cache-XXXX"] empty
233
  export "XDG_CACHE_HOME" $ lineToText cachedir
Valentin Reis's avatar
Valentin Reis committed
234 235
  printInfo $ lineToText cachedir <> " exported to XDG_CACHE_HOME"
  printInfo "running nix-build for the containers attribute."
Valentin Reis's avatar
Valentin Reis committed
236
  printCommand $ "nix-build " <> pack (unwords (nixArguments "containers" sa))
Valentin Reis's avatar
Valentin Reis committed
237 238 239
  nodeos_config <- single
    $ inproc "nix-build" (fmap pack (nixArguments "containers" sa)) empty
  printInfo "Checking filesystem attributes on /tmp"
240
  checkFsAttributes "/tmp"
Valentin Reis's avatar
Valentin Reis committed
241 242 243 244 245 246 247 248 249 250 251 252 253
  verboseShell "sudo rm -rf /tmp/argo_nodeos_config" empty
  verboseShell
    (format ("cp " % s % "/bin/argo_nodeos_config /tmp/argo_nodeos_config")
            (lineToText nodeos_config)
    )
    empty
  verboseShell "sudo chown root:root /tmp/argo_nodeos_config" empty >>= \case
    ExitSuccess -> return ()
    ExitFailure n ->
      die ("Failed to set argo_nodeos_config permissions " <> repr n)
  verboseShell "sudo chmod u+sw /tmp/argo_nodeos_config" empty >>= \case
    ExitSuccess   -> return ()
    ExitFailure n -> die ("Setting suid bit failed with exit code " <> repr n)
Valentin Reis's avatar
Valentin Reis committed
254 255
  verboseShell "sudo /tmp/argo_nodeos_config --clean_config=kill_content:true"
               empty
Valentin Reis's avatar
Valentin Reis committed
256
  void $ printInfo "Done setting the environment for nix-build up."
257

Valentin Reis's avatar
Valentin Reis committed
258 259
nixArguments :: String -> ArgsCommon -> [String]
nixArguments target ArgsCommon {..} = [unpack argopkgs, "-A", target]
Valentin Reis's avatar
Valentin Reis committed
260
  ++ concat [ ["--arg", longform <> "-src", p] | (longform, p) <- overrides ]
261

Valentin Reis's avatar
Valentin Reis committed
262 263 264 265 266
data NixCommand = NixBuild | NixShell
toCommand :: IsString p => NixCommand -> p
toCommand NixBuild = "nix-build"
toCommand NixShell = "nix-shell"

Valentin Reis's avatar
Valentin Reis committed
267 268
wrap :: NixCommand -> String -> ArgsCommon -> IO ()
wrap nixCommand target sa@ArgsCommon {..} = sh $ do
Valentin Reis's avatar
Valentin Reis committed
269
  when (verbosity == Verbose) $ liftIO $ print sa
Valentin Reis's avatar
Valentin Reis committed
270
  _ <- setupSystem sa
Valentin Reis's avatar
Valentin Reis committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  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"
         ]
294

Valentin Reis's avatar
Valentin Reis committed
295 296 297 298
remotely :: String -> ArgsCommon -> ArgsRemote -> IO ()
remotely _ _ _ = do
  putStrLn "Remote argonix execution unsupported in this version yet."

Valentin Reis's avatar
Valentin Reis committed
299 300
{-nixshell :: IO ()-}
{-nixshell = undefined-}
Valentin Reis's avatar
Valentin Reis committed
301
  {-ArgsCommon {..} <- liftIO $ execParser opts-}
Valentin Reis's avatar
Valentin Reis committed
302

Valentin Reis's avatar
Valentin Reis committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
  {--- 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
327

Valentin Reis's avatar
Valentin Reis committed
328 329 330 331 332 333 334 335 336 337 338 339 340
  {-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
341

Valentin Reis's avatar
Valentin Reis committed
342 343 344 345
      {-drv <- single $ inproc-}
        {-"nix-instantiate"-}
        {-(["--quiet", argopkgs, "-A", "test"] ++ fmap pack nixArguments)-}
        {-empty-}
Valentin Reis's avatar
Valentin Reis committed
346

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

Valentin Reis's avatar
Valentin Reis committed
349 350 351 352 353 354 355 356 357
      {-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
358

Valentin Reis's avatar
Valentin Reis committed
359 360 361 362 363 364
          {-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
365

Valentin Reis's avatar
Valentin Reis committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
      {-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
399
    {-(commonParser <**> helper)-}
Valentin Reis's avatar
Valentin Reis committed
400 401 402 403
    {-(  fullDesc-}
    {-<> progDesc "Argo environment provisioning/deployment/execution."-}
    {-<> header "argonix"-}
    {-)-}