Migrate SRIHash tests to lib

Author: thomashoneyman

app/spago.yaml

@@ -53,6 +53,7 @@ package:
     - prelude
     - record
     - refs
+    - registry-lib
     - safe-coerce
     - spec
     - strings

app/test/Foreign/Tar.purs

@@ -12,8 +12,8 @@ import Node.FS.Stats as FS.Stats
 import Node.Path as Path
 import Registry.SRIHash as SRIHash
 import Test.Spec as Spec
+import Test.Spec.Assertions (AnyShow(..))
 import Test.Spec.Assertions as Assert
-import Test.Utils (shouldEqual)
 
 tar :: Spec.Spec Unit
 tar = do
@@ -26,7 +26,7 @@ tar = do
       tarball1 <- createTarball
       Aff.delay (Aff.Milliseconds 1010.0)
       tarball2 <- createTarball
-      tarball1 `shouldEqual` tarball2
+      AnyShow tarball1 `Assert.shouldEqual` AnyShow tarball2
   where
   createTarball = do
     packageTmp <- liftEffect Tmp.mkTmpDir

app/test/Main.purs

@@ -35,7 +35,6 @@ import Test.Fixture.Manifest as Fixture
 import Test.Foreign.JsonRepair as Foreign.JsonRepair
 import Test.Foreign.Licensee (licensee)
 import Test.Foreign.Tar as Foreign.Tar
-import Test.Registry.Hash as Registry.Hash
 import Test.Registry.Index as Registry.Index
 import Test.Registry.PackageSet as PackageSet
 import Test.Registry.SSH as SSH
@@ -89,8 +88,6 @@ main = launchAff_ do
       Spec.describe "Encoding examples" (manifestExamplesRoundtrip manifestExamplePaths)
     Spec.describe "Registry Index" do
       Registry.Index.spec registryEnv
-    Spec.describe "Hash" do
-      Registry.Hash.testHash
     Spec.describe "Tar" do
       Foreign.Tar.tar
     Spec.describe "Json Repair" do

app/test/Registry/Hash.purs

@@ -96,7 +96,8 @@
           registry-test = ''
             cd $(git rev-parse --show-toplevel)
             npm ci
-            spago test
+            spago test -p registry-app
+            spago test -p registry-lib -m Test.Registry
           '';
 
           registry-check-format = ''

app/test/Utils.purs

@@ -11,4 +11,6 @@ package:
     - prelude
     - strings
   test_dependencies:
+    - argonaut-core
     - spec
+    - sunde

flake.nix

@@ -0,0 +1,19 @@
+module Test.Assert where
+
+import Prelude
+
+import Control.Monad.Error.Class (class MonadThrow)
+import Data.Argonaut.Core as Argonaut
+import Data.Either (Either(..))
+import Effect.Exception (Error)
+import Test.Spec.Assertions (AnyShow(..))
+import Test.Spec.Assertions as Assertions
+import Unsafe.Coerce (unsafeCoerce)
+
+shouldEqual :: forall m a. MonadThrow Error m => Eq a => a -> a -> m Unit
+shouldEqual a b = Assertions.shouldEqual (AnyShow a) (AnyShow b)
+
+shouldEqualRight :: forall m e a. MonadThrow Error m => Eq a => a -> Either e a -> m Unit
+shouldEqualRight a = case _ of
+  Left e -> Assertions.fail (Argonaut.stringify (unsafeCoerce e :: Argonaut.Json))
+  Right b -> Assertions.shouldEqual (AnyShow a) (AnyShow b)

lib/spago.yaml

@@ -0,0 +1,14 @@
+module Test.Registry where
+
+import Prelude
+
+import Effect (Effect)
+import Effect.Aff as Aff
+import Test.Registry.SRIHash as Test.SRIHash
+import Test.Spec as Spec
+import Test.Spec.Reporter as Spec.Reporter
+import Test.Spec.Runner as Spec.Runner
+
+main :: Effect Unit
+main = Aff.launchAff_ $ Spec.Runner.runSpec [ Spec.Reporter.consoleReporter ] do
+  Spec.describe "SRIHash" Test.SRIHash.spec

