Extract applyAdd and infer command from args (#437)

* Extract applyAdd and infer command from args

* Fixup

Author: nmattia

src/Niv/Cli.hs

@@ -256,31 +256,24 @@ cmdInit nixpkgs = do
     dontCreateFile path = say $ "Not creating " <> path
 
 initNixpkgs :: FetchNixpkgs -> NIO ()
-initNixpkgs nixpkgs =
+initNixpkgs nixpkgs = modifySources $ \sources -> do
   case nixpkgs of
-    NoNixpkgs -> say "Not importing 'nixpkgs'."
+    NoNixpkgs -> say "Not importing 'nixpkgs'." >> pure sources
     NixpkgsFast -> do
       say "Using known 'nixpkgs' ..."
       packageSpec <- HTTP.getResponseBody <$> HTTP.httpJSON "https://raw.githubusercontent.com/nmattia/niv/master/data/nixpkgs.json"
-      cmdAdd
-        githubCmd
-        (PackageName "nixpkgs")
-        (specToLockedAttrs packageSpec)
-      pure ()
-    NixpkgsCustom branch nixpkgs' -> do
+      applyAdd sources (PackageName "nixpkgs", packageSpec)
+    NixpkgsCustom branch (Nixpkgs owner repo) -> do
       say "Importing 'nixpkgs' ..."
-      let (owner, repo) = case nixpkgs' of
-            Nixpkgs o r -> (o, r)
-      cmdAdd
-        githubCmd
-        (PackageName "nixpkgs")
-        ( specToFreeAttrs $
-            PackageSpec $
-              KM.fromList
-                [ "owner" .= owner,
-                  "repo" .= repo,
-                  "branch" .= branch
-                ]
+      applyAdd
+        sources
+        ( PackageName "nixpkgs",
+          PackageSpec $
+            KM.fromList
+              [ "owner" .= owner,
+                "repo" .= repo,
+                "branch" .= branch
+              ]
         )
 
 -------------------------------------------------------------------------------
@@ -298,8 +291,8 @@ parseCmdAdd =
     -- implementer: it'll be tricky to have the correct arguments show up
     -- without repeating "PACKAGE PACKAGE PACKAGE" for every package type.
     parseShortcuts = parseShortcut githubCmd
-    parseShortcut cmd = uncurry (cmdAdd cmd) <$> parseShortcutArgs cmd
-    parseCmd cmd = uncurry (cmdAdd cmd) <$> parseCmdArgs cmd
+    parseShortcut cmd = uncurry cmdAdd <$> parseShortcutArgs cmd
+    parseCmd cmd = uncurry cmdAdd <$> parseCmdArgs cmd
     parseCmdAddGit =
       Opts.info (parseCmd gitCmd <**> Opts.helper) (description gitCmd)
     parseCmdAddLocal =
@@ -370,20 +363,32 @@ parseCmdArgs cmd = collapse <$> parseNameAndShortcut <*> parsePackageSpec cmd
                 <> Opts.help "Set the package name to <NAME>"
             )
 
-cmdAdd :: Cmd -> PackageName -> Attrs -> NIO ()
-cmdAdd cmd packageName attrs = do
+cmdAdd :: PackageName -> Attrs -> NIO ()
+cmdAdd packageName attrs = do
   job ("Adding package " <> T.unpack (unPackageName packageName)) $ do
-    modifySources $ \(unSources -> sources) -> do
-      when (HMS.member packageName sources) $
-        li $
-          abortCannotAddPackageExists packageName
-      eFinalSpec <- fmap attrsToSpec <$> li (doUpdate attrs cmd)
-      case eFinalSpec of
-        Left e -> li (abortUpdateFailed [(packageName, e)])
-        Right finalSpec -> do
-          pure $
-            Sources $
-              HMS.insert packageName finalSpec sources
+    let spec = attrsToSpec attrs
+    modifySources $ \sources -> applyAdd sources (packageName, spec)
+
+applyAdd :: Sources -> (PackageName, PackageSpec) -> NIO Sources
+applyAdd (unSources -> sources) (packageName, defaultSpec) = do
+  cmds <- getCmds
+
+  -- infer what command (git, github, etc) to use to add the package
+  cmd <- case inferCmd cmds defaultSpec of
+    Just cmd -> pure cmd
+    Nothing -> li $ abortNoSuitableCommandForAdd packageName
+
+  when (HMS.member packageName sources) $
+    li $
+      abortCannotAddPackageExists packageName
+
+  let attrs = specToLockedAttrs defaultSpec
+  eFinalSpec <- fmap attrsToSpec <$> li (doUpdate attrs cmd)
+  finalSpec <- case eFinalSpec of
+    Left e -> li (abortUpdateFailed [(packageName, e)])
+    Right finalSpec -> pure finalSpec
+
+  pure $ Sources $ HMS.insert packageName finalSpec sources
 
 -------------------------------------------------------------------------------
 -- SHOW
@@ -464,7 +469,7 @@ updatePackage packageName defaultSpec mSpec = do
   -- infer what command (git, github, etc) to use to update the package
   cmd <- case inferCmd cmds defaultSpec of
     Just cmd -> pure cmd
-    Nothing -> li $ abortNoSuitableCommand packageName
+    Nothing -> li $ abortNoSuitableCommandForUpdate packageName
 
   job ("Update " <> T.unpack (unPackageName packageName)) $
     fmap attrsToSpec <$> li (doUpdate attrs cmd)
@@ -772,6 +777,10 @@ abortUpdateFailed errs =
           )
           errs
 
