packages feed

hnix-store-readonly (empty) → 0.1.0.0

raw patch · 7 files changed

+533/−0 lines, 7 filesdep +basedep +bytestringdep +crypton

Dependencies added: base, bytestring, crypton, data-default-class, hnix-store-core, hnix-store-nar, hnix-store-readonly, hspec, mtl, text, unordered-containers

Files

+ CHANGELOG.md view
@@ -0,0 +1,9 @@+# 0.1.0.0 2024-07-31++* Initial release++---++`hnix-store-readonly` uses [PVP Versioning][1].++[1]: https://pvp.haskell.org
+ LICENSE view
@@ -0,0 +1,201 @@+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright 2018 Shea Levy.++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.
+ README.md view
@@ -0,0 +1,6 @@+# hnix-store-readonly++Read-only variant of Nix store. Only computes paths+without interacting with the actual Nix store.++[System.Nix.Store.ReadOnly]: ./src/System/Nix/Store/ReadOnly.hs
+ hnix-store-readonly.cabal view
@@ -0,0 +1,61 @@+cabal-version:       2.2+name:                hnix-store-readonly+version:             0.1.0.0+synopsis:            Read-only Nix store+description:+  Path computation without interaction with the actual Nix store+homepage:            https://github.com/haskell-nix/hnix-store+license:             Apache-2.0+license-file:        LICENSE+author:              Shea Levy+maintainer:          srk@48.io+copyright:           2018 Shea Levy+category:            Nix+build-type:          Simple+extra-doc-files:+    CHANGELOG.md+extra-source-files:+    README.md++common commons+  ghc-options:  -Wall+  default-extensions:+      Rank2Types+    , ScopedTypeVariables+    , TypeApplications+  default-language: Haskell2010++library+  import: commons+  exposed-modules:+      System.Nix.Store.ReadOnly+  build-depends:+      base >=4.12 && <5+    , hnix-store-core >= 0.8+    , hnix-store-nar >= 0.1+    , bytestring+    , crypton+    , mtl+    , text+    , unordered-containers+  hs-source-dirs:      src++test-suite readonly+  import: commons+  type: exitcode-stdio-1.0+  main-is: Spec.hs+  other-modules:+    ReadOnlySpec+  hs-source-dirs:+    tests+  build-tool-depends:+    hspec-discover:hspec-discover+  build-depends:+      base+    , hnix-store-core+    , hnix-store-readonly+    , bytestring+    , crypton+    , data-default-class+    , hspec+    , unordered-containers
+ src/System/Nix/Store/ReadOnly.hs view
@@ -0,0 +1,130 @@+{-# LANGUAGE OverloadedStrings #-}++module System.Nix.Store.ReadOnly+  ( makeStorePath+  , makeTextPath+  , makeFixedOutputPath+  , computeStorePathForText+  , computeStorePathForPath+  ) where++import Control.Monad.State (StateT, execStateT, modify)+import Crypto.Hash (Context, Digest, SHA256)+import Data.ByteString (ByteString)+import Data.HashSet (HashSet)+import System.Nix.Hash (BaseEncoding(Base16), NamedAlgo(algoName))+import System.Nix.Store.Types (FileIngestionMethod(..), PathFilter, RepairMode)+import System.Nix.StorePath (StoreDir, StorePath, StorePathName)++import qualified Crypto.Hash+import qualified Data.ByteString.Char8+import qualified Data.ByteString+import qualified Data.HashSet+import qualified Data.List+import qualified Data.Text+import qualified Data.Text.Encoding+import qualified System.Nix.Hash+import qualified System.Nix.Nar+import qualified System.Nix.StorePath++makeStorePath+  :: forall hashAlgo+   . (NamedAlgo hashAlgo)+  => StoreDir+  -> ByteString+  -> Digest hashAlgo+  -> StorePathName+  -> StorePath+makeStorePath storeDir ty h nm =+ System.Nix.StorePath.unsafeMakeStorePath storeHash nm+ where+  storeHash = System.Nix.StorePath.mkStorePathHashPart @hashAlgo s+  s =+    Data.ByteString.intercalate ":" $+      ty:fmap Data.Text.Encoding.encodeUtf8+        [ algoName @hashAlgo+        , System.Nix.Hash.encodeDigestWith Base16 h+        , Data.Text.pack . Data.ByteString.Char8.unpack $ System.Nix.StorePath.unStoreDir storeDir+        , System.Nix.StorePath.unStorePathName nm+        ]++makeTextPath+  :: StoreDir+  -> StorePathName+  -> Digest SHA256+  -> HashSet StorePath+  -> StorePath+makeTextPath storeDir nm h refs = makeStorePath storeDir ty h nm+ where+  ty =+    Data.ByteString.intercalate+      ":"+      $ "text"+      : Data.List.sort+          (System.Nix.StorePath.storePathToRawFilePath storeDir+           <$> Data.HashSet.toList refs)++makeFixedOutputPath+  :: forall hashAlgo+  .  NamedAlgo hashAlgo+  => StoreDir+  -> FileIngestionMethod+  -> Digest hashAlgo+  -> StorePathName+  -> StorePath+makeFixedOutputPath storeDir recursive h =+  if recursive == FileIngestionMethod_FileRecursive+     && (algoName @hashAlgo) == "sha256"+  then makeStorePath storeDir "source" h+  else makeStorePath storeDir "output:out" h'+ where+  h' =+    Crypto.Hash.hash @ByteString @SHA256+      $  "fixed:out:"+      <> Data.Text.Encoding.encodeUtf8 (algoName @hashAlgo)+      <> (if recursive == FileIngestionMethod_FileRecursive then ":r:" else ":")+      <> Data.Text.Encoding.encodeUtf8 (System.Nix.Hash.encodeDigestWith Base16 h)+      <> ":"++computeStorePathForText+  :: StoreDir+  -> StorePathName+  -> ByteString+  -> (HashSet StorePath -> StorePath)+computeStorePathForText storeDir nm =+  makeTextPath storeDir nm+  . Crypto.Hash.hash++computeStorePathForPath+  :: StoreDir+  -> StorePathName        -- ^ Name part of the newly created `StorePath`+  -> FilePath             -- ^ Local `FilePath` to add+  -> FileIngestionMethod  -- ^ Add target directory recursively+  -> PathFilter           -- ^ Path filter function+  -> RepairMode           -- ^ Only used by local store backend+  -> IO StorePath+computeStorePathForPath storeDir name pth recursive _pathFilter _repair = do+  selectedHash <-+    if recursive == FileIngestionMethod_FileRecursive+      then recursiveContentHash+      else flatContentHash+  pure $ makeFixedOutputPath storeDir recursive selectedHash name+ where+  recursiveContentHash :: IO (Digest SHA256)+  recursiveContentHash =+    Crypto.Hash.hashFinalize+    <$> execStateT streamNarUpdate (Crypto.Hash.hashInit @SHA256)++  streamNarUpdate :: StateT (Context SHA256) IO ()+  streamNarUpdate =+    System.Nix.Nar.streamNarIO+      System.Nix.Nar.narEffectsIO+      pth+      (modify . flip (Crypto.Hash.hashUpdate @ByteString @SHA256))++  flatContentHash :: IO (Digest SHA256)+  flatContentHash =+    Crypto.Hash.hashlazy+    <$> System.Nix.Nar.narReadFile+          System.Nix.Nar.narEffectsIO+          pth
+ tests/ReadOnlySpec.hs view
@@ -0,0 +1,125 @@+{-# LANGUAGE OverloadedStrings #-}++module ReadOnlySpec where++import Data.Default.Class (Default(def))+import Test.Hspec (Spec, describe, it, shouldBe, pendingWith)++import Crypto.Hash (hash, Digest, SHA256(..))+import Data.ByteString (ByteString)+import System.Nix.StorePath (StorePath, StorePathName)+import System.Nix.Store.Types (FileIngestionMethod(..))++import qualified Data.HashSet+import qualified System.Nix.StorePath++import System.Nix.Store.ReadOnly++testDigest :: Digest SHA256+testDigest = Crypto.Hash.hash @ByteString "testDigest"++testName :: StorePathName+testName =+    either undefined id+  $ System.Nix.StorePath.mkStorePathName "testFixed"++testPath :: StorePath+testPath =+    either undefined id+  $ System.Nix.StorePath.parsePathFromText+      def+      "/nix/store/9472ijanf79nlkb5n1yh57s7867p1930-testFixed"++testPath2 :: StorePath+testPath2 =+    either undefined id+  $ System.Nix.StorePath.parsePathFromText+      def+      "/nix/store/iali40m5597kikibjxw8cx1ssxlqnii3-testFixed"++spec :: Spec+spec = do+  describe "ReadOnly" $ do+    it "makeStorePath computes correct StorePath" $+      (pure+        $ makeStorePath+            def+            "test"+            testDigest+            testName+      )+      `shouldBe`+      System.Nix.StorePath.parsePathFromText+        def+        "/nix/store/iali40m5597kikibjxw8cx1ssxlqnii3-testFixed"++    describe "makeTextPath" $ do+      it "computes correct StorePath for empty refs" $+        (pure+          $ makeTextPath+              def+              testName+              testDigest+              mempty+        )+        `shouldBe`+        System.Nix.StorePath.parsePathFromText+          def+          "/nix/store/ync87sfmahhaqwnykzwbk31q96drm9vn-testFixed"++      it "computes correct StorePath for nonempty refs" $+        (pure+          $ makeTextPath+              def+              testName+              testDigest+              (Data.HashSet.fromList [ testPath, testPath2 ])+        )+        `shouldBe`+        System.Nix.StorePath.parsePathFromText+          def+          "/nix/store/jcvh84zapqndh8hva515d4y41s07n2g8-testFixed"++    describe "makeFixedOuputPath" $ do+      it "computes correct StorePath, recursive" $+        (pure+          $ makeFixedOutputPath+              def+              FileIngestionMethod_FileRecursive+              testDigest+              testName+        )+        `shouldBe`+        System.Nix.StorePath.parsePathFromText+          def+          "/nix/store/c0cgdqy9i3smyh3as8c4s6fg6nvwdpzy-testFixed"++      it "computes correct StorePath, non-recursive" $+        (pure+          $ makeFixedOutputPath+              def+              FileIngestionMethod_Flat+              testDigest+              testName+        )+        `shouldBe`+        System.Nix.StorePath.parsePathFromText+          def+          "/nix/store/9472ijanf79nlkb5n1yh57s7867p1930-testFixed"++    it "computeStorePathForText computes correct StorePath" $+        (pure+          $ computeStorePathForText+              def+              testName+              "test"+              (Data.HashSet.fromList [ testPath ])+        )+        `shouldBe`+        System.Nix.StorePath.parsePathFromText+          def+          "/nix/store/838lq5qh5a88wsalcjpmj33bcnmpz3pc-testFixed"++    describe "computeStorePathForForPath" $ do+      it "computes correct StorePath" $+        pendingWith "needs IO and a sample directory to add"
+ tests/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}