patrol-1.1.0.0: source/test-suite/Patrol/Type/DsnSpec.hs

{-# LANGUAGE QuasiQuotes #-}

module Patrol.Type.DsnSpec where

import qualified Data.Text as Text
import qualified Data.Text.Encoding as Text
import qualified Network.URI.Static as Uri
import qualified Patrol.Exception.Problem as Problem
import qualified Patrol.Type.Dsn as Dsn
import qualified Patrol.Version as Version
import qualified Test.Hspec as Hspec

spec :: Hspec.Spec
spec = Hspec.describe "Patrol.Type.Dsn" $ do
  Hspec.describe "fromText" $ do
    Hspec.it "fails with an invalid DSN" $ do
      Dsn.fromText (Text.pack "a:") `Hspec.shouldThrow` (\(Problem.Problem _) -> True)

    Hspec.it "succeeds with a minimal DSN" $ do
      dsn <- Dsn.fromText (Text.pack "a://b@c/d")
      dsn
        `Hspec.shouldBe` Dsn.Dsn
          { Dsn.protocol = Text.singleton 'a',
            Dsn.publicKey = Text.singleton 'b',
            Dsn.secretKey = Text.empty,
            Dsn.host = Text.singleton 'c',
            Dsn.port = Nothing,
            Dsn.path = Text.singleton '/',
            Dsn.projectId = Text.singleton 'd'
          }

    Hspec.it "succeeds with a maximal DSN" $ do
      dsn <- Dsn.fromText (Text.pack "a://b:c@d:5/f/g")
      dsn
        `Hspec.shouldBe` Dsn.Dsn
          { Dsn.protocol = Text.singleton 'a',
            Dsn.publicKey = Text.singleton 'b',
            Dsn.secretKey = Text.singleton 'c',
            Dsn.host = Text.singleton 'd',
            Dsn.port = Just 5,
            Dsn.path = Text.pack "/f/",
            Dsn.projectId = Text.singleton 'g'
          }

  Hspec.describe "fromUri" $ do
    Hspec.it "fails with an invalid DSN" $ do
      Dsn.fromUri [Uri.uri|a:|] `Hspec.shouldBe` Nothing

    Hspec.it "succeeds with a minimal DSN" $ do
      let dsn =
            Dsn.Dsn
              { Dsn.protocol = Text.singleton 'a',
                Dsn.publicKey = Text.singleton 'b',
                Dsn.secretKey = Text.empty,
                Dsn.host = Text.singleton 'c',
                Dsn.port = Nothing,
                Dsn.path = Text.singleton '/',
                Dsn.projectId = Text.singleton 'd'
              }
      Dsn.fromUri [Uri.uri|a://b@c/d|] `Hspec.shouldBe` Just dsn

    Hspec.it "succeeds with a maximal DSN" $ do
      let dsn =
            Dsn.Dsn
              { Dsn.protocol = Text.singleton 'a',
                Dsn.publicKey = Text.singleton 'b',
                Dsn.secretKey = Text.singleton 'c',
                Dsn.host = Text.singleton 'd',
                Dsn.port = Just 5,
                Dsn.path = Text.pack "/f/",
                Dsn.projectId = Text.singleton 'g'
              }
      Dsn.fromUri [Uri.uri|a://b:c@d:5/f/g|] `Hspec.shouldBe` Just dsn

    Hspec.it "fails with a query" $ do
      Dsn.fromUri [Uri.uri|a://b@c/d?|] `Hspec.shouldBe` Nothing

    Hspec.it "fails with a fragment" $ do
      Dsn.fromUri [Uri.uri|a://b@c/d#|] `Hspec.shouldBe` Nothing

    Hspec.it "fails without a project ID" $ do
      Dsn.fromUri [Uri.uri|a://b@c|] `Hspec.shouldBe` Nothing

    Hspec.it "fails with a trailing slash" $ do
      Dsn.fromUri [Uri.uri|a://b@c/d/|] `Hspec.shouldBe` Nothing

  Hspec.describe "intoUri" $ do
    Hspec.it "converts a minimal DSN into URI" $ do
      let dsn =
            Dsn.Dsn
              { Dsn.protocol = Text.singleton 'a',
                Dsn.publicKey = Text.singleton 'b',
                Dsn.secretKey = Text.empty,
                Dsn.host = Text.singleton 'c',
                Dsn.port = Nothing,
                Dsn.path = Text.singleton '/',
                Dsn.projectId = Text.singleton 'd'
              }
      Dsn.intoUri dsn `Hspec.shouldBe` [Uri.uri|a://b@c/d|]

    Hspec.it "converts a maximal DSN into URI" $ do
      let dsn =
            Dsn.Dsn
              { Dsn.protocol = Text.singleton 'a',
                Dsn.publicKey = Text.singleton 'b',
                Dsn.secretKey = Text.singleton 'c',
                Dsn.host = Text.singleton 'd',
                Dsn.port = Just 5,
                Dsn.path = Text.pack "/f/",
                Dsn.projectId = Text.singleton 'g'
              }
      Dsn.intoUri dsn `Hspec.shouldBe` [Uri.uri|a://b:c@d:5/f/g|]

  Hspec.describe "intoAuthorization" $ do
    Hspec.it "works without a secret key" $ do
      dsn <- maybe (fail "invalid DSN") pure $ Dsn.fromUri [Uri.uri|a://b@c/d|]
      let byteString = Text.encodeUtf8 . Text.pack $ "Sentry sentry_version=7,sentry_client=patrol/" <> Version.string <> ",sentry_key=b"
      Dsn.intoAuthorization dsn `Hspec.shouldBe` byteString

    Hspec.it "works with a secret key" $ do
      dsn <- maybe (fail "invalid DSN") pure $ Dsn.fromUri [Uri.uri|a://b:c@d/e|]
      let byteString = Text.encodeUtf8 . Text.pack $ "Sentry sentry_version=7,sentry_client=patrol/" <> Version.string <> ",sentry_key=b,sentry_secret=c"
      Dsn.intoAuthorization dsn `Hspec.shouldBe` byteString