[#119] Refactor and new test for missing contents in set-field

serokell · Aug 2, 2022 · e5e088d · e5e088d
1 parent 4a373e2
commit e5e088d
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 81 deletions.
diff --git a/lib/Web/Server.hs b/lib/Web/Server.hs
@@ -125,13 +125,6 @@ reportErrors io = do
     Right (Right a) -> do
       return a
 
--- setFieldVisibility
---   :: (forall a. Command a -> Handler a)
---   -> Bool
---   -> EntryPath
---   -> FieldName
---   -> Handler Entry
-
 makeServer
   :: (SomeBackend -> (forall a. Command a -> Handler a))
   -> Server API

diff --git a/tests/server-integration/SetField/SetFieldTest.hs b/tests/server-integration/SetField/SetFieldTest.hs
@@ -9,11 +9,11 @@ import Control.Lens
 import Data.Aeson (Value)
 import Data.Aeson.Lens
 import Data.Aeson.QQ.Simple (aesonQQ)
-import Data.Functor (void)
 import Data.Text (Text)
 import Data.Time
+import Network.HTTP.Client (responseStatus)
 import Network.HTTP.Req
-import Network.HTTP.Types (status404)
+import Network.HTTP.Types (status404, status415)
 import Test.Tasty.HUnit
 import Utils
 
@@ -43,7 +43,7 @@ unit_set_field_private :: IO ()
 unit_set_field_private = cofferTest do
   createEntry "entry"
 
-  response <- setField "entry" "private-field" (Just False) "contents"
+  response <- setField "entry" "private-field" (Just "private") "contents"
 
   let fieldMb =
         responseBody response
@@ -66,7 +66,7 @@ unit_set_field_public :: IO ()
 unit_set_field_public = cofferTest do
   createEntry "entry"
 
-  response <- setField "entry" "public-field" (Just True) "contents"
+  response <- setField "entry" "public-field" (Just "public") "contents"
 
   let fieldMb =
         responseBody response
@@ -98,8 +98,30 @@ unit_set_field_entry_not_found = cofferTest do
         ]
       |]
 
--- unit_set_field_missing_field_contents :: IO ()
--- TODO: add test that expects an error in case of missing contents
+-- | Request with no body in set-field must be invalid
+-- HTTP Exception with 415 status code (unsupported
+-- media type) is expected
+unit_set_field_missing_field_contents :: IO ()
+unit_set_field_missing_field_contents = cofferTest do
+  createEntry "entry"
+
+  result <- try @HttpException
+    (executeCommand
+      POST
+      ["set-field"]
+      NoReqBody
+      (jsonResponse @Value)
+      (mconcat
+        [ "path" =: ("/entry" :: Text)
+        , "field" =: ("field" :: Text)
+        ]
+      )
+    )
+
+  flip unwrapStatusCodeError result $ \response _ ->
+    if responseStatus response == status415
+    then pure ()
+    else assertFailure $ "Expected Http status 415, got: " <> show response
 
 unit_set_field_updates_modification_date :: IO ()
 unit_set_field_updates_modification_date = cofferTest do
@@ -117,50 +139,44 @@ unit_set_field_updates_modification_date = cofferTest do
   assertBool "Dates are not equal"
     $ responseBody response ^?! key "fields" . key "field" . key "dateModified" . _JSON == newModifiedDate
 
-unit_set_field_visibility :: IO ()
-unit_set_field_visibility = cofferTest do
+unit_set_field_visibility_public :: IO ()
+unit_set_field_visibility_public = cofferTest do
   createEntry "dir/entry"
-  void $ setField "dir/entry" "private-field" Nothing "contents"
-  void $ setField "dir/entry" "public-field" Nothing "contents"
-  changeFieldVisibility "dir/entry" "private-field" "private"
-  changeFieldVisibility "dir/entry" "public-field" "public"
-
-  response <-
-    executeCommand
-      GET
-      ["view"]
-      NoReqBody
-      (jsonResponse @Value)
-      ("path" =: (("dir/entry") :: Text))
+  setField "dir/entry" "public-field" (Just "private") "contents"
+  fieldMb <-
+    changeFieldVisibility "dir/entry" "public-field" "public"
+      <&> scrubDates
+      <&> findField "public-field"
 
-  response @=
-    [aesonQQ|
-      {
-        "entries": [],
-        "subdirs": {
-          "dir": {
-            "entries": [
-              {
-                "path": "/dir/entry",
-                "dateModified": "",
-                "masterField": null,
-                "fields": {
-                  "public-field": {
-                    "dateModified": "",
-                    "visibility": "public",
-                    "contents": "contents"
-                  },
-                  "private-field": {
-                    "dateModified": "",
-                    "visibility": "private",
-                    "contents": "contents"
-                  }
-                },
-                "tags": []
-              }
-            ],
-            "subdirs": {}
+  case fieldMb of
+    Nothing -> assertFailure $ "Expected field \"public-field\", found nothing"
+    Just value ->
+      value @?=
+        [aesonQQ|
+          {
+            "visibility": "public",
+            "dateModified": "",
+            "contents": "contents"
           }
-        }
-      }
-    |]
+        |]
+
+unit_set_field_visibility_private :: IO ()
+unit_set_field_visibility_private = cofferTest do
+  createEntry "dir/entry"
+  setField "dir/entry" "private-field" (Just "public") "contents"
+  fieldMb <-
+    changeFieldVisibility "dir/entry" "private-field" "private"
+      <&> scrubDates
+      <&> findField "private-field"
+
+  case fieldMb of
+    Nothing -> assertFailure $ "Expected field \"private-field\", found nothing"
+    Just value ->
+      value @?=
+        [aesonQQ|
+          {
+            "visibility": "private",
+            "dateModified": "",
+            "contents": "contents"
+          }
+        |]
diff --git a/tests/server-integration/Utils.hs b/tests/server-integration/Utils.hs
@@ -102,8 +102,8 @@ scrubDates =
 cofferTest :: IO () -> IO ()
 cofferTest test = deleteRecords >> test
 
-setField :: Text -> Text -> Maybe Bool -> Text -> IO (JsonResponse Value)
-setField path name public contents =
+setField :: Text -> Text -> Maybe Text -> Text -> IO (JsonResponse Value)
+setField path name visibility contents =
   executeCommand
     POST
     ["set-field"]
@@ -115,21 +115,21 @@ setField path name public contents =
         , queryParam "visibility" visibility
         ]
     )
-  where
-    visibility = boolToVisibility <$> public
 
-changeFieldVisibility :: Text -> Text -> Text -> IO ()
-changeFieldVisibility path field visibility = void $
-  executeCommand
-    POST
-    ["set-field-visibility", visibility]
-    NoReqBody
-    ignoreResponse
-    ( mconcat
-        [ "path" =: path
-        , "field" =: field
-        ]
-    )
+changeFieldVisibility :: Text -> Text -> Text -> IO Value
+changeFieldVisibility path field visibility = do
+  response <-
+    executeCommand
+      POST
+      ["set-field-visibility", visibility]
+      NoReqBody
+      (jsonResponse @Value)
+      ( mconcat
+          [ "path" =: path
+          , "field" =: field
+          ]
+      )
+  pure $ responseBody response
 
 -- | Finds field in entry
 findField :: Text -> Value -> Maybe Value
@@ -264,11 +264,3 @@ addOrRemoveTag method path tag =
         , "tag" =: tag
         ]
     )
-
--- Util functions
-
--- | Converts Bool to "public" and "private".
--- true is public
-boolToVisibility :: Bool -> Text
-boolToVisibility True  = "public"
-boolToVisibility False = "private"