-abortNoSuitableCommand :: PackageName -> IO a
-abortNoSuitableCommand pname =
+abortNoSuitableCommandForUpdate :: PackageName -> IO a
+abortNoSuitableCommandForUpdate pname =
   abort $ "Don't know how to update package: " <> unPackageName pname
+
+abortNoSuitableCommandForAdd :: PackageName -> IO a
+abortNoSuitableCommandForAdd pname =
+  abort $ "Don't know how to add package: " <> unPackageName pname

src/Niv/Cmd.hs

@@ -10,7 +10,10 @@ import qualified Options.Applicative as Opts
 
 data Cmd = Cmd
   { description :: forall a. Opts.InfoMod a,
+    -- | Important: if an object is returned, then it should be accepted by 'acceptsCmd'
     parseCmdShortcut :: T.Text -> Maybe (PackageName, Aeson.Object),
+
+    -- | Important: if an object is returned, then it should be accepted by 'acceptsCmd'
     parsePackageSpec :: Opts.Parser PackageSpec,
     updateCmd :: Update () (),
     name :: T.Text,

src/Niv/Git/Cmd.hs

@@ -8,6 +8,7 @@ module Niv.Git.Cmd where
 
 import Control.Applicative
 import Control.Arrow
+import Data.Aeson ((.=))
 import qualified Data.Aeson as Aeson
 import qualified Data.Aeson.Key as K
 import qualified Data.Aeson.KeyMap as KM
@@ -64,8 +65,8 @@ parseGitShortcut txt'@(T.dropWhileEnd (== '/') -> txt) =
     then case T.splitOn "/" txt of
       [] -> Nothing
       (last -> w) -> case T.stripSuffix ".git" w of
-        Nothing -> Just (PackageName w, KM.singleton "repo" (Aeson.String txt'))
-        Just w' -> Just (PackageName w', KM.singleton "repo" (Aeson.String txt'))
+        Nothing -> Just (PackageName w, KM.fromList [ "repo" .= txt', "type" .= Aeson.String "git" ])
+        Just w' -> Just (PackageName w', KM.fromList [ "repo" .= txt', "type" .= Aeson.String "git" ])
     else Nothing
   where
     isGitURL =
@@ -78,7 +79,7 @@ parseGitShortcut txt'@(T.dropWhileEnd (== '/') -> txt) =
 
 parseGitPackageSpec :: Opts.Parser PackageSpec
 parseGitPackageSpec =
-  PackageSpec . KM.fromList
+  PackageSpec . KM.fromList . (["type" .= Aeson.String "git"] <> )
     <$> many (parseRepo <|> parseBranch <|> parseRev <|> parseAttr <|> parseSAttr)
   where
     parseRepo =

src/Niv/Git/Test.hs

@@ -6,6 +6,8 @@ module Niv.Git.Test
   )
 where
 
+import Data.Aeson ((.=))
+import qualified Data.Aeson as Aeson
 import Control.Monad
 import qualified Data.Aeson.KeyMap as KM
 import Data.Bifunctor
@@ -30,21 +32,21 @@ test_repositoryParse =
       Tasty.testCase "git@github.com:nmattia/niv" $
         parseGitShortcut "git@github.com:nmattia/niv"
           @=? Just
-            (PackageName "niv", KM.singleton "repo" "git@github.com:nmattia/niv"),
+            (PackageName "niv", KM.fromList [ "repo" .= Aeson.String "git@github.com:nmattia/niv" , "type" .= Aeson.String "git" ]),
       Tasty.testCase "ssh://git@github.com/stedolan/jq" $
         parseGitShortcut "ssh://git@github.com/stedolan/jq"
           @=? Just
-            (PackageName "jq", KM.singleton "repo" "ssh://git@github.com/stedolan/jq"),
+            (PackageName "jq", KM.fromList [ "repo" .= Aeson.String "ssh://git@github.com/stedolan/jq", "type" .= Aeson.String "git" ]),
       Tasty.testCase "https://github.com/stedolan/jq.git" $
         parseGitShortcut "https://github.com/stedolan/jq.git"
           @=? Just
-            (PackageName "jq", KM.singleton "repo" "https://github.com/stedolan/jq.git"),
+            (PackageName "jq", KM.fromList [ "repo" .= Aeson.String "https://github.com/stedolan/jq.git", "type" .= Aeson.String "git" ]),
       Tasty.testCase "https://github.com/stedolan/jq" $
         parseGitShortcut "https://github.com/stedolan/jq" @=? Nothing,
       Tasty.testCase "~/path/to/repo.git" $
         parseGitShortcut "~/path/to/repo.git"
           @=? Just
-            (PackageName "repo", KM.singleton "repo" "~/path/to/repo.git")
+            (PackageName "repo", KM.fromList [ "repo" .= Aeson.String "~/path/to/repo.git", "type" .= Aeson.String "git" ])
     ]
 
 test_gitUpdates :: Tasty.TestTree

src/Niv/Local/Cmd.hs

@@ -36,11 +36,11 @@ parseLocalShortcut txt =
   if T.isPrefixOf "./" txt || T.isPrefixOf "/" txt
     then do
       let n = last $ T.splitOn "/" txt
-      Just (PackageName n, KM.fromList [("path", Aeson.String txt)])
+      Just (PackageName n, KM.fromList [("path", Aeson.String txt), ("type", Aeson.String "local")])
     else Nothing
 
 parseLocalPackageSpec :: Opts.Parser PackageSpec
-parseLocalPackageSpec = PackageSpec . KM.fromList <$> parseParams
+parseLocalPackageSpec = PackageSpec . KM.fromList . ([("type", Aeson.String "local")] <> ) <$> parseParams
   where
     parseParams :: Opts.Parser [(K.Key, Aeson.Value)]
     parseParams = maybe [] pure <$> Opts.optional parsePath
@@ -61,6 +61,6 @@ describeLocal =
           Opts.vcat
             [ "Examples:",
               "",
-              "  niv add local ./foo/bar"
+              "  niv add local --name some-package --path ./foo/bar"
             ]
     ]

tests/default.nix

@@ -17,7 +17,8 @@ let
   eval = collectResults "eval-tests" (import ./eval { inherit pkgs niv; });
   github = collectResults "github-tests" (import ./github { inherit pkgs niv; });
   git = collectResults "git-tests" (import ./git { inherit pkgs niv; });
+  local = collectResults "local-tests" (import ./local { inherit pkgs niv; });
 
 in
 
-{ inherit eval github git; }
+{ inherit eval github git local; }

tests/local/default.nix

@@ -0,0 +1,50 @@
+{ pkgs, niv }:
+
+{
+  local =
+    pkgs.runCommand "local-test"
+      { nativeBuildInputs = [ niv pkgs.nix pkgs.jq ]; }
+      (
+
+        ''
+      # don't use /nix/store (even evaluation adds files to the store)
+      # https://github.com/NixOS/nix/issues/3258
+      export NIX_REMOTE="local?root=$TMPDIR/local-test-store"
+      export NIX_STATE_DIR=$TMPDIR
+
+      export HOME="$TMPDIR/homeless"
+
+      # custom nix.conf
+      export NIX_USER_CONF_FILES=$(mktemp)
+      echo 'extra-experimental-features = nix-command flakes' >> "$NIX_USER_CONF_FILES"
+
+      # create a dir
+
+      localdir="my-dir"
+      mkdir -p "$localdir"
+      pushd $localdir > /dev/null
+      echo hello > file
+      echo world >> file
+      popd > /dev/null
+
+      # then we niv add the dir containing the files
+
+      nivdir=$(mktemp -d)
+      pushd $nivdir > /dev/null
+      mkdir -p nix
+      echo "{}" > nix/sources.json
+      niv init --latest
+      niv add local --name my-dir --path=$localdir
+
+      nivdir=$(nix eval --json --impure --expr '(import ./nix/sources.nix).my-dir.path' | jq -r)
+      if [ ! "$localdir" = "$nivdir" ]; then
+        echo "Mismatched dirs: $localdir != $nivdir"
+        exit 42
+      fi
+
+      popd > /dev/null
+
+      touch $out
+        ''
+      );
+}