lib/test/Assert.purs

@@ -0,0 +1,73 @@
+module Test.Registry.SRIHash (spec) where
+
+import Prelude
+
+import Control.Monad.Except (ExceptT(..))
+import Control.Monad.Except as Except
+import Data.Either (Either(..))
+import Data.Maybe (Maybe(..))
+import Data.String as String
+import Effect.Aff (Aff)
+import Node.ChildProcess as Process
+import Node.Path (FilePath)
+import Node.Path as Path
+import Registry.SRIHash as SRIHash
+import Sunde as Sunde
+import Test.Assert as Assert
+import Test.Spec as Spec
+import Test.Utils as Utils
+
+spec :: Spec.Spec Unit
+spec = do
+  Spec.describe "Creates a valid sha256 SRI hash" do
+    Spec.it "Hashes a spago.dhall file the same as openssl" do
+      hash <- SRIHash.hashFile hooksSpago
+      hash `Assert.shouldEqual` hooksSpagoHash
+
+    Spec.it "Hashes a LICENSE file the same as openssl" do
+      hash <- SRIHash.hashFile hooksLicense
+      hash `Assert.shouldEqual` hooksLicenseHash
+
+    Spec.it "spago.dhall hash matches the nix hash" do
+      hash <- SRIHash.hashFile hooksSpago
+      nix <- Except.runExceptT $ sha256Nix hooksSpago
+      hash `Assert.shouldEqualRight` nix
+
+    Spec.it "LICENSE hash matches the nix hash" do
+      hash <- SRIHash.hashFile hooksLicense
+      nix <- Except.runExceptT $ sha256Nix hooksLicense
+      hash `Assert.shouldEqualRight` nix
+
+  Spec.describe "Encodes and decodes from string" do
+    Spec.it "Round-trips spago.dhall file" do
+      hooksSpagoHash `Assert.shouldEqualRight` SRIHash.parse (SRIHash.print hooksSpagoHash)
+
+    Spec.it "Round-trips LICENSE file" do
+      hooksLicenseHash `Assert.shouldEqualRight` SRIHash.parse (SRIHash.print hooksLicenseHash)
+
+-- Test hash produced by `openssl`:
+-- openssl dgst -sha256 -binary < test/_fixtures/halogen-hooks/spago.dhall | openssl base64 -A
+hooksSpagoHash :: SRIHash.SRIHash
+hooksSpagoHash = Utils.fromRight "Failed to parse SRIHash" $ SRIHash.parse "sha256-fN9RUAzN21ZY4Y0UwqUSxwUPVz1g7/pcqoDvbJZoT04="
+
+hooksSpago :: FilePath
+hooksSpago = Path.concat [ "test", "_fixtures", "halogen-hooks", "spago.dhall" ]
+
+-- Test hash produced by `openssl`:
+-- openssl dgst -sha256 -binary < test/_fixtures/LICENSE | openssl base64 -A
+hooksLicenseHash :: SRIHash.SRIHash
+hooksLicenseHash = Utils.fromRight "Failed to parse SRIHash" $ SRIHash.parse "sha256-wOzNcCq20TAL/LMT1lYIiaoEIFGDBw+yp14bj7qK9v4="
+
+hooksLicense :: FilePath
+hooksLicense = Path.concat [ "test", "_fixtures", "halogen-hooks", "LICENSE" ]
+
+sha256Nix :: FilePath -> ExceptT String Aff SRIHash.SRIHash
+sha256Nix path = ExceptT do
+  -- In Nix 2.4 this will become `nix hash file`
+  let args = [ "hash-file", "--sri", path ]
+  result <- Sunde.spawn { cmd: "nix", args, stdin: Nothing } Process.defaultSpawnOptions
+  pure $ case result.exit of
+    Process.Normally 0 -> do
+      SRIHash.parse $ String.trim result.stdout
+    _ ->
+      Left result.stderr