Add package.isLocal for plan-to-nix & stack-to-nix (input-output-hk#63)

Author: hamishmack

nix-tools/cabal2nix/Main.hs

@@ -48,10 +48,10 @@ main = getArgs >>= \case
             (Just (DerivationSource{..}, genBindings)) -> genBindings derivHash
             _ -> return ()
   [path,file] -> doesDirectoryExist file >>= \case
-    False -> print . prettyNix =<< cabal2nix MinimalDetails (Just (Path path)) (OnDisk file)
+    False -> print . prettyNix =<< cabal2nix False MinimalDetails (Just (Path path)) (OnDisk file)
     True  -> print . prettyNix =<< cabalexprs file
   [file] -> doesDirectoryExist file >>= \case
-    False -> print . prettyNix =<< cabal2nix MinimalDetails (Just (Path ".")) (OnDisk file)
+    False -> print . prettyNix =<< cabal2nix False MinimalDetails (Just (Path ".")) (OnDisk file)
     True  -> print . prettyNix =<< cabalexprs file
   _ -> putStrLn "call with cabalfile (Cabal2Nix file.cabal)."
 
@@ -72,7 +72,7 @@ cabalFromPath url rev subdir path = do
           subdir' = if subdir == "." then Nothing
                     else Just subdir
           src = Just $ Git url rev (Just sha256) subdir'
-      print . prettyNix =<< cabal2nix MinimalDetails src cabalFile
+      print . prettyNix =<< cabal2nix False MinimalDetails src cabalFile
 
 findCabalFiles :: FilePath -> IO [CabalFile]
 findCabalFiles path = doesFileExist (path </> Hpack.packageConfig) >>= \case
@@ -103,7 +103,7 @@ expr p pkg version = do
   doesFileExist (cabalFilePath cabal) >>= \case
     True ->
       do createDirectoryIfMissing True pkg'
-         writeDoc nix =<< prettyNix <$> cabal2nix MinimalDetails Nothing cabal
+         writeDoc nix =<< prettyNix <$> cabal2nix False MinimalDetails Nothing cabal
          pure $ version' $= mkRelPath nix
     False -> pure $ version' $= mkNull
 

nix-tools/ci.nix

@@ -1,6 +1,6 @@
 builtins.mapAttrs (k: _v:
   let
-    pkgs = import (builtins.fetchTarball "https://github.com/input-output-hk/haskell.nix/archive/160ecb6fd7eaa203c4939f79cdc5b5e2b24dd71e.tar.gz") {
+    pkgs = import (builtins.fetchTarball "https://github.com/input-output-hk/haskell.nix/archive/57d58888d91f978fccd8648a05fe79dff71d2384.tar.gz") {
         nixpkgs = builtins.fetchTarball "https://github.com/NixOS/nixpkgs/archive/2255f292063ccbe184ff8f9b35ce475c04d5ae69.tar.gz";
         nixpkgsArgs = { system = k; };
       };
@@ -13,6 +13,7 @@ builtins.mapAttrs (k: _v:
 ) {
   x86_64-linux = {};
 
+
   # Uncomment to test build on macOS too
   # x86_64-darwin = {};
 }

nix-tools/hackage2nix/Main.hs

@@ -56,7 +56,7 @@ main = do
   createDirectoryIfMissing False (out </> "hackage")
 
   for_ cabalFiles $ \(cabalFile, pname, path) -> do
-    gpd <- cabal2nix MinimalDetails Nothing $ InMemory Nothing pname $ BL.toStrict cabalFile
+    gpd <- cabal2nix False MinimalDetails Nothing $ InMemory Nothing pname $ BL.toStrict cabalFile
     writeFile (out </> path) $ show $ prettyNix gpd
 
 type GPDWriter = State (Seq (BL.ByteString, String, FilePath))

nix-tools/lib/Cabal2Nix.hs

@@ -56,10 +56,10 @@ flags  = "flags"
 buildDepError, sysDepError, pkgConfDepError, exeDepError, legacyExeDepError, buildToolDepError :: Text
 buildDepError = "buildDepError"
 sysDepError = "sysDepError"
-pkgConfDepError = "pkgConfDepError" 
+pkgConfDepError = "pkgConfDepError"
 exeDepError = "exeDepError"
 legacyExeDepError = "legacyExeDepError"
-buildToolDepError = "buildToolDepError" 
+buildToolDepError = "buildToolDepError"
 
 ($//?) :: NExpr -> Maybe NExpr -> NExpr
 lhs $//? (Just e) = lhs $// e
@@ -87,17 +87,17 @@ genExtra Hpack = mkNonRecSet [ "cabal-generator" $= mkStr "hpack" ]
 
 data CabalDetailLevel = MinimalDetails | FullDetails deriving (Show, Eq)
 
-cabal2nix :: CabalDetailLevel -> Maybe Src -> CabalFile -> IO NExpr
-cabal2nix fileDetails src = \case
-  (OnDisk path) -> gpd2nix fileDetails src Nothing
+cabal2nix :: Bool -> CabalDetailLevel -> Maybe Src -> CabalFile -> IO NExpr
+cabal2nix isLocal fileDetails src = \case
+  (OnDisk path) -> gpd2nix isLocal fileDetails src Nothing
     <$> readGenericPackageDescription normal path
-  (InMemory gen _ body) -> gpd2nix fileDetails src (genExtra <$> gen)
+  (InMemory gen _ body) -> gpd2nix isLocal fileDetails src (genExtra <$> gen)
     <$> case runParseResult (parseGenericPackageDescription body) of
         (_, Left (_, err)) -> error ("Failed to parse in-memory cabal file: " ++ show err)
         (_, Right desc) -> pure desc
 
-gpd2nix :: CabalDetailLevel -> Maybe Src -> Maybe NExpr -> GenericPackageDescription -> NExpr
-gpd2nix fileDetails src extra gpd = mkLets errorFunctions $ mkFunction args $ toNix' fileDetails gpd $//? (toNix <$> src) $//? extra
+gpd2nix :: Bool -> CabalDetailLevel -> Maybe Src -> Maybe NExpr -> GenericPackageDescription -> NExpr
+gpd2nix isLocal fileDetails src extra gpd = mkLets errorFunctions $ mkFunction args $ toNixGenericPackageDescription isLocal fileDetails gpd $//? (toNix <$> src) $//? extra
   where args :: Params NExpr
         args = mkParamset [ ("system", Nothing)
                           , ("compiler", Nothing)
@@ -108,44 +108,44 @@ gpd2nix fileDetails src extra gpd = mkLets errorFunctions $ mkFunction args $ to
                           True
 
 errorFunctions :: [Binding NExpr]
-errorFunctions = 
-  [ buildDepError $= mkFunction "pkg" (mkThrow $ 
-      Fix $ NStr $ Indented 0 
-          [ Plain "The Haskell package set does not contain the package: " 
+errorFunctions =
+  [ buildDepError $= mkFunction "pkg" (mkThrow $
+      Fix $ NStr $ Indented 0
+          [ Plain "The Haskell package set does not contain the package: "
           , Antiquoted "pkg"
           , Plain " (build dependency).\n\n"
           , Plain haskellUpdateSnippet
           ])
-  , sysDepError $= mkFunction "pkg" (mkThrow $ 
-      Fix $ NStr $ Indented 0 
-          [ Plain "The Nixpkgs package set does not contain the package: " 
+  , sysDepError $= mkFunction "pkg" (mkThrow $
+      Fix $ NStr $ Indented 0
+          [ Plain "The Nixpkgs package set does not contain the package: "
           , Antiquoted "pkg"
           , Plain " (system dependency).\n\n"
           , Plain systemUpdateSnippet
           ])
-  , pkgConfDepError $= mkFunction "pkg" (mkThrow $ 
-      Fix $ NStr $ Indented 0 
-          [ Plain "The pkg-conf packages does not contain the package: " 
+  , pkgConfDepError $= mkFunction "pkg" (mkThrow $
+      Fix $ NStr $ Indented 0
+          [ Plain "The pkg-conf packages does not contain the package: "
           , Antiquoted "pkg"
           , Plain " (pkg-conf dependency).\n\n"
           , Plain "You may need to augment the pkg-conf package mapping in haskell.nix so that it can be found."
           ])
-  , exeDepError $= mkFunction "pkg" (mkThrow $ 
-      Fix $ NStr $ Indented 0 
-          [ Plain "The local executable components do not include the component: " 
+  , exeDepError $= mkFunction "pkg" (mkThrow $
+      Fix $ NStr $ Indented 0
+          [ Plain "The local executable components do not include the component: "
           , Antiquoted "pkg"
           , Plain " (executable dependency)."
           ])
-  , legacyExeDepError $= mkFunction "pkg" (mkThrow $ 
-      Fix $ NStr $ Indented 0 
-          [ Plain "The Haskell package set does not contain the package: " 
+  , legacyExeDepError $= mkFunction "pkg" (mkThrow $
+      Fix $ NStr $ Indented 0
+          [ Plain "The Haskell package set does not contain the package: "
           , Antiquoted "pkg"
           , Plain " (executable dependency).\n\n"
           , Plain haskellUpdateSnippet
           ])
-  , buildToolDepError $= mkFunction "pkg" (mkThrow $ 
-      Fix $ NStr $ Indented 0 
-          [ Plain "Neither the Haskell package set or the Nixpkgs package set contain the package: " 
+  , buildToolDepError $= mkFunction "pkg" (mkThrow $
+      Fix $ NStr $ Indented 0
+          [ Plain "Neither the Haskell package set or the Nixpkgs package set contain the package: "
           , Antiquoted "pkg"
           , Plain " (build tool dependency).\n\n"
           , Plain "If this is a system dependency:\n"
@@ -213,9 +213,6 @@ capitalize = transformFst toUpper
 class ToNixExpr a where
   toNix :: a -> NExpr
 
-class ToNixExpr' a where
-  toNix' :: CabalDetailLevel -> a -> NExpr
-
 class ToNixBinding a where
   toNixBinding :: a -> Binding NExpr
 
@@ -242,8 +239,8 @@ instance ToNixExpr PackageIdentifier where
   toNix ident = mkNonRecSet [ "name"    $= mkStr (fromString (show (disp (pkgName ident))))
                             , "version" $= mkStr (fromString (show (disp (pkgVersion ident))))]
 
-instance ToNixExpr' PackageDescription where
-  toNix' detailLevel pd = mkNonRecSet $
+toNixPackageDescription :: Bool -> CabalDetailLevel -> PackageDescription -> NExpr
+toNixPackageDescription isLocal detailLevel pd = mkNonRecSet $
     [ "specVersion" $= mkStr (fromString (show (disp (specVersion pd))))
     , "identifier"  $= toNix (package pd)
     , "license"     $= mkStr (fromString (show (pretty (license pd))))
@@ -260,6 +257,8 @@ instance ToNixExpr' PackageDescription where
 
     , "buildType"   $= mkStr (fromString (show (pretty (buildType pd))))
     ] ++
+    [ "isLocal"     $= mkBool True | isLocal
+    ] ++
     [ "setup-depends" $= toNix (BuildToolDependency . depPkgName <$> deps) | Just deps <- [setupDepends <$> setupBuildInfo pd ]] ++
     if detailLevel == MinimalDetails
       then []
@@ -279,10 +278,10 @@ newtype BuildToolDependency = BuildToolDependency { unBuildToolDependency :: Pac
 mkSysDep :: String -> SysDependency
 mkSysDep = SysDependency
 
-instance ToNixExpr' GenericPackageDescription where
-  toNix' detailLevel gpd = mkNonRecSet
+toNixGenericPackageDescription :: Bool -> CabalDetailLevel -> GenericPackageDescription -> NExpr
+toNixGenericPackageDescription isLocal detailLevel gpd = mkNonRecSet
                           [ "flags"         $= (mkNonRecSet . fmap toNixBinding $ genPackageFlags gpd)
-                          , "package"       $= toNix' detailLevel (packageDescription gpd)
+                          , "package"       $= toNixPackageDescription isLocal detailLevel (packageDescription gpd)
                           , "components"    $= components ]
     where _packageName :: IsString a => a
           _packageName = fromString . show . disp . pkgName . package . packageDescription $ gpd

nix-tools/plan2nix/Plan2Nix.hs

@@ -90,7 +90,7 @@ plan2nix args (Plan { packages, extras, compilerVersion, compilerPackages }) = d
                src = Just . C2N.Path $ relPath </> ".." </> (shortRelativePath cwd folder)
            in do createDirectoryIfMissing True (takeDirectory nixFile)
                  writeDoc nixFile =<<
-                   prettyNix <$> cabal2nix (argDetailLevel args) src cabalFile
+                   prettyNix <$> cabal2nix True (argDetailLevel args) src cabalFile
                  return $ fromString pkg $= mkPath False nix
     (name, Just (Package v r flags (Just (DVCS (Git url rev) subdirs)))) ->
       fmap concat . forM subdirs $ \subdir ->
@@ -153,7 +153,7 @@ plan2nix args (Plan { packages, extras, compilerVersion, compilerPackages }) = d
                 src = Just $ C2N.Git url rev (Just sha256) subdir'
             createDirectoryIfMissing True (takeDirectory nixFile)
             writeDoc nixFile =<<
-              prettyNix <$> cabal2nix (argDetailLevel args) src cabalFile
+              prettyNix <$> cabal2nix True (argDetailLevel args) src cabalFile
             liftIO $ appendCache (argCacheFile args) url rev subdir sha256 pkg nix
             return $ fromString pkg $= mkPath False nix
 

nix-tools/stack2nix/Stack2nix.hs

@@ -141,7 +141,7 @@ packages2nix args (Stack _ _ pkgs _) =
                   src = Just . C2N.Path $ relPath </> folder
               in do createDirectoryIfMissing True (takeDirectory nixFile)
                     writeDoc nixFile =<<
-                      prettyNix <$> cabal2nix (argDetailLevel args) src cabalFile
+                      prettyNix <$> cabal2nix True (argDetailLevel args) src cabalFile
                     return $ fromString pkg $= mkPath False nix
        (DVCS (Git url rev) subdirs) ->
          fmap concat . forM subdirs $ \subdir ->
@@ -177,7 +177,7 @@ packages2nix args (Stack _ _ pkgs _) =
                 src = Just $ C2N.Git url rev (Just sha256) subdir'
             createDirectoryIfMissing True (takeDirectory nixFile)
             writeDoc nixFile =<<
-              prettyNix <$> cabal2nix (argDetailLevel args) src cabalFile
+              prettyNix <$> cabal2nix True (argDetailLevel args) src cabalFile
             liftIO $ appendCache (argCacheFile args) url rev subdir sha256 pkg nix
             return $ fromString pkg $= mkPath False nix