hnix-store-json (empty) → 0.1.0.0
raw patch · 7 files changed
+556/−0 lines, 7 filesdep +aesondep +attoparsecdep +base
Dependencies added: aeson, attoparsec, base, containers, data-default-class, deriving-aeson, hnix-store-core, hnix-store-json, hnix-store-tests, hspec, text
Files
- CHANGELOG.md +9/−0
- LICENSE +201/−0
- README.md +3/−0
- hnix-store-json.cabal +65/−0
- src/System/Nix/JSON.hs +176/−0
- tests/JSONSpec.hs +101/−0
- tests/Spec.hs +1/−0
+ CHANGELOG.md view
@@ -0,0 +1,9 @@+# 0.1.0.0 2024-07-31++* Initial release++---++`hnix-store-json` 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,3 @@+# hnix-store-json++Aeson instances for core types.
+ hnix-store-json.cabal view
@@ -0,0 +1,65 @@+cabal-version: 2.2+name: hnix-store-json+version: 0.1.0.0+synopsis: JSON serialization for core types+description:+ Aeson instances for core types, required for remote store protocol+homepage: https://github.com/haskell-nix/hnix-store+license: Apache-2.0+license-file: LICENSE+author: Sorki+maintainer: srk@48.io+copyright: 2023 Sorki+category: Nix+build-type: Simple+extra-doc-files:+ CHANGELOG.md+extra-source-files:+ README.md++common commons+ ghc-options: -Wall+ default-extensions:+ DataKinds+ , DeriveAnyClass+ , DeriveGeneric+ , DerivingVia+ , FlexibleInstances+ , LambdaCase+ , RecordWildCards+ , StandaloneDeriving+ , TypeApplications+ default-language: Haskell2010++library+ import: commons+ exposed-modules:+ System.Nix.JSON+ build-depends:+ base >=4.12 && <5+ , hnix-store-core >= 0.8+ , aeson >= 2.0 && < 3.0+ , attoparsec+ , deriving-aeson >= 0.2+ , text+ hs-source-dirs: src++test-suite json+ import: commons+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ other-modules:+ JSONSpec+ hs-source-dirs:+ tests+ build-tool-depends:+ hspec-discover:hspec-discover+ build-depends:+ base+ , hnix-store-core+ , hnix-store-json+ , hnix-store-tests+ , aeson+ , containers+ , data-default-class+ , hspec
+ src/System/Nix/JSON.hs view
@@ -0,0 +1,176 @@+{-# LANGUAGE OverloadedStrings #-}+{-# OPTIONS_GHC -fno-warn-orphans #-}+{-|+Description : JSON serialization++This module is mostly a stub for now+providing (From|To)JSON for Realisation type+which is required for `-remote`.+-}+module System.Nix.JSON where++import Data.Aeson+import Deriving.Aeson+import System.Nix.Base (BaseEncoding(NixBase32))+import System.Nix.OutputName (OutputName)+import System.Nix.Realisation (DerivationOutput, Realisation, RealisationWithId(..))+import System.Nix.Signature (Signature)+import System.Nix.StorePath (StoreDir(..), StorePath, StorePathName, StorePathHashPart)++import qualified Data.Aeson.KeyMap+import qualified Data.Aeson.Types+import qualified Data.Attoparsec.Text+import qualified Data.Char+import qualified Data.Text+import qualified Data.Text.Lazy+import qualified Data.Text.Lazy.Builder+import qualified System.Nix.Base+import qualified System.Nix.OutputName+import qualified System.Nix.Realisation+import qualified System.Nix.Signature+import qualified System.Nix.StorePath++instance ToJSON StorePathName where+ toJSON = toJSON . System.Nix.StorePath.unStorePathName+ toEncoding = toEncoding . System.Nix.StorePath.unStorePathName++instance FromJSON StorePathName where+ parseJSON =+ withText "StorePathName"+ ( either (fail . show) pure+ . System.Nix.StorePath.mkStorePathName)++instance ToJSON StorePathHashPart where+ toJSON = toJSON . System.Nix.StorePath.storePathHashPartToText+ toEncoding = toEncoding . System.Nix.StorePath.storePathHashPartToText++instance FromJSON StorePathHashPart where+ parseJSON =+ withText "StorePathHashPart"+ ( either+ (fail . show)+ (pure . System.Nix.StorePath.unsafeMakeStorePathHashPart)+ . System.Nix.Base.decodeWith NixBase32+ )++instance ToJSON StorePath where+ toJSON =+ toJSON+ -- TODO: hacky, we need to stop requiring StoreDir for+ -- StorePath rendering and have a distinct+ -- types for rooted|unrooted paths+ . Data.Text.drop 1+ . System.Nix.StorePath.storePathToText (StoreDir mempty)++ toEncoding =+ toEncoding+ . Data.Text.drop 1+ . System.Nix.StorePath.storePathToText (StoreDir mempty)++instance FromJSON StorePath where+ parseJSON =+ withText "StorePath"+ ( either+ (fail . show)+ pure+ . System.Nix.StorePath.parsePathFromText (StoreDir mempty)+ . Data.Text.cons '/'+ )++instance ToJSON (DerivationOutput OutputName) where+ toJSON =+ toJSON+ . Data.Text.Lazy.toStrict+ . Data.Text.Lazy.Builder.toLazyText+ . System.Nix.Realisation.derivationOutputBuilder+ System.Nix.OutputName.unOutputName++ toEncoding =+ toEncoding+ . Data.Text.Lazy.toStrict+ . Data.Text.Lazy.Builder.toLazyText+ . System.Nix.Realisation.derivationOutputBuilder+ System.Nix.OutputName.unOutputName++instance ToJSONKey (DerivationOutput OutputName) where+ toJSONKey =+ Data.Aeson.Types.toJSONKeyText+ $ Data.Text.Lazy.toStrict+ . Data.Text.Lazy.Builder.toLazyText+ . System.Nix.Realisation.derivationOutputBuilder+ System.Nix.OutputName.unOutputName++instance FromJSON (DerivationOutput OutputName) where+ parseJSON =+ withText "DerivationOutput OutputName"+ ( either+ (fail . show)+ pure+ . System.Nix.Realisation.derivationOutputParser+ System.Nix.OutputName.mkOutputName+ )++instance FromJSONKey (DerivationOutput OutputName) where+ fromJSONKey =+ FromJSONKeyTextParser+ ( either+ (fail . show)+ pure+ . System.Nix.Realisation.derivationOutputParser+ System.Nix.OutputName.mkOutputName+ )++instance ToJSON Signature where+ toJSON = toJSON . System.Nix.Signature.signatureToText+ toEncoding = toEncoding . System.Nix.Signature.signatureToText++instance FromJSON Signature where+ parseJSON =+ withText "Signature"+ ( either+ (fail . show)+ pure+ . Data.Attoparsec.Text.parseOnly+ System.Nix.Signature.signatureParser+ )++data LowerLeading+instance StringModifier LowerLeading where+ getStringModifier "" = ""+ getStringModifier (c:xs) = Data.Char.toLower c : xs++deriving+ via CustomJSON+ '[FieldLabelModifier+ '[ StripPrefix "realisation"+ , LowerLeading+ , Rename "dependencies" "dependentRealisations"+ ]+ ] Realisation+ instance ToJSON Realisation+deriving+ via CustomJSON+ '[FieldLabelModifier+ '[ StripPrefix "realisation"+ , LowerLeading+ , Rename "dependencies" "dependentRealisations"+ ]+ ] Realisation+ instance FromJSON Realisation++-- For a keyed version of Realisation+-- we use RealisationWithId (DerivationOutput OutputName, Realisation)+-- instead of Realisation.id :: (DerivationOutput OutputName)+-- field.+instance ToJSON RealisationWithId where+ toJSON (RealisationWithId (drvOut, r)) =+ case toJSON r of+ Object o -> Object $ Data.Aeson.KeyMap.insert "id" (toJSON drvOut) o+ _ -> error "absurd"++instance FromJSON RealisationWithId where+ parseJSON v@(Object o) = do+ r <- parseJSON @Realisation v+ drvOut <- o .: "id"+ pure (RealisationWithId (drvOut, r))+ parseJSON x = fail $ "Expected Object but got " ++ show x
+ tests/JSONSpec.hs view
@@ -0,0 +1,101 @@+{-# LANGUAGE OverloadedStrings #-}+module JSONSpec where++import Data.Aeson (ToJSON, FromJSON, decode, encode)+import Data.Default.Class (Default(def))+import Test.Hspec (Expectation, Spec, describe, it, shouldBe)+import Test.Hspec.QuickCheck (prop)+import Test.Hspec.Nix (forceRight, roundtrips)++import System.Nix.Arbitrary ()+import System.Nix.JSON ()+import System.Nix.OutputName (OutputName)+import System.Nix.Realisation (DerivationOutput(..), Realisation(..))+import System.Nix.Signature (Signature)+import System.Nix.StorePath (StorePath, StorePathName, StorePathHashPart)++import qualified Data.Map+import qualified Data.Set+import qualified System.Nix.Hash+import qualified System.Nix.OutputName+import qualified System.Nix.Signature+import qualified System.Nix.StorePath++roundtripsJSON+ :: ( Eq a+ , Show a+ , ToJSON a+ , FromJSON a+ )+ => a+ -> Expectation+roundtripsJSON = roundtrips encode decode++sampleDerivationOutput :: DerivationOutput OutputName+sampleDerivationOutput = DerivationOutput+ { derivationOutputHash =+ forceRight+ $ System.Nix.Hash.mkNamedDigest+ "sha256"+ "1b4sb93wp679q4zx9k1ignby1yna3z7c4c2ri3wphylbc2dwsys0"+ , derivationOutputOutput =+ forceRight+ $ System.Nix.OutputName.mkOutputName "foo"+ }++sampleRealisation0 :: Realisation+sampleRealisation0 = Realisation+ { realisationOutPath =+ forceRight+ $ System.Nix.StorePath.parsePath+ def+ "/nix/store/cdips4lakfk1qbf1x68fq18wnn3r5r14-builder.sh"+ , realisationSignatures = mempty+ , realisationDependencies = mempty+ }++sampleRealisation1 :: Realisation+sampleRealisation1 = Realisation+ { realisationOutPath =+ forceRight+ $ System.Nix.StorePath.parsePath+ def+ "/nix/store/5rwxzi7pal3qhpsyfc16gzkh939q1np6-curl-7.82.0.drv"+ , realisationSignatures =+ Data.Set.fromList+ $ forceRight+ . System.Nix.Signature.parseSignature+ <$> [ "fW3iEMfyx6IZzGNswD54BjclfkXiYzh0xRXddrXfJ1rp1l8p1xTi9/0g2EibbwLFb6p83cwIJv5KtTGksC54CQ=="+ , "SMjnB3mPgXYjXacU+xN24BdzXlAgGAuFnYwPddU3bhjfHBeQus/OimdIPMgR/JMKFPHXORrk7pbjv68vecTEBA=="+ ]+ , realisationDependencies =+ Data.Map.fromList+ [ ( sampleDerivationOutput+ , forceRight+ $ System.Nix.StorePath.parsePathFromText+ def+ "/nix/store/9472ijanf79nlkb5n1yh57s7867p1930-testFixed"+ )+ ]+ }++spec :: Spec+spec = do+ describe "JSON" $ do+ describe "roundtrips" $ do+ prop "StorePathName" $ roundtripsJSON @StorePathName+ prop "StorePathHashPart" $ roundtripsJSON @StorePathHashPart+ prop "StorePath" $ roundtripsJSON @StorePath+ prop "DerivationOutput OutputName" $ roundtripsJSON @(DerivationOutput OutputName)+ prop "Signature" $ roundtripsJSON @Signature+ prop "Realisation" $ roundtripsJSON @Realisation++ describe "ground truth" $ do+ it "sampleDerivationOutput matches preimage" $+ encode sampleDerivationOutput `shouldBe` "\"sha256:1b4sb93wp679q4zx9k1ignby1yna3z7c4c2ri3wphylbc2dwsys0!foo\""++ it "sampleRealisation0 matches preimage" $+ encode sampleRealisation0 `shouldBe` "{\"outPath\":\"cdips4lakfk1qbf1x68fq18wnn3r5r14-builder.sh\",\"signatures\":[],\"dependentRealisations\":{}}"++ it "sampleRealisation1 matches preimage" $+ encode sampleRealisation1 `shouldBe` "{\"outPath\":\"5rwxzi7pal3qhpsyfc16gzkh939q1np6-curl-7.82.0.drv\",\"signatures\":[\"SMjnB3mPgXYjXacU+xN24BdzXlAgGAuFnYwPddU3bhjfHBeQus/OimdIPMgR/JMKFPHXORrk7pbjv68vecTEBA==\",\"fW3iEMfyx6IZzGNswD54BjclfkXiYzh0xRXddrXfJ1rp1l8p1xTi9/0g2EibbwLFb6p83cwIJv5KtTGksC54CQ==\"],\"dependentRealisations\":{\"sha256:1b4sb93wp679q4zx9k1ignby1yna3z7c4c2ri3wphylbc2dwsys0!foo\":\"9472ijanf79nlkb5n1yh57s7867p1930-testFixed\"}}"
+ tests/